Update and link ssh agent docs

lmakarov · Oct 10, 2016 · e99ce44 · e99ce44
1 parent 77f4001
commit e99ce44
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,7 @@ Tools available inside the **cli** container:
 - [Enabling Varnish support](/docs/varnish.md)
 - [Enabling Apache Solr support](/docs/apache-solr.md)
 - [Using Sass](/docs/sass.md)
+- [Using custom ssh keys (with or without passwords) via ssh-agent](/docs/ssh-agent.md)
 
 <a name="troubleshooting"></a>
 ## Troubleshooting

diff --git a/docs/ssh-agent.md b/docs/ssh-agent.md
@@ -8,15 +8,25 @@ Required dsh version: `1.20.0+`
 # Setup
 
 1. Make sure dsh version is `1.20.0` or higher.
-2. `dsh reset ssh-agent` (only necessary when updating from older versions) 
-3. Add the following configuration option to the `cli` service in your projects `docker-compose.yml` file
+2. `dsh reset ssh-agent` (only necessary when updating from older versions).
+3. Add the following configuration option to the `cli` service in your projects `docker-compose.yml` file:
 
+    For Compose file format version 1
     ```yml
     cli:
       ...
       volumes_from:
         - ssh-agent
       ...
     ```
-4. Update container configuration with `dsh up`
+
+    For Compose file format version 2
+    ```yml
+    cli:
+      ...
+      volumes_from:
+        - container:ssh-agent
+      ...
+    ```
+4. Reset the cli container `dsh reset cli`.
 5. See `dsh help ssh-agent` for more usage information.