diff --git a/README.md b/README.md index 134feaf..84ef971 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,15 @@ Invidious, how I do it. 1. Clone with submodules!!! (`--recursive`) 2. Fill in placeholders 3. Schedule: - - `reset.sh` restarts Invidious. - - `hard_reset.sh` updates and restarts everything. I suggest to schedule only this, daily. + - [`reset.sh`](reset.sh) restarts Invidious. + - [`hard-reset.sh`](hard-reset.sh) updates and restarts everything. I suggest to schedule only this, daily. Placeholders: -1. `192.168.81.2` in [docker-compose.yml] -2. In both [config.yml] and [config-refresh.yml]: - - `hmac_key` - - `invidious_companion_key` - - companions +1. `192.168.81.2` in [docker-compose.yml](docker-compose.yml) +2. In both [config.yml](config.yml) and [config-refresh.yml](config-refresh.yml): + - `hmac_key` - see below + - `invidious_companion_key` - see below + - companions - [see here](/id.420129/companion-setup) - (optional) `http_proxy` - (optional) `modified_source_code_url` @@ -20,9 +20,11 @@ You can generate keys with: openssl rand -hex 8 ``` +--- + #### `config.yml` vs `config-refresh.yml` There are two Invidious instances (or, precisely, classes) One handles "background work," that is **refreshing** stuff, like user subscriptions. It's not exposed to users. \ -One (several, replicated) is exposed to users. \ +The other (replicated) is exposed to users and handles user stuff. It's what you see.