uBlock/dist
Raymond Hill 47bdec422a
New revision for dev build
2024-11-29 10:55:07 -05:00
..
chromium Add publish script for stable version on Chromium 2024-08-12 14:24:10 -04:00
description Remove languages with no translations, no activity 2023-04-25 14:21:46 -04:00
firefox Make Firefox dev build auto-update 2024-11-28 12:01:12 -05:00
mv3 Delete dist/mv3/log.txt 2024-11-01 16:33:23 -04:00
README.md Update dist/README.md 2024-11-01 16:33:23 -04:00
version New revision for dev build 2024-11-29 10:55:07 -05:00

README.md

INSTALL

Chromium

  1. Download and unzip ublock0.chromium.zip (latest release desirable).
  2. Rename the unzipped directory to ublock.
    • When you update manually, replace the content of the ublock folder with the content of the latest zipped version. This ensures all extension settings are preserved.
    • As long as the extension loads from the same folder path as it was originally installed, your settings will be kept.
  3. Open Chromium/Chrome and go to Extensions.
  4. Click to enable Developer mode.
  5. Click Load unpacked extension....
  6. In the file selector dialog:
    • Select the ublock directory you created.
    • Click Open.

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

Note: You must update manually. For some users, manual updates are beneficial because:

  • You can update when you want.
  • If a new version is unsatisfactory, you can easily reinstall the previous one.

Firefox

Compatible with Firefox 52 and beyond.

For Stable Release Version

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

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

For Beta Version

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 this file, and all your settings will be lost.

Firefox Legacy

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

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

For 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 preserved even after uninstalling the addon.

  • On Linux, settings are saved in a SQLite file located at:
~/.mozilla/firefox/[profile name]/extension-data/ublock0.sqlite
  • On Windows, settings are saved in a SQLite file located at:
%APPDATA%\Mozilla\Firefox\Profiles\[profile name]\extension-data\ublock0.sqlite

Build Instructions (for Developers)

  1. Clone the uBlock repository:
    git clone https://github.com/gorhill/uBlock.git
    
  2. Set the path to uBlock:
    cd uBlock
    
  3. The official version of uBO is in the master branch:
    git checkout master
    
  4. Build the plugin:
    • Chromium:
      make chromium
      
    • Firefox:
      make firefox
      
    • NPM package:
      make npm
      
  5. 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/