Advanced settings

Raymond Hill edited this page Jan 8, 2019 · 41 revisions

Back to Wiki home


The "Advanced settings" page contains settings which are experimental, or which are of interest to advanced users who want more control over how uBO behaves internally.

These advanced settings can be easily accessed only when the setting "I am an advanced user" in the Settings pane in the dashboard is checked, but will persist and work even when the setting "I am an advanced user" is not checked:

Click on the cogs icon

The advanced settings available are described below. Be aware that those settings may change or be removed in the future, or more may be added.

If you want to reset a specific setting to its defautl value, just delete the value, uBO will fill the missing value with the default one.

If you want to reset all settings to their default values, delete everything then press "Apply changes".


assetFetchTimeout

Default: 30 seconds.

The number of seconds after which uBO throws an error when a remote server fails to respond to a request.


autoCommentFilterTemplate

uBO 1.17.7b2 and above.

Default value is {{date}} {{origin}}.

Placeholders are identified by {{...}}. There are currently only three placeholders supported:

  • {{date}}: will be replaced with current date
  • {{time}}: will be replaced with current time
  • {{origin}}: will be replaced with site information on which the filter(s) was created

If no placeholder is found in autoCommentFilterTemplate, this will disable auto-commenting. So one can use - to disable auto-commenting.


autoUpdateAssetFetchPeriod

Default: 120 seconds.

When the auto-updater kicks in and an asset in need of update is fetched, this is the number of seconds to wait before fetching the next asset which needs to be updated. The delay helps spread the load on CPU and memory as a result of loading/parsing/compiling the filter lists which have been updated.


autoUpdatePeriod

Default: 7 hours.

The time to wait in hours between each update session[1]. uBO will always start an update session a few minutes after launch when auto-update is enabled. Once that first update session is completed, uBO will wait autoUpdatePeriod hours before starting a new update session.

[1] "Update session" means that uBO will lookup and update assets deemed out of date, if any.


cacheControlForFirefox1376932

Default: no-cache, no-store, must-revalidate.

uBO 1.17.0 and above.

Configure how uBO should affect caching for the purpose of dealing with browser bug (see #229).

Possible values:

no-cache, no-store, must-revalidate:

  • Undesirable side effect: documents themselves for which uBO has to inject CSP directives as a result of filters/ruleset won't be available offline.

no-cache:

  • Undesirable side effect: One will need to explicitly cache-bypass reload a page each time uBO has to inject CSP directives as a result of filters/ruleset. Note that such cache-bypass reload does not affect only the document itself, but also all secondary resources inside that document.

Related browser issues:


cacheStorageCompression

Default: true.

uBO 1.16.21 and above.

If set to true, uBO will lz4-compress data before storing it in its cache storage. The cache storage is used for storing downloaded filter lists, compiled filter lists, selfies. This setting currently only work with Firefox/Firefox for Android. See https://github.com/uBlockOrigin/uBlock-issues/issues/141 for related discussion.


debugScriptlets

Default: false.

If set to true, debugger; statement will be inserted just before scriptlet code


disableWebAssembly

Default: false.

uBO 1.17.3rc4 and above.

For development purposes only.


ignoreRedirectFilters

Default: false.

If set to true, uBO will no longer attempt to redirect blocked network requests to a local, neutered version of a resource. The main purpose of redirect filters is to minimize web page breakage as a result of blocking resources.


ignoreScriptInjectFilters

Default: false.

If set to true, uBO will no longer lookup and inject scriptlets into web pages. The main purpose of the scriptlets is to defuse anti-blocker mechanisms present on some sites.


manualUpdateAssetFetchPeriod

Default: 500 milliseconds.

When clicking the "Update now" button in the "3rd-party filters" pane in the dashboard, this is the number of milliseconds to wait before fetching the next asset which needs to be updated. The delay helps spread the load incurred as a result of loading/processing new filter lists, and its purpose is also to be considerate to remote servers by not subjecting them to rapid-fire requests.


popupFontSize

Default: unset.

A valid CSS font size value (14px) to use for the popup panel. Use if you are unhappy with the default size.


requestJournalProcessPeriod

Default: 1000 milliseconds.

uBO 1.16.21b2 and above.

Controls the delay before uBO internally process it's network request journal queue. The network request journal queue exists for the purpose of fixing issue 2053.

As a benign side effect to the fix, there is a delay in displaying the number of blocked requests on extension icon (see #155).

A lower delay than the default one could bring back the issue it's meant to fix.


strictBlockingBypassDuration

Default: 120 seconds.

uBO 1.17.3b4 and above.

Controls duration of the Strict blocking "Temporarily" bypass.


suspendTabsUntilReady (experimental)

Default: false.

After uBO 1.17.5rc0 - Chromium only. Firefox now uses "persistent startup listeners" by default.

If set to true, uBO will hard block all network requests when the browser launches until all the filter lists and rules are loaded and ready, at which time uBO will force a reload of the tabs for which there were network requests blocked during the setup phase.

Disclaimer: even with this setting enabled (set to true), it's impossible for uBO to guarantee with 100% certainty that everything will be properly blocked when the browser is launched. This is a by-design browser issue -- do not open an issue on uBO issue tracker about this.

Related browser issues:


userResourcesLocation

Default: unset.

uBO 1.11.5 and above.

If set to a valid URL, uBO will load the content of the URL and parse it as token-identified resources to be used for redirect or script:inject purpose. For example, I use this setting to test resources before publishing them for uAssets. uBO expects valid content such as can be seen in resources.txt, anything else will lead to undefined results.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.