docs(readme): adds docker compose example

This commit is contained in:
Gareth Flowers 2022-01-22 23:03:13 +00:00
parent ae94c71a53
commit 5b26f6425a

View file

@ -5,7 +5,7 @@ A simple FTP server, using
## How to use this image
### Start a FTP Server instance
### start a FTP Server instance
To start a container, with data stored in `/data` on the host, use the
following:
@ -22,6 +22,23 @@ docker run \
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