Skip to content

Commit c72c33d

Browse files
author
Benton Roberts
committed
update documentation
1 parent e8579f0 commit c72c33d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This program runs in two different modes:
1313
----------------
1414
Installation
1515
----------------
16-
To install the server, just pull it like any other Docker image.
16+
To install the server, just pull `mdsol/docker-ssh-exec` like any other Docker image.
1717

1818
To install the client, just grab it from the [releases page][1], uncompress the archive, and copy the binary to somewhere in your `$PATH`. Remember that the client is run during the `docker build...` process, so either install the client just before invoking it, or make sure it's already present in your source image. Here's an example of the code you might run in your source image, to prepare it for SSH cloning from GitHub:
1919

@@ -39,6 +39,8 @@ or as an ENV var:
3939
docker run -e DOCKER-SSH-KEY="$(cat ~/.ssh/id_rsa)" --name=keyserver -d \
4040
mdsol/docker-ssh-exec -server
4141

42+
The benefit of this second method is that OS X systems using a virtual Docker host cannot easily use Docker's shared volume feature with files on the OS X side. The drawback is that the kay data is exposed in the process list.
43+
4244
Then, run a quick test of the client, to make sure it can get the key:
4345

4446
docker run --rm -it mdsol/docker-ssh-exec cat /root/.ssh/id_rsa
@@ -79,8 +81,8 @@ This software was created by Benton Roberts _([email protected])_
7981

8082
To build it yourself, just `go get` and `go install` as usual:
8183

82-
go get github.com/mdsol/12factor-tools/docker-ssh-exec
83-
cd $GOPATH/src/github.com/mdsol/12factor-tools/docker-ssh-exec
84+
go get github.com/mdsol/docker-ssh-exec
85+
cd $GOPATH/src/github.com/mdsol/docker-ssh-exec
8486
go install
8587

8688

0 commit comments

Comments
 (0)