diff --git a/README.md b/README.md index ac33bcd..1b1d767 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ # blacklist + +Custom blocklists for Pi-hole (v6+). + +## Lists + +| File | Contents | Raw URL | +| --- | --- | --- | +| `blacklist` | Ads, analytics, telemetry, scams, adult, gambling, game ads | `https://git.ki5bhv.com/justin/blacklist/raw/branch/main/blacklist` | +| `social-only` | Dating sites, social apps, Reddit tracking | `https://git.ki5bhv.com/justin/blacklist/raw/branch/main/social-only` | + +## Format + +Each entry uses Adblock Plus syntax, which Pi-hole v6 supports: + +``` +# Section name +||example.com^ +``` + +- `||example.com^` blocks `example.com` **and all its subdomains** (`www.example.com`, `api.example.com`, ...). +- List the highest domain you want blocked; don't add subdomains that a parent entry already covers. +- To block only part of a site, list just those subdomains (e.g. `||events.reddit.com^`). +- Lines starting with `#` are comments; group entries under a `# Section` heading. +- Domains are lowercase, one per line, no `0.0.0.0` prefix. + +## Deploying + +After pushing, update gravity on the Pi-hole: + +``` +pihole -g +```