From 5353d708bad524f02ee6f316aa913ecde3cbdc10 Mon Sep 17 00:00:00 2001 From: Adrian Dvergdal Date: Wed, 15 Oct 2014 22:47:14 +0200 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a09061c..605d959 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,34 @@ sftp ==== -SFTP Docker image +Simple and easy to use SFTP server based on Debian Usage ----- - - Define users and passwords in comma separated list with SFTP_USERS ("user1:pass1,user2:pass2"). - Mount volumes in user's home folder. The users are chrooted to their home folders, so it is important to mount the volumes in separate folders inside the user's home folder (/home/your-user/**your-folder**). -Example -------- +Examples +-------- +Simple (one user and one folder): ``` docker run \ - -e SFTP_USERS="foo:pass,bar:pass" \ - -v "ebooks:/home/foo/ebooks" \ - -v "http:/home/bar/http" \ + -e SFTP_USERS="foo:123" \ + -v "/sftp/share:/home/foo/share" \ + -p 2222:22 -d atmoz/sftp +``` + +Multiple users and folders: +``` +docker run \ + -e SFTP_USERS="foo:123,bar:abc" \ + -v "/sftp/share:/home/foo/share" \ + -v "/sftp/ebooks:/home/foo/ebooks" \ + -v "/sftp/http:/home/bar/http" \ -p 2222:22 -d atmoz/sftp ```