Skip to content

Latest commit

 

History

History
119 lines (78 loc) · 5.52 KB

README.md

File metadata and controls

119 lines (78 loc) · 5.52 KB
Raw

pure-ftpd container

Build Status

pure-ftpd with virtual users. Based on stilliard/docker-pure-ftpd

Main differences:

  • Based on Alpine Linux, not Debian
  • s6 init

Usage

Plain FTP

docker run -d --name ftpd_server -p 20-21:20-21 -p 30000-30009:30000-30009 -e "PUBLICHOST=localhost" ajoergensen/pure-ftpd

FTP with TLS

docker run -d --name ftpd_server -p 20-21:20-21 -p 30000-30009:30000-30009 -e "PUBLICHOST=localhost" -v ./certs:/etc/ssl/private:ro ajoergensen/pure-ftpd

In the default configuration only TLSv1.2 and strong ciphers are used (testssl.sh report)

Certificate
Manual certificate handling

If you use a traditional CA which issues certificates manually and with a long expiry time (1-3 years) you can simply provide the needed files via the volume used for /etc/ssl/private/

The directory must contain the file pure-ftpd.pem.

pure-ftpd.pem must contain the private key, certificate and all intermediate certificates needed.

cat private-key.pem certificate.pem intermediate.pem > pure-ftpd.pem

If you place a file called pure-ftpd-dhparams.pem in /etc/ssl/private it will be used by pure-ftpd

The dhparams should be at least 2048 bits:

# openssl dhparam -out pure-ftpd-dhparams.pem 4096
Automatic certificate handling

If you use Let's Encrypt and rely on automatic certificate renewal it is possible to have the container monitor the certificate for changes and restart pure-ftpd is a change is detected

docker run -name -p 20-21:20-21 -p 30000-30009:30000-30009 -e "PUBLICHOST=localhost" -v /etc/letsencrypt/ftp.example.com/key.pem:/certs/ftpd.key:ro -v /etc/letsencrypt/ftp.example.com/fullchain.pem:/certs/ftpd.pem:ro -v -v /etc/letsencrypt/dhparams.pem:/certs/dhparams.pem ajoergensen/pure-ftpd

The location and name of the files inside the can be controlled through environment variables. See below.

Environment

  • ADDED_FLAGS: Any command line options to be added to the default
  • PUBLICHOST: Host/IP used for PASV
  • MONITOR_CERTIFICATE: Monitors the supplied key/certificate for changes. This is useful if using Let's Encrypt certificates. Default is FALSE
  • CERTIFICATE_KEY_PATH: Path inside the container to the key file for the SSL certificate. Only used if MONITOR_CERTIFICATE is true. Default is /certs/ftpd.key
  • CERTIFICATE_FULLCHAIN_PATH: Path inside the container to the SSL certificate file (including all needed intermediates). Only used if MONITOR_CERTIFICATE is true. Default is /certs/ftpd.pem
  • CERTIFICATE_DHPARAMS_PATH: Path inside the container to the dhparams.pem file. Only used if MONITOR_CERTIFICATE is true. Default is /certs/dhparams.pem
  • CIPHER_LIST: List of SSL ciphers to use/support if TLS is enabled, default is ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256 (Mozilla modern cipher list)

Management

To enter the running container: docker exec -it ftpd_server bash

This comes in handy for managing user

pure-pw useradd bob -f /etc/pure-ftpd/passwd/pureftpd.passwd -m -u ftpuser -d /home/ftpusers/bob

This will add a virtual user bob chroot'ed into /home/ftpusers/bob.

For more information: https://download.pureftpd.org/pure-ftpd/doc/README.Virtual-Users

Logs

To get verbose logs add the following to your docker run command:

-e "ADDED_FLAGS=-d -d"

Then follow the output with docker logs -f ftpd_server

Want a transfer log file? add the following to your docker run command:

-e "ADDED_FLAGS=-O w3c:/var/log/pure-ftpd/transfer.log"

Default options

/usr/sbin/pure-ftpd # path to pure-ftpd executable
-c 50 # --maxclientsnumber (no more than 50 people at once)
-C 10 # --maxclientsperip (no more than 10 requests from the same ip)
-l puredb:/etc/pure-ftpd/pureftpd.pdb # --login (login file for virtual users)
-E # --noanonymous (only real users)
-j # --createhomedir (auto create home directory if it doesnt already exist)
-R # --nochmod (prevent usage of the CHMOD command)
-P $PUBLICHOST # IP/Host setting for PASV support, passed in your the PUBLICHOST env var
-p 30000:30009 # PASV port range
-tls 1 # Enables optional TLS support

For more information please see man pure-ftpd, or visit: https://www.pureftpd.org/

Volumes

  • /home/ftpusers/ The ftp's data volume (by convention).
  • /etc/pure-ftpd/passwd A directory containing the single pureftps.passwd file which contains the user database (i.e., all virtual users, their passwords and their home directories). This is read on startup of the container and updated by the pure-pw useradd -f /etc/pure- ftpd/passwd/pureftpd.passwd ... command.
  • /etc/ssl/private/ A directory containing a single pure-ftpd.pem file with the server's SSL certificates for TLS support. Optional TLS is automatically enabled when the container finds this file on startup.