d064537c07
- Added #284 - Added #56 - Fixed #241 - Possible fix & workaround for #203 - Fixed bug in "history tracking injection protection". This option was not disabled, when the global filter switch are on off - Added an option to im-/export the log (requires the `downloads` permission) - Added an option to im-/export the settings (requires the `downloads` permission) - Added information page for blocked sites, when they are called in the `main_frame` - Added "multiple times URL encodes" recognition - Refactoring - Changed background script loading sequence to prevent that required functions are not yet loaded.
85 lines
5.8 KiB
Markdown
85 lines
5.8 KiB
Markdown
[<img src="https://addons.cdn.mozilla.net/static/img/addons-buttons/AMO-button_1.png" alt="for Firefox">](https://addons.mozilla.org/en-US/firefox/addon/clearurls/) [<img src="https://developer.chrome.com/webstore/images/ChromeWebStore_BadgeWBorder_v2_206x58.png" alt="for Chrome">](https://chrome.google.com/webstore/detail/clearurls/lckanjgmijmafbedllaakclkaicjfmnk)
|
||
|
||
# <sub><img src="https://gitlab.com/KevinRoebert/ClearUrls/raw/master/img/clearurls.svg" width="64px" height="64px"></sub> ClearURLs
|
||
|
||
**ClearURLs** is an add-on based on the new WebExtensions technology and is optimized for *Firefox* and *Chrome* based browsers.
|
||
|
||
This add-on will remove the tracking fields from all URLs, which are visited by the browser, with the help of an external rule file,
|
||
which is regularly updated by us and can be found [here](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.min.json),
|
||
to protect your privacy.
|
||
|
||
## Application
|
||
Large (and small) websites use elements in the URL, e.g.: `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale`
|
||
to track your online activities. In this example, the `utm` fields used to track a custom campaign, managed by Google. It tells the provider, and also Google,
|
||
the source, the medium (e.g. email or web) and the specific campaign of the link. All these tracking fields are not necessary for a website to be displayed
|
||
or work correctly and can therefore be removed - that is exactly what ClearURLs does, so you can think of it as an *URL clean maid*.
|
||
|
||
Another common example are Amazon URLs. If you search for a product on Amazon you will get a very long URL for this product, e.g.
|
||
`https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011`,
|
||
the most of this URL is available for tracking and is not needed. After ClearURLs has cleaned this URL, it looks like this:
|
||
`https://www.amazon.com/dp/exampleProduct`
|
||
|
||
## Screenshot
|
||
|
||
|
||
## CI/CD Artifacts Download (for Firefox- and Chrome-Dev only)
|
||
Here you can download the packed files for the Firefox- and Chrome-Dev:
|
||
|
||
[Firefox](https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/ClearUrls_firefox.zip?job=build%20firefox)
|
||
|
||
[Chrome](https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/ClearUrls_chrome.zip?job=build%20chrome)
|
||
|
||
## Test
|
||
If you want to test whether ClearURLs works correctly on your system, you can go to this test page: [https://clearurls.roebert.eu/](https://clearurls.roebert.eu/)
|
||
|
||
## Contribute
|
||
If you have any suggestions or complaints, please [create an issue.](https://gitlab.com/KevinRoebert/ClearUrls/issues/new)
|
||
|
||
### Translate ClearURLs
|
||
You want to help translating ClearURLs into many languages? – Nice
|
||
|
||
You can choose between two options to contribute. You can create a merge request, or you can use the POEditor to translate ClearURLs.
|
||
|
||
*Hint: The description field in the translation files are only an information for what the translation is used.
|
||
It is not necessary to translate the description field; in the most cases it is empty.*
|
||
|
||
#### Merge request
|
||
If you want to create a merge request, you must open the path [`_locales/en/messages.json`](https://github.com/KevinRoebert/ClearUrls/blob/master/_locales/en/messages.json) in the ClearURLs repo
|
||
and translate the english terms into terms of your language. Once you have translated all the terms, you make a pull request of your translation.
|
||
Please push your translation into the folder `_locales/{country code}/messages.json`.
|
||
|
||
#### POEditor
|
||
[<img src="https://poeditor.com/public/images/logo/logo.svg" alt="https://poeditor.com/join/project/vKTpQWWvk2" width="150">](https://poeditor.com/join/project/vKTpQWWvk2)
|
||
|
||
## Projects that use parts of ClearURLs
|
||
|
||
* [Uroute](https://github.com/walterl/uroute) used ClearURLs to filter/clean URL before launching browser
|
||
|
||
## Recommended by...
|
||
* [ghacks-user.js](https://github.com/ghacksuserjs/ghacks-user.js/wiki/4.1-Extensions)
|
||
* [Awesome Humane Tech List](https://github.com/humanetech-community/awesome-humane-tech#tracking)
|
||
|
||
## Permissions
|
||
Reasoning for needed permissions you can find under [this discussion](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
|
||
|
||
## Copyright
|
||
We use some third-party scripts in our add-on. The authors and licenses are listed below.
|
||
- [WebExtension browser API Polyfill](https://github.com/mozilla/webextension-polyfill) |
|
||
Copyright by Mozilla |
|
||
[MPL-2.0](https://github.com/mozilla/webextension-polyfill/blob/master/LICENSE)
|
||
- [Bootstrap v3.3.7 ](http://getbootstrap.com) |
|
||
Copyright 2011-2016 Twitter, Inc. |
|
||
[MIT](https://github.com/twbs/bootstrap/blob/master/LICENSE)
|
||
- [jQuery v3.2.1](https://jquery.com/) |
|
||
Copyright 2017 The jQuery Foundation |
|
||
[MIT](https://jquery.org/license/)
|
||
- [sha256.jquery.plugin](https://github.com/orsozed/sha256.jquery.plugin) |
|
||
Copyright 2003, Christoph Bichlmeier |
|
||
[MIT](https://raw.github.com/orsozed/JQuery-Plugins/master/license/MIT-LICENSE.txt) |
|
||
[GPLv2](https://raw.github.com/orsozed/JQuery-Plugins/master/license/GPL-LICENSE.txt)
|
||
- [DataTables](https://datatables.net/) | Copyright 2011-2015 SpryMedia Ltd | [MIT](https://datatables.net/license/)
|
||
- [Pick-a-Color v1.2.3](https://github.com/lauren/pick-a-color) | Copyright (c) 2013 Lauren Sperber and Broadstreet Ads |
|
||
[MIT](https://github.com/lauren/pick-a-color/blob/master/LICENSE)
|
||
- [ip-range-check v0.2.0](https://github.com/danielcompton/ip-range-check) | Copyright (c) 2018 Daniel Compton |
|
||
[MIT](https://github.com/danielcompton/ip-range-check/blob/master/LICENSE)
|