Microsoft has acquired GitHub. Decentraleyes has left GitHub. Welcome to its new home!

To participate, please register, or sign in with an existing GitLab.com, Bitbucket, or GitHub account.

Past contributions on GitHub? Be sure to reclaim your Comments, Issues, and Pull Requests.

README.md 2.04 KB
Newer Older
Thomas Rientjes's avatar
Thomas Rientjes committed
1 2 3
Decentraleyes
=============

Thomas Rientjes's avatar
Thomas Rientjes committed
4
A [web browser extension](https://decentraleyes.org) 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://decentraleyes.org/test/) to find out if you are properly protected. For more information, please read this [basic introduction](https://git.synz.io/Synzvato/decentraleyes/wikis/Simple-Introduction).
Thomas Rientjes's avatar
Thomas Rientjes committed
5 6 7

> **Note:** Decentraleyes is no silver bullet, but it does prevent a lot of websites from making you send these kinds of requests. Ultimately, you can make Decentraleyes block requests for any missing CDN resources, too.

8 9
## Contributing Code

Thomas Rientjes's avatar
Thomas Rientjes committed
10
Suggestions in the form of **Issues**, and contributions in the form of **Merge Requests**, are highly welcome. Code **Forks** can be requested from within issues, or via email. You can use the contact details and public PGP key on the extension's [contact page](https://decentraleyes.org/contact/) to get in touch.
Thomas Rientjes's avatar
Thomas Rientjes committed
11

12
#### Prerequisites
Thomas Rientjes's avatar
Thomas Rientjes committed
13

14
* Mozilla Firefox 56 *(or higher)*.
Thomas Rientjes's avatar
Thomas Rientjes committed
15

16
> **Note:** If you want to contribute to the Firefox legacy extension, please check out the ```legacy``` branch. If you are looking for the Chromium-compatible codebase, please see the ```experimental``` branch.
Thomas Rientjes's avatar
Thomas Rientjes committed
17

18
#### Running the Code
Thomas Rientjes's avatar
Thomas Rientjes committed
19

Thomas Rientjes's avatar
Thomas Rientjes committed
20
Please read this [developer guide](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out) for information on how to run the extension from source.
Thomas Rientjes's avatar
Thomas Rientjes committed
21

Thomas Rientjes's avatar
Thomas Rientjes committed
22
> **Important:** All tagged commits since 26 October 2016 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.
Thomas Rientjes's avatar
Thomas Rientjes committed
23

Thomas Rientjes's avatar
Thomas Rientjes committed
24 25 26 27
## Submitting Translations

Do you master a non-supported language? Please help out by translating this add-on on [Crowdin](https://crowdin.com/project/decentraleyes).

Thomas Rientjes's avatar
Thomas Rientjes committed
28 29
## License

Thomas Rientjes's avatar
Thomas Rientjes committed
30
[MPL-2.0](https://www.mozilla.org/MPL/2.0).