uBlock

mirror of https://github.com/gorhill/uBlock.git synced 2024-11-02 08:52:45 +01:00

History

q1800 682988ec29 Update description-en.txt (#3885 ) * Update description-en.txt Using the current uBO README.md, I made changes to bring the web store description file more inline and consistent with it. Updated various verbiage and naming conventions. Minor restructuring to last section for conciseness and to include more information. Fixed Documentation URL. * Update description-en.txt Removed sentence as per feedback.		2023-01-08 10:53:38 -05:00
..
chromium	Remove unused dependency	2022-12-09 11:28:48 -05:00
description	Update description-en.txt (#3885 )	2023-01-08 10:53:38 -05:00
firefox	Make Firefox dev build auto-update	2023-01-07 10:26:20 -05:00
mv3	Update build log file	2022-12-26 15:40:31 +00:00
README.md	Update build instructions	2022-01-15 06:53:00 -05:00
version	New revision for dev build	2023-01-07 10:18:47 -05:00

README.md

INSTALL

Chromium

Download and unzip ublock0.chromium.zip (latest release desirable).
Rename the unzipped directory to ublock
- When you later update manually, replace the content of the ublock folder with the content of the latest zipped version.
- This will ensure that all the extension settings will be preserved
- As long as the extension loads from same folder path from which it was originally installed, all your settings will be preserved.
Go to chromium/chrome Extensions.
Click to check Developer mode.
Click Load unpacked extension....
In the file selector dialog:
- Select the directory ublock which was created above.
- Click Open.

The extension will now be available in your chromium/chromium-based browser.

Remember that you have to update manually also. For some users, updating manually is actually an advantage because:

You can update when you want
If ever a new version sucks, you can easily just re-install the previous one

Firefox

Compatible with Firefox 52 and beyond.

For stable release version

This works only if you set xpinstall.signatures.required to false in about:config.^{see "Add-on signing in Firefox"}

Download ublock0.firefox.xpi (latest release desirable).
- Right-click and choose "Save As...".
Drag and drop the previously downloaded ublock0.firefox.xpi into Firefox

For beta version

Click on ublock0.firefox.signed.xpi (latest release desirable).

Location of uBO settings

On Linux, the settings are saved in a JSON file located at ~/.mozilla/firefox/[profile name]/browser-extension-data/uBlock0@raymondhill.net/storage.js.

When you uninstall the extension, Firefox deletes that file, so all your settings are lost when you uninstall.

Firefox legacy

Compatible with Firefox 24-56, Pale Moon and SeaMonkey.

Download ublock0.firefox-legacy.xpi (latest release desirable).
- Right-click and select "Save Link As..."
Drag and drop the previously downloaded ublock0.firefox-legacy.xpi into Firefox

With Firefox 43 and beyond, you may need to toggle the setting xpinstall.signatures.required to false in about:config.^{see "Add-on signing in Firefox"}

Your uBlock Origin settings are kept intact even after you uninstall the addon.

On Linux, the settings are saved in a SQlite file located at ~/.mozilla/firefox/[profile name]/extension-data/ublock0.sqlite.

On Windows, the settings are saved in a SQlite file located at %APPDATA%\Mozilla\Firefox\Profiles\[profile name]\extension-data\ublock0.sqlite.

Build instructions (for developers)

Clone uBlock repo: git clone https://github.com/gorhill/uBlock.git
Set path to uBlock: cd uBlock
The official version of uBO is in the master branch
- git checkout master
Build the plugin:
- Chromium: make chromium
- Firefox: make firefox
- NPM package: make npm
Load the result of the build into your browser:
- Chromium:
  - Navigate to chrome://extensions/
  - Check "Developer mode"
  - Click "Load unpacked"
  - Select /uBlock/dist/build/uBlock0.chromium/
- Firefox:
  - Navigate to about:debugging#/runtime/this-firefox
  - Click "Load Temporary Add-on..."
  - Select /uBlock/dist/build/uBlock0.firefox/