FTP server configuration¶
Warning
ftp and sftp are mutually exclusive
Example
server:
ftp:
host: test.rebex.net
port: 21
username: demo
password: password
sources:
- /
timeout: 5s
disableUTF8: false
disableEPSV: false
disableMLSD: false
escapeRegexpMeta: false
tls: false
insecureSkipVerify: false
logTrace: false
Reference¶
host¶
FTP host IP or domain.
Config file
server:
ftp:
host: 127.0.0.1
Environment variables
FTPGRAB_SERVER_FTP_HOST
port¶
FTP port. (default 21)
Config file
server:
ftp:
port: 21
Environment variables
FTPGRAB_SERVER_FTP_PORT
username¶
FTP username.
Config file
server:
ftp:
username: foo
Environment variables
FTPGRAB_SERVER_FTP_USERNAME
usernameFile¶
Use content of secret file as FTP username if username not defined.
Config file
server:
ftp:
usernameFile: /run/secrets/username
Environment variables
FTPGRAB_SERVER_FTP_USERNAMEFILE
password¶
FTP password.
Config file
server:
ftp:
password: bar
Environment variables
FTPGRAB_SERVER_FTP_PASSWORD
passwordFile¶
Use content of secret file as FTP password if password not defined.
Config file
server:
ftp:
passwordFile: /run/secrets/password
Environment variables
FTPGRAB_SERVER_FTP_PASSWORDFILE
sources¶
List of sources paths to grab from FTP server.
Config file
server:
ftp:
sources:
- /path1
- /path2/folder
Environment variables
FTPGRAB_SERVER_FTP_SOURCES
timeout¶
Timeout for opening connections, sending control commands, and each read/write of data transfers. (default 5s)
Config file
server:
ftp:
timeout: 5s
Environment variables
FTPGRAB_SERVER_FTP_TIMEOUT
disableUTF8¶
Do not issue the OPTS UTF8 ON command (default false).
Config file
server:
ftp:
disableUTF8: false
Environment variables
FTPGRAB_SERVER_FTP_DISABLEUTF8
disableEPSV¶
Disables EPSV in favour of PASV. This is useful in cases where EPSV connections neither complete nor downgrade to
PASV successfully by themselves, resulting in hung connections. (default false)
Config file
server:
ftp:
disableEPSV: false
Environment variables
FTPGRAB_SERVER_FTP_DISABLEEPSV
disableMLSD¶
Disables MLSD can be useful for servers which advertise MLSD (e.g. some versions of Serv-U) but don't support it
properly. (default false)
Config file
server:
ftp:
disableMLSD: false
Environment variables
FTPGRAB_SERVER_FTP_DISABLEMLSD
escapeRegexpMeta¶
Escapes all regular expression metacharacters in the source path. (default false)
Warning
This setting is only useful for FTP servers that enforce global matching or if you don't want to use regular expressions when listing files. See crazy-max/ftpgrab#49 for more information.
Config file
server:
ftp:
escapeRegexpMeta: false
Environment variables
FTPGRAB_SERVER_FTP_ESCAPEREGEXPMETA
tls¶
Use implicit FTP over TLS. (default false)
Config file
server:
ftp:
tls: false
Environment variables
FTPGRAB_SERVER_FTP_TLS
insecureSkipVerify¶
Controls whether a client verifies the server’s certificate chain and host name. (default false)
Config file
server:
type: ftp
ftp:
insecureSkipVerify: false
Environment variables
FTPGRAB_SERVER_FTP_INSECURESKIPVERIFY
logTrace¶
Enable low-level FTP log. Works only if global log level is debug. (default false)
Config file
server:
type: ftp
ftp:
logTrace: false
Environment variables
FTPGRAB_SERVER_FTP_LOGTRACE
Created: 2020-07-07 20:06:09