ftp.bindings

2.15.0+ FTP port and address bindings. By default, no bindings are defined and the server will not listen on any port for FTP connections.

# example
ftp:
  bindings: 
    - port: 21
      ipAddress: '0.0.0.0'
      mode: explicit
      # use default certificate group 
    
    - port: 21
      ipAddress: '::'
      mode: explicit
      
    - port: 990
      ipAddress: '0.0.0.0'
      mode: implicit
      
    - port: 990
      ipAddress: '::'
      mode: implicit

    - port: 9909
      ipAddress: 'test.rebex.net'
      mode: implicit 
      externalAddress: 'test.rebex.net'
      dataPortRange: '49152-65535'
      
      # use certificate group named 'rebexnet'
      certificateGroup: rebexnet

ftp.bindings[].certificateGroup

string | null

Certificate group to be used for the selected binding. If not specified, the default certificate group is used. Unless mode is set to explicitPlain, the certificate group must contain at least one certificate.

ftp.bindings[].dataPortRange

string: <start-end> | number | null

2.15.5+ Port range to be used for FTP passive mode. Range in the format start-end or single number is accepted. If not specified, any port between 49152-65535 can be used.

ftp.bindings[].externalAddress

string: [<IPv4 address> | <hostname>]

2.15.5+ External address to be used for FTP passive mode. Either valid IPv4 address or hostname can be used. Hostname will be resolved to IPv4 address when the server starts.

ftp.bindings[].ipAddress

string: [<IPv4 address> | <IPv6 address> | <hostname>]

IP address to listen on. Use 0.0.0.0 to listen on any IPv4 endpoint and :: on any IPv6 endpoint. Hostnames can be used as well, the address will be resolved when the server starts.

ftp:
  bindings:
    - ipAddress: 192.168.1.1
      # ...
    - ipAddress: "::"
      # ...
    - ipAddress: test.rebex.net
      # ...

ftp.bindings[].mode

string: "implicit" | "explicit" | "explicitPlain" | "explicitTls"

FTP mode to use on the binding.

Mode Description Typical port numbers
explicitPlain Plain FTP (not encrypted). 21
explicitTls FTP with explicit TLS (encrypted). 21
explicit FTP with an optional TLS upgrade. 21
implicit FTP with implicit TLS (encrypted). 990

Encrypted modes require at least one certificate to be present in the specified certificate group.

ftp.bindings[].port

number

Port number to listen on. Port 21 is the default port for FTP (explicit mode). Port 990 is the default port for FTP over TLS (implicit mode).