LocalCDN-Firefox-Chrome-Brave/README.md

107 lines
6.8 KiB
Markdown
Raw Normal View History

2020-05-21 06:13:42 +02:00
# LocalCDN
2020-06-21 06:52:28 +02:00
2020-08-02 10:38:45 +02:00
[![Translate](https://www.localcdn.org/badges/translation.svg)](https://hosted.weblate.org/projects/localcdn/localcdn/) [![CDNs](https://www.localcdn.org/badges/cdn.svg)](https://codeberg.org/nobody/LocalCDN/src/branch/main/core/mappings.js) [![Frameworks](https://www.localcdn.org/badges/frameworks.svg)](https://codeberg.org/nobody/LocalCDN/src/branch/main/resources/)
2020-06-21 06:52:28 +02:00
2020-07-05 18:47:07 +02:00
A web browser extension (and a fork of Decentraleyes) that emulates Content Delivery Networks to improve your online privacy. It intercepts traffic, finds supported resources locally, and injects them into the environment. All of this happens automatically, so no prior configuration is required. Feel free to use the following [testing utility](https://www.localcdn.org/test/) to find out if you are properly protected. For more information, please read the [tutorial](https://www.localcdn.org/tutorial) or our [Wiki pages](https://codeberg.org/nobody/LocalCDN/wiki). You can also [download](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/) the extension directly from Mozilla and just try it.
2020-02-27 13:45:29 +01:00
2020-07-30 08:48:27 +02:00
## How does it work?
LocalCDN uses redirection for certain requests. There is a [mapping file](https://codeberg.org/nobody/LocalCDN/src/branch/main/core/mappings.js#L71) that lists the source (all CDNs and the path to the frameworks) and a [resource file](https://codeberg.org/nobody/LocalCDN/src/branch/main/core/resources.js#L328) that defines the destination.
Currently only JavaScript and CSS files are redirected. However, some CSS files internally refer to other files, e.g. Font Awesome. All requests are redirected to a local file, e.g. [jQuery](https://codeberg.org/nobody/LocalCDN/src/branch/main/resources/jquery). This is the reason why the extension is currently 10 MB in size. Only if LocalCDN cannot find a local resource (and the option is enabled), a request will be blocked.
2020-09-13 07:54:47 +02:00
An adblocker (e.g. uBlock Origin, uMatrix or AdGuard) decides which requests are allowed. Only if your adblocker allows a request, it will be intercepted by LocalCDN. LocalCDN catches the request after an adblocker and not before.
2020-02-27 13:45:29 +01:00
2020-03-01 10:01:49 +01:00
## Differences between LocalCDN and Decentraleyes
LocalCDN based on Decentraleyes. It includes more frameworks and more CDNs:
2020-06-13 09:46:33 +02:00
* Supports cloud storage by browsers sync feature (Firefox Sync or own Sync-Server) if enabled
* Removed integrity checks of embedded script and style elements (Firefox only)
2020-05-12 06:50:34 +02:00
* Font Awesome
2020-06-21 06:54:52 +02:00
* jQuery up to 3.5.1
2020-03-01 10:01:49 +01:00
* Bootstrap CSS (Delivered by StackPath, NetDNA and MaxCDN)
* Bootstrap JavaScript (Delivered by StackPath, NetDNA and MaxCDN)
* AngularJS, AngularJS-Animate, AngularJS-Sanitize, AngularJS-Cookies and AngularJS-Touch
2020-09-13 07:54:47 +02:00
* Prepared rules for uBlock Origin, uMatrix and AdGuard
2020-03-01 10:01:49 +01:00
2020-02-27 17:48:10 +01:00
> **Note:** LocalCDN is no silver bullet, but it does prevent a lot of websites from making you send these kinds of requests. Ultimately, you can make LocalCDN block requests for any missing CDN resources, too.
2020-02-27 13:45:29 +01:00
2020-05-21 06:13:42 +02:00
2020-05-16 18:18:25 +02:00
## What is the different of LocalCDN in comparison to other CDN emulators?
2020-05-31 20:21:28 +02:00
![The Replacement of Libraries](screenshots/replacement.png?raw=true "The Replacement of Libraries")
2020-05-16 18:18:25 +02:00
2020-05-16 18:56:41 +02:00
**Advantages of LocalCDN:**
2020-08-01 12:01:02 +02:00
:thumbsup: more frameworks/libraries (> 100 :tada: :tada: :tada:)
2020-05-16 18:56:41 +02:00
:thumbsup: smaller size than other extensions
2020-06-04 06:57:56 +02:00
:thumbsup: remove crossorigin and integrity attributes of script and stylesheet tags to increase replacements (Firefox only)
2020-05-16 18:56:41 +02:00
:thumbsup: doesn't matter which version a website requested
2020-06-13 09:46:33 +02:00
:thumbsup: supports cloud storage if enabled
2020-05-21 06:13:42 +02:00
2020-03-01 10:01:49 +01:00
## We need you!
2020-05-31 20:21:28 +02:00
![We Need You!](pages/images/we-need-you.png?raw=true "We Need You!")
2020-03-01 10:01:49 +01:00
The whole Internet is full of different frameworks and CDNs that negatively affect your privacy. If you find a website that embeds another unsupported version of a framework, please report that website.
2020-03-12 10:42:22 +01:00
### :warning: **Important** :warning:
2020-05-21 06:13:42 +02:00
In some cases, it isn't possible to use our framework because the website sets up a strong "Same Origin Policy" (SOP). Please read [Broken JavaScript or CSS on some websites](https://codeberg.org/nobody/LocalCDN/wiki/Broken-JavaScript-or-CSS-on-some-websites) before opening an issue.
2020-03-12 10:42:22 +01:00
2020-03-01 10:01:49 +01:00
On behalf of everyone: Thank you!
2020-05-21 06:13:42 +02:00
2020-03-09 07:10:35 +01:00
## Screenshots
2020-03-14 18:02:08 +01:00
### Light
2020-06-03 17:51:04 +02:00
[<img src="screenshots/screenshot_light.png" alt="Light Theme" width="500"/>](screenshots/screenshot_light.png)
2020-03-14 18:02:08 +01:00
### Dark
2020-06-03 17:51:04 +02:00
[<img src="screenshots/screenshot_dark.png" alt="Dark Theme" width="500"/>](screenshots/screenshot_dark.png)
2020-03-14 18:02:08 +01:00
2020-09-13 07:54:47 +02:00
### Rule generator for uBlock Origin, uMatrix and AdGuard (after an update)
2020-06-03 17:51:04 +02:00
[<img src="screenshots/screenshot_after_update.png" alt="Rule generator after an update" width="500"/>](screenshots/screenshot_after_update.png)
2020-05-21 06:13:42 +02:00
2020-09-13 07:54:47 +02:00
### Rule generator for uBlock Origin, uMatrix and AdGuard (settings page)
2020-06-03 17:51:04 +02:00
[<img src="screenshots/screenshot_settings.png" alt="Rule generator on settings page" width="500"/>](screenshots/screenshot_settings.png)
2020-03-09 07:10:35 +01:00
2020-08-13 08:18:00 +02:00
### Internal statistics
2020-08-13 08:21:54 +02:00
[<img src="screenshots/screenshot_statistics_light.png" alt="Internal statistics" width="200"/>](screenshots/screenshot_statistics_light.png) [<img src="screenshots/screenshot_statistics_dark.png" alt="Internal statistics" width="200"/>](screenshots/screenshot_statistics_dark.png)
2020-08-13 08:18:00 +02:00
2020-02-27 13:45:29 +01:00
## Contributing Code
2020-02-27 17:48:10 +01:00
Suggestions in the form of **Issues**, and contributions in the form of **Merge Requests**, are highly welcome.
2020-02-27 13:45:29 +01:00
2020-05-21 06:13:42 +02:00
## Installation
2020-02-27 13:45:29 +01:00
2020-03-07 07:29:22 +01:00
* Mozilla Firefox *(63 or higher)*: [get it on addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/)
2020-06-08 20:38:49 +02:00
* Chromium based browser: [Chrome Web Store (by Emanuel Bennici)](https://chrome.google.com/webstore/detail/localcdn-fork-from-decent/njdfdhgcmkocbgbhcioffdbicglldapd) :warning: **Please note this Wiki article [FAQ: Chromium incompatibilities](https://codeberg.org/nobody/LocalCDN/wiki/Chromium-incompatibilities)** :warning:
2020-02-27 13:45:29 +01:00
2020-05-21 06:13:42 +02:00
#### Running the Code as temporary extension
2020-02-27 13:45:29 +01:00
2020-07-02 06:03:10 +02:00
Please read this [guide](https://codeberg.org/nobody/LocalCDN/wiki/Running-the-code-as-temporary-extension) to run the extension from source.
2020-02-27 13:45:29 +01:00
2020-02-27 17:48:10 +01:00
> **Important:** All tagged commits are signed with GPG. It's likely best to ignore unsigned commits, unless you really know what you're doing. Please send an email if you have any questions or security concerns.
2020-02-27 13:45:29 +01:00
2020-05-12 06:50:34 +02:00
## Contact
2020-07-05 18:47:07 +02:00
Just open an issue with your question or write an [email](https://www.localcdn.org/contact/) (PGP possible!).
2020-05-12 06:50:34 +02:00
## Submitting Translations
The language you want is not completely translated or you are a language talent? Please help us by translating this add-on on [Weblate](https://hosted.weblate.org/projects/localcdn/).
2020-05-12 06:50:34 +02:00
2020-04-12 06:38:52 +02:00
## Donations
2020-06-05 06:30:55 +02:00
LocalCDN is free and open-source. If you like LocalCDN you can support continued development by making a donation. Any help would be greatly appreciated! Every way to donate can be found inside the extension (Just click on the heart). At the moment donations are possible with SEPA bank transfer, Bitcoin and Ether.
2020-04-12 06:38:52 +02:00
2020-02-27 13:45:29 +01:00
## License
[MPL-2.0](https://www.mozilla.org/MPL/2.0).