docker-ftp-server/README.md
2022-01-22 23:03:13 +00:00

45 lines
929 B
Markdown

# FTP Server
A simple FTP server, using
[`vsftpd`](https://security.appspot.com/vsftpd.html).
## How to use this image
### start a FTP Server instance
To start a container, with data stored in `/data` on the host, use the
following:
```sh
docker run \
--detach \
--env FTP_PASS=123 \
--env FTP_USER=user \
--name my-ftp-server \
--publish 20-21:20-21/tcp \
--publish 40000-40009:40000-40009/tcp \
--volume /data:/home/user \
garethflowers/ftp-server
```
### ... via `docker compose`
```yml
services:
ftp-server:
container_name: my-ftp-server
environment:
- FTP_PASS=123
- FTP_USER=user
image: garethflowers/ftp-server
ports:
- '20-21:20-21/tcp'
- '40000-40009:40000-40009/tcp'
volumes:
- '/data:/home/user'
```
## License
- This image is released under the
[MIT License](https://raw.githubusercontent.com/garethflowers/docker-ftp-server/master/LICENSE).