Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

FTP Screen

  5 minute read.

Last Modified 2022-08-11 11:07 EDT

File Transfer Protocol (FTP) is a communication protocol. It transfers data across a computer network. Configure FTP service settings on TrueNAS using the FTP services screen.

FTPBasicOption

After making changes to settings click SAVE to confirm and save your changes.

Click ADVANCED OPTIONS to display advanced settings options. Click BASIC OPTIONS to return to the basic settings options.

Click CANCEL to exit without saving.

General Options Settings

NameDescription
PortEnter the port the FTP service listens on.
ClientsEnter the maximum number of simultaneous clients.
ConnectionsEnter the maximum number of connections per IP address. 0 is unlimited.
Login AttemptsEnter the greatest number of attempts client permitted before disconnect. Increase if users are prone to misspellings or typos.
TimeoutEnter the maximum client idle time in seconds before disconnect. Default value is 600 seconds.
CertificateSelect from the dropdown list the SSL certificate to use for TLS FTP connections. Currently listed as freenas_default. To create a certificate, go to System > Certificates.

Advanced Option Settings

Click Advanced Options if you need to customize your FTP service. Advanced Options are more detailed than the Basic Options settings.

Access and TLS Settings

FTPAdvancedOptionsAccessTLS

Access Settings

NameDescription
Always ChrootSelect to only allow users access their home directory if they are in the wheel group. This option increases security risk.
Allow Root LoginSelect to allow root logins. Selecting this option increases security risk. Not recommended.
Allow Anonymous LoginSelect to allow anonymous FTP logins with access to the directory specified in Path.
Allow Local User LoginBy default, only members of the ftp group can to log in. Select this checkbox to allow any local user to log in.
Require IDENT AuthenticationSelect to require IDENT authentication. Selecting this option results in timeouts when ident (or in Shell identd) is not running on the client.
File PermissionsSelect to define default permissions for newly created files.
Directory PermissionsSelect to define default permissions for newly created directories.

TLS Settings

Unless necessary, do not allow anonymous or root access. For better security, enable TLS when possible. This is effectively FTPS. When FTP is exposed to a WAN, enable TLS.
NameDescription
Enable TLSSelect to allow encrypted connections. Requires a certificate. To create or import a certificate go to System > Certificates.
TLS PolicySelect the policy from the dropdown list of options. Options are On, Off, Data, !Data, Auth, Ctrl, Ctrl + Data, Ctrl +!Data, Auth + Data or Auth +!Data. Defines whether the control channel, data channel, both channels, or neither channel of an FTP session must occur over SSL/TLS. The policies are described here.
TLS Allow Client RenegotiationsSelect to allow client renegotiations. This option is not recommended. Selecting this option breaks several security measures. See mod_tls for details.
TLS Allow Dot LoginIf selected, TrueNAS checks the user home directory for a .tlslogin file. This file must contain one or more PEM-encoded certificates. System prompts user for password authentication if file not found.
TLS Allow Per UserIf selected, allows sending a user password unencrypted.
TLS Common Name RequiredSelect to require the common name in the certificate match the FQDN of the host.
TLS Enable DiagnosticsSelect to make logs more verbose. Useful in troubleshooting a connection.
TLS Export Certificate DataSelect to export the certificate environment variables.
TLS No Certificate RequestSelect if the client cannot connect due to a problem with the certificate request. Example: the client server is unable to handle the server certificate request.
TLS No Empty FragmentsNot recommended. This option bypasses a security mechanism.
TLS No Session Reuse RequiredThis option reduces connection security. Only select if the client does not understand reused SSL sessions.
TLS Export Standard VarsSelect to put in place several environment variables.
TLS DNS Name RequiredSelect to require the client DNS name resolve to its IP address, and the cert contain the same DNS name.
TLS IP Address RequiredSelect to require the client certificate IP address match the client IP address.

Bandwidth and Other Settings**

FTPAdvancedOptionsBandwidthOther

Bandwitdth Settings

NameDescription
Local User Upload Bandwidth: (Examples: 500 KiB, 500M, 2 TB)Enter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is 0 KiB.
Local User Download BandwidthEnter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is 0 KiB.
Anonymous User Upload BandwidthEnter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is 0 KiB.
Anonymous User Download BandwidthEnter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is 0 KiB.

Other Options Settings

NameDescription
Minimum Passive PortUsed by clients in PASV mode. A default of 0 means any port above 1023.
Maximum Passive PortUsed by clients in PASV mode. A default of 0 means any port above 1023.
Enable FXPSelect to enable the File eXchange Protocol (FXP). Not recommended as this leaves the server vulnerable to FTP bounce attacks.
Allow Transfer ResumptionSelect to allow FTP clients to resume interrupted transfers.
Perform Reverse DNS LookupsSelect to allow performing reverse DNS lookups on client IPs. Causes long delays if reverse DNS isn’t configured.
Masquerade AddressPublic IP address or host name. Select if FTP clients cannot connect through a NAT device.
Display LoginSpecify the message displayed to local login users after authentication. This is not displayed to anonymous login users.
Auxiliary ParametersSelect to add additional proftpd(8 parameters.

Related Content