2023-10-13 17:38:15 +00:00
|
|
|
# Hyperpipe / Piped
|
2023-10-13 17:34:22 +00:00
|
|
|
|
2023-10-13 17:38:15 +00:00
|
|
|
Hyperpipe, a privacy-friendly frontend designed for YouTube Music, was inspired and created using Piped and YouTube's InnerTube API.
|
|
|
|
|
|
|
|
|
|
In the following steps, you'll be guided through the installation of Hyperpipe, as well as Piped, to dramatically improve your online privacy.
|
|
|
|
|
|
|
|
|
|
What sets Hyperpipe and Piped apart in particular is the ability to enjoy YouTube music and videos without being interrupted by ads.
|
|
|
|
|
|
|
|
|
|
In this detailed tutorial, I'll explain how to deploy Hyperpipe using Docker and Portainer.
|
|
|
|
|
|
|
|
|
|
## Considerations
|
|
|
|
|
|
|
|
|
|
This Docker stack is scaled for a 8 vCPUs _and 24 Gb memory_ on a gigabite network.
|
|
|
|
|
|
|
|
|
|
Using ADSL will give poorer performance than using fiber.
|
|
|
|
|
|
|
|
|
|
I strongly recommend that you only use this tool if you finally have a good fiber connection.
|
|
|
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
You must have already installed:
|
|
|
|
|
|
|
|
|
|
* A fully fonctionnal [internet domain name](https://infos.zogg.fr/caddy-docker-cloudflare)
|
|
|
|
|
* [Docker](https://infos.zogg.fr/tags#docker)
|
|
|
|
|
* A textual editor ([Visual Studio Code](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/), nano...)
|
|
|
|
|
* A fully functionnal [Traefik reverse proxy](https://infos.zogg.fr/tags#traefik) setup
|
|
|
|
|
|
|
|
|
|
## What's here
|
|
|
|
|
|
|
|
|
|
### Folders
|
|
|
|
|
|
|
|
|
|
* **conf** : used to store all configuration files
|
|
|
|
|
* **datas** : persistent storage _(mainly for the PostgreQL database)_
|
|
|
|
|
|
|
|
|
|
### Files
|
|
|
|
|
|
|
|
|
|
* **docker-compose.yml** : a fully functionnal docker-compose file to run using _docker compose up -d_
|
|
|
|
|
* **vm/common.yml** : docker-compose on which _docker-compose.yml_ is extended
|
|
|
|
|
* **vm/host.yml** : docker-compose on which host.yml_ is extended
|
|
|
|
|
* **.env** : default environement variables used by the docker-compose file
|
|
|
|
|
|
|
|
|
|
* **traefik/hyperpipe.yml** : the Traefik configuration for this stack _(routers, services, middlewares)_
|
|
|
|
|
|
|
|
|
|
* **conf/hyperpipe/nginx.conf** : highly optimized [NGinx](https://infos.zogg.fr/nginx) base configuration used by _hyperpipe-nginx_
|
|
|
|
|
* **conf/hyperpipe/youtube.conf** : used by _hyperpipe-nginx_
|
|
|
|
|
* **conf/piped/api.conf** : used by _hyperpipe-nginx_
|
|
|
|
|
* **conf/piped/backend.conf** : configuration file used by _piped-back_
|
|
|
|
|
* **conf/piped/frontend.conf** : used by _hyperpipe-nginx_
|
|
|
|
|
* **conf/piped/proxy.conf** : used by _hyperpipe-nginx_
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
You **MUST** find & replace all _'xxx'_ entries in each file to match your setup.
|
|
|
|
|
|
|
|
|
|
* **docker-compose.yml** : piped-db _POSTGRES_PASSWORD_
|
|
|
|
|
* **nginx.conf** : resolver _(put your private dns ip resolver or comment the entire line)_
|
|
|
|
|
* **domain.com** : replace all _domain.com_ to match your domain name in all files
|
