-
Notifications
You must be signed in to change notification settings - Fork 81
Deploying uBlock Origin: configuration
uBlock Origin (uBO) supports configuration through central policies. See browser documentation for administrators:
- Chromium: "Configuring Apps and Extensions by Policy"
- Firefox: "Managed storage manifests"
- Tutorial: Deploying uBO configuration for Microsoft Edge Chromium and Google Chrome - newer way (Editing Registry by PowerShell) by u/DefinitelyYou
- Deploying uBlock via Google workspace? (Q&A discussion) (with a successful deployment)
The documented settings below are only available with uBO version 1.33.0 and above.
The purpose of the userSettings
property is to set the values of various user settings (more specifically, to modify these variables).
Each entry in the array consists of a pair of name-value strings. Each name string must be a supported user setting, and each value string must correctly resolve to a supported value.
Every valid entry gets used to overwrite the corresponding default user setting at launch time.
Example:
{
"userSettings": [
[ "contextMenuEnabled", "false" ],
[ "dynamicFilteringEnabled", "false" ]
]
}
The advancedSettings
property is to set the values of various advanced settings.
Each entry in the array consists of a pair of name-value strings. Each name string must be a valid advanced setting, and each value string must correctly resolve to a supported value.
Every valid entry will get used to overwrite the corresponding default advanced setting and become read-only. The user will not be able to change it.
Example:
{
"advancedSettings": [
[ "disableWebAssembly", "true" ]
]
}
Set to true
to prevent access to uBO's dashboard.
An array of strings where each string refers to a part of the popup panel that gets removed. Each supported component and its name:
-
globalStats
: remove access to "Blocked since install" statistic. -
basicTools
: remove access to basic tools. -
extraTools
: remove access to per-site switches. -
overviewPane
: remove access to the overview pane.
The properties in the toOverwrite
branch will wholly replace the corresponding local settings. Currently, the following properties are supported:
The filters
property is an array of strings that represent all the lines making the text to use as the content of the "My filters" pane.
The filterLists
property is an array of strings, where each one is a token that identifies a list to enable by default. To activate a stock filter list, this is the token identifying the list per the contents of assets.json
. For an external list not found in assets.json
, the token is the URL of the filter list.
Use the token user-filters
in your list of filter lists to enforce the filters in the "My filters" pane.
For reference, the following array corresponds to the default list of filter lists enabled in uBO by default:
[
"user-filters",
"ublock-filters",
"ublock-badware",
"ublock-privacy",
"ublock-abuse",
"ublock-unbreak",
"easylist",
"easyprivacy",
"urlhaus-1",
"plowe-0"
]
Additionally, according to the current locale, one or more regional lists may be enabled.
The trustedSiteDirectives
property is an array of strings, each of which must resolve into a valid trusted-site directive, used to dictate where uBO must be disabled.
All directives will replace the local trusted-site rules, including the built-in ones.
See the documentation on how to create valid trusted-site directives: "How to mark a web site as trusted"
The properties in the toAdd
branch will append to the already present local settings. Currently, the following properties are supported:
The trustedSiteDirectives
property is an array of strings, each of which must resolve into a valid trusted-site directive, used to dictate where uBO must be disabled.
Here is an example of how adding example.com
and example.org
would look like for managed storage on Chromium/Linux:
xxxxx@xxxxx:~$ cat /etc/chromium/policies/managed/ubo.json
{
"3rdparty": {
"extensions": {
"cjpalhdlnbpafiamejdnhcphjbkeiagm": {
"toAdd": {
"trustedSiteDirectives": [
"example.com",
"example.org"
]
}
}
}
}
}
The directives will get appended to the local ones.
See the documentation on how to create valid trusted-site directives: "How to mark a web site as trusted"
- Wiki home
- About the Wiki documentation
- Permissions
- Privacy policy
- Info:
- The toolbar icon
- The popup user interface
- The context menu
-
Dashboard
- Settings pane
- Filter lists pane
- My filters pane
- My rules pane
- Trusted sites pane
- Keyboard shortcuts
- The logger
- Element picker
- Element zapper
-
Blocking mode
- Very easy mode
- Easy mode (default)
- Medium mode (optimal for advanced users)
- Hard mode
- Nightmare mode
- Strict blocking
- Few words about re-design of uBO's user interface
- Reference answers to various topics seen in the wild
- Overview of uBlock's network filtering engine
- uBlock's blocking and protection effectiveness:
- uBlock's resource usage and efficiency:
- Memory footprint: what happens inside uBlock after installation
- uBlock vs. ABP: efficiency compared
- Counterpoint: Who cares about efficiency, I have 8 GB RAM and|or a quad core CPU
- Debunking "uBlock Origin is less efficient than Adguard" claims
- Myth: uBlock consumes over 80MB
- Myth: uBlock is just slightly less resource intensive than Adblock Plus
- Myth: uBlock consumes several or several dozen GB of RAM
- Various videos showing side by side comparison of the load speed of complex sites
- Own memory usage: benchmarks over time
- Contributed memory usage: benchmarks over time
- Can uBO crash a browser?
- Tools, tests
- Deploying uBlock Origin
- Proposal for integration/unit testing
- uBlock Origin Core (Node.js):
- Troubleshooting:
- Good external guides:
- Scientific papers