summaryrefslogtreecommitdiffstats
path: root/docker/README.md
diff options
context:
space:
mode:
authorArnstein Ressem <aressem@gmail.com>2016-06-21 18:26:17 +0200
committerArnstein Ressem <aressem@gmail.com>2016-06-21 18:26:17 +0200
commit8f5cfcdd54ab439e09ae6d9e7da7011247231465 (patch)
treeb3e54462fdd647e434b8b074c13f774d5bce4fea /docker/README.md
parent9ac578694a81e2de0539e22d05e373c8e87adbcf (diff)
Added readme. Exit from scripts on error.
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md
index e69de29bb2d..53e5a392ebc 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -0,0 +1,24 @@
+
+# Building and running Vespa on Docker (OS X and Linux)
+
+## Installing docker
+[Docker installation](https://docs.docker.com/engine/installation/)
+
+>*On OS X, the native Docker engine has **not** been tested. Please use the [Docker Toolbox](https://www.docker.com/products/docker-toolbox).*
+
+
+## Building Vespa
+> *On OS X, execute ```source osx-setup-docker-machine.sh``` to setup the Docker VM in which to run Docker.*
+
+Execute ```./build-vespa.sh <Vespa version number>``` to build Vespa from this source code.
+
+The produced rpms will be available in this folder after compiliation.
+
+
+## Running Vespa
+> *On OS X, execute ```source osx-setup-docker-machine.sh``` to setup the Docker VM in which to run Docker.*
+
+Execute ```./run-vespa.sh <Vespa version number>```
+
+This will create a Docker image which has the rpms from the build step installed. Vespa will be started inside the container.
+> *On OS X, the container runs inside the Docker VM. Execute ```docker-machine ssh vespa-docker-machine```to enter the VM.