0
0
Fork 0
mirror of https://github.com/atmoz/sftp.git synced 2024-11-24 12:59:24 -05:00
atmoz-sftp/README.md

93 lines
2.3 KiB
Markdown
Raw Normal View History

2015-08-25 08:50:23 -04:00
atmoz/sftp
==========
2014-10-06 15:40:59 -04:00
Easy to use SFTP ([SSH File Transfer Protocol](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol)) server with [OpenSSH](https://en.wikipedia.org/wiki/OpenSSH). This is an automated build linked with the [debian](https://hub.docker.com/_/debian/) repository.
2014-10-06 15:40:59 -04:00
Usage
-----
2015-12-07 04:10:24 -05:00
- Define users as command arguments, STDIN or mounted in /etc/sftp-users.conf
(syntax: `user:pass[:e][:uid[:gid]]...`).
2014-10-20 21:21:53 -04:00
- 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 16:26:16 -04: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 16:26:16 -04:00
2014-10-15 16:47:14 -04:00
Examples
--------
2015-12-07 04:10:24 -05:00
### Simple example
2014-10-15 18:09:27 -04:00
2014-10-15 16:47:14 -04:00
```
docker run \
2014-10-20 21:21:53 -04:00
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
foo:123:1001
2014-10-15 16:47:14 -04:00
```
2014-10-06 18:25:49 -04:00
2015-11-23 09:11:48 -05:00
#### Using Docker Compose:
```
sftp:
image: atmoz/sftp
volumes:
- /host/share:/home/foo/share
ports:
- "2222:22"
command: foo:123:1001
```
#### Logging in
2015-02-23 06:08:11 -05:00
The OpenSSH server runs by default on port 22, and in this example, we are
forwarding the container's port 22 to the host's port 2222. To log in with an
2015-02-23 06:23:07 -05:00
OpenSSH client, run: `sftp -P 2222 foo@<host-ip>`
2015-12-07 04:10:24 -05:00
### Store users in config
2014-10-06 18:25:49 -04:00
```
docker run \
2015-12-07 04:10:24 -05:00
-v /host/users.conf:/etc/sftp-users.conf:ro \
2014-10-20 21:21:53 -04:00
-v /host/share:/home/foo/share \
-v /host/documents:/home/foo/documents \
-v /host/http:/home/bar/http \
2015-12-07 04:10:24 -05:00
-p 2222:22 -d atmoz/sftp
2014-10-06 18:25:49 -04:00
```
2015-12-07 04:27:14 -05:00
/host/users.conf:
```
foo:123:1001
bar:abc:1002
```
2014-10-20 21:21:53 -04:00
### Encrypted password
2014-10-20 21:21:53 -04:00
Add `:e` behind password to mark it as encrypted. Use single quotes.
```
2014-10-20 21:21:53 -04:00
docker run \
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
'foo:$1$0G2g0GSt$ewU0t6GXG15.0hWoOX8X9.:e:1001'
```
2015-12-07 04:14:34 -05:00
Tip: you can use makepasswd to generate encrypted passwords:
2015-12-07 04:10:24 -05:00
`echo -n "password" | makepasswd --crypt-md5 --clearfrom -`
### Using SSH key (without password)
Mount all public keys in the user's `.ssh/keys/` folder. All keys are automatically
appended to `.ssh/authorized_keys`.
```
2014-10-20 21:21:53 -04:00
docker run \
-v /host/id_rsa.pub:/home/foo/.ssh/keys/id_rsa.pub:ro \
-v /host/id_other.pub:/home/foo/.ssh/keys/id_other.pub:ro \
2014-10-20 21:21:53 -04:00
-v /host/share:/home/foo/share \
-p 2222:22 -d atmoz/sftp \
foo::1001
```