aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2023-06-22 19:48:09 +0200
committerMiguel Ángel Moreno <mail@migalmoreno.com>2023-06-22 19:48:09 +0200
commitfa8e6044f7eff54f29af21fd6685280031c986dc (patch)
tree437a4d5087b4786e29490bf42dfd0878aa0b4f5c
parent606c3279f7d89bbbae895bd20727d2206e61eaae (diff)
doc: Update packaging instructions with more methods
-rw-r--r--README55
-rw-r--r--README.md100
2 files changed, 119 insertions, 36 deletions
diff --git a/README b/README
index 94597a5..81d501f 100644
--- a/README
+++ b/README
@@ -9,15 +9,38 @@ To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/Ne
You can try a live demo at https://tubo.mianmoreno.com but beware this is hosted on a personal low-end VPS. If you can, please consider self-hosting Tubo and let me know about your instance via the [[*Contributing][contribution methods]]. See [[*Installation][installation]] for ways to set up Tubo in your server.
** Installation
-*** Manual
-The easiest way to set up Tubo's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
+*** 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-<VERSION>.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
-To run the application, first compile the downloader ahead-of-time.
+Then, compile the downloader ahead-of-time:
#+begin_src sh
clojure -M -e "(compile 'tubo.downloader-impl)"
@@ -30,13 +53,13 @@ npm i
npm run build
#+end_src
-Then, compile the front-end.
+Finally, compile the front-end.
#+begin_src sh
-clojure -M:frontend compile tubo
+clojure -M:frontend release tubo
#+end_src
-You can now start a local server that listens on port 3000 by running the following:
+You can now start a local server that listens on port 3000 by running this:
#+begin_src sh
clojure -M:run
@@ -44,6 +67,26 @@ clojure -M:run
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.<YOUR_DOMAIN>
+ ssl_certificate /etc/letsencrypt/live/tubo.<YOUR_DOMAIN>/fullchain.pem;
+ ssl_certificate_key /etc/letsencrypt/live/tubo.<YOUR_DOMAIN>/privkey.pem;
+
+ location / {
+ proxy_pass http://localhost:3000;
+ proxy_set_header X-Forwarded-For $remote_addr;
+ proxy_set_header HOST $http_host;
+ }
+}
+#+end_src
+
** Road-map
- [X] Basic audio player
- [ ] Track queuing system
diff --git a/README.md b/README.md
index 9d23ed3..1d3d592 100644
--- a/README.md
+++ b/README.md
@@ -2,44 +2,84 @@
# Tubo
-Tubo is an alternative web front-end to various streaming sites. It aims to free users from the world of ad-ridden streaming sites by providing a distraction-free interface to consume content from. It currently supports the following platforms:
+Tubo is a streaming front-end focused on bringing the [NewPipe](https://github.com/TeamNewPipe/NewPipe) experience to the web. It currently supports the same platforms as NewPipe, including YouTube, SoundCloud, and more.
-- YouTube
-- SoundCloud
-- media.ccc.de
-- PeerTube
-- Bandcamp
+To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) library and exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
-To retrieve the data, it leverages the excellent [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) library that powers the popular [NewPipe](https://github.com/TeamNewPipe/NewPipe) Android app. Tubo exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
-The ultimate goal behind Tubo is to replicate the Newpipe experience on the web, so that it's accessible to those that don't use an Android device.
+## Try It Out
+You can try a live demo at <https://tubo.mianmoreno.com> but beware this is hosted on a personal low-end VPS. If you can, please consider self-hosting Tubo and let me know about your instance via the [contribution methods](#org09f3d2b). See [installation](#orgb0098d1) for ways to set up Tubo in your server.
-## Installation
-
-The easiest way to set up Tubo's dependencies is via the [GNU Guix](https://guix.gnu.org/) package manager. Simply invoke what follows:
-
- cd /path/to/tubo
- guix shell
-
-To run the application, first compile the downloader ahead-of-time.
-
- clojure -M -e "(compile 'tubo.downloader-impl)"
-Fetch the front-end dependencies and build the front-end assets.
-
- npm i
- npm run build
-
-Then, compile the front-end.
-
- clojure -M:frontend compile tubo
-
-You can now start a local server that listens on port 3000 by running the following:
+## Installation
- clojure -M:run
-Access the front-end in your browser at `http://localhost:3000`.
+### Packaging
+
+- Uberjar
+
+ To bundle the whole project into a self-contained uber-jar you need to follow these build steps:
+
+ npm i
+ npm run build
+ clojure -T:frontend:build uberjar
+
+ After the last command is completed, you'll get a path to the uber-jar, which you can run like this:
+
+ java -jar target/tubo-<VERSION>.jar
+
+- Docker
+
+ Alternatively, you can use Docker to set up Tubo. Simply invoke this:
+
+ docker-compose up -d
+
+- Manual
+
+ You can also set up Tubo manually via the [GNU Guix](https://guix.gnu.org/) package manager. First, download the necessary tooling:
+
+ cd /path/to/tubo
+ guix shell
+
+ Then, compile the downloader ahead-of-time:
+
+ clojure -M -e "(compile 'tubo.downloader-impl)"
+
+ Fetch the front-end dependencies and build the front-end assets.
+
+ npm i
+ npm run build
+
+ Finally, compile the front-end.
+
+ clojure -M:frontend release tubo
+
+ You can now start a local server that listens on port 3000 by running this:
+
+ clojure -M:run
+
+ 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
+
+ server {
+ listen 443 ssl http2;
+ server_name tubo.<YOUR_DOMAIN>
+ ssl_certificate /etc/letsencrypt/live/tubo.<YOUR_DOMAIN>/fullchain.pem;
+ ssl_certificate_key /etc/letsencrypt/live/tubo.<YOUR_DOMAIN>/privkey.pem;
+
+ location / {
+ proxy_pass http://localhost:3000;
+ proxy_set_header X-Forwarded-For $remote_addr;
+ proxy_set_header HOST $http_host;
+ }
+ }
## Road-map