Correct consumer model in README #3

Merged
CodeX merged 1 commits from docs/cleanuparr-only-consumers into main 2026-04-07 02:15:49 +02:00
+29 -21
View File
@@ -2,8 +2,9 @@
Curated blacklist and whitelist for the ARR media stack. The blacklist is Curated blacklist and whitelist for the ARR media stack. The blacklist is
synced automatically from upstream Cleanuparr and stripped of anything synced automatically from upstream Cleanuparr and stripped of anything
listed in the locally-maintained whitelist, so consumers like qBittorrent listed in the locally-maintained whitelist. Both files are consumed by
and Cleanuparr can point at a single raw URL per list and stay in sync. 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: See the wiki for full technical reference:
- [Sync](https://git.hisp.no/arr/blocklists/wiki/Sync) - [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) - [Lists](https://git.hisp.no/arr/blocklists/wiki/Lists)
-- the two-file model, pattern semantics, maintaining the whitelist -- the two-file model, pattern semantics, maintaining the whitelist
- [Consumers](https://git.hisp.no/arr/blocklists/wiki/Consumers) - [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) - [CI and Workflow](https://git.hisp.no/arr/blocklists/wiki/CI-and-Workflow)
-- scheduled Gitea Actions job, manual dispatch, commit behaviour -- scheduled Gitea Actions job, manual dispatch, commit behaviour
@@ -39,9 +40,11 @@ and prevents consumers from blocking or deleting it. See
## Prerequisites ## Prerequisites
- A consumer that reads a remote text file of glob patterns (qBittorrent - A running [Cleanuparr](https://github.com/Cleanuparr/Cleanuparr) instance
excluded file names, Cleanuparr blacklist/whitelist sync, etc.) with Blocklist Sync and/or Malware Blocker configured
- Network access from that consumer to `git.hisp.no` - Network access from Cleanuparr to `git.hisp.no`
- For Blocklist Sync: a qBittorrent instance reachable from Cleanuparr's
qBittorrent connection settings
## File structure ## File structure
@@ -55,35 +58,40 @@ and prevents consumers from blocking or deleting it. See
## Usage ## 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. Cleanuparr's **Blocklist Sync** fetches a blocklist URL on its configured
Set the excluded file names list (Options -> Downloads -> Excluded file schedule and pushes the full pattern set into qBittorrent's excluded file
names) to: 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 https://git.hisp.no/arr/blocklists/raw/branch/main/blacklist
``` ```
Because the whitelist is already subtracted from this file, any extension Because the locally-maintained whitelist is already subtracted from this
you add to `whitelist` stops being blocked by qBittorrent on the next sync. 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 Cleanuparr's **Malware Blocker** inspects torrents in the Sonarr and
matches your setup: Radarr queues and removes ones that violate its rules. It supports both
blacklist and whitelist modes. This repository is configured for
- **Blacklist mode** -- point at the same `blacklist` raw URL as qBittorrent. **whitelist mode**:
- **Whitelist mode** -- point at the `whitelist` raw URL:
``` ```
https://git.hisp.no/arr/blocklists/raw/branch/main/whitelist https://git.hisp.no/arr/blocklists/raw/branch/main/whitelist
``` ```
See [Consumers](https://git.hisp.no/arr/blocklists/wiki/Consumers) for In whitelist mode, only torrents whose contained files all have
recommended mode per feature. 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 ## Maintaining the whitelist