Add SSO docker container

[arvados.git] / docker / README

diff --git a/docker/README b/docker/README
index 073f9aa9adae6c9febee13fe1b36545c91d17cd7..2bb947a5e43ac1578349630531c6c00e04eebe6d 100644 (file)
--- a/docker/README
+++ b/docker/README
@@ -24,20 +24,33 @@ PREREQUISITES
 BUILDING
 --------
 
-1. Before building, edit config.yml with settings for your
-   installation.
+1. Copy `config.yml.example' to `config.yml' and edit it with settings
+   for your installation.
 
 2. Run `./config.rb' to generate configuration files.
 
-3. Add a DNS entry for your API_HOSTNAME which resolves to the machine
-   that the API container will be deployed to.
-
-4. Provision your Omniauth server with the APP_ID and
-   APP_SECRET from api/omniauth.rb.
-
-5. Run `./build.sh' to build the following Docker images:
+3. Run `./build.sh' to build the following Docker images:
 
      arvados/api    - the Arvados API server
      arvados/keep   - Keep, the Arvados content-addressable filesystem
      arvados/crunch - Crunch, a compute node for Arvados
+     arvados/workbench - the Arvados console
+
+DEPLOYING
+---------
+
+1. Make sure the ARVADOS_DNS_SERVER has been provisioned with the
+   following DNS entries, resolving to the appropriate IP addresses
+   where each service will be deployed.
+
+   $API_HOSTNAME
+   keep0
+   compute0
+   controller
+   git
+   shell
+
+2. Provision your Omniauth server with the APP_ID and
+   APP_SECRET from api/omniauth.rb.
 
+3. docker run -p 80:80 -p 443:443 arvados/api