diff --git a/README.md b/README.md new file mode 100644 index 0000000..33c6c2e --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# ARR Stack Blocklists + +Automatically synchronized blocklists for use with Cleanuparr in the ARR media stack. + +## Files + +| File | Description | +|------|-------------| +| `blacklist` | Standard blocklist — blocks all known malicious and unwanted file types | +| `blacklist_permissive` | Permissive blocklist — blocks genuinely malicious types with fewer false positives | +| `whitelist` | Whitelist — only files matching these patterns are allowed | +| `whitelist_with_subtitles` | Whitelist with subtitle file types included | +| `*.prev` | Internal sync reference files — do not edit manually | + +## Usage + +Point Cleanuparr's Malware Blocker and Blacklist Sync at the raw URL of your chosen file: +``` +https://git.hisp.no/arr/blocklists/raw/branch/main/blacklist_permissive +``` + +## Sync + +Files are automatically synchronized from the upstream [Cleanuparr](https://github.com/Cleanuparr/Cleanuparr) repository every 6 hours via Gitea Actions. + +The sync uses a three-way merge strategy: +- Upstream additions are automatically included +- Upstream removals are automatically removed +- Your custom additions are preserved across every sync + +## Custom Entries + +To add your own entries, edit the relevant file directly in Gitea. Your additions will be detected as custom entries and preserved on every subsequent sync. + +## Upstream Source + +Blocklists are sourced from: +``` +https://raw.githubusercontent.com/Cleanuparr/Cleanuparr/main/ +``` \ No newline at end of file