georgegedox/vsftpd

This Docker container implements a vsftpd server, with the following features:

Centos 7 base image.
vsftpd 3.0
Virtual users
Passive mode
Logging to a file or STDOUT.

Installation from Docker registry hub.

You can download the image with the following command:

docker pull georgegedox/vsftpd

Environment variables

Variable name: UID
Default value: 50.
Accepted values: User ID.
Description: User id used by this container, if you have an existing directory owned by a user that you want FTP access to without changing the user on the host, grab that user's ID and use it for the container.

Variable name: GID
Default value: 50.
Accepted values: Group ID.
Description: Same as the above, just for the group instead.

This image uses environment variables to allow the configuration of some parameters at run time:

Variable name: FTP_USER
Default value: admin
Accepted values: Any string. Avoid whitespaces and special chars.
Description: Username for the default FTP account. If you don't specify it through the FTP_USER environment variable at run time, admin will be used by default.

Variable name: FTP_PASS
Default value: Random string.
Accepted values: Any string.
Description: If you don't specify a password for the default FTP account through FTP_PASS, a 16 character random string will be automatically generated. You can obtain this value through the container logs.

Variable name: PASV_ADDRESS
Default value: Docker host IP / Hostname.
Accepted values: Any IPv4 address or Hostname (see PASV_ADDRESS_RESOLVE).
Description: If you don't specify an IP address to be used in passive mode, the routed IP address of the Docker host will be used. Bear in mind that this could be a local address.

Variable name: PASV_ADDR_RESOLVE
Default value: NO
Accepted values: <NO|YES>
Description: Set to YES if you want to use a hostname (as opposed to IP address) in the PASV_ADDRESS option.

Variable name: PASV_ENABLE
Default value: YES
Accepted values: <NO|YES>
Description: Set to NO if you want to disallow the PASV method of obtaining a data connection.

Variable name: PASV_MIN_PORT
Default value: 21100
Accepted values: Any valid port number.
Description: This will be used as the lower bound of the passive mode port range. Remember to publish your ports with docker -p parameter.

Variable name: PASV_MAX_PORT
Default value: 21110
Accepted values: Any valid port number.
Description: This will be used as the upper bound of the passive mode port range. It will take longer to start a container with a high number of published ports.

Variable name: XFERLOG_STD_FORMAT
Default value: NO
Accepted values: <NO|YES>
Description: Set to YES if you want the transfer log file to be written in standard xferlog format.

Variable name: LOG_STDOUT
Default value: Empty string.
Accepted values: Any string to enable, empty string or not defined to disable.
Description: Output vsftpd log through STDOUT, so that it can be accessed through the container logs.

Variable name: FILE_OPEN_MODE
Default value: 0666
Accepted values: File system permissions.
Description: The permissions with which uploaded files are created. Umasks are applied on top of this value. You may wish to change to 0777 if you want uploaded files to be executable.

Variable name: LOCAL_UMASK
Default value: 077
Accepted values: File system permissions.
Description: The value that the umask for file creation is set to for local users. NOTE! If you want to specify octal values, remember the "0" prefix otherwise the value will be treated as a base 10 integer!

Variable name: REVERSE_LOOKUP_ENABLE
Default value: YES
Accepted values: <NO|YES>
Description: Set to NO if you want to avoid performance issues where a name server doesn't respond to a reverse lookup.

Variable name: PASV_PROMISCUOUS
Default value: NO
Accepted values: <NO|YES>
Description: Set to YES if you want to disable the PASV security check that ensures the data connection originates from the same IP address as the control connection. Only enable if you know what you are doing! The only legitimate use for this is in some form of secure tunnelling scheme, or perhaps to facilitate FXP support.

Variable name: PORT_PROMISCUOUS
Default value: NO
Accepted values: <NO|YES>
Description: Set to YES if you want to disable the PORT security check that ensures that outgoing data connections can only connect to the client. Only enable if you know what you are doing! Legitimate use for this is to facilitate FXP support.

Exposed ports and volumes

The image exposes ports 20 and 21. Also, exports two volumes: /ftp, which contains users home directories, and /var/log/vsftpd, used to store logs.

When sharing a homes directory between the host and the container (/ftp) the owner user id and group id should be 50 for both but this can be changed by specifying the UID and GID environment variables to match a local user on the host.

Use cases

Create a temporary container for testing purposes:

  docker run --rm georgegedox/vsftpd

Create a container in active mode using the default user account, with a binded data directory:

docker run -d -p 21:21 -v /my/data/directory:/ftp --name vsftpd georgegedox/vsftpd
# see logs for credentials:
docker logs vsftpd

Create a production container with a custom user account, binding a data directory and enabling both active and passive mode:

docker run -d -v /my/data/directory:/ftp \
-p 20:20 -p 21:21 -p 21100-21110:21100-21110 \
-e FTP_USER=myuser -e FTP_PASS=mypass \
-e PASV_ADDRESS=127.0.0.1 -e PASV_MIN_PORT=21100 -e PASV_MAX_PORT=21110 \
--name vsftpd --restart=always georgegedox/vsftpd

Manually add a new FTP user to an existing container:

docker exec -i -t vsftpd bash
mkdir /ftp/myuser
echo -e "myuser\nmypass" >> /etc/vsftpd/virtual_users.txt
/usr/bin/db_load -T -t hash -f /etc/vsftpd/virtual_users.txt /etc/vsftpd/virtual_users.db
exit
docker restart vsftpd

GeorgeGedox/docker_vsftpd

georgegedox/vsftpd

Installation from Docker registry hub.

Environment variables

Exposed ports and volumes

Use cases