Merge branch 'master' into 2060-edit-tags-in-workbench
[arvados.git] / docker / README.md
index 48b255f9ed246d787e9f5f85b2d007fcf7bb5241..63387d3384c2984cf3ba2617157e79a63a1f3f4d 100644 (file)
@@ -16,8 +16,39 @@ Prerequisites
 
   Docker is a Linux container management system based on LXC. It is a
   very young system but is being developed rapidly.
-  [Installation packages](http://www.docker.io/gettingstarted/#h_installation)
+  [Installation packages](http://www.docker.io/gettingstarted/)
   are available for several platforms.
+  
+  If a prebuilt docker package is not available for your platform, the
+  short instructions for installing it are:
+  
+  1. Create a `docker` group and add yourself to it.
+
+     <pre>
+     $ sudo addgroup docker
+     $ sudo adduser `whoami` docker
+     </pre>
+
+     Log out and back in.
+        
+  2. Add a `cgroup` filesystem and mount it:
+
+     <pre>
+     $ mkdir -p /cgroup
+     $ grep cgroup /etc/fstab
+     none   /cgroup    cgroup    defaults    0    0
+     $ sudo mount /cgroup
+        </pre>
+
+  3. Enable IPv4 forwarding:
+
+     <pre>
+     $ grep ipv4.ip_forward /etc/sysctl.conf
+     net.ipv4.ip_forward=1
+     $ sudo sysctl net.ipv4.ip_forward=1
+     </pre>
+        
+  4. [Download and run a docker binary from docker.io.](http://docs.docker.io/en/latest/installation/binaries/)
 
 * Ruby (any version)
 
@@ -57,6 +88,12 @@ Deploying
    * controller.$API_HOSTNAME
    * workbench.$API_HOSTNAME
 
-2. The `run.sh` script in this directory will start all Arvados
-   servers on your machine.
+2. The `arvdock` script in this directory is used to start, stop and
+   restart Arvados servers on your machine. Example usages:
 
+   * `arvdock start`
+   * `arvdock stop`
+   * `arvdock restart`
+   * `arvdock start --api --sso` to start just the API and SSO services.
+   * `arvdock start --workbench=8000` starts just the Workbench service on port 8000.
+   * `arvdock stop --keep` to stop just the Keep services.