Table of Contents
- Back to Wiki home
- Back to Dashboard
- Back to Dashboard: Settings
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.
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.
- I have observed that too large an amount of per-pane data will cause a warning in the browser console (> 8K).
- A new installation of uBO will erase cloud storage data.
- Update: Reportedly fixed in Bugzilla Report #753289 and included in Firefox 43.0.
- See https://discourse.mozilla.org/t/how-to-sync-preferences-of-a-bootstrapped-extension-via-sync/3024.
- But since uBO will not automatically import settings from the cloud storage, this will not cause any loss of local ones. However, you will have to push your settings to the cloud storage again.
- Due to minimal documentation, there might be undocumented limitations about this in Firefox.
- It appears Firefox for Android can not sync extension settings. This is tracked in Bugzilla Report #1625257.
- It is unknown if this new feature will work for other Firefox-based browsers.
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:
- (2015) Automatic cloud sync
- (2016) [Firefox] Sync settings between desktop and mobile
- (2016) Improvement: sync cloud options automatically
- (2017) Auto-sync for dynamic filters among browsers/devices?
- (2018) Let me sync another person's custom filer automatically.
- (2018) Cloud storage autosync option
- (2018) Settings are not synchronized
- (2021) Feature Request: Sync uBO settings between two (or more) browsers
- (2024) My filters are not synced between different browsers connected to my Firefox account
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.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
- 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
- Overview of uBlock's network filtering engine: details
- Does uBlock Origin block ads or just hide them?
- Doesn't uBlock Origin add overhead to page load?
- About "Why uBlock Origin works so much better than Pi‑hole does?"
- 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
uBlock Origin - An efficient blocker for Chromium and Firefox. Fast and lean.