Mirrors/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-09-29 06:07:11 +02:00
Code Issues Releases Wiki Activity

Grammar & URL Updates

q1800 2022-02-01 22:41:48 -06:00
parent 572c31917b
commit 3855bffa4e
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Cloud-storage.md

@ -10,11 +10,11 @@ _Cloud storage_ in uBlock Origin is supported through your browser's _sync_ feat
If your browser/environment does not support cloud storage, the feature will be disabled. If your browser/environment does not support cloud storage, the feature will be disabled.
Using your browser's built-in sync ability means uBlock Origin does not need a remote server of its own, your browser's specific solution for syncing data will be used, assuming you enabled such feature in your browser. Using your browser's built-in sync ability means uBlock Origin does not need a remote server of its own, your browser's specific solution for syncing data will be used, assuming you enabled such a feature in your browser.
In uBlock Origin, cloud storage support must be explicitly enabled by the user, from the _Settings_ pane in the dashboard: check the _"Enable cloud storage support"_ checkbox. In uBlock Origin, cloud storage support must be explicitly enabled by the user, from the _Settings_ pane in the dashboard: check the _"Enable cloud storage support"_ checkbox.
Once you enable cloud storage support, a new UI widget will be available in the dashboard for panes which support the export/import of settings to/from cloud storage: 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](https://user-images.githubusercontent.com/585534/92239074-6410b180-ee88-11ea-8bb6-b8ecb2f121d3.png) ![screenshot](https://user-images.githubusercontent.com/585534/92239074-6410b180-ee88-11ea-8bb6-b8ecb2f121d3.png)
@ -24,7 +24,7 @@ Once you enable cloud storage support, a new UI widget will be available in the
> Even if cloud storage support is enabled, it will work **if and only if** you actually enable sync support in your browser -- as uBlock itself does not connect to any remote server, your browser does this through its own sync feature, if you enabled such feature. > Even if cloud storage support is enabled, it will work **if and only if** you actually enable sync support in your browser -- as uBlock itself does not connect to any remote server, your browser does this through its own sync feature, if you enabled such feature.
> *** > ***
Narrow, purple-grey strip on the bottom of the cloud storage widget allows to estimate available space on cloud storage servers. Violet part represents space occupied by settings in current page. Dark grey represents all storage used by uBO settings. ([1.29.3b7](https://github.com/gorhill/uBlock/commit/2afcc13ca6c09175b33ff74494eba7113ceb3df1)) A narrow, purple-grey strip on the bottom of the cloud storage widget allows estimating available space on cloud storage servers. The violet part represents space occupied by settings on the current page. Dark grey represents all storage used by uBO settings. ([1.29.3b7](https://github.com/gorhill/uBlock/commit/2afcc13ca6c09175b33ff74494eba7113ceb3df1))
Your uBlock Origin settings are precious, and in order to prevent any automated browser's syncing task to cause precious local data (or cloud data) to be mistakenly overwritten, the chosen solution in uBlock Origin is to _never_ ever export to/import from cloud storage without **the user expressly asking uBlock Origin to do so**. Your uBlock Origin settings are precious, and in order to prevent any automated browser's syncing task to cause precious local data (or cloud data) to be mistakenly overwritten, the chosen solution in uBlock Origin is to _never_ ever export to/import from cloud storage without **the user expressly asking uBlock Origin to do so**.
@ -36,12 +36,12 @@ The import/export of cloud storage data in a pane works strictly at the UI level
If ever an export operation causes the cloud storage capacity limit to be reached, typically the cloud storage providers will refuse the operation, and the data on the cloud storage will be left unchanged. This is what I have observed with Chromium-based browsers. If ever an export operation causes the cloud storage capacity limit to be reached, typically the cloud storage providers will refuse the operation, and the data on the cloud storage will be left unchanged. This is what I have observed with Chromium-based browsers.
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 settings. Might be convenient sometimes, but please do not use cloud storage as a replacement for [uBlock Origin's backup feature](./Dashboard:-Settings#backuprestore-section). It is recommended you back up your settings regularly, this is especially true for those who have extensive custom static filters, custom rules or trusted sites directives. 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. Might be convenient sometimes, but please do not use cloud storage as a replacement for [uBlock Origin's backup feature](./Dashboard:-Settings#backuprestore-section). It is recommended you back up your settings regularly, this is especially true for those who have extensive custom static filters, custom rules or trusted sites directives.
> *** > ***
> **Important:** > **Important:**
> >
> Some browsers offer the ability to use a passphrase for their sync feature, in order to enable end-to-end encryption of the data stored for sync purpose ([example](https://support.google.com/chrome/answer/1181035)). It is strongly suggested to make use of such passphrase. > Some browsers offer the ability to use a passphrase for their sync feature, in order to enable end-to-end encryption of the data stored for sync purpose ([example](https://support.google.com/chrome/answer/1181035)). It is strongly suggested to make use of such a passphrase.
> *** > ***
#### Caveats #### Caveats
@ -52,18 +52,18 @@ Cloud storage services offered by specific browser vendors have their own limita
- Various size limits: for example, on Chrome storage space limit is 102,400 bytes. - 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. - Various limits on the number of operations per unit of time.
- See [`chrome.storage` API](https://developer.chrome.com/extensions/storage#property-sync) for more technical details. - See [`chrome.storage` API](https://developer.chrome.com/docs/extensions/reference/storage/#property-sync) for more technical details.
##### Firefox browsers ##### Firefox browsers
- Note that Firefox Sync is not triggered when you export uBlock settings, it seems to be executed regularly however if you want to force the cloud export you have to launch Firefox Sync manually. - Note that Firefox Sync is not triggered when you export uBlock settings, it seems to be executed regularly however if you want to force the cloud export you have to launch Firefox Sync manually.
![Sync button](https://user-images.githubusercontent.com/886325/41821498-e081fe7e-77e1-11e8-81de-03a09d826cb9.png) ![Sync button](https://user-images.githubusercontent.com/886325/41821498-e081fe7e-77e1-11e8-81de-03a09d826cb9.png)
- I have observed that too large amount of per-pane data will cause a warning in the browser console (> 8K). - 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 uBlock Origin will cause cloud storage data to be blanked.** - **A new installation of uBlock Origin will cause cloud storage data to be blanked.**
- Update: [Reportedly fixed in BZ#753289](https://bugzilla.mozilla.org/show_bug.cgi?id=753289), included in [Firefox 43.0](https://bugzilla.mozilla.org/buglist.cgi?j_top=OR&f1=target_milestone&o3=equals&v3=Firefox%2043&o1=equals&resolution=FIXED&o2=anyexact&query_format=advanced&f3=target_milestone&f2=cf_status_firefox43&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&v1=mozilla43&v2=fixed%2Cverified&limit=0) - Update: [Reportedly fixed in BZ#753289](https://bugzilla.mozilla.org/show_bug.cgi?id=753289), included in [Firefox 43.0](https://bugzilla.mozilla.org/buglist.cgi?j_top=OR&f1=target_milestone&o3=equals&v3=Firefox%2043&o1=equals&resolution=FIXED&o2=anyexact&query_format=advanced&f3=target_milestone&f2=cf_status_firefox43&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&v1=mozilla43&v2=fixed%2Cverified&limit=0)
- See: <https://discourse.mozilla-community.org/t/how-to-sync-preferences-of-a-bootstrapped-extension-via-sync/3024>. - See: <https://discourse.mozilla.org/t/how-to-sync-preferences-of-a-bootstrapped-extension-via-sync/3024>.
- But since uBlock Origin won't automatically import settings from the cloud storage, this will not cause any lost of local settings. However, you will have to push again your settings to the cloud storage. - But since uBlock Origin won't automatically import settings from the cloud storage, this will not cause any loss of local settings. However, you will have to push again your settings to the cloud storage.
- There is [not much doc about this for Firefox](https://support.mozilla.org/en-US/products/firefox/sync-and-save), so there might be undocumented limitations yet to be found. - There is [not much doc about this for Firefox](https://support.mozilla.org/en-US/products/firefox/sync-and-save), so there might be undocumented limitations yet to be found.
- It appears Firefox for Android can't sync extensions settings. This is tracked in [Bugzilla #1316442](https://bugzilla.mozilla.org/show_bug.cgi?id=1316442). - It appears Firefox for Android can't sync extensions settings. This is tracked in [Bugzilla #1316442](https://bugzilla.mozilla.org/show_bug.cgi?id=1316442).
- Other Firefox-related platform: - Other Firefox-related platforms:
- I have no clue whether this new feature will work for other brands of Firefox-based browsers. - I have no clue whether this new feature will work for other brands of Firefox-based browsers.