diff --git a/uftpd.cfg b/uftpd.cfg index 12e38df..afc6940 100755 --- a/uftpd.cfg +++ b/uftpd.cfg @@ -1,67 +1,68 @@ -#FTP CONFIGURATION SAMPLE "/etc/uftpd.cfg" +# FTP CONFIGURATION SAMPLE "/etc/uftpd.cfg" ####################################################### # UFTP SERVER SETTINGS # ####################################################### -#MAXIMUM ALLOWED CONNECTIONS ON THE SERVER -MAXIMUM_ALLOWED_FTP_CONNECTION = 30 +# NOTES: +# restart uFTP to apply the configuration after changing parameters -#TCP/IP PORT SETTINGS (DEFAULT 21) +# Maximum allowed FTP connections on the server +MAXIMUM_ALLOWED_FTP_CONNECTION = 50 + +# TCP/IP port settings (default: 21) FTP_PORT = 21 -#Allow only one server instance (true or false) +# Allow only one server instance (true or false) SINGLE_INSTANCE = true -#Run in background, daemon mode ok +# Run in background daemon mode (true or false) DAEMON_MODE = true -# Folder where to save the logs, use the same format below, the folder must terminate with / +# Folder where logs are saved; must end with a '/' LOG_FOLDER = /var/log/ -# Maximum number of logs to keep, if 0 log functionality is disabled +# Maximum number of logs to keep; set to 0 to disable logging MAXIMUM_LOG_FILES = 0 -# Idle timeout in seconds, client are disconnected for inactivity after the -# specified amount of time in seconds, set to 0 to disable -IDLE_MAX_TIMEOUT = 3600 +# Idle timeout in seconds; clients are disconnected after this period of inactivity; set to 0 to disable +# some clients may fail if the timeout is too high https://github.com/kingk85/uFTP/issues/29 +IDLE_MAX_TIMEOUT = 330 -#MAX CONNECTIONS PER IP -#LIMIT THE MAXIMUM NUMBER OF CONNECTION FOR EACH IP ADDRESS -# 0 TO DISABLE +# Maximum connections per IP address; set to 0 to disable MAX_CONNECTION_NUMBER_PER_IP = 10 -#MAX LOGIN TRY PER IP -#THE IP ADDRESS WILL BE BLOCKED FOR 5 MINUTES AFTER WRONG LOGIN USERNAME AND PASSWORD -#0 TO DISABLE +# Maximum login attempts per IP (anti bruteforce feature); IP will be blocked for 5 minutes after exceeding this number of failed login attempts; set to 0 to disable MAX_CONNECTION_TRY_PER_IP = 10 -#USE THE SERVER IP PARAMETER IF THE FTP SERVER IS UNDER NAT -#SERVER IP SHOULD BE SET TO ROUTER IP IN THIS CASE -#IF NOT IN USE LEAVE IT COMMENTED OR BLANK -#USE , instad of . eg: 192,168,1,1 +# Server IP address for NAT configurations; use commas instead of periods (e.g., 192,168,1,1); leave commented or blank if not used #SERVER_IP = 192,168,1,1 -#TLS CERTIFICATE FILE PATH +# TLS certificate file paths CERTIFICATE_PATH=/etc/uFTP/cert.pem PRIVATE_CERTIFICATE_PATH=/etc/uFTP/key.pem -#Enable system authentication based on /etc/passwd -#and /etc/shadow +# Enable system authentication based on /etc/passwd and /etc/shadow (true or false) ENABLE_PAM_AUTH = false -# Force usage of the TLS -# If enabled, only TLS connections will be allowed +# Force usage of TLS; if enabled, only TLS connections are allowed (true or false) FORCE_TLS = false -# -# Random port for passive FTP connections range -# +# Random port range for passive FTP connections RANDOM_PORT_START = 10000 RANDOM_PORT_END = 50000 -#USERS -#START FROM USER 0 TO XXX +####################################################### +# USER SETTINGS # +####################################################### + +# Define users with the following parameters: +# USER_ = username +# PASSWORD_ = password +# HOME_ = home directory +# GROUP_NAME_OWNER_ = group ownership for new files (optional) +# USER_NAME_OWNER_ = user ownership for new files (optional) + USER_0 = username PASSWORD_0 = password HOME_0 = / @@ -78,7 +79,7 @@ USER_2 = anotherUsername PASSWORD_2 = anotherPassowrd HOME_2 = / -#blocked user that are not allowed to login +# Blocked users who are not allowed to log in BLOCK_USER_0 = user1 BLOCK_USER_1 = user2 BLOCK_USER_2 = user3