mirror of
https://github.com/gorhill/uBlock.git
synced 2024-11-21 18:02:34 +01:00
Update dist/README.md
This commit is contained in:
daylight
Raymond Hill
parent
b5aaec47b3
commit
c936a72bb3
140
dist/README.md
vendored
140
dist/README.md
vendored
@ -1,81 +1,103 @@
|
||||
## INSTALL
|
||||
# INSTALL
|
||||
|
||||
### Chromium
|
||||
## Chromium
|
||||
|
||||
- Download and unzip `ublock0.chromium.zip` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
|
||||
- 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*.
|
||||
1. Download and unzip `ublock0.chromium.zip` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
|
||||
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.
|
||||
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
|
||||
**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
|
||||
## Firefox
|
||||
|
||||
Compatible with Firefox 52 and beyond.
|
||||
Compatible with Firefox 52 and beyond.
|
||||
|
||||
#### For stable release version
|
||||
### 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>
|
||||
This method only works 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>
|
||||
|
||||
- Download `ublock0.firefox.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
|
||||
- Right-click and choose _"Save As..."_.
|
||||
- Drag and drop the previously downloaded `ublock0.firefox.xpi` into Firefox
|
||||
1. Download `ublock0.firefox.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
|
||||
- Right-click and choose _"Save As..."_.
|
||||
2. Drag and drop the downloaded `ublock0.firefox.xpi` into Firefox.
|
||||
|
||||
#### For beta version
|
||||
### For Beta Version
|
||||
|
||||
- Click on `ublock0.firefox.signed.xpi` ([latest release desirable](https://github.com/gorhill/uBlock/releases)).
|
||||
|
||||
#### Location of uBO settings
|
||||
### 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`.
|
||||
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.
|
||||
|
||||
When you uninstall the extension, Firefox deletes that file, so all your settings are lost when you uninstall.
|
||||
### Firefox Legacy
|
||||
|
||||
### Firefox legacy
|
||||
Compatible with Firefox 24-56, [Pale Moon](https://www.palemoon.org/), and [SeaMonkey](https://www.seamonkey-project.org/).
|
||||
|
||||
Compatible with Firefox 24-56, [Pale Moon](https://www.palemoon.org/) and [SeaMonkey](http://www.seamonkey-project.org/).
|
||||
1. Download `ublock0.firefox-legacy.xpi` ([latest release desirable](https://github.com/gorhill/uBlock-for-firefox-legacy/releases)).
|
||||
- Right-click and select "Save Link As..."
|
||||
2. Drag and drop the downloaded `ublock0.firefox-legacy.xpi` into Firefox.
|
||||
|
||||
- Download `ublock0.firefox-legacy.xpi` ([latest release desirable](https://github.com/gorhill/uBlock-for-firefox-legacy/releases)).
|
||||
- Right-click and select "Save Link As..."
|
||||
- Drag and drop the previously 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`.<sup>[see "Add-on signing in Firefox"](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox)</sup>
|
||||
|
||||
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>
|
||||
Your uBlock Origin settings are preserved even after uninstalling the addon.
|
||||
|
||||
Your uBlock Origin settings are kept intact even after you uninstall 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
|
||||
```
|
||||
|
||||
On Linux, the settings are saved in a SQlite file located at `~/.mozilla/firefox/[profile name]/extension-data/ublock0.sqlite`.
|
||||
## Build Instructions (for Developers)
|
||||
|
||||
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](https://github.com/gorhill/uBlock): `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/`
|
||||
|
||||
1. Clone the [uBlock repository](https://github.com/gorhill/uBlock):
|
||||
```bash
|
||||
git clone https://github.com/gorhill/uBlock.git
|
||||
```
|
||||
2. Set the path to uBlock:
|
||||
```bash
|
||||
cd uBlock
|
||||
```
|
||||
3. The official version of uBO is in the `master` branch:
|
||||
```bash
|
||||
git checkout master
|
||||
```
|
||||
4. Build the plugin:
|
||||
- Chromium:
|
||||
```bash
|
||||
make chromium
|
||||
```
|
||||
- Firefox:
|
||||
```bash
|
||||
make firefox
|
||||
```
|
||||
- NPM package:
|
||||
```bash
|
||||
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/`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user