uBlock/dist/README.md

56 lines
2.8 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
2017-09-04 05:25:40 -06:00
### Firefox webext
- Download `ublock0.webext.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
- Drag and drop the previously downloaded `ublock0.webext.xpi` into Firefox
On Linux, the settings are saved in a JSON file located at `~/.mozilla/firefox/[profile name]/browser-extension-data/uBlock0@raymondhill.net/storage.js`.
### Firefox legacy
2015-04-17 17:23:41 -06:00
2015-04-17 17:32:43 -06:00
- Download `ublock0.firefox.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
- Drag and drop the previously downloaded `ublock0.firefox.xpi` into Firefox
2015-04-17 17:23:41 -06:00
2017-09-04 05:23:32 -06:00
With Firefox 43 and beyond, you may need to toggle the setting `xpinstall.signatures.required` to `false` in `about:config`.
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
- Clone [uBlock](https://github.com/gorhill/uBlock) and [uAssets](https://github.com/uBlockOrigin/uAssets) repositories in the same parent directory
- Set path to uBlock: `cd uBlock`
- Optional: Select the version to build: `git checkout <tag>`
- Build the plugin:
- Chromium: `./tools/make-chromium.sh`
2017-09-04 05:25:40 -06:00
- Firefox webext: `./tools/make-webext.sh all`
- Firefox legacy: `./tools/make-firefox.sh all`
2017-05-26 05:34:01 -06:00
- Load the result of the build into your browser:
- Chromium: load the unpacked extension folder `/uBlock/dist/build/uBlock0.chromium/` in Chromium to use the extension.
- Firefox: drag-and-drop `/uBlock/dist/build/uBlock0.firefox.xpi` into Firefox.