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

Update custom-blocklists.md #288

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/orion/features/custom-blocklists.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
# Orion Content Blocker
# Orion's Content Blocker

## Table of Contents
- [Default Blocklists](#default_blocklists)
- [Custom Blocklists](#custom_blocklists)
- [Updating Blocklists](#updating_blocklists)
- [Adding Blocklists](#adding_blocklists)
- [Impact of Number of Blocking Rules on Performance](#performance_chart)
- [Third-Party Blocklists](#third_party_blocklists)
- [Regional Blocklists](#regional_blocklists)
- [Personal Filters](#personal_filters)
- [Blocklist Syntax](#blocklist_syntax)
- [Blocklist Syntax](#blocklist-syntax)
- [Contributing to Blocklists](#contributing_blocklists)

<a id="default_blocklists"></a>
## Default Blocklists {#default_blocklists}

To protect you from most ads and trackers, Orion for Mac includes the following blocklists by default:
- EasyList (Enabled)
- EasyPrivacy (Enabled)
- Fanboy's Annoyance (Disabled)

You can enable or disable these blocklists in **Orion** > **Settings** > **Privacy**, then click the **Show Filter Lists** button.

<a id="custom_blocklists"></a>
## Custom Blocklists {#custom_blocklists}

> **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 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.


Expand Down Expand Up @@ -231,8 +240,8 @@ Orion allows you to create your own filters directly in Orion Settings. You can
<img src="./media/blocklists_personal_filters.png" width="500" alt="Blocklists - Personal Filters"><br />


<a id="blocklist_syntax"></a>
## Blocklist Syntax {#blocklist_syntax}
<a id="blocklist-syntax"></a>
## Blocklist Syntax {#blocklist-syntax}

Orion follows the Adblock Plus standard for its blocklist syntax, this means any filters created for Adblock Plus are compatible with Orion. You can learn how to create your own blocklists by following the [step-by-step guide](https://adblockplus.org/filter-cheatsheet), or visit the full [blocklist syntax reference](https://help.adblockplus.org/hc/en-us/articles/360062733293-How-to-write-filters) for more technical details.

Expand Down