|
1 | 1 | # Docker volume plugin for sshFS
|
2 | 2 |
|
3 |
| -This plugin allows you to mount remote folder using sshfs in your container easily. |
| 3 | +See vieux/sshfs for original documentation |
4 | 4 |
|
5 |
| -[](https://travis-ci.org/vieux/docker-volume-sshfs) |
6 |
| -[](https://goreportcard.com/report/github.com/vieux/docker-volume-sshfs) |
7 |
| - |
8 |
| -## Usage |
9 |
| - |
10 |
| -### Using a password |
11 |
| - |
12 |
| -1 - Install the plugin |
13 |
| - |
14 |
| -``` |
15 |
| -$ docker plugin install vieux/sshfs |
16 |
| -
|
17 |
| -# or to enable debug |
18 |
| -docker plugin install vieux/sshfs DEBUG=1 |
19 |
| -
|
20 |
| -# or to change where plugin state is stored |
21 |
| -docker plugin install vieux/sshfs state.source=<any_folder> |
22 |
| -``` |
23 |
| - |
24 |
| -2 - Create a volume |
25 |
| - |
26 |
| -``` |
27 |
| -$ docker volume create -d vieux/sshfs -o sshcmd=<user@host:path> -o password=<password> [-o port=<port>] [-o <any_sshfs_-o_option> ] sshvolume |
28 |
| -sshvolume |
29 |
| -$ docker volume ls |
30 |
| -DRIVER VOLUME NAME |
31 |
| -local 2d75de358a70ba469ac968ee852efd4234b9118b7722ee26a1c5a90dcaea6751 |
32 |
| -local 842a765a9bb11e234642c933b3dfc702dee32b73e0cf7305239436a145b89017 |
33 |
| -local 9d72c664cbd20512d4e3d5bb9b39ed11e4a632c386447461d48ed84731e44034 |
34 |
| -local be9632386a2d396d438c9707e261f86fd9f5e72a7319417901d84041c8f14a4d |
35 |
| -local e1496dfe4fa27b39121e4383d1b16a0a7510f0de89f05b336aab3c0deb4dda0e |
36 |
| -vieux/sshfs sshvolume |
37 |
| -``` |
38 |
| - |
39 |
| -3 - Use the volume |
40 |
| - |
41 |
| -``` |
42 |
| -$ docker run -it -v sshvolume:<path> busybox ls <path> |
43 |
| -``` |
44 |
| - |
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 | 5 |
|
| 6 | +Usage |
76 | 7 | ```
|
77 | 8 | $ docker run -it -v sshvolume:<path> busybox ls <path>
|
78 | 9 | ```
|
|
0 commit comments