Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blocklists: add lists and subcategories #260

Merged
merged 8 commits into from
Oct 17, 2023
Merged
106 changes: 83 additions & 23 deletions docs/orion/features/custom-blocklists.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Custom Block Lists
# Custom Blocklists

> **Note**: The Custom Block Lists feature is currently only available in Orion RC version.
> **Note**: The Custom Blocklists feature is currently only available in Orion RC version.

Orion for Mac allows you to customize it's ad blocker by using custom block lists. Block lists are lists of domains that are known to serve ads, trackers, malware and other annoyances. Orion checks web page requests against these lists and blocks any requests to the listed domains. This prevents ads from being displayed and trackers from following you around.
Orion for Mac allows you to customize it's ad blocker by using custom blocklists. Blocklists are lists of domains that are known to serve ads, trackers, malware and other annoyances. Orion checks web page requests against these lists and blocks any requests to the listed domains. This prevents ads from being displayed and trackers from following you around.

## Updating Block Lists
## Updating Blocklists

Block lists are constantly updated as new ad/tracking domains appear. List maintainers work to identify and add new ad-serving domains as they pop up.
Blocklists are constantly updated as new ad/tracking domains appear. List maintainers work to identify and add new ad-serving domains as they pop up.

To manually update block lists, go to **Orion** > **Settings** > **Privacy** and click **Update Now**. Wait for the "Processing update" message to disappear.
To manually update blocklists, go to **Orion** > **Settings** > **Privacy** and click **Update Now**. Wait for the "Processing update" message to disappear.

<img src="./media/blocklists_update_now.png" width="500" alt="Blocklists - Update Now"><br />

<img src="./media/blocklists_procesing_update.png" width="500" alt="Blocklists - Processing Update"><br />

## Adding Block Lists
## Adding Blocklists

To add a block list to Orion go to **Orion** > **Settings** > **Privacy** and click the **Show Filter Lists** button.

Expand All @@ -32,40 +32,98 @@ Then, paste the URL of the block list you wish to add and click the **Add** butt

<img src="./media/blocklists_done.png" width="500" alt="Blocklists - Done"><br />

## Third Party Block Lists
## Third-Party Blocklists

There are different types of lists - general ad lists, regional lists, malware lists, privacy lists etc. You can customize your ad blocking by choosing which lists you want to add to Orion.
There are different types of lists - general ad lists, regional lists, malware lists, privacy lists, etc. You can customize your ad blocking by choosing which lists you want to add to Orion.

