Deploying uBlock Origin: configuration

• Back to "Deploying uBlock Origin"

---

uBO supports being configured through central policies, see browser documentation for administrators:

• Chromium: "Configuring Apps and Extensions by Policy"
• Firefox: "Managed storage manifests"
• Tutorial: Deploying uBO configuration - newer way by u/DefinitelyYou

The documented settings below are only available with uBO version 1.33.0 and above.

userSettings

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

Every valid entry will be used to overwrite the corresponding default user setting at launch time.

Example:

{
    "userSettings": [
        [ "contextMenuEnabled", "false" ],
        [ "dynamicFilteringEnabled", "false" ]
    ]
}

advancedSettings

The purpose of the advancedSettings property is to set the values of various 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.

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.

Example:

{
    "advancedSettings": [
        [ "disableWebAssembly", "true" ]
    ]
}

disableDashboard

Set to true to prevent access to uBO's dashboard.

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:

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

toOverwrite

The properties in the toOverwrite branch will wholly replace the corresponding local settings. Currently, the following properties are supported:

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.

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. For an external list, i.e. 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.

For reference, the following array correspond 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, one or more regional lists may be enabled according to the current locale.

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.

All the directives will be used to wholly replace the local trusted-site directives, including the built-in ones.

See documentation on how to create valid trusted-site directives: "How to mark a web site as trusted"

toAdd

The properties in the toAdd branch will append to the already present local settings. Currently, the following properties are supported:

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.

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 be appended to the local ones.

See documentation on how to create valid trusted-site directives: "How to mark a web site as trusted"