Correct consumer model in README #3
@@ -2,8 +2,9 @@
|
||||
|
||||
Curated blacklist and whitelist for the ARR media stack. The blacklist is
|
||||
synced automatically from upstream Cleanuparr and stripped of anything
|
||||
listed in the locally-maintained whitelist, so consumers like qBittorrent
|
||||
and Cleanuparr can point at a single raw URL per list and stay in sync.
|
||||
listed in the locally-maintained whitelist. Both files are consumed by
|
||||
Cleanuparr -- qBittorrent does not read either URL directly; Cleanuparr's
|
||||
Blocklist Sync feature pushes patterns to qBittorrent on its behalf.
|
||||
|
||||
See the wiki for full technical reference:
|
||||
- [Sync](https://git.hisp.no/arr/blocklists/wiki/Sync)
|
||||
@@ -11,7 +12,7 @@ See the wiki for full technical reference:
|
||||
- [Lists](https://git.hisp.no/arr/blocklists/wiki/Lists)
|
||||
-- the two-file model, pattern semantics, maintaining the whitelist
|
||||
- [Consumers](https://git.hisp.no/arr/blocklists/wiki/Consumers)
|
||||
-- qBittorrent and Cleanuparr integration, raw URLs, recommended modes
|
||||
-- Cleanuparr Blocklist Sync and Malware Blocker, raw URLs, recommended modes
|
||||
- [CI and Workflow](https://git.hisp.no/arr/blocklists/wiki/CI-and-Workflow)
|
||||
-- scheduled Gitea Actions job, manual dispatch, commit behaviour
|
||||
|
||||
@@ -39,9 +40,11 @@ and prevents consumers from blocking or deleting it. See
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A consumer that reads a remote text file of glob patterns (qBittorrent
|
||||
excluded file names, Cleanuparr blacklist/whitelist sync, etc.)
|
||||
- Network access from that consumer to `git.hisp.no`
|
||||
- A running [Cleanuparr](https://github.com/Cleanuparr/Cleanuparr) instance
|
||||
with Blocklist Sync and/or Malware Blocker configured
|
||||
- Network access from Cleanuparr to `git.hisp.no`
|
||||
- For Blocklist Sync: a qBittorrent instance reachable from Cleanuparr's
|
||||
qBittorrent connection settings
|
||||
|
||||
## File structure
|
||||
|
||||
@@ -55,35 +58,40 @@ and prevents consumers from blocking or deleting it. See
|
||||
|
||||
## Usage
|
||||
|
||||
Point your consumer at the raw URL of the file it should use.
|
||||
Both files are consumed by Cleanuparr through two independent features.
|
||||
qBittorrent itself does not read any URL from this repository.
|
||||
|
||||
### qBittorrent
|
||||
### Blocklist Sync (push to qBittorrent)
|
||||
|
||||
qBittorrent has no whitelist feature, so it consumes the blacklist directly.
|
||||
Set the excluded file names list (Options -> Downloads -> Excluded file
|
||||
names) to:
|
||||
Cleanuparr's **Blocklist Sync** fetches a blocklist URL on its configured
|
||||
schedule and pushes the full pattern set into qBittorrent's excluded file
|
||||
names via the qBittorrent Web API. Only blocklists are supported -- there
|
||||
is no whitelist mode for this feature. Point Blocklist Sync at:
|
||||
|
||||
```
|
||||
https://git.hisp.no/arr/blocklists/raw/branch/main/blacklist
|
||||
```
|
||||
|
||||
Because the whitelist is already subtracted from this file, any extension
|
||||
you add to `whitelist` stops being blocked by qBittorrent on the next sync.
|
||||
Because the locally-maintained whitelist is already subtracted from this
|
||||
file, any extension you add to `whitelist` stops being pushed to
|
||||
qBittorrent on the next sync.
|
||||
|
||||
### Cleanuparr
|
||||
### Malware Blocker (Sonarr/Radarr queue)
|
||||
|
||||
Cleanuparr supports both blacklist and whitelist modes. Use whichever
|
||||
matches your setup:
|
||||
|
||||
- **Blacklist mode** -- point at the same `blacklist` raw URL as qBittorrent.
|
||||
- **Whitelist mode** -- point at the `whitelist` raw URL:
|
||||
Cleanuparr's **Malware Blocker** inspects torrents in the Sonarr and
|
||||
Radarr queues and removes ones that violate its rules. It supports both
|
||||
blacklist and whitelist modes. This repository is configured for
|
||||
**whitelist mode**:
|
||||
|
||||
```
|
||||
https://git.hisp.no/arr/blocklists/raw/branch/main/whitelist
|
||||
```
|
||||
|
||||
See [Consumers](https://git.hisp.no/arr/blocklists/wiki/Consumers) for
|
||||
recommended mode per feature.
|
||||
In whitelist mode, only torrents whose contained files all have
|
||||
whitelisted extensions are kept. Everything else is removed from the queue.
|
||||
|
||||
See [Consumers](https://git.hisp.no/arr/blocklists/wiki/Consumers) for the
|
||||
full configuration details and troubleshooting.
|
||||
|
||||
## Maintaining the whitelist
|
||||
|
||||
|
||||
Reference in New Issue
Block a user