The [FilterLists](https://filterlists.com/) website provides a comprehensive directory of blocklists to block advertisements, malware, trackers, and other general annoyances.
The [FilterLists](https://filterlists.com/) website provides a comprehensive directory of blocklists you can add to Orion.

### Recommended Block Lists
### Privacy
<details><summary>Show filters</summary> <br>

Bypass Paywalls Clean filter - [Info](https://gitlab.com/magnolia1234/bypass-paywalls-clean-filters) <br>
`https://gitlab.com/magnolia1234/bypass-paywalls-clean-filters/-/raw/main/bpc-paywall-filter.txt`
AdGuard Tracking Protection - [Info](https://adguard.com/kb/general/ad-filtering/adguard-filters/) <br>
`https://raw.githubusercontent.com/AdguardTeam/FiltersRegistry/master/filters/filter_3_Spyware/filter.txt`

Hagezi's Personal Blocklist - [Info](https://github.com/hagezi/dns-blocklists) <br>
`https://raw.githubusercontent.com/hagezi/dns-blocklists/main/adblock/personal.txt`

yokoffing's Privacy Essentials - [Info](https://github.com/yokoffing/filterlists) <br>
`https://raw.githubusercontent.com/yokoffing/filterlists/main/privacy_essentials.txt`

Block Outsider Intrusion into LAN - [Info](https://github.com/uBlockOrigin/uBlock-issues/issues/1070) <br>
`https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/lan-block.txt`

#### URL Tracking Parameters

d3Host List by d3ward - [Info](https://github.com/d3ward/toolz) <br>
*Orion cannot filter URL parameters, even when using uBlock Origin. See [Chrome and Firefox Extensions Support](https://help.kagi.com/orion/browser-extensions/macos-extensions.html#chrome-and-firefox-extensions-support) and [Supported WebExtensions APIs](https://help.kagi.com/orion/browser-extensions/macos-extensions.html#supported-webextensions-apis) for more details.*

Actually Legitimate URL Shortener Tool - [Info](https://github.com/DandelionSprout/adfilt) <br>
`https://raw.githubusercontent.com/DandelionSprout/adfilt/master/LegitimateURLShortener.txt`

#### Fonts

Block third-party fonts - [Info](https://github.com/yokoffing/filterlists) <br>
`https://raw.githubusercontent.com/yokoffing/filterlists/main/block_third_party_fonts.txt`

</details>

### Ads
<details><summary>Show filters</summary> <br>

Peter Lowe's ad & tracking server list - [Info](https://pgl.yoyo.org/as/#about) <br>
`https://pgl.yoyo.org/adservers/serverlist.php?hostformat=adblockplus&showintro=1&mimetype=plaintext`

d3Host List - [Info](https://github.com/d3ward/toolz) <br>
`https://raw.githubusercontent.com/d3ward/toolz/master/src/d3host.adblock`

AdGuard Tracking Protection - [Info](https://adguard.com/kb/general/ad-filtering/adguard-filters/) <br>
`https://raw.githubusercontent.com/AdguardTeam/FiltersRegistry/master/filters/filter_3_Spyware/filter.txt`
</details>

AdGuard Social Media - [Info](https://adguard.com/kb/general/ad-filtering/adguard-filters/) <br>
`https://raw.githubusercontent.com/AdguardTeam/FiltersRegistry/master/filters/filter_4_Social/filter.txt`
### Annoyances
<details><summary>Show filters</summary> <br>

AdGuard Annoyances - [Info](https://adguard.com/kb/general/ad-filtering/adguard-filters/) <br>
`https://raw.githubusercontent.com/AdguardTeam/FiltersRegistry/master/filters/filter_14_Annoyances/filter.txt`

AdGuard Social Media - [Info](https://adguard.com/kb/general/ad-filtering/adguard-filters/) <br>
`https://raw.githubusercontent.com/AdguardTeam/FiltersRegistry/master/filters/filter_4_Social/filter.txt`

I don't care about cookies - [Info](https://www.i-dont-care-about-cookies.eu/) <br>
`https://www.i-dont-care-about-cookies.eu/abp/`

yokoffing's Annoyance List - [Info](https://github.com/yokoffing/filterlists) <br>
`https://raw.githubusercontent.com/yokoffing/filterlists/main/annoyance_list.txt`

Browse websites without logging in - [Info](https://github.com/DandelionSprout/adfilt) <br>
`https://raw.githubusercontent.com/DandelionSprout/adfilt/master/BrowseWebsitesWithoutLoggingIn.txt`

#### Paywalls

Bypass Paywalls Clean filter - [Info](https://gitlab.com/magnolia1234/bypass-paywalls-clean-filters) <br>
`https://gitlab.com/magnolia1234/bypass-paywalls-clean-filters/-/raw/main/bpc-paywall-filter.txt`

</details>

### Security
<details><summary>Show filters</summary> <br>

NoCoin Filter List - [Info](https://github.com/hoshsadiq/adblock-nocoin-list/) <br>
`https://raw.githubusercontent.com/hoshsadiq/adblock-nocoin-list/master/nocoin.txt`

### Regional Block Lists
Dandelion Sprout's Anti-Malware List - [Info](https://github.com/DandelionSprout/adfilt) <br>
`https://raw.githubusercontent.com/DandelionSprout/adfilt/master/Dandelion%20Sprout's%20Anti-Malware%20List.txt`

iam-py-test's The malicious website blocklist - [Info](https://github.com/iam-py-test/my_filters_001) <br>
`https://raw.githubusercontent.com/iam-py-test/my_filters_001/main/antimalware.txt`

</details>

EasyList maintains a list of numerous [regional block lists](https://easylist.to/pages/other-supplementary-filter-lists-and-easylist-variants.html), these can help improve the ad blocking effectiveness if you regularly visit non-English websites.
## Regional Blocklists

For your convenience we are listing the regional filters below however please visit their website for more information.
EasyList maintains [supplementary blocklists](https://easylist.to/pages/other-supplementary-filter-lists-and-easylist-variants.html) that can improve ad blocking on non-English websites.

The list of regional filters is below. Please visit the [EasyList website](https://easylist.to/pages/other-supplementary-filter-lists-and-easylist-variants.html) for more information.

<details><summary>Show filters</summary> <br>

EasyList Germany <br>
`https://easylist.to/easylistgermany/easylistgermany.txt`
Expand Down Expand Up @@ -130,6 +188,8 @@ KoreanList <br>
ROList (Romanian) <br>
`https://www.zoso.ro/pages/rolist.txt`

## Contributing to Block Lists
</details>

## Contributing to Blocklists

Many block lists are open source and maintained by independent groups and communities. Anyone can submit domains for inclusion in the lists.
Many blocklists are open source and maintained by independent groups and communities. Anyone can submit domains for inclusion in the lists.