# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; after-save-hook: (lambda nil (org-export-to-file 'md (org-export-output-file-name ".md")) (org-export-to-file 'md (org-export-output-file-name ".md" nil ".github/"))); -*-
#+OPTIONS: toc:nil num:nil
* Tubo
Tubo is a streaming front-end focused on bringing the [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] experience to the web. It aims at providing a clean and simple user interface to consume media from your favorite streaming platforms. It currently supports the same services as NewPipe, including YouTube, SoundCloud, Bandcamp, and more.
To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library and it exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
** Screenshots
| https://files.migalmoreno.com/tubo_kiosk_light.jpg | https://files.migalmoreno.com/tubo_channel_light.jpg | [[https://files.migalmoreno.com/tubo_stream_playing_light.jpg]] | https://files.migalmoreno.com/tubo_queue_light.jpg | https://files.migalmoreno.com/tubo_settings_light.jpg |
|----------------------------------------------------+------------------------------------------------------+-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------|
| https://files.migalmoreno.com/tubo_kiosk_dark.jpg | https://files.migalmoreno.com/tubo_channel_dark.jpg | https://files.migalmoreno.com/tubo_stream_dark.jpg | https://files.migalmoreno.com/tubo_queue_dark.jpg | https://files.migalmoreno.com/tubo_bookmarks_dark.jpg |
** Features
- [X] No ads
- [X] Audio player
- [X] Media queue
- [X] Playlists
- [X] Settings
- [ ] Subscriptions
- [ ] User login
** Instances
| URL | Country |
|-----------------------------------------+---------|
| https://tubo.migalmoreno.com (Official) | 🇪🇸 |
| [[https://tubo.reallyaweso.me][https://tubo.reallyaweso.me]] | 🇩🇪 |
| [[https://tubo.ducks.party][https://tubo.ducks.party]] | 🇩🇪 |
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.
** Installation
*** Packaging
**** Uberjar
To bundle the whole project into a self-contained uber-jar you need to follow these build steps:
#+begin_src sh
npm i
npm run build
clojure -T:frontend:build uberjar
#+end_src
After the last command is completed, you'll get a path to the uber-jar, which you can run like this:
#+begin_src sh
java -jar target/tubo-.jar
#+end_src
**** Docker
Alternatively, you can use Docker to set up Tubo. Simply invoke this:
#+begin_src sh
docker-compose up -d
#+end_src
**** Manual
You can also set up Tubo manually via the [[https://guix.gnu.org/][GNU Guix]] package manager. First, download the necessary tooling:
#+begin_src sh
cd /path/to/tubo
guix shell
#+end_src
Then, compile the downloader ahead-of-time:
#+begin_src sh
clojure -M -e "(compile 'tubo.downloader-impl)"
#+end_src
Fetch the front-end dependencies and build the front-end assets.
#+begin_src sh
npm i
npm run build
#+end_src
Finally, compile the front-end.
#+begin_src sh
clojure -M:frontend release tubo
#+end_src
You can now start a local server that listens on port 3000 by running this:
#+begin_src sh
clojure -M:run
#+end_src
Access the front-end in your browser at =http://localhost:3000=.
*** Reverse Proxy
If you want to self-host Tubo and make it publicly accessible you'll need to set up a reverse proxy.
**** Nginx
#+begin_src nginx
server {
listen 443 ssl http2;
server_name tubo.;
ssl_certificate /etc/letsencrypt/live/tubo./fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/tubo./privkey.pem;
location / {
proxy_pass http://localhost:3000;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header HOST $http_host;
}
}
#+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.