Commit 4366f17e authored by Booteille's avatar Booteille

Add README.md

parent 1fd5845e
# Invidition - YouTube to Invidious Redirection
## Introduction
Invidition is a small extension allowing you to redirect YouTube requests to Invidious before loading them.
Invidition has for purpose to make 0 call to YouTube. If you see any call to YouTube/Google servers being made, feel free to fill an issue.
## Downloads
### Firefox
You can download it for Firefox here: https://addons.mozilla.org/firefox/addon/invidition
### Others
I have no Google account. I don't plan to host it on Chrome. Sources are open and the license is permissive (Public Domain Dedication) so feel free to host it on Chrome Store if you want.
## Compatibility with uMatrix and NoScript
Invidition is compatible with any other extension, but you will need to configure extensions using WebRequest API, like uMatrix and NoScript.
The reason is because these addons tend to block requests before Invidition. In such cases, Invidition never knows it has a request to redirect.
I'll investigate if there is a way to give priority to Invidition over uMatrix and NoScript.
Rulesets and recipes provided are set for invidio.us. If you want to use Invidition for another instance, please, download and update files accordingly.
### uMatrix Ruleset and Recipe
#### Rules
You can import [this ruleset](https://gitlab.com/Booteille/invidition/raw/master/umatrix/rules.txt) if you want to allow Invidition to automatically work without any action from your part.
To import a ruleset, you have to open uMatrix settings then:
* Click on *My Rules* tab.
* Click on *Import from a file* and select the rules you downloaded on your computer.
* Click on *Apply*.
#### Recipe
You can use [the recipe](https://gitlab.com/Booteille/invidition/raw/master/umatrix/recipe.txt) if you want to be able to allow Invidition to work in one click.
To import the recipe, open uMatrix settings then:
* Click on *Resources*.
* Under *Rulessets Recipes", click on *Import*.
* In the text area, grab this URL: `https://gitlab.com/Booteille/invidition/raw/master/umatrix/recipe.txt`.
* Click on *Apply*.
### NoScript
Since NoScript version 10, ABE is not supported and I didn't find a way to create an easy to install rulesets. (I never used NoScript, so maybe I am missing something. If you know how to do it, please, fill an issue.)
So, you'll have to manually authorize those domains:
* `youtube.com` - SCRIPT, FRAME
* `s.ytimg.com` - SCRIPT
* `invidio.us` - SCRIPT, FRAME, XHR, MEDIA
### Why does I need to allow scripts and frames?
`youtube.com` and `s.ytimg.com` scripts are mandatory because of the YouTube iFrame API.
Some websites (like joinmastodon.org) use this API to generate the iFrame.
So, the browser needs first to load a script called `iframe_api` on `youtube.com` and then load a script called `www-widgetapi.js` on `s.ytimg.com`.
To bypass this need, those two files have been integrated in the extension, so you never have to call youtube to generate the iFrame.
The reason why you need to allow frames is the same explained above: Invidition can't read the iFrame URL if you block it.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment