mirror of https://github.com/gorhill/uBlock.git
Rewrote sentences for better clarity, to reduce wordiness/redundancy, etc. Consistency fixes. Corrected grammar, spelling, punctuation, etc. URL updates, uBO naming convention
parent
9f2b70266a
commit
f8e3414763
|
@ -1,13 +1,9 @@
|
||||||
- Back to ["Deploying uBlock Origin"](./Deploying-uBlock-Origin)
|
uBlock Origin (uBO) supports configuration through central policies. See browser documentation for administrators:
|
||||||
|
|
||||||
***
|
- Chromium: ["Configuring Apps and Extensions by Policy"](https://www.chromium.org/administrators/configuring-policy-for-extensions/)
|
||||||
|
- Firefox: ["Managed storage manifests"](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#managed_storage_manifests)
|
||||||
uBO supports being configured through central policies, see browser documentation for administrators:
|
- [Tutorial: Deploying uBO configuration for Microsoft Edge Chromium and Google Chrome - newer way](https://www.reddit.com/r/uBlockOrigin/comments/o7q2ou/comment/h3crkxf/) (Editing Registry by PowerShell) by [u/DefinitelyYou](https://www.reddit.com/user/DefinitelyYou)
|
||||||
|
- [Deploying uBlock via Google workspace? (Q&A discussion)](https://github.com/uBlockOrigin/uBlock-issues/discussions/1834) (with a successful deployment)
|
||||||
- Chromium: ["Configuring Apps and Extensions by Policy"](https://www.chromium.org/administrators/configuring-policy-for-extensions)
|
|
||||||
- Firefox: ["Managed storage manifests"](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#Managed_storage_manifests)
|
|
||||||
- [Tutorial: Deploying uBO configuration for Microsoft Edge Chromium and Google Chrome - newer way](https://old.reddit.com/r/uBlockOrigin/comments/o7q2ou/control_trusted_sites_with_gpo/h3crkxf/) (Editing Registry by PowerShell) by [u/DefinitelyYou](https://old.reddit.com/user/DefinitelyYou)
|
|
||||||
- [Deploying uBlock via Google workspace? (Q&A discussion)](https://github.com/uBlockOrigin/uBlock-issues/discussions/1834) (with successful deployment)
|
|
||||||
|
|
||||||
The documented settings below are only available with uBO version 1.33.0 and above.
|
The documented settings below are only available with uBO version 1.33.0 and above.
|
||||||
|
|
||||||
|
@ -15,9 +11,9 @@ The documented settings below are only available with uBO version 1.33.0 and abo
|
||||||
|
|
||||||
The purpose of the `userSettings` property is to set the values of various [user settings](./Dashboard:-Settings) (more specifically, to modify [these variables](https://github.com/gorhill/uBlock/blob/1c3b45f75d0f84d68abb51b15bbdc043464ee3e0/src/js/background.js#L86-L109)).
|
The purpose of the `userSettings` property is to set the values of various [user settings](./Dashboard:-Settings) (more specifically, to modify [these variables](https://github.com/gorhill/uBlock/blob/1c3b45f75d0f84d68abb51b15bbdc043464ee3e0/src/js/background.js#L86-L109)).
|
||||||
|
|
||||||
Each entry in the array is an array consisting of a pair of name-value strings. Each name string must be a supported user setting, and each value string must properly resolve to a supported value.
|
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 will be used to overwrite the corresponding default user setting at launch time.
|
Every valid entry gets used to overwrite the corresponding default user setting at launch time.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
@ -30,11 +26,11 @@ Example:
|
||||||
|
|
||||||
## advancedSettings
|
## advancedSettings
|
||||||
|
|
||||||
The purpose of the `advancedSettings` property is to set the values of various [advanced settings](./Advanced-settings).
|
The `advancedSettings` property is to set the values of various [advanced settings](./Advanced-settings).
|
||||||
|
|
||||||
Each entry in the array is an array consisting of a pair of name-value strings. Each name string must be a supported advanced setting, and each value string must properly resolve to a supported value.
|
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 be used to overwrite the corresponding default advanced setting, and will also become read-only, i.e. the user won't be able to change it.
|
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:
|
Example:
|
||||||
|
|
||||||
|
@ -50,7 +46,7 @@ Set to `true` to prevent access to uBO's dashboard.
|
||||||
|
|
||||||
## disabledPopupPanelParts
|
## disabledPopupPanelParts
|
||||||
|
|
||||||
An array of strings, where each string refer to a part of the popup panel which should be removed from view. Current supported named parts:
|
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.
|
- `globalStats`: remove access to _"Blocked since install"_ statistic.
|
||||||
- `basicTools`: remove access to [basic tools](./Quick-guide:-popup-user-interface#the-tools).
|
- `basicTools`: remove access to [basic tools](./Quick-guide:-popup-user-interface#the-tools).
|
||||||
|
@ -63,15 +59,15 @@ The properties in the `toOverwrite` branch will wholly replace the corresponding
|
||||||
|
|
||||||
#### filters
|
#### filters
|
||||||
|
|
||||||
The `filters` property is an array of strings, which are meant to represent all the lines making the text to use as the content of the [_"My filters"_ pane](./Dashboard:-My-filters).
|
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](./Dashboard:-My-filters).
|
||||||
|
|
||||||
#### filterLists
|
#### filterLists
|
||||||
|
|
||||||
The `filterLists` property is an array of strings, where each string is a token which identifies a list to enable by default. To enable a stock filter list, this is the token identifying the list as per content of [`assets.json`](https://github.com/gorhill/uBlock/blob/master/assets/assets.json). For an external list, i.e. not found in `assets.json`, the token is the URL of the filter list.
|
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`](https://github.com/gorhill/uBlock/blob/master/assets/assets.json). For an external list not found in `assets.json`, the token is the URL of the filter list.
|
||||||
|
|
||||||
If you want the filters present in the _"My filters"_ pane to be enforced, be sure to use the token `user-filters` in your list of filter lists.
|
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 correspond to the default list of filter lists enabled in uBO by default:
|
For reference, the following array corresponds to the default list of filter lists enabled in uBO by default:
|
||||||
|
|
||||||
[
|
[
|
||||||
"user-filters",
|
"user-filters",
|
||||||
|
@ -86,15 +82,15 @@ For reference, the following array correspond to the default list of filter list
|
||||||
"plowe-0"
|
"plowe-0"
|
||||||
]
|
]
|
||||||
|
|
||||||
Additionally, one or more regional lists may be enabled according to the current locale.
|
Additionally, according to the current locale, one or more regional lists may be enabled.
|
||||||
|
|
||||||
#### trustedSiteDirectives
|
#### trustedSiteDirectives
|
||||||
|
|
||||||
The `trustedSiteDirectives` property is an array of string, each of which must resolve into a valid trusted-site directive, used to dictate where uBO must be disabled.
|
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 the directives will be used to wholly replace the local trusted-site directives, including the built-in ones.
|
All directives will replace the local trusted-site rules, including the built-in ones.
|
||||||
|
|
||||||
See documentation on how to create valid trusted-site directives: ["How to mark a web site as trusted"](./How-to-mark-a-web-site-as-trusted)
|
See the documentation on how to create valid trusted-site directives: ["How to mark a web site as trusted"](./How-to-mark-a-web-site-as-trusted)
|
||||||
|
|
||||||
## toAdd
|
## toAdd
|
||||||
|
|
||||||
|
@ -102,7 +98,7 @@ The properties in the `toAdd` branch will append to the already present local se
|
||||||
|
|
||||||
#### trustedSiteDirectives
|
#### trustedSiteDirectives
|
||||||
|
|
||||||
The `trustedSiteDirectives` property is an array of string, each of which must resolve into a valid trusted-site directive, used to dictate where uBO must be disabled.
|
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:
|
Here is an example of how adding `example.com` and `example.org` would look like for managed storage on Chromium/Linux:
|
||||||
|
|
||||||
|
@ -122,6 +118,6 @@ Here is an example of how adding `example.com` and `example.org` would look like
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
The directives will be appended to the local ones.
|
The directives will get appended to the local ones.
|
||||||
|
|
||||||
See documentation on how to create valid trusted-site directives: ["How to mark a web site as trusted"](./How-to-mark-a-web-site-as-trusted)
|
See the documentation on how to create valid trusted-site directives: ["How to mark a web site as trusted"](./How-to-mark-a-web-site-as-trusted)
|
Loading…
Reference in New Issue