Skip to content

SFTP server configuration

Warning

ftp and sftp are mutually exclusive

Example

server:
  sftp:
    host: 10.0.0.1
    port: 22
    username: foo
    password: bar
    sources:
      - /
    timeout: 30s
    maxPacketSize: 32768

Reference

host

SFTP host IP or domain.

Config file

server:
  sftp:
    host: 127.0.0.1

Environment variables

  • FTPGRAB_SERVER_SFTP_HOST

port

SFTP port. (default 22)

Config file

server:
  sftp:
    port: 22

Environment variables

  • FTPGRAB_SERVER_SFTP_PORT

username

SFTP username.

Config file

server:
  sftp:
    username: foo

Environment variables

  • FTPGRAB_SERVER_SFTP_USERNAME

usernameFile

Use content of secret file as SFTP username if username not defined.

Config file

server:
  sftp:
    usernameFile: /run/secrets/username

Environment variables

  • FTPGRAB_SERVER_SFTP_USERNAMEFILE

password

Warning

password and keyFile are mutually exclusive

SFTP password.

Config file

server:
  sftp:
    password: bar

Environment variables

  • FTPGRAB_SERVER_SFTP_PASSWORD

passwordFile

Use content of secret file as SFTP password if password not defined.

Config file

server:
  sftp:
    passwordFile: /run/secrets/password

Environment variables

  • FTPGRAB_SERVER_SFTP_PASSWORDFILE

keyFile

Warning

keyFile and password are mutually exclusive

Path to your private key to enable publickey authentication.

Config file

server:
  sftp:
    keyFile: /home/user/key.ppk

Environment variables

  • FTPGRAB_SERVER_SFTP_KEYFILE

keyPassphrase

SFTP key passphrase if keyFile is defined.

Config file

server:
  sftp:
    keyPassphrase: bar

Environment variables

  • FTPGRAB_SERVER_SFTP_PASSWORD

keyPassphraseFile

Use content of secret file as SFTP key passphrase if keyPassphrase not defined.

Config file

server:
  sftp:
    keyPassphraseFile: /run/secrets/passphrase

sources

List of sources paths to grab from SFTP server.

Config file

server:
  sftp:
    sources:
      - /path1
      - /path2/folder

Environment variables

  • FTPGRAB_SERVER_SFTP_SOURCES

timeout

Timeout is the maximum amount of time for the TCP connection to establish. 0s means no timeout. (default 30s)

Config file

server:
  sftp:
    timeout: 30s

Environment variables

  • FTPGRAB_SERVER_SFTP_TIMEOUT

maxPacketSize

Sets the maximum size of the payload, measured in bytes. (default 32768)

Config file

server:
  sftp:
    maxPacketSize: 32768

Environment variables

  • FTPGRAB_SERVER_SFTP_MAXPACKETSIZE
Last update: 2020-07-18 01:05:32
Created: 2020-07-07 20:06:09