_traefik | ||
_vm | ||
conf | ||
datas | ||
.env | ||
docker-compose.yml | ||
LICENSE | ||
README.md |
Hyperpipe / Piped
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
- Docker
- A textual editor (Visual Studio Code, Notepad++, nano...)
- A fully functionnal Traefik reverse proxy 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 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