X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/190d0f110dab5d51dcfa7b13ff658583fdd21a5d..2b96f0945cfdbda223227b96393a5f77aff477a4:/doc/install/install-docker.html.textile.liquid
diff --git a/doc/install/install-docker.html.textile.liquid b/doc/install/install-docker.html.textile.liquid
index 31342e5ee7..00f84eb6e2 100644
--- a/doc/install/install-docker.html.textile.liquid
+++ b/doc/install/install-docker.html.textile.liquid
@@ -6,8 +6,7 @@ title: Installing with Docker
h2. Purpose
-This installation method is appropriate for local testing, evaluation, and
-development. For production use, this method is not recommended.
+This installation method is appropriate for local testing, evaluation, and development. For production use, this method is not recommended.
h2. Prerequisites
@@ -25,29 +24,22 @@ See also: "Downloading the source code":https://arvados.org/projects/arvados/wik
h2. Building the Arvados Docker containers
-First of all, a suitable @config.yml@ file is needed.
+First of all, a suitable @config.yml@ file is needed. The easiest way to generate one based on the provided @config.yml.example@ file is to run the @build.sh@ script. If no @config.yml@ file exists, it will will prompt for a few inputs, write the @config.yml@ file, and then proceed to build all the Docker containers. If @config.yml@ exists, invoking @build.sh@ will simply build all Docker containers or update those that need to be updated.
-~$ cd arvados/docker
-~$ cp config.yml.example config.yml
-
-PUBLIC_KEY_PATH -ARVADOS_USER_NAME -API_HOSTNAME -API_AUTO_ADMIN_USER -- -Then build the docker containers (this will take a while): +Run @build.sh@ without arguments to generate @config.yml@ and build all Docker containers (this will take a while!):
~$ ./build.sh
+Generating config.yml.
+Arvados needs to know the email address of the administrative user,
+so that when that user logs in they are automatically made an admin.
+This should be an email address associated with a Google account.
+
+Enter your Google ID email address here:
+
...
+
Step 7 : ADD generated/setup.sh /usr/local/bin/setup.sh
---> d7c0e7fdf7ab
Removing intermediate container f3d81180795d
@@ -84,22 +76,40 @@ crosbymichael/skydns latest 1923ce648d4c 5 months ago
h2. Updating the Arvados Docker containers
-If there has been an update to the Arvados Docker building code, it is safest to rebuild the Arvados Docker images from scratch. All build information can be cleared with the '--clean' option to build.sh:
+@build.sh@ takes a few optional arguments:
-~$ ./build.sh --clean
+
+~$ ./build.sh --help
+
+usage: ./build.sh [options]
+
+Calling ./build.sh without arguments will build all Arvados docker images
+
+./build.sh options:
+ -h, --help Print this help text
+ clean Clear all build information
+ realclean clean and remove all Arvados Docker images except arvados/debian
+ deepclean realclean and remove arvados/debian, crosbymichael/skydns and
+ crosbymichael/skydns Docker images
+
+
+If there has been an update to the Arvados Docker building code, it is safest to rebuild the Arvados Docker images from scratch. All build information can be cleared with the 'clean' option to build.sh:
+
+
+~$ ./build.sh clean
-You can also use '--realclean', which does what '--clean' does and in addition removes all Arvados Docker containers and images from your system, with the exception of the arvados/debian image.
+You can also use 'realclean', which does what 'clean' does and in addition removes all Arvados Docker containers and images from your system, with the exception of the arvados/debian image.
-~$ ./build.sh --realclean
+~$ ./build.sh realclean
-Finally, the '--deepclean' option does what '--realclean' does, and also removes the arvados/debian image.
+Finally, the 'deepclean' option does what 'realclean' does, and also removes the arvados/debian, crosbymichael/skydns and crosbymichael/skydock images.
-~$ ./build.sh --deepclean
+~$ ./build.sh deepclean
h2. Running the Arvados Docker containers
@@ -177,6 +187,8 @@ Point your browser to the Dockerized workbench: