docs(config): document filter_lists configuration options
- commit
- 1b3918c3fa10ff6b658f58e4c6d64e576760c826
- author
- bnema · · 2025-11-29 13:24 UTC
- committer
- bnema · · 2025-11-29 13:24 UTC
- parent
- cac6aa4
- signature
- GPG Unverified
2B82207D370127A0The key is unknown
1 file · +32 -2
M docs/CONFIG.md +32 -2
| @@ -286,17 +286,47 @@ cancel = ["escape"] | |||
| 286 | 286 | ||
| 287 | 287 | | Key | Type | Default | Description | | |
| 288 | 288 | |-----|------|---------|-------------| | |
| 289 | - | | `content_filtering_whitelist` | array | See below | Domains to skip ad blocking | | |
| 289 | + | | `content_filtering.enabled` | bool | `true` | Enable ad blocking | | |
| 290 | + | | `content_filtering.whitelist` | array | See below | Domains to skip ad blocking | | |
| 291 | + | | `content_filtering.filter_lists` | array | See below | Filter list URLs to use | | |
| 290 | 292 | ||
| 291 | 293 | **Default whitelist:** | |
| 292 | 294 | ```toml | |
| 293 | - | content_filtering_whitelist = [ | |
| 295 | + | [content_filtering] | |
| 296 | + | enabled = true | |
| 297 | + | whitelist = [ | |
| 294 | 298 | "twitch.tv", | |
| 295 | 299 | "passport.twitch.tv", | |
| 296 | 300 | "gql.twitch.tv" | |
| 297 | 301 | ] | |
| 298 | 302 | ``` | |
| 299 | 303 | ||
| 304 | + | **Default filter lists:** | |
| 305 | + | ```toml | |
| 306 | + | [content_filtering] | |
| 307 | + | filter_lists = [ | |
| 308 | + | # Core blocking | |
| 309 | + | "https://easylist.to/easylist/easylist.txt", # Ads | |
| 310 | + | "https://easylist.to/easylist/easyprivacy.txt", # Tracking | |
| 311 | + | # uBlock extras | |
| 312 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters.txt", # uBO optimizations | |
| 313 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/annoyances.txt", # Cookie banners, popups | |
| 314 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/quick-fixes.txt" # Site fixes | |
| 315 | + | ] | |
| 316 | + | ``` | |
| 317 | + | ||
| 318 | + | **Custom filter lists example:** | |
| 319 | + | ```toml | |
| 320 | + | [content_filtering] | |
| 321 | + | filter_lists = [ | |
| 322 | + | # Minimal setup | |
| 323 | + | "https://easylist.to/easylist/easylist.txt", | |
| 324 | + | "https://easylist.to/easylist/easyprivacy.txt", | |
| 325 | + | # Regional list | |
| 326 | + | "https://easylist-downloads.adblockplus.org/liste_fr.txt" | |
| 327 | + | ] | |
| 328 | + | ``` | |
| 329 | + | ||
| 300 | 330 | ## Environment Variables | |
| 301 | 331 | ||
| 302 | 332 | All config values can be overridden via environment variables with the prefix `DUMB_BROWSER_`: | |
| @@ -286,17 +286,47 @@ cancel = ["escape"] | |||||
| 286 | 286 | ||||
| 287 | | Key | Type | Default | Description | | 287 | | Key | Type | Default | Description | | ||
| 288 | |-----|------|---------|-------------| | 288 | |-----|------|---------|-------------| | ||
| 289 | - | | `content_filtering_whitelist` | array | See below | Domains to skip ad blocking | | 289 | + | | `content_filtering.enabled` | bool | `true` | Enable ad blocking | |
| 290 | + | | `content_filtering.whitelist` | array | See below | Domains to skip ad blocking | | |||
| 291 | + | | `content_filtering.filter_lists` | array | See below | Filter list URLs to use | | |||
| 290 | 292 | ||||
| 291 | **Default whitelist:** | 293 | **Default whitelist:** | ||
| 292 | ```toml | 294 | ```toml | ||
| 293 | - | content_filtering_whitelist = [ | 295 | + | [content_filtering] |
| 296 | + | enabled = true | |||
| 297 | + | whitelist = [ | |||
| 294 | "twitch.tv", | 298 | "twitch.tv", | ||
| 295 | "passport.twitch.tv", | 299 | "passport.twitch.tv", | ||
| 296 | "gql.twitch.tv" | 300 | "gql.twitch.tv" | ||
| 297 | ] | 301 | ] | ||
| 298 | ``` | 302 | ``` | ||
| 299 | 303 | ||||
| 304 | + | **Default filter lists:** | |||
| 305 | + | ```toml | |||
| 306 | + | [content_filtering] | |||
| 307 | + | filter_lists = [ | |||
| 308 | + | # Core blocking | |||
| 309 | + | "https://easylist.to/easylist/easylist.txt", # Ads | |||
| 310 | + | "https://easylist.to/easylist/easyprivacy.txt", # Tracking | |||
| 311 | + | # uBlock extras | |||
| 312 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters.txt", # uBO optimizations | |||
| 313 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/annoyances.txt", # Cookie banners, popups | |||
| 314 | + | "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/quick-fixes.txt" # Site fixes | |||
| 315 | + | ] | |||
| 316 | + | ``` | |||
| 317 | + | ||||
| 318 | + | **Custom filter lists example:** | |||
| 319 | + | ```toml | |||
| 320 | + | [content_filtering] | |||
| 321 | + | filter_lists = [ | |||
| 322 | + | # Minimal setup | |||
| 323 | + | "https://easylist.to/easylist/easylist.txt", | |||
| 324 | + | "https://easylist.to/easylist/easyprivacy.txt", | |||
| 325 | + | # Regional list | |||
| 326 | + | "https://easylist-downloads.adblockplus.org/liste_fr.txt" | |||
| 327 | + | ] | |||
| 328 | + | ``` | |||
| 329 | + | ||||
| 300 | ## Environment Variables | 330 | ## Environment Variables | ||
| 301 | 331 | ||||
| 302 | All config values can be overridden via environment variables with the prefix `DUMB_BROWSER_`: | 332 | All config values can be overridden via environment variables with the prefix `DUMB_BROWSER_`: | ||