qbit-maid/README.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2022-07-14 19:03:06 -05:00
# qbit-maid
2022-07-14 20:33:53 -05:00
Warning: This application removes torrents that aren't downloading and that aren't from iptorrents. Age in the config.json only controls the age for torrents from iptorrents.
2022-07-14 19:03:06 -05:00
The objective is to filter torrents based on the following criteria:
- tracker domain name
- age
- ratio
- state
Client to the qbit api and the processing of the torrents.
2022-07-14 19:03:06 -05:00
qbit-clean.py
Functions to build out a list of torrents.
2022-07-14 19:03:06 -05:00
qlist.py
Logging and push notification communication.
2022-07-14 19:03:06 -05:00
qlogging.py
Logic to process torrents.
2022-07-14 20:33:53 -05:00
qprocess.py
You will need a config.json in the root directory.
It should look something like this:
2022-07-20 11:49:06 -05:00
```
2022-07-14 20:33:53 -05:00
{
"host": "192.168.1.1",
"port": 8080,
"username": "admin",
"password": "admin",
"loglevel": "INFO",
"logpath": "./qc.log",
"age": 2419200,
"use_pushover": true,
"use_log": true,
"po_key": "",
"po_token": ""
2022-07-14 20:33:53 -05:00
}
2022-07-20 11:49:06 -05:00
```
Config.json
2022-07-20 11:56:43 -05:00
|Key|Value|
|---|
|host | string, ip or hostname of qbittorrent server|
|port | number, port of admin gui(used for api aswell)|
|username | admin account for qbittorrent|
|password | password for admin account|
|loglevel | is what log messages are written to the log file. INFO or DEBUG are valid entries(case sensitive)|
|logpath | will write a log in root directory if left as is other wise specify other path using forward slashes|
|age | number, seconds for how long we keep torrents from IPTORRENTS|
|use_pushover | true or false to enable or disable pushover notification summary|
|use_log | true or false to enable or disable writing to alog file|
|po_key | pushover key|
|po_token | pushover api token|