Add usage instructions
This commit is contained in:
parent
d805748b9f
commit
070352c7cc
1 changed files with 13 additions and 12 deletions
25
README.md
25
README.md
|
@ -1,14 +1,14 @@
|
|||
# docker-alpine-ftp-server
|
||||
Small and flexible docker image with vsftpd server
|
||||
# docker-alpine-ftp-server-tls
|
||||
Small and flexible docker image with vsftpd server with tls
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker run -d \
|
||||
-p 21:21 \
|
||||
-p 21000-21010:21000-21010 \
|
||||
-e USERS="one|1234" \
|
||||
-e ADDRESS=ftp.site.domain \
|
||||
delfer/alpine-ftp-server
|
||||
-p 21:21 \
|
||||
-p 21000-21010:21000-21010 \
|
||||
-e USERS="one|1234" \
|
||||
-e ADDRESS=ftp.site.domain \
|
||||
aminvakil/alpine-ftp-server-tls
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
@ -17,14 +17,15 @@ Environment variables:
|
|||
- `USERS` - space and `|` separated list (optional, default: `ftp|alpineftp`)
|
||||
- format `name1|password1|[folder1][|uid1] name2|password2|[folder2][|uid2]`
|
||||
- `ADDRESS` - external address witch clients can connect passive ports (optional)
|
||||
- `MIN_PORT` - minimum port number to be used for passive connections (optional, default `21000`)
|
||||
- `MAX_PORT` - maximum port number to be used for passive connections (optional, default `21010`)
|
||||
- `MIN_PORT` - minamal port number may be used for passive connections (optional, default `21000`)
|
||||
- `MAX_PORT` - maximal port number may be used for passive connections (optional, default `21010`)
|
||||
|
||||
## USERS examples
|
||||
|
||||
- `user|password foo|bar|/home/foo`
|
||||
- `user|password|/home/user/dir|10000`
|
||||
- `user|password||10000`
|
||||
=======
|
||||
# docker-alpine-ftp-server-tls
|
||||
Small and flexible docker image with vsftpd server with tls
|
||||
|
||||
## ALERT
|
||||
Do not use this certificate in your production server, you should generate your own certificate using this command
|
||||
`openssl req -x509 -nodes -days 7300 -newkey rsa:2048 -keyout vsftpd.pem -out vsftpd.pem`
|
||||
|
|
Loading…
Reference in a new issue