Skip to content
This repository was archived by the owner on Oct 19, 2022. It is now read-only.

Commit 69972ed

Browse files
committed
update readme
Signed-off-by: Victor Vieux <victorvieux@gmail.com>
1 parent 4dbf79b commit 69972ed

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ This plugin allows you to mount remote folder using sshfs in your container easi
77

88
## Usage
99

10+
### Using a password
11+
1012
1 - Install the plugin
1113

1214
```
@@ -40,6 +42,41 @@ vieux/sshfs sshvolume
4042
$ docker run -it -v sshvolume:<path> busybox ls <path>
4143
```
4244

45+
### Using an ssh key
46+
47+
1 - Install the plugin
48+
49+
```
50+
$ docker plugin install vieux/sshfs sshkey.source=/home/<user>/.ssh/
51+
52+
# or to enable debug
53+
docker plugin install vieux/sshfs DEBUG=1 sshkey.source=/home/<user>/.ssh/
54+
55+
# or to change where plugin state is stored
56+
docker plugin install vieux/sshfs state.source=<any_folder> sshkey.source=/home/<user>/.ssh/
57+
```
58+
59+
2 - Create a volume
60+
61+
```
62+
$ docker volume create -d vieux/sshfs -o sshcmd=<user@host:path> [-o IdentityFile=/root/.ssh/<key>] [-o port=<port>] [-o <any_sshfs_-o_option> ] sshvolume
63+
sshvolume
64+
$ docker volume ls
65+
DRIVER VOLUME NAME
66+
local 2d75de358a70ba469ac968ee852efd4234b9118b7722ee26a1c5a90dcaea6751
67+
local 842a765a9bb11e234642c933b3dfc702dee32b73e0cf7305239436a145b89017
68+
local 9d72c664cbd20512d4e3d5bb9b39ed11e4a632c386447461d48ed84731e44034
69+
local be9632386a2d396d438c9707e261f86fd9f5e72a7319417901d84041c8f14a4d
70+
local e1496dfe4fa27b39121e4383d1b16a0a7510f0de89f05b336aab3c0deb4dda0e
71+
vieux/sshfs sshvolume
72+
```
73+
74+
3 - Use the volume
75+
76+
```
77+
$ docker run -it -v sshvolume:<path> busybox ls <path>
78+
```
79+
4380
## LICENSE
4481

4582
MIT

0 commit comments

Comments
 (0)