-
Notifications
You must be signed in to change notification settings - Fork 5
/
docs.html
114 lines (104 loc) · 5.56 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="robots" content="index, follow">
<link rel="stylesheet" href="css/style.css">
<link rel="icon" type="image/x-icon" href="img/icon.svg">
<link rel="canonical" href="https://libredirect.github.io">
<meta property="og:type" content="website">
<meta property="og:title" content="LibRedirect – Privacy-friendly Redirector">
<meta property="og:site_name" content="libredirect.github.io">
<meta property="og:description"
content="A web extension that redirects YouTube, Twitter, Instagram, etc. requests to alternative privacy-friendly frontends">
<title>Docs</title>
<meta name="referrer" content="same-origin">
<meta http-equiv="Content-Security-Policy"
content=" default-src 'none' base-uri 'self' script-src 'none' form-action 'none' frame-ancestors 'none' ">
</head>
<body>
<div id="body">
<div id="logo"><img src="img/icon.svg" width="160" height="160" alt="LibRedirect icon">
<h1>LibRedirect</h1>
</div>
<div class="nav_bar">
<a href="./index.html">Home</a>
<a href="./download.html">Download</a>
<a href="./source_code.html">Source Code</a>
<a href="./contact.html">Contact</a>
<a href="./faq.html">FAQ</a>
<a href="./docs.html" style="font-weight: bold;">Docs</a>
<a href="./donate.html">Donate</a>
</div>
<h2>Documentation</h2>
<h3 id="Keyboard_Shortcuts"><a href="#Keyboard_Shortcuts">Keyboard shortcuts</a></h3>
<p>LibRedirect offers the following keyboard shortcuts for easier access:</p>
<ul>
<li>
<code>Shift+Alt+L</code> – To switch to a different instance from the one you're currently in.
</li>
<li>
<code>Shift+Alt+C</code> – Copies the original link – e.g. copies the original Twitter link
when you're using <a href="https://github.com/zedeus/nitter">Nitter</a>.
</li>
<li>
<code>Shift+Alt+O</code> – Redirects to the original site from the frontend.
</li>
<li>
<code>Shift+Alt+R</code> – Redirects to the frontend from the original site.
</li>
</ul>
<p>Some shortcuts may or may not work in certain browsers such as Microsoft Edge.</p>
<h3 id="preferred"><a href="#preferred">Preferred instances</a></h3>
<p>To go from the current instance you're using to your preferred or favourite instance, it is explained as follows.
For example, assume someone shares with you a <a href="https://github.com/TeamPiped/Piped">Piped</a> link for the
instance
<a href="https://piped.mha.fi">piped.mha.fi</a>, but you want to use your favourite instance,
<a href="https://piped.video">piped.video</a>, the official instance. It would be a hassle to change the domain
manually,
especially if you've been sent multiple links.
</p>
<p>To avoid that hassle, you can redirect to your favourite instance with just two clicks! Just open the
popup menu and click the reload button near the frontend (in this case, YouTube). Voila! You have reached your
destination.</p>
<p>Below is a small demo of this feature. Please note that switching to your favourite instance by clicking the
reload button
works regardless of whether redirection for that frontend is turned off or on.</p>
<video src="./vids/preferred_instances.webm" type="video/webm" controls></video>
<p><strong>Note:</strong> Some frontends may not have this feature, but the most popular ones do. We
will try to expand this functionality if feasible.</p>
<h3 id="exceptions"><a href="#exceptions">Exceptions</a></h3>
<div><img class="align" src="img/docs/exceptions.webp" alt="Image of Exceptions settings"></div>
<p>Exceptions will exclude certain sites from being redirected.
When you add a site to the exceptions list, it will not redirect as it is excluded from redirection.</p>
<p>This exceptions list is an allowlist, <em>not</em> a blocklist.</p>
<h3 id="instances"><a href="#instances">Cloudflare</a></h3>
<p>You might see some instances marked with <span class="color-c">Cloudflare</span>.</p>
<p>
<span class="color-c">Cloudflare</span> indicates that an instance is using Cloudflare as its CDN.
Cloudflare basically decrypts the data between you and the instance to compress it and send it faster;
in other words, Cloudflare can see your data in plain text, even with HTTPS, so use these instances carefully.
</p>
<h3 id="search_engine_chromium"><a href="#search_engine_chromium">Setting LibRedirect as a search engine in
Chromium</a></h3>
<p>Type in your address bar: <span class="yellow">chrome://settings/searchEngines</span>. Under
<span class="yellow">Site search</span>,
click <span class="yellow">Add</span> and type:
<br>
<strong>Search engine:</strong> LibRedirect<br>
<strong>Shortcut:</strong> libredirect<br>
<strong>URL with %s in place of query:</strong> http://search.libredirect.invalid/?q=%s
</p>
<video src="./vids/chrome_default_seach_engine.webm" type="video/webm" controls></video>
<h3 id="search_engine_firefox_android"><a href="#search_engine_firefox_android">Setting LibRedirect as a search
engine in
Firefox Android</a></h3>
<p>Go to Settings => Search => Default search engine => Add search engine:<br>
<strong>Search engine name:</strong> LibRedirect<br>
<strong>Search string URL:</strong> http://libredirect.github.io/?q=%s
</p>
<br><br><br>
</div>
</body>
</html>