-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*.xpi |
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
Decentraleyes | ||
============= | ||
|
||
A [Firefox add-on](https://addons.mozilla.org/en-US/firefox/addon/decentraleyes) that emulates Content Delivery Networks locally by intercepting requests, finding the required resource and injecting it into the environment. This all happens instantaneously, automatically, and no prior configuration is required. | ||
|
||
> **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. | ||
## Roadmap | ||
|
||
Now that there's a solid, Mozilla approved, foundation, it's time to move forward. Mobility, extensibility (through support for community-powered resource packages), and usability, will be the main points of attention during this phase. | ||
|
||
#### Planned Features | ||
|
||
* Advanced policy management for users who block requests for missing resources. | ||
* Smarter resource version interpretation for handling dynamic notations. | ||
* A minimalistic and non-essential graphical user interface. | ||
* Support for custom, importable, library repositories. | ||
|
||
> **Note:** These long-term goals are subjective to change, and can be discussed. That is, as long as the suggestions do not conflict with the ultimate goal of realizing a free and open standard for exchanging web resource bundles. | ||
## Contributing | ||
|
||
Suggestions in the form of **Issues** and contributions in the form of **Pull Requests** are highly welcome. You can also use the contact details and PGP key on the add-on [download page](https://addons.mozilla.org/en-US/firefox/addon/decentraleyes) to get in touch. | ||
|
||
#### Prerequisites | ||
|
||
* Jetpack Manager [jpm](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm#Installation) (a Node-based replacement for cfx). | ||
* Firefox version 38 or later. *If you need to work with earlier versions of Firefox, you'll need to use the old cfx tool. See instructions for [getting started with cfx](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started). | ||
|
||
#### Build Instructions (Unix) | ||
|
||
git clone https://github.com/Synzvato/decentraleyes | ||
cd decentraleyes | ||
jpm xpi | ||
|
||
## License | ||
|
||
[MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
INTRODUCTION | ||
------------ | ||
|
||
This script (first introduced in Decentraleyes v1.1.5) should make reviewing this extension a lot easier than it used to be. It's open source and open for scrutiny, and it automatically compares the bundled libraries (resources) to their original sources (after removing any source mapping URLs). | ||
|
||
|
||
FOR NON-LINUX USERS | ||
------------------- | ||
|
||
This usage guide is tailored to Linux based operating systems. If you're on a different type of system, the easiest direct solution might be to launch a free Linux box with Node.js pre-installed on Red Hat OpenShift. You can then SSH into it (after adding your own machine's public key to your account). | ||
|
||
Having said that, every terminal command in the usage guide below comes with a description, so it should not be too hard to get this done on practically any type of configuration. | ||
|
||
|
||
USAGE INSTRUCTIONS | ||
------------------ | ||
|
||
1. Make sure you have Node.js installed on your machine (or install it). | ||
|
||
2. Open up a terminal and 'cd' into this directory. | ||
Description: Navigate to this directory. | ||
|
||
3. Execute 'rm -r ./node_modules; npm install' to ensure dependency integrity. | ||
Description: Remove the node modules folder and reinstall dependencies using npm. | ||
|
||
Note: If this fails, compare dependency file hashes and leave the folder in place. | ||
|
||
4. Run the audit script by executing 'node run'. | ||
Description: Run the script through Node.js and view the output. | ||
|
||
Note: If you'd like to store the report, run 'node run > report.txt'. | ||
Note description: It's possible to write the console output to a file. | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.