Crontab script that allows to receive wanted torrents from multiple YGGtracker nodes

php bittorrent yggtracker api sync seedbox ftp

4.1 KiB

Raw Blame History

yggtracker-wanted-torrents-receiver

Crontab script that allows to receive wanted torrents from multiple YGGtracker nodes

Install

Latest version of toolkit could be installed with single command:

git clone https://github.com/YGGverse/yggtracker-wanted-torrents-receiver.git

Config

All configuration files placed at /config folder

local.json

{
  "import":
  {
    // Common rules for FTP connections
    "ftp":
    {
      // How many of seconds wait for each provider response
      "timeout":5,
      // Which of remote folders grab to
      // array of target directories for each provider, eg. all, sensitive/no, locale/en, etc
      "directories":
      [
        "all"
      ]
    },
    // Requirements filter before import something from providers
    "require":
    {
      // Require approved torrents import only (according to provide.approved option in remote.json for each provider)
      "approved":true
    },
    // Local storage settings for imported content
    "storage":
    {
      // Storage directory by default, feel free to change like `/home/qbittorrent-nox/import`
      "directory":"storage",

      // Copy all torrents imported from providers folders to the storage/_common/{hash}.torrent
      // This mode check files MD5 hash sum to prevent duplicates in single folder from different providers
      // Useful when bittorrent client does not support support listening of multiple folders, recursive mode
      "common":true
    }
  },
  "update":
  {
    "config":
    {
      // This option allows to auto-update remote.json file on the fly without updating codebase with git clone
      "remote":
      {
        // If disabled, local file will not be updated, but manually
        "enabled": true,

        // Don't worry, just this repository
        "repository":"https://raw.githubusercontent.com/YGGverse/yggtracker-wanted-torrents-receiver/main/config/remote.json",

        // How many seconds to wait before ask repository for remote.json updates (after last file write)
        "cache":86400
      }
    }
  }
}

remote.json

The remote configuration contains available YGGtracker providers.

File also could be auto-updated from this repository when owner enabled update.config.remote.enabled option in local.json that makes registry actualization simpler for recipients and providers, as update details without git pull.

[
  {
    "description":
    {
      "name":"YGGtracker",                                                // Used as storage subfolder
      "description":"YGGtracker official node",                           // Just provider description
      "url":"http://[201:23b4:991a:634d:8359:4521:5576:15b7]/yggtracker/" // Provider's website
    },
    "ftp":
    {
      "host":"201:23b4:991a:634d:8359:4521:5576:15b7",                    // Connection host
      "port":21,                                                          // Connection port
      "passive":true,                                                     // Recommended passive mode for better compatibility
      "username":"anonymous",                                             // YGGtracker instances usually provides public FTP access
      "password":"anonymous",
      "directory":"/yggtracker/torrents/wanted"                           // Directory where wanted torrent files placed
    },
    "provide":
    {
      "approved":true                                                     // Tells to receiver that node administrator check the torrents before send to API
    }
  }
],
...

Usage

php src/receiver.php

or add to crontab:

* * * * * /usr/bin/php src/receiver.php > /dev/null 2>&1

Bash, python?

Feel free to contribute!

Add new YGGtracker node

Just send PR to nodes.json file

Feedback

Any questions and bug reports, please send to the Issues!

4.1 KiB Raw Blame History