0
0
Fork 0
mirror of https://github.com/atmoz/sftp.git synced 2025-03-09 15:16:00 -04:00
atmoz-sftp/README.md

65 lines
1.5 KiB
Markdown
Raw Normal View History

2014-10-06 21:40:59 +02:00
sftp
====
Easy to use SFTP (*SSH File Transfer Protocol*) server.
2014-10-06 21:40:59 +02:00
Usage
-----
2014-10-21 03:21:53 +02:00
- Define users as last arguments to `docker run`, one user per argument
(syntax: `user:pass[:e][:[uid][:gid]]`).
- You must set custom UID for your users if you want them to make changes to
your mounted volumes with permissions matching your host filesystem.
2014-10-15 22:26:16 +02:00
- Mount volumes in user's home folder.
- The users are chrooted to their home directory, so you must mount the
volumes in separate directories inside the user's home directory
(/home/user/**mounted-directory**).
2014-10-15 22:26:16 +02:00
2014-10-15 22:47:14 +02:00
Examples
--------
### Single user and volume
2014-10-16 00:09:27 +02:00
2014-10-15 22:47:14 +02:00
```
docker run \
2014-10-21 03:21:53 +02:00
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
foo:123:1001
2014-10-15 22:47:14 +02:00
```
2014-10-07 00:25:49 +02:00
### Multiple users and volumes
2014-10-16 00:09:27 +02:00
2014-10-07 00:25:49 +02:00
```
docker run \
2014-10-21 03:21:53 +02:00
-v /host/share:/home/foo/share \
-v /host/documents:/home/foo/documents \
-v /host/http:/home/bar/http \
-p 2222:22 -d atmoz/sftp \
foo:123:1001 \
bar:abc:1002
2014-10-07 00:25:49 +02:00
```
2014-10-21 03:21:53 +02:00
### Encrypted password
2014-10-21 03:21:53 +02:00
Add `:e` behind password to mark it as encrypted. Use single quotes.
```
2014-10-21 03:21:53 +02:00
docker run \
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
'foo:$1$0G2g0GSt$ewU0t6GXG15.0hWoOX8X9.:e:1001'
```
2014-10-21 03:21:53 +02:00
Tip: you can use makepasswd to generate encrypted passwords:
`echo -n 123 | makepasswd --crypt-md5 --clearfrom -`
### Using SSH key (without password)
```
2014-10-21 03:21:53 +02:00
docker run \
-v /host/id_rsa.pub:/home/foo/.ssh/authorized_keys:ro \
2014-10-21 03:21:53 +02:00
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
foo::1001
```