Skip to content

Download configuration

Example

download:
  output: /download
  uid: 1000
  gid: 1000
  chmodFile: 0o644
  chmodDir: 0o755
  include:
    - ^Mr\.Robot\.S04.+(VOSTFR|SUBFRENCH).+(720p).+(HDTV|WEB-DL|WEBRip).+
  exclude:
    - \.nfo$
  since: 2019-02-01T18:50:05Z
  retry: 3
  concurrency: 1
  force: false
  hideSkipped: false
  tempFirst: false
  createBaseDir: false

output

Output destination folder of downloaded files. Env var FTPGRAB_DOWNLOAD_OUTPUT overrides this value.

Config file

download:
  output: /download

Environment variables

  • FTPGRAB_DOWNLOAD_OUTPUT

uid

Owner user applied to downloaded files. (default to caller)

Config file

download:
  uid: 1000

Environment variables

  • FTPGRAB_DOWNLOAD_UID

gid

Owner group applied to downloaded files. (default to caller)

Config file

download:
  gid: 1000

Environment variables

  • FTPGRAB_DOWNLOAD_GID

chmodFile

Permissions applied to files. (default: 0o644)

Config file

download:
  chmodFile: 0o644

Environment variables

  • FTPGRAB_DOWNLOAD_CHMODFILE

chmodDir

Permissions applied to folders. (default: 0o755)

Config file

download:
  chmodDir: 0o755

Environment variables

  • FTPGRAB_DOWNLOAD_CHMODDIR

include

List of regular expressions to include files.

Config file

download:
  include:
    - ^Mr\.Robot\.S04.+(VOSTFR|SUBFRENCH).+(720p).+(HDTV|WEB-DL|WEBRip).+

Environment variables

  • FTPGRAB_DOWNLOAD_INCLUDE

exclude

List of regular expressions to exclude files.

To skip incomplete uploads, see the FAQ.

Config file

download:
  exclude:
    - \.nfo$

Environment variables

  • FTPGRAB_DOWNLOAD_EXCLUDE

since

Only download files created since the specified date in RFC3339 format.

Config file

download:
  since: 2019-02-01T18:50:05Z

Environment variables

  • FTPGRAB_DOWNLOAD_SINCE

retry

Number of retries in case of download failure. (default: 3)

Config file

download:
  retry: 3

Environment variables

  • FTPGRAB_DOWNLOAD_RETRY

concurrency

Maximum number of simultaneous file downloads. (default: 1, minimum: 1) Concurrent FTP transfers use separate sessions, opened lazily and reused within the run. SFTP workers share one SSH/SFTP connection. The number of workers is limited to the number of independent groups of files. Directory listing remains sequential. Files sharing a destination or database history key are processed in their original order by one worker. Destination paths differing only in case are also grouped together for filesystem compatibility.

Choose a value within the server's per-user connection limit. If an additional FTP session cannot be opened, FTPGrab logs a warning and continues with fewer workers.

Config file

download:
  concurrency: 4

Environment variables

  • FTPGRAB_DOWNLOAD_CONCURRENCY

force

Download matching files on every run, even if they already exist locally or are recorded in the database. Existing destination files are overwritten. (default: false)

The include, exclude, and since filters still apply. Downloads are still recorded in the database, and database errors retain their usual behavior. Disabling this option restores the usual checks against local files and history.

This is useful for files such as nightly backups that reuse the same filename. Enable tempFirst to download to a temporary location before replacing an existing file.

Config file

download:
  force: true

Environment variables

  • FTPGRAB_DOWNLOAD_FORCE

hideSkipped

Not display skipped downloads. (default: false)

Config file

download:
  hideSkipped: false

Environment variables

  • FTPGRAB_DOWNLOAD_HIDESKIPPED

tempFirst

First download the files to a temporary location and then move them to the final destination. (default false)

Config file

download:
  tempFirst: false

Environment variables

  • FTPGRAB_DOWNLOAD_TEMPFIRST

createBaseDir

Create basename of a FTP source path in the destination folder. This is highly recommended if you have multiple FTP source paths to prevent overwriting. (default: false)

Warning

Does not apply if sources is / only.

Config file

download:
  createBaseDir: false

Environment variables

  • FTPGRAB_DOWNLOAD_CREATEBASEDIR