From 846f4921871374854649780a68367337ac5e851f Mon Sep 17 00:00:00 2001 From: dede Date: Tue, 6 May 2025 22:30:26 +0200 Subject: [PATCH] update README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index db7adf9..4c47245 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,18 @@ which is in the _whois_ debian package. ## Usage Example +### Docker Compose +First, setup your .env file by copying the sample file and modifying it to suit your needs. +``` +cp env.sample .env +vi .env +``` +Then run the stack +``` +docker compose up -d +``` + +### Docker ``` docker run --rm -it -p 21:21 -p 4559-4564:4559-4564 -e FTP_USER=ftp -e FTP_PASSWORD=ftp docker.io/panubo/vsftpd:latest ``` @@ -73,4 +85,4 @@ See [serverfault: vsftp: whu is allow_writable_chroot=YES a bad idea?](https://s ## Logs -To get the FTP logs mount `/var/log` outside of the container. For example add `-v /var/log/ftp:/var/log` to your `docker run ...` command. +To get the FTP logs mount `/var/log` outside of the container. For example add `-v /var/log/ftp:/var/log` to your `docker run ...` command or use `docker compose`.