0
0
Fork 0
mirror of https://github.com/atmoz/sftp.git synced 2024-12-22 13:14:42 -05:00
A containerized SFTP service.
Find a file
2015-02-23 11:52:45 +01:00
.dockerignore Add README.md to .dockerignore 2014-10-21 03:23:12 +02:00
Dockerfile Rename run to entrypoint 2014-12-31 16:35:46 +01:00
entrypoint Rename variables 2015-01-03 13:10:38 +01:00
README.md Added docs on logging into the SFTP server 2015-02-18 18:12:37 -05:00
sshd_config No need for group, forced sftp 2014-10-16 22:07:39 +02:00

sftp Docker Build Status

Easy to use SFTP (SSH File Transfer Protocol) server with OpenSSH.

Usage

  • 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.
  • 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 \
    -v /host/share:/home/foo/share \
    -p 2222:22 -d atmoz/sftp \
    foo:123:1001

Logging in

The SFTP server runs in the container on port 22, and in this example, you are forwarding the container's port 22 to the host's port 2222.

To log into the STFP server, run

sftp -P 2222 foo@docker.host.tld

with docker.host.tld being the address (IP or domain name) of the machine running the Docker daemon.

Multiple users and volumes

docker run \
    -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

Encrypted password

Add :e behind password to mark it as encrypted. Use single quotes.

docker run \
    -v /host/share:/home/foo/share \
    -p 2222:22 -d atmoz/sftp \
    'foo:$1$0G2g0GSt$ewU0t6GXG15.0hWoOX8X9.:e:1001'

Tip: you can use makepasswd to generate encrypted passwords:
echo -n 123 | makepasswd --crypt-md5 --clearfrom -

Using SSH key (without password)

docker run \
    -v /host/id_rsa.pub:/home/foo/.ssh/authorized_keys:ro \
    -v /host/share:/home/foo/share \
    -p 2222:22 -d atmoz/sftp \
    foo::1001