diff --git a/README.md b/README.md index 47389f5..1bfbc6f 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,20 @@ SFTP Docker image Usage ----- -Define users and passwords in comma separated list (user1:pass1,user2:pass2), and mount filesystem as folder in user's home folder. + +- 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//****). + +Example +------- ``` docker run \ - -e SFTP_USERS=":,:" \ - -v some-dir:/home//some-dir \ - -v another-dir:/home//another-dir \ + -e SFTP_USERS="foo:pass,bar:pass" \ + -v "ebooks:/home/foo/ebooks" \ + -v "http:/home/bar/http" \ -p 2222:22 -d atmoz/sftp ```