YGGverse/yggtracker-wanted-torrents-receiver
1
0
Fork 0
mirror of https://github.com/YGGverse/yggtracker-wanted-torrents-receiver.git synced 2026-03-31 18:25:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
ghost 2023-10-25 01:59:27 +03:00
parent 636ed417a3
commit 1dfeba3f56
1 changed files with 14 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -4,8 +4,6 @@ Crontab script that allows to receive wanted torrents from multiple [YGGtracker]
#### Install #### Install
Latest version of toolkit could be installed with single command:
`git clone https://github.com/YGGverse/yggtracker-wanted-torrents-receiver.git` `git clone https://github.com/YGGverse/yggtracker-wanted-torrents-receiver.git`
#### Config #### Config
@ -18,51 +16,38 @@ All configuration files placed at `/config` folder
{ {
"import": "import":
{ {
// Common rules for FTP connections "ftp": // Common rules for FTP connections
"ftp":
{ {
// How many of seconds wait for each provider response "timeout":5, // How many seconds to wait for each provider response
"timeout":5, "directories": // Remote folders to grab
// Which of remote folders grab to
// array of target directories for each provider, eg. all, sensitive/no, locale/en, etc
"directories":
[ [
"all" "all"
] ]
}, },
// Requirements filter before import something from providers
"require": "require":
{ {
// Require approved torrents import only (according to provide.approved option in remote.json for each provider) "approved":true // Require approved torrents import only (related to provide.approved option in remote.json for each provider)
"approved":true
}, },
// Local storage settings for imported content
"storage": "storage":
{ {
// Storage directory by default, feel free to change like `/home/qbittorrent-nox/import` "directory":"storage", // Storage directory by default
"directory":"storage", "common":true // Copy all torrents imported from providers folders to the storage/_common/{hash}.torrent
// 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 // 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 // Useful when bittorrent client does not support support listening of multiple folders, recursive mode
"common":true
} }
}, },
"update": "update":
{ {
"config": "config":
{ {
// This option allows to auto-update remote.json file on the fly without updating codebase with git clone
"remote": "remote": // This option allows to auto-update remote.json file on the fly without updating codebase with git clone
{ {
// If disabled, local file will not be updated, but manually "enabled": true, // If disabled, local file will not be updated, but manually
"enabled": true, "cache":86400, // How many seconds to wait before ask repository for remote.json updates (after last file write)
// Don't worry, just this repository "repository":
"repository":"https://raw.githubusercontent.com/YGGverse/yggtracker-wanted-torrents-receiver/main/config/remote.json", "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
} }
} }
} }