iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2024-11-23 05:49:42 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Updated Redirector Setup for clarity and consistency. (#362)

Browse Source 
* Updated Redirector Setup for clarity and consistency.

Updated with clearer language and more consistent formatting.

* Correct a rule description

---------

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com>
This commit is contained in:
MintMain21 2023-04-04 07:54:48 -07:00 committed by GitHub
parent da5af47a87
commit 59ed79b67d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/redirector-setup.md
View File

@ -4,11 +4,13 @@ Redirector is a Browser extension for Firefox and Chromium that can manually be
Get Redirector: [Firefox](https://addons.mozilla.org/en-US/firefox/addon/redirector/) — [Chromium-based](https://chrome.google.com/webstore/detail/redirector/ocgpenflpmgnfapjedencafcfakcekcd) — [GitHub](https://github.com/einaregilsson/Redirector)
All of these rules are made with Wildcard Processing.
# How to use it for Invidious Redirects?
For basic redirects, you will need the following rules set up.
# Rule 1
# Rule 1 (Redirect Video URLs)
Redirects Youtube Videos to Invidious
Redirect: https://*.youtube.com/watch?*v=*
@ -17,13 +19,13 @@ Hint: Redirects individual videos to their Invidious equivelant
Example: https://www.youtube.com/watch?v=Lz13cxZNTCo → https://[Invidious Domain Here]/watch?v=Lz13cxZNTCo
Applies to: Main window (address bar)
# Rule 2 (Note, Rule 2 is for redirecting the youtu.be domain, typically accociated with embeds)
# Rule 2 (Redirects the youtu.be domain, typically accociated with URLs generated by the "Share" button)
Redirect: https://youtu.be/*
to: https://[Invidious Domain Here]/watch?v=$1
Example: https://youtu.be/Ae5yV4p7uh8?t=35 → https://[Invidious Domain Here]/watch?v=Ae5yV4p7uh8?t=35
# Rule 3 (Note, Rule 3 is for those who use DDG bangs or search extensions to search YouTube and would like those properly redirected to Invidious)
# Rule 3 (Redirects Search Results, useful for those who use DDG bangs or search extensions to search YouTube and would like those properly redirected to Invidious)
Redirect YouTube Search to Invidious
Redirect: https://www.youtube.com/results?search_query=*&page
@ -32,7 +34,7 @@ Example: https://www.youtube.com/results?search_query=Smash+Bros+Trailer&page
Applies to: Main window (address bar)
# Rule 4
# Rule 4 (Redirects the YouTube Domain itself, IE: channel pages and the homepage)
Redirects Youtube to Invidous
Redirect: https://*.youtube.com/*
@ -40,6 +42,7 @@ to: https://[Invidious Domain Here]/$2
Example: https://www.youtube.com/channel/UCOkL7q2SeGZeZuj22njMYEA → https://[Invidious Domain Here]/channel/UCOkL7q2SeGZeZuj22njMYEA
Applies to: Main window (address bar)
# How to use it for Invidious URL Parameters?
If you would like to use URL Parameters in your redirects (see https://github.com/cloudrac3r/invidious-documentation/blob/master/List-of-URL-parameters.md), you will need to manually add them to Rule 1, (https://[Invidious Domain Here]/watch?v=$1[URL Parameters here] in place of https://[Invidious Domain Here]/watch?v=$1.
@ -47,7 +50,7 @@ For clarity, an example of a URL parameter would be &related_videos=false&commen
Should you choose to use URL Parameters, I would reccomend adding the following rule to both ensure all invidious videos load with your preference, and to ensure that unnecesary parameters are not added when already applied.
# Rule 5
# Rule 5 (Redirects Invidious Video URLs with parameters)
Redirects Invidious Videos with URL Parameters
Redirect: https://[Invidious Domain Here]/watch?v=*
@ -59,9 +62,11 @@ Applies to: Main window (address bar)
It is important that you add the exception so as not to create infinite repeats of the same URL Parameters when opening multiple Invidious Videos in a single session. When creating or editing rules in Redirector you must access "Advanced Options" in order to set exceptions.
For redirecting embeds, you'll need the following two rules.
# How to use it for Redirecting Embeds?
# Rule 6
For redirecting embeds, you'll need the following two rules. (Note, it is imparative that you check these two roles apply to both the Main Window and IFrames, otherwise the rule won't apply to Embeds).
# Rule 6 (For redirecting standard embed links)
Redirects Embedded Youtube Videos to Invidious
Redirect: https://www.youtube.com/embed/*
@ -70,7 +75,7 @@ Hint: Redirects individual videos to their Invidious equivelant
Example: https://www.youtube.com/embed/Lz13cxZNTCo → https://[Invidious Domain Here]/embed/Lz13cxZNTCo
Applies to: Main window (address bar), IFrames
# Rule 7
# Rule 7 (For redirecting nocookie embeds)
Redirects Embedded Youtube Videos to Invidious
Redirect: https://www.youtube-nocookie.com/embed/*
@ -79,12 +84,13 @@ Hint: Redirects individual videos to their Invidious equivelant
Example: https://www.youtube-nocookie.com/embed/Lz13cxZNTCo → https://[Invidious Domain Here]/embed/Lz13cxZNTCo
Applies to: Main window (address bar), IFrames
(Note, it is imparative that you check it applies to both the Main Window and IFrames, otherwise the rule won't applied to Embeds).
Finally, if you like to subscribe to channels using RSS feeds, you made add the following two rules to redirect Invidious RSS feeds to their YouTube equivelants. This way you'll still have access to your feeds should you need to migrate to another instance.
# How to use it to redirect Invidious Feeds to YouTube Feeds?
# Rule 8
Finally, if you like to subscribe to channels using RSS feeds, the following two rules will redirect Invidious RSS feeds to their YouTube equivelants. This way you'll still have access to your feeds should you need to migrate to another instance.
# Rule 8 (For redirecting channel feeds)
Redirect Invidious Feeds to YouTube Feeds
Redirect: https://[Invidious Domain Here]/feed/channel/*
@ -93,7 +99,7 @@ Hint: And now you can subscribe in peace.
Example: https://[Invidious Domain Here]/feed/channel/UCOkL7q2SeGZeZuj22njMYEA → https://www.youtube.com/feeds/videos.xml?channel_id=UCOkL7q2SeGZeZuj22njMYEA
Applies to: Main window (address bar)
#Rule 9
# Rule 9 (For redirecting playlist feeds)
Redirect Playlist RSS from Invidious to YouTube
Redirect: https://[Invidious Domain Here]/feed/playlist/*
@ -101,5 +107,5 @@ to: https://www.youtube.com/feeds/videos.xml?playlist_id=$1
Example: https://[Invidious Domain Here]/feed/playlist/PLY_6uAtgkYXl1sPyzNa2UFQYgPj2qA-qj → https://www.youtube.com/feeds/videos.xml?playlist_id=PLY_6uAtgkYXl1sPyzNa2UFQYgPj2qA-qj
Applies to: Main window (address bar)
All of these rules are made with Wildcard Processing.