aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel รngel Moreno <mail@migalmoreno.com>2024-04-07 14:25:08 +0200
committerMiguel รngel Moreno <mail@migalmoreno.com>2024-04-07 14:25:08 +0200
commitca16a379b0563029ef7a8e4414c62dacb4e9274b (patch)
tree40cf98d1b3ac63b6aebce1da6d5b7ee7492f86ce
parent800652c653684947e7394934bb06355ff07aac4b (diff)
doc: update README
-rw-r--r--.github/README.md83
-rw-r--r--README80
-rw-r--r--README.md83
3 files changed, 243 insertions, 3 deletions
diff --git a/.github/README.md b/.github/README.md
index 29d659b..6c9444a 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -78,10 +78,16 @@ To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.
<td class="org-left"><a href="https://tubo.migalmoreno.com">https://tubo.migalmoreno.com</a> (Official)</td>
<td class="org-left">๐Ÿ‡ช๐Ÿ‡ธ</td>
</tr>
+
+
+<tr>
+<td class="org-left"><a href="https://tubo.reallyaweso.me">https://tubo.reallyaweso.me</a></td>
+<td class="org-left">๐Ÿ‡ฉ๐Ÿ‡ช</td>
+</tr>
</tbody>
</table>
-If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#org190dbd6). See [installation](#orgc634111) for ways to set up Tubo in your server.
+If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#org3459bb2). See [installation](#org3fdd525) for ways to set up Tubo in your server.
## Installation
@@ -154,6 +160,81 @@ If you want to self-host Tubo and make it publicly accessible you'll need to set
}
+## Browser Extension Support
+
+
+### [Redirector](https://github.com/einaregilsson/Redirector)
+
+You can manually add any redirect rule based on regex patterns with this extension. Below are some sample configurations to redirect links from supported services to Tubo so you can get a basic idea of how to write manual Redirector rules. Note the `serviceId` of each service is: YouTube (0), SoundCloud(1), media.ccc.de(2), PeerTube(3), and Bandcamp(4). Replace <https://tubo.migalmoreno.com/> in the redirect rule to the instance of your choice.
+
+ Description: YouTube video to Tubo stream
+ Example URL: https://www.youtube.com/watch?v=YE7VzlLtp-4
+ Include pattern: ^((?:https?://)(?:www.)?youtube.com/(watch\?v.*|shorts/.*))
+ Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/stream?url=https://www.youtube.com/watch?v=YE7VzlLtp-4
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: SoundCloud stream to Tubo stream
+ Example URL: https://soundcloud.com/unfa/stop-the-panic
+ Include pattern: ^((?:https?://)(?:www.)?soundcloud.com/.*/.*)
+ Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/stream?url=https://soundcloud.com/unfa/stop-the-panic
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: Bandcamp album to Tubo playlist
+ Example URL: https://unfa.bandcamp.com/album/suppressed
+ Include pattern: ^((?:https?://)(.*\.)?bandcamp.com/album/.*)
+ Redirect to: https://tubo.migalmoreno.com/playlist?url=$1
+ Example result: https://tubo.migalmoreno.com/playlist?url=https://unfa.bandcamp.com/album/suppressed
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: PeerTube (Framatube) channel to Tubo channel
+ Example URL: https://framatube.org/accounts/framasoft@framatube.org
+ Include pattern: ^((?:https?://)(?:www.)?framatube.org/accounts/.*)
+ Redirect to: https://tubo.migalmoreno.com/channel?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/channel?url=https://framatube.org/accounts/framasoft@framatube.org
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: media.ccc.de search query to Tubo search query
+ Example URL: https://media.ccc.de/search/?q=37c3
+ Include pattern: ^(?:https?://)media.ccc.de/search/\?q=(.*)
+ Redirect to: https://tubo.migalmoreno.com/search?query=$1&serviceId=2
+ Example result: https://tubo.migalmoreno.com/search?query=37c3&serviceId=2
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+
+### [LibRedirect](https://github.com/libredirect/browser_extension)
+
+Redirects many popular services to their alternative front-ends. Has a ton of features and an active community. Tubo is supported by default for YouTube and SoundCloud, so no need to do anything for these. The rest of services are pending as per [#884](https://github.com/libredirect/browser_extension/issues/884).
+
+
+### [Privacy Redirector](https://github.com/dybdeskarphet/privacy-redirector)
+
+A userscript that redirects popular social media platforms to their privacy respecting front-ends.
+
+
+### [nx-router](https://github.com/migalmoreno/nx-router)
+
+Similar to Redirector but for the [Nyxt](https://nyxt.atlas.engineer/) browser, you can manually add any redirect rule based on regex patterns with this extension, which allows you to define all redirection rules in a single "router". A sample configuration for YouTube would look like this:
+
+ (make-instance 'router:redirector
+ :name 'youtube-to-tubo
+ :route (match-domain "youtube.com")
+ :redirect
+ '(("https://tubo.migalmoreno.com/stream?url=\\&" . (".*/watch\\?v.*" ".*/shorts/.*"))
+ ("https://tubo.migalmoreno.com/playlist?list=\\&" . ".*/playlist/.*")
+ ("https://tubo.migalmoreno.com/channel?url=\\&" . ".*/channel/.*")
+ ("https://tubo.migalmoreno.com/search?q=\\1&serviceId=0" . ".*/search\\?q=(.*)")))
+
+
## Contributing
Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too.
diff --git a/README b/README
index 7d08a5f..9691446 100644
--- a/README
+++ b/README
@@ -22,7 +22,8 @@ To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/Ne
** Instances
| URL | Country |
|-----------------------------------------+---------|
-| https://tubo.migalmoreno.com (Official) | ๐Ÿ‡ช๐Ÿ‡ธ |
+| https://tubo.migalmoreno.com (Official) | ๐Ÿ‡ช๐Ÿ‡ธ |
+| [[https://tubo.reallyaweso.me][https://tubo.reallyaweso.me]] | ๐Ÿ‡ฉ๐Ÿ‡ช |
If you consider self-hosting Tubo let me know about your instance via the [[*Contributing][contribution methods]]. See [[*Installation][installation]] for ways to set up Tubo in your server.
@@ -105,5 +106,82 @@ server {
}
#+end_src
+** Browser Extension Support
+*** [[https://github.com/einaregilsson/Redirector][Redirector]]
+You can manually add any redirect rule based on regex patterns with this extension. Below are some sample configurations to redirect links from supported services to Tubo so you can get a basic idea of how to write manual Redirector rules. Note the =serviceId= of each service is: YouTube (0), SoundCloud(1), media.ccc.de(2), PeerTube(3), and Bandcamp(4). Replace https://tubo.migalmoreno.com/ in the redirect rule to the instance of your choice.
+
+#+begin_src
+Description: YouTube video to Tubo stream
+Example URL: https://www.youtube.com/watch?v=YE7VzlLtp-4
+Include pattern: ^((?:https?://)(?:www.)?youtube.com/(watch\?v.*|shorts/.*))
+Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+Example result:
+https://tubo.migalmoreno.com/stream?url=https://www.youtube.com/watch?v=YE7VzlLtp-4
+Pattern type: Regular Expression
+Apply to: Main window (address bar)
+#+end_src
+
+#+begin_src
+Description: SoundCloud stream to Tubo stream
+Example URL: https://soundcloud.com/unfa/stop-the-panic
+Include pattern: ^((?:https?://)(?:www.)?soundcloud.com/.*/.*)
+Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+Example result:
+https://tubo.migalmoreno.com/stream?url=https://soundcloud.com/unfa/stop-the-panic
+Pattern type: Regular Expression
+Apply to: Main window (address bar)
+#+end_src
+
+#+begin_src
+Description: Bandcamp album to Tubo playlist
+Example URL: https://unfa.bandcamp.com/album/suppressed
+Include pattern: ^((?:https?://)(.*\.)?bandcamp.com/album/.*)
+Redirect to: https://tubo.migalmoreno.com/playlist?url=$1
+Example result: https://tubo.migalmoreno.com/playlist?url=https://unfa.bandcamp.com/album/suppressed
+Pattern type: Regular Expression
+Apply to: Main window (address bar)
+#+end_src
+
+#+begin_src
+Description: PeerTube (Framatube) channel to Tubo channel
+Example URL: https://framatube.org/accounts/framasoft@framatube.org
+Include pattern: ^((?:https?://)(?:www.)?framatube.org/accounts/.*)
+Redirect to: https://tubo.migalmoreno.com/channel?url=$1
+Example result:
+https://tubo.migalmoreno.com/channel?url=https://framatube.org/accounts/framasoft@framatube.org
+Pattern type: Regular Expression
+Apply to: Main window (address bar)
+#+end_src
+
+#+begin_src
+Description: media.ccc.de search query to Tubo search query
+Example URL: https://media.ccc.de/search/?q=37c3
+Include pattern: ^(?:https?://)media.ccc.de/search/\?q=(.*)
+Redirect to: https://tubo.migalmoreno.com/search?query=$1&serviceId=2
+Example result: https://tubo.migalmoreno.com/search?query=37c3&serviceId=2
+Pattern type: Regular Expression
+Apply to: Main window (address bar)
+#+end_src
+
+*** [[https://github.com/libredirect/browser_extension][LibRedirect]]
+Redirects many popular services to their alternative front-ends. Has a ton of features and an active community. Tubo is supported by default for YouTube and SoundCloud, so no need to do anything for these. The rest of services are pending as per [[https://github.com/libredirect/browser_extension/issues/884][#884]].
+
+*** [[https://github.com/dybdeskarphet/privacy-redirector][Privacy Redirector]]
+A userscript that redirects popular social media platforms to their privacy respecting front-ends.
+
+*** [[https://github.com/migalmoreno/nx-router][nx-router]]
+Similar to Redirector but for the [[https://nyxt.atlas.engineer/][Nyxt]] browser, you can manually add any redirect rule based on regex patterns with this extension, which allows you to define all redirection rules in a single "router". A sample configuration for YouTube would look like this:
+
+#+begin_src lisp
+(make-instance 'router:redirector
+ :name 'youtube-to-tubo
+ :route (match-domain "youtube.com")
+ :redirect
+ '(("https://tubo.migalmoreno.com/stream?url=\\&" . (".*/watch\\?v.*" ".*/shorts/.*"))
+ ("https://tubo.migalmoreno.com/playlist?list=\\&" . ".*/playlist/.*")
+ ("https://tubo.migalmoreno.com/channel?url=\\&" . ".*/channel/.*")
+ ("https://tubo.migalmoreno.com/search?q=\\1&serviceId=0" . ".*/search\\?q=(.*)")))
+#+end_src
+
** Contributing
Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too.
diff --git a/README.md b/README.md
index e50364f..492b780 100644
--- a/README.md
+++ b/README.md
@@ -78,10 +78,16 @@ To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.
<td class="org-left"><a href="https://tubo.migalmoreno.com">https://tubo.migalmoreno.com</a> (Official)</td>
<td class="org-left">๐Ÿ‡ช๐Ÿ‡ธ</td>
</tr>
+
+
+<tr>
+<td class="org-left"><a href="https://tubo.reallyaweso.me">https://tubo.reallyaweso.me</a></td>
+<td class="org-left">๐Ÿ‡ฉ๐Ÿ‡ช</td>
+</tr>
</tbody>
</table>
-If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#orgb0aedc4). See [installation](#org284835d) for ways to set up Tubo in your server.
+If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#org38cb33b). See [installation](#org5b92d7b) for ways to set up Tubo in your server.
## Installation
@@ -154,6 +160,81 @@ If you want to self-host Tubo and make it publicly accessible you'll need to set
}
+## Browser Extension Support
+
+
+### [Redirector](https://github.com/einaregilsson/Redirector)
+
+You can manually add any redirect rule based on regex patterns with this extension. Below are some sample configurations to redirect links from supported services to Tubo so you can get a basic idea of how to write manual Redirector rules. Note the `serviceId` of each service is: YouTube (0), SoundCloud(1), media.ccc.de(2), PeerTube(3), and Bandcamp(4). Replace <https://tubo.migalmoreno.com/> in the redirect rule to the instance of your choice.
+
+ Description: YouTube video to Tubo stream
+ Example URL: https://www.youtube.com/watch?v=YE7VzlLtp-4
+ Include pattern: ^((?:https?://)(?:www.)?youtube.com/(watch\?v.*|shorts/.*))
+ Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/stream?url=https://www.youtube.com/watch?v=YE7VzlLtp-4
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: SoundCloud stream to Tubo stream
+ Example URL: https://soundcloud.com/unfa/stop-the-panic
+ Include pattern: ^((?:https?://)(?:www.)?soundcloud.com/.*/.*)
+ Redirect to: https://tubo.migalmoreno.com/stream?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/stream?url=https://soundcloud.com/unfa/stop-the-panic
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: Bandcamp album to Tubo playlist
+ Example URL: https://unfa.bandcamp.com/album/suppressed
+ Include pattern: ^((?:https?://)(.*\.)?bandcamp.com/album/.*)
+ Redirect to: https://tubo.migalmoreno.com/playlist?url=$1
+ Example result: https://tubo.migalmoreno.com/playlist?url=https://unfa.bandcamp.com/album/suppressed
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: PeerTube (Framatube) channel to Tubo channel
+ Example URL: https://framatube.org/accounts/framasoft@framatube.org
+ Include pattern: ^((?:https?://)(?:www.)?framatube.org/accounts/.*)
+ Redirect to: https://tubo.migalmoreno.com/channel?url=$1
+ Example result:
+ https://tubo.migalmoreno.com/channel?url=https://framatube.org/accounts/framasoft@framatube.org
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+ Description: media.ccc.de search query to Tubo search query
+ Example URL: https://media.ccc.de/search/?q=37c3
+ Include pattern: ^(?:https?://)media.ccc.de/search/\?q=(.*)
+ Redirect to: https://tubo.migalmoreno.com/search?query=$1&serviceId=2
+ Example result: https://tubo.migalmoreno.com/search?query=37c3&serviceId=2
+ Pattern type: Regular Expression
+ Apply to: Main window (address bar)
+
+
+### [LibRedirect](https://github.com/libredirect/browser_extension)
+
+Redirects many popular services to their alternative front-ends. Has a ton of features and an active community. Tubo is supported by default for YouTube and SoundCloud, so no need to do anything for these. The rest of services are pending as per [#884](https://github.com/libredirect/browser_extension/issues/884).
+
+
+### [Privacy Redirector](https://github.com/dybdeskarphet/privacy-redirector)
+
+A userscript that redirects popular social media platforms to their privacy respecting front-ends.
+
+
+### [nx-router](https://github.com/migalmoreno/nx-router)
+
+Similar to Redirector but for the [Nyxt](https://nyxt.atlas.engineer/) browser, you can manually add any redirect rule based on regex patterns with this extension, which allows you to define all redirection rules in a single "router". A sample configuration for YouTube would look like this:
+
+ (make-instance 'router:redirector
+ :name 'youtube-to-tubo
+ :route (match-domain "youtube.com")
+ :redirect
+ '(("https://tubo.migalmoreno.com/stream?url=\\&" . (".*/watch\\?v.*" ".*/shorts/.*"))
+ ("https://tubo.migalmoreno.com/playlist?list=\\&" . ".*/playlist/.*")
+ ("https://tubo.migalmoreno.com/channel?url=\\&" . ".*/channel/.*")
+ ("https://tubo.migalmoreno.com/search?q=\\1&serviceId=0" . ".*/search\\?q=(.*)")))
+
+
## Contributing
Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too.