uBlock/dist/README.md

82 lines
3.7 KiB
Markdown
Raw Normal View History

2014-06-23 16:42:43 -06:00
## INSTALL
2017-09-04 05:25:40 -06:00
### Chromium
2015-04-17 17:23:41 -06:00
2015-04-17 17:32:43 -06:00
- Download and unzip `ublock0.chromium.zip` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
2014-07-14 20:12:29 -06:00
- Rename the unzipped directory to `ublock`
2014-08-25 17:50:50 -06:00
- 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.
2014-06-23 16:42:43 -06:00
- Go to chromium/chrome *Extensions*.
- Click to check *Developer mode*.
- Click *Load unpacked extension...*.
- In the file selector dialog:
2014-07-17 19:03:16 -06:00
- Select the directory `ublock` which was created above.
2014-06-23 16:42:43 -06:00
- Click *Open*.
2014-09-26 08:05:12 -06:00
The extension will now be available in your chromium/chromium-based browser.
2014-06-29 15:52:42 -06:00
2014-08-25 17:50:50 -06:00
Remember that you have to update manually also. For some users, updating manually is actually an advantage because:
- You can update when **you** want
2015-01-24 05:33:02 -07:00
- If ever a new version sucks, you can easily just re-install the previous one
2015-04-17 17:23:41 -06:00
2018-06-21 17:40:38 -06:00
### Firefox
2017-09-04 05:25:40 -06:00
2018-02-28 06:00:16 -07:00
Compatible with Firefox 52 and beyond.
#### For stable release version
This works only if you set `xpinstall.signatures.required` to `false` in `about:config`.<sup>[see "Add-on signing in Firefox"](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox)</sup>
2017-09-04 05:27:38 -06:00
2018-06-21 17:43:51 -06:00
- Download `ublock0.firefox.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
2018-02-24 12:40:26 -07:00
- Right-click and choose _"Save As..."_.
2018-06-21 17:43:51 -06:00
- Drag and drop the previously downloaded `ublock0.firefox.xpi` into Firefox
2018-02-28 06:00:16 -07:00
#### For beta version
2018-06-21 17:40:38 -06:00
- Click on `ublock0.firefox.signed.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
2017-09-04 05:25:40 -06:00
2018-02-28 06:00:16 -07:00
#### Location of uBO settings
2017-09-04 05:25:40 -06:00
On Linux, the settings are saved in a JSON file located at `~/.mozilla/firefox/[profile name]/browser-extension-data/uBlock0@raymondhill.net/storage.js`.
2017-09-04 05:26:33 -06:00
When you uninstall the extension, Firefox deletes that file, so all your settings are lost when you uninstall.
2017-09-04 05:25:40 -06:00
### Firefox legacy
2015-04-17 17:23:41 -06:00
Compatible with Firefox 24-56, [Pale Moon](https://www.palemoon.org/) and [SeaMonkey](http://www.seamonkey-project.org/).
2017-09-04 05:27:38 -06:00
- Download `ublock0.firefox-legacy.xpi` ([latest release desirable](https://github.com/gorhill/uBlock-for-firefox-legacy/releases)).
2018-04-29 09:12:43 -06:00
- Right-click and select "Save Link As..."
- Drag and drop the previously downloaded `ublock0.firefox-legacy.xpi` into Firefox
2015-04-17 17:23:41 -06:00
2018-01-07 17:07:12 -07:00
With Firefox 43 and beyond, you may need to toggle the setting `xpinstall.signatures.required` to `false` in `about:config`.<sup>[see "Add-on signing in Firefox"](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox)</sup>
2017-09-04 05:23:32 -06:00
2015-08-25 06:56:45 -06:00
Your uBlock Origin settings are kept intact even after you uninstall the addon.
2015-04-17 17:27:41 -06:00
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`.
2017-05-26 05:34:01 -06:00
2017-09-04 05:25:40 -06:00
### Build instructions (for developers)
2017-05-26 05:34:01 -06:00
2022-01-15 04:53:00 -07:00
- Clone [uBlock repo](https://github.com/gorhill/uBlock): `git clone https://github.com/gorhill/uBlock.git`
2017-05-26 05:34:01 -06:00
- Set path to uBlock: `cd uBlock`
2018-06-22 03:32:41 -06:00
- The official version of uBO is in the `master` branch
- `git checkout master`
2017-05-26 05:34:01 -06:00
- Build the plugin:
2022-01-15 04:53:00 -07:00
- Chromium: `make chromium`
- Firefox: `make firefox`
- NPM package: `make npm`
2017-05-26 05:34:01 -06:00
- Load the result of the build into your browser:
2022-01-15 04:53:00 -07:00
- 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/`
2017-05-26 05:34:01 -06:00