summaryrefslogtreecommitdiff
path: root/invidious/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
commit1d043702ef136e8f2e516c5304a57be5718f1f6f (patch)
tree9b3ad070f11dad5994c58acd41a15db8043745aa /invidious/README.md
Initial commit: docker compose files for all self-hosted servicesHEADmaster
12 services: adguard, ampache, azuracast, flood, glance, glances, grafana, immich, invidious, jellyfin, openwebui, watchtower Each service includes a docker-compose.yml, README.md with setup instructions, and .env.example where applicable.
Diffstat (limited to 'invidious/README.md')
-rw-r--r--invidious/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/invidious/README.md b/invidious/README.md
new file mode 100644
index 0000000..fbfa29f
--- /dev/null
+++ b/invidious/README.md
@@ -0,0 +1,28 @@
+# Invidious
+
+Self-hosted YouTube frontend. No ads, no tracking.
+
+## Setup
+
+1. Generate required keys:
+ ```
+ docker compose run --rm invidious --generate-hmac-key
+ docker compose run --rm invidious --generate-api-key
+ ```
+
+2. Set the generated keys as environment variables and start:
+ ```
+ INVIDIOUS_HMAC_KEY=<generated> INVIDIOUS_COMPANION_KEY=<generated> docker compose up -d
+ ```
+
+ Or add them to an `.env` file (create one in this directory).
+
+## Access
+
+- Web UI: `http://<host>:3000`
+
+## What to Configure
+
+- **Keys** — `INVIDIOUS_HMAC_KEY` and `INVIDIOUS_COMPANION_KEY` must be set. Without them, Invidious will not work.
+- **Database password** — Defaults to `kemal`. Change via `POSTGRES_PASSWORD` env var for production.
+- **Database init** — `docker/init-invidious-db.sh` and `config/sql/` are used for first-time database setup. No changes needed unless you customize the schema.