summaryrefslogtreecommitdiff
path: root/invidious/README.md
blob: fbfa29fe7bc0abba4bfc4ddb0cede5a7168f46e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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.