Configuration

Configuration file #

You can use the example configuration file. This example file can be located in:

• /usr/local/config/ (pip install)
• ~/.local/config/ (pip install in user privileges)

mkdir ~/.config/seedboxsync
cp ~/.local/config/seedboxsync.yml.example ~/.config/seedboxsync/seedboxsync.yml

or

sudo mkdir /etc/seedboxsync
sudo cp /usr/local/config/seedboxsync.yml.example /etc/seedboxsync/seedboxsync.yml

You can put your configuration in:

• /etc/seedboxsync/seedboxsync.yml
• ~/.config/seedboxsync/seedboxsync.yml
• ~/.seedboxsync/config/seedboxsync.yml
• ~/.seedboxsync.yml

Settings #

Configuration about your seedbox and your BitTorrent client #

• First, set information about the connection to your Seedbox. Currently, only sftp is supported.

#
# Informations about your seedbox
#
seedbox:

  ### Informations about your seedbox connection
  host: my-seedbox.ltd
  port: 22
  login: me
  password: p4sw0rd
  timeout: false

  ### For the moment, only sftp
  protocol: sftp

• To prevent some issues between your transfer account and your BitTorrent client account, SeedboxSync chmod torrent file after upload.

    ### Chmod torrent after upload (false :  disable)
    ### Use octal notation like https://docs.python.org/3.4/library/os.html#os.chmod
    chmod: false

• To prevent that your BitTorrent client watch (and use) an incomplete torrent file, SeedboxSync transfer torrent file in a tmp directory (tmp_path) and move it in the watch folder after full transfer and chmod. The tmp folder must also be used in your BitTorrent client to download unfinished torrent.

    # Use a tempory directory (you must create it !)
    tmp_path: /tmp

• The blackhole folder of your BitTorrent client. Only used by blackhole synchronization.

    # Your "watch" folder you must create it!)
    watch_path: /watch

• The folder of your Bittorrent client with finished file. You can configure your client to move the finished file in a specific folder.

    # Your finished folder you must create it!)
    finished_path: /files

• You can remove a prefix part of the path in your synced directory.

    # Allow to remove a part of the synced path. In General, same path than "finished_path".
    prefixed_path: /files

• You can also specify the extension used by your torrent client for downloads in progress to exclude it from synchronisation.

    # Exclude part files
    part_suffix: .part

• You can also exclude files from sync with regular expression.

    # Exclude pattern from sync
    # Use re syntaxe: https://docs.python.org/3/library/re.html
    # Example: .*missing$|^\..*\.sw
    exclude_syncing: .*missing$|^\..*\.sw

Configuration about your NAS #

Your NAS configuration is in local and pid sections:

#
# Informations about local environment (NAS ?)
#
local:

  ### Your local "watch" folder
  watch_path: ~/watch

  ### Path where download files
  download_path: ~/Downloads/

  ### Use local sqlite database for store downloaded files
  db_file: ~/.config/seedboxsync/seedboxsync.db


#
# PID and lock management to prevent several launch
#
pid:

    ### PID for blackhole sync
    blackhole_path: ~/.config/seedboxsync/lock/blackhole.pid

    ### PID for seedbox downloaded sync
    download_path: ~/.config/seedboxsync/lock/download.pid

Configuration of a ping service #

Ping service is called by --ping argument.

Currently, only Healthchecks ping service is supported.

Healthchecks #

Add a healthchecks by sync command.

#
# Healthchecks ping service
#
healthchecks:

  ### sync seedbox part
  sync_seedbox:
    ## Enable or disable service
    enabled: true

    ## Ping URL
    ping_url: https://hc-ping.com/ca5e1159-9acf-410c-9202-f76a7bb856e0

  ### sync blackhole part
  sync_blackhole:
    ## Enable or disable service
    enabled: true

    ## Ping URL
    ping_url: https://hc-ping.com/ca5e1159-9acf-410c-9202-f76a7bb856e0