umatrix/README.md

44 lines
3.6 KiB
Markdown
Raw Permalink Normal View History

2015-05-08 14:19:12 +02:00
## uMatrix<br>[<img src="https://travis-ci.org/gorhill/uMatrix.svg?branch=master" height="16">](https://travis-ci.org/gorhill/uMatrix)
2015-05-08 14:19:23 +02:00
Definitely for advanced users.
2014-10-17 21:01:09 +02:00
2017-06-15 19:25:38 +02:00
***
Keep Github issues for actual bugs. User support is [/r/uMatrix](https://www.reddit.com/r/uMatrix/).
2015-11-06 04:53:35 +01:00
2014-11-04 15:25:06 +01:00
Forked and refactored from [HTTP Switchboard](https://github.com/gorhill/httpswitchboard).
2015-05-12 17:01:30 +02:00
Install [manually](https://github.com/gorhill/uMatrix/blob/master/doc/README.md) the [latest release](https://github.com/gorhill/uMatrix/releases), or install from:
2015-05-12 17:04:48 +02:00
- [Firefox AMO](https://addons.mozilla.org/firefox/addon/umatrix/)
2018-03-19 12:50:49 +01:00
- To help find issues with ongoing development: [uMatrix dev build in _Releases_](https://github.com/gorhill/uMatrix/releases) (click the latest `uMatrix.webext.signed.xpi` link of the last pre-resease.)
2015-05-12 16:56:16 +02:00
- [Chrome store](https://chrome.google.com/webstore/detail/µmatrix/ogfcmafjalglgifnmanfmnieipoejdcf)
2017-12-03 15:04:40 +01:00
- To help find issues with ongoing development: [uMatrix dev build in Chrome store](https://chrome.google.com/webstore/detail/umatrix-dev-build/eckgcipdkhcfghnmincccnhpdmnbefki)
2015-05-12 16:56:16 +02:00
- [Opera store](https://addons.opera.com/en-gb/extensions/details/umatrix/)
2014-10-20 15:19:48 +02:00
2015-05-12 20:07:15 +02:00
You may contribute with translation work:
- For in-app strings, on Crowdin: [uMatrix on Crowdin](https://crowdin.com/project/umatrix).
- For [description](https://github.com/gorhill/uMatrix/tree/master/doc/description) (to be used in AMO, Chrome store, etc.), submit a pull request. [Reference description is here](https://github.com/gorhill/uMatrix/blob/master/doc/description/description.txt) (feel free to improve as you wish, I am not a writer).
2014-10-28 16:52:27 +01:00
2015-05-08 14:20:48 +02:00
[HTTP Switchboard's documentation](https://github.com/gorhill/httpswitchboard/wiki) is still relevant, except for [uMatrix's differences with HTTP Switchboard](https://github.com/gorhill/uMatrix/wiki/Changes-from-HTTP-Switchboard).
2014-10-17 21:01:09 +02:00
2015-05-08 14:20:48 +02:00
You may contribute with documentation: [uMatrix's wiki](https://github.com/gorhill/uMatrix/wiki).
2014-11-04 15:25:06 +01:00
2014-11-02 14:37:25 +01:00
## Warnings
#### Regarding broken sites
2015-05-12 20:08:19 +02:00
uMatrix does not guarantee that sites will work fine: it is for advanced users who can figure how to un-break sites, because essentially uMatrix is a firewall which works in relaxed block-all/allow-exceptionally mode out of the box: it is not unexpected that sites will break.
2014-11-02 14:37:25 +01:00
2015-05-08 14:20:48 +02:00
**So this means do not file issues to report broken sites when the sites are broken because uMatrix does its job as expected.** I will close any such issue without further comment.
2014-11-02 14:37:25 +01:00
2018-04-18 15:16:30 +02:00
**Using uMatrix logger is key to un-break sites:** the logger will show you all that uMatrix does internally.
2018-04-18 15:15:24 +02:00
2015-05-08 14:20:48 +02:00
I expect there will be community driven efforts for users to help each others. If uMatrix had a home, I would probably set up a forum, but I do not plan for such thing, I really just want to code, not manage web sites. If you need help to un-break a site when using uMatrix, you can try [Wilders Security](http://www.wilderssecurity.com/threads/umatrix-the-http-switchboard-successor.369601/), where you are likely to receive help if needed, whether by me or other users.
2014-11-02 14:37:25 +01:00
2015-05-12 20:09:58 +02:00
uMatrix can be set to work in [allow-all/block-exceptionally](https://github.com/gorhill/httpswitchboard/wiki/How-to-use-HTTP-Switchboard:-Two-opposing-views#the-allow-allblock-exceptionally-approach) mode with a single click on the `all` cell in the global scope `*`, if you prefer to work this way. This will of course break less sites, but you would then lose all the benefits which comes with block-all/allow-exceptionally mode -- though you will still benefit from the 62,000+ blacklisted hostnames by default.
2014-11-02 14:37:25 +01:00
2014-10-17 21:01:09 +02:00
## License
<a href="https://github.com/gorhill/umatrix/blob/master/LICENSE.txt">GPLv3</a>.