mirror of
https://github.com/atmoz/sftp.git
synced 2024-11-17 12:51:33 -05:00
63 lines
1.3 KiB
Markdown
63 lines
1.3 KiB
Markdown
sftp
|
|
====
|
|
|
|
Easy to use SFTP (*SSH File Transfer Protocol*) server.
|
|
|
|
Usage
|
|
-----
|
|
|
|
- Define users and passwords in comma separated list with SFTP_USERS (syntax:
|
|
`user:pass[:e][:[uid][:gid]][,...]`).
|
|
- You must set custom UID and/or GID for your users if you want them to make
|
|
changes to your mounted volumes with permissions matching your host
|
|
filesystem.
|
|
- 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**).
|
|
|
|
Examples
|
|
--------
|
|
|
|
### Single user and volume
|
|
|
|
```
|
|
docker run \
|
|
-e SFTP_USERS='foo:123' \
|
|
-v "/host/share:/home/foo/share" \
|
|
-p 2222:22 -d atmoz/sftp
|
|
```
|
|
|
|
### Multiple users and volumes
|
|
|
|
```
|
|
docker run \
|
|
-e SFTP_USERS='foo:123,bar:abc' \
|
|
-v "/host/share:/home/foo/share" \
|
|
-v "/host/documents:/home/foo/documents" \
|
|
-v "/host/http:/home/bar/http" \
|
|
-p 2222:22 -d atmoz/sftp
|
|
```
|
|
|
|
### Custom UID and GID
|
|
|
|
```
|
|
SFTP_USERS='foo:123:1001:100'
|
|
```
|
|
|
|
Only custom GID:
|
|
|
|
```
|
|
SFTP_USERS='foo:123::100'
|
|
```
|
|
|
|
### Encrypted password
|
|
|
|
Add `:e` behind password to mark it as encrypted:
|
|
|
|
```
|
|
SFTP_USERS='foo:$1$0G2g0GSt$ewU0t6GXG15.0hWoOX8X9.:e:1001:100'
|
|
```
|
|
|
|
Tip: you can use makepasswd to generate encrypted passwords:
|
|
`echo -n 123 | makepasswd --crypt-md5 --clearfrom -`
|