Go to file
Michael Campagnaro 9130a4338b Add an updated build 2023-08-29 14:45:43 -04:00
.github Update FUNDING.yml 2020-08-22 00:26:59 +02:00
.gitlab Grammar 2020-11-27 22:41:35 +00:00
GitLabPages Update test site 2020-02-05 20:24:18 +01:00
_locales Poeditor 2021-03-24 11:40:18 +00:00
build Add an updated build 2023-08-29 14:45:43 -04:00
build_tools Added yandex link fixer + renewed copyright notice 2020-01-06 17:14:34 +01:00
core_js Use new git.michael.is url 2023-08-29 14:22:26 -04:00
css Prevent CJK text from breaking in switch label in the popup 2020-11-25 14:26:57 -08:00
data Update the rules 2023-08-29 14:22:26 -04:00
external_js Removed even more jQuery dependencies 2020-06-06 00:02:03 +02:00
fonts Version 1.1.2.5 2017-11-18 01:34:01 +01:00
html Version 1.21.0 2021-03-24 12:55:46 +01:00
img Version 1.21.0 2021-03-24 12:55:46 +01:00
promotion Version 1.17.0 2020-04-15 00:53:01 +02:00
.gitignore Move data files into this repo 2023-02-15 16:14:09 -05:00
.gitlab-ci.yml Update .gitlab-ci.yml 2020-11-21 00:43:31 +01:00
CHANGELOG.md Version 1.21.0 2021-03-24 12:55:46 +01:00
LICENSE Change of LICENSE to GNU LGPLv3. This change is granted by the old license (QaPL v0.2 sec. [4]) without the permission of the contributors. 2019-03-13 11:58:04 +00:00
PRIVACY.md Update PRIVACY.md 2021-01-07 22:02:22 +00:00
README.md Add an updated build 2023-08-29 14:45:43 -04:00
browser-polyfill.js remove sourcemap ref from browser-polyfill.js 2019-07-05 12:16:29 +00:00
clearurls.js Updated referralMarketing pattern to match rule pattern 2021-01-13 16:32:57 +01:00
manifest.json Add an updated build 2023-08-29 14:45:43 -04:00
package-lock.json Add an updated build 2023-08-29 14:45:43 -04:00

README.md

This is a fork of ClearURLs/Addon with some modifications. The main change is moving the data/rule files to this repo instead of loading them from a gitlab page that the original author hosts. This removes the risk of a bad actor gaining control over that URL and making changes that lead to arbitrary code execution or redirecting your browser to arbitrary URLs.

Install

Firefox

  • I have a signed xpi that you can immediately install. Open build/ and drag the xpi into Firefox. It may take a few seconds for the browser to display the extension installation dialog box.
  • You can also find the signed Firefox files in the project's Releases page.

Chrome

  • Go to Chrome extensions page.
  • Toggle the developer mode (top-right of page).
  • Click Load unpacked.
  • Select this project's root folder.

Development

Local Testing

  • Firefox: open about:debugging and click Load Temporary Add-on... then select manifest.json file.
  • Chrome: follow the install steps from above.

Signing and Building

Firefox

  • Install web-ext with $ npm install --global web-ext
  • Generate an unlisted xpi with: web-ext sign --api-key <your JWT issuer> --api-secret <your JWT secret>
  • The signed xpi will be in web-ext-artifacts/. Drag this into Firefox to install it.
  • Alternatively use the private sign-firefox-extension.sh script (not included in the repo) which places the xpi in build/.

ClearURLs is an add-on based on the new WebExtensions technology and is optimized for Firefox and Chrome based browsers.

This extension will automatically remove tracking elements from URLs to help protect your privacy when browse through the Internet, which is regularly updated by us and can be found here.

Application

Many websites use tracking elements in the URL (e.g. https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale) to mark your online activity. All that tracking code is not necessary for a website to be displayed or work correctly and can therefore be removed—that is exactly what ClearURLs does.

Another common example are Amazon URLs. If you search for a product on Amazon you will see a very long URL, such as:

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

Indeed most of the above URL is tracking code. Once ClearURLs has cleaned the address, it will look like this: https://www.amazon.com/dp/exampleProduct

Features

  • Removes tracking from URLs automatically in the background
  • Blocks some common ad domains (optional)
  • Has a built-in tool to clean up multiple URLs at once
  • Supports redirection to the destination, without tracking services as middleman
  • Adds an entry to the context menu so that links can be copied quickly and cleanly
  • Blocks hyperlink auditing, also known as ping tracking (see also this article)
  • Prevents ETag tracking
  • Prevents tracking injection over history API (see also: The replaceState() method)
  • Prevents Google from rewriting the search results (to include tracking elements)
  • Prevents Yandex from rewriting the search results (to include tracking elements)

Permissons

Reasoning for needed permissions can be found under here.

We use some third-party scripts in our add-on. The authors and licenses are listed below.