Skip to content

Basic example

In this section we quickly go over a basic way to run FTPGrab.

Setup

Warning

Make sure to follow the instructions to install from binary before.

First create a ftpgrab.yml configuration file like this one:

# ./ftpgrab.yml

db:
  path: ftpgrab.db

server:
  ftp:
    host: test.rebex.net
    port: 21
    username: demo
    password: password
    sources:
      - /
    timeout: 5s

download:
  output: /download
  retry: 3
  hideSkipped: false
  createBaseDir: false

notif:
  mail:
    host: smtp.example.com
    port: 25
    username: foo
    password: bar
    from: ftpgrab@example.com
    to: webmaster@example.com

That's it. Now you can launch FTPGrab with the following command:

ftpgrab --config ./ftpgrab.yml

Last update: 2021-04-25 21:26:36
Created: 2020-07-07 20:06:09