Cloud storage - uBlockOrigin/uBlock-issues GitHub Wiki

Support for cloud storage started with uBlock Origin (uBO) 1.1.0.0.

uBO's cloud storage uses your browser's sync feature (Firefox Sync or Google Account) to synchronize extension settings across multiple devices.

If your browser/environment does not support cloud storage, the feature will be disabled.

uBO does not need a remote server due to using your browser's built-in sync ability as long as you have enabled it.

The user must explicitly enable cloud storage support on uBO's Settings pane in the dashboard by checking the "Enable cloud storage support" checkbox.

Once you enable cloud storage support, a new UI widget will be available in the dashboard for panes that support the export/import of settings to/from cloud storage.

screenshot

The widget shows (from left to right):

  • "Export to cloud storage" button
  • The name of the device from which the data was uploaded and timestamp of upload
  • "Import from cloud storage" - this will override your current filters
  • "Import from cloud storage and merge with current settings" - this will merge your cloud storage filters with your current filters
  • Settings button (gear, far right) to setup the name of your current device

[!IMPORTANT] Even if cloud storage support is enabled, it will only work if you have enabled sync support in your browser. uBO itself does not connect to any remote server. Your browser does this through its sync feature if you have enabled this feature.

A narrow, purple-grey strip on the bottom of the cloud storage widget allows for estimating available space on cloud storage servers. The violet part represents the space occupied by settings on the current page. Dark grey represents all storage used by uBO settings. (1.29.3b7)

Your uBO settings are precious. To prevent any automated browser syncing task from overwriting your local or cloud data, you must expressly ask uBO to export to/import from cloud storage.

uBO's implemented sync feature is a global clipboard where settings are copied and pasted. Only you decide when to export/import.

uBO does not support auto-sync, such auto-sync feature requests on uBO issue trackers have been declined many times in the past, see the list at the bottom of the page.

The granularity of uBO settings regarding cloud storage support is straightforward. One dashboard pane equals one dedicated cloud storage entry. This way, it is possible for a user to use cloud storage for different panes and choose whether or not to persist a specific pane to the cloud because browser vendors can limit cloud storage.

The import/export of cloud storage data in a pane works strictly at the UI level. When importing cloud storage data, it will fill in the pane's UI as if you entered the data yourself. However, depending on the pane, you will still have to validate/commit the imported data.

Cloud storage providers may refuse an export operation if you reach the cloud storage capacity limit, and the data on the cloud storage will be left untouched.

If you do not have a syncing account with your browser vendor, I have observed that the cloud storage feature can still be used as a local clipboard to save a pane's settings. It might be convenient sometimes, but please do not use cloud storage to replace uBO's backup feature. Regularly backing up your settings is recommended, especially for those having extensive custom static filters, custom rules, or trusted site directives.

Important: Some browsers offer to use a passphrase for their sync feature to enable end-to-end encryption of the data stored for sync purposes (example). Using such as passphrase is strongly suggested.

Caveats

Cloud storage services offered by specific browser vendors have limitations and quirks and are out of the control of uBO.

Chromium-based browsers
  • Various size limits: for example, on Chrome storage space limit is 102,400 bytes.
  • Various limits on the number of operations per unit of time.
  • See chrome.storage API for more technical details.
Firefox
  • Note that Firefox Sync is not triggered when you export uBO settings. It seems to get executed regularly; however, if you want to force the cloud export, you must launch Firefox Sync manually.

Sync button

Auto-sync

uBO does not support auto-sync, such auto-sync feature requests on uBO issue trackers have been declined many times in the past:

Hence there is no point in spamming the issue tracker by creating new duplicates over and over, discussion and sharing opinions should be continued in already existing threads, new threads will be labeled as invalid or duplicate and closed.