From 3f5811c7570c4b6ba36f711b48354ca7fecec91a Mon Sep 17 00:00:00 2001 From: "Trez.One" Date: Wed, 1 Oct 2025 06:27:44 -0400 Subject: [PATCH] Updating Invidious config to accompany new Companion component. --- app-configs/rinoa/invidious/config.yml.j2 | 77 ++++++++++++++++++++--- 1 file changed, 69 insertions(+), 8 deletions(-) diff --git a/app-configs/rinoa/invidious/config.yml.j2 b/app-configs/rinoa/invidious/config.yml.j2 index ae86764..81f5a12 100644 --- a/app-configs/rinoa/invidious/config.yml.j2 +++ b/app-configs/rinoa/invidious/config.yml.j2 @@ -1,6 +1,5 @@ {% set vault_addr = 'https://vault.trez.wtf' %} {% set secrets_path = 'rinoa-docker/env' %} - ######################################### # # Database and other external servers @@ -55,8 +54,56 @@ check_tables: true ## Accepted values: a path to a UNIX socket or ":" ## Default: ## -signature_server: invidious-sig-helper:12999 +#signature_server: +## +## Invidious companion is an external program +## for loading the video streams from YouTube servers. +## +## When this setting is commented out, Invidious companion is not used. +## Otherwise, Invidious will proxy the requests to Invidious companion. +## +## Note: multiple URL can be configured. In this case, Invidious will +## randomly pick one every time video data needs to be retrieved. This +## URL is then kept in the video metadata cache to allow video playback +## to work. Once said cache has expired, requesting that video's data +## again will cause a new companion URL to be picked. +## +## The parameter private_url is required for the internal communication +## between Invidious companion and Invidious. +## +## The optional parameter public_url is the public URL from which +## Invidious companion is listening to the requests from the user(s). +## When this setting is commented out, Invidious proxy all requests to +## Invidious companion. Useful for simple setups. +## Otherwise, requests from the user(s) will reach Invidious companion directly. +## And you will need to configure a reverse proxy with separate routes +## for Invidious and Invidious companion. +## Read the post-install documentation for advanced reverse proxy +## documentation: https://docs.invidious.io/installation/#post-install-configuration +## +## Accepted values: "http(s)://:" +## Default: +## +invidious_companion: + - private_url: "http://invidious-companion:8282" +# # Uncomment for advanced reverse proxy configuration (see above). + - public_url: https://invid.{{ lookup('community.hashi_vault.vault_kv2_get', 'env', engine_mount_point='rinoa-docker', url=vault_addr, token=vault_token)['secret']['MY_TLD'] }}/companion + +## +## API key for Invidious companion, used for securing the communication +## between Invidious and Invidious companion. +## The key needs to be exactly 16 characters long. +## +## Note: This parameter is mandatory when Invidious companion is enabled +## and should be a random string. +## Such random string can be generated on linux with the following +## command: `pwgen 16 1` +## +## Accepted values: a string (of length 16) +## Default: +## +invidious_companion_key: {{ lookup('community.hashi_vault.vault_kv2_get', 'env', engine_mount_point='rinoa-docker', url=vault_addr, token=vault_token)['secret']['INVID_COMPANION_KEY'] }} ######################################### # @@ -133,6 +180,20 @@ https_only: false ## #hsts: true +## +## Path and permissions of a UNIX socket to listen on for incoming connections. +## +## Note: Enabling socket will make invidious stop listening on the address +## specified by 'host_binding' and 'port'. +## +## Accepted values: Any path to a new file (that doesn't exist yet) and its +## permissions following the UNIX octal convention. +## Default: +## +#socket_binding: +# path: /tmp/invidious.sock +# permissions: 777 + # ----------------------------- # Network (outbound) @@ -180,7 +241,7 @@ https_only: false ## Configuration for using a HTTP proxy ## ## If unset, then no HTTP proxy will be used. -## +## #http_proxy: # user: # password: @@ -800,14 +861,14 @@ default_user_preferences: ## Default video quality. ## ## Accepted values: dash, hd720, medium, small - ## Default: hd720 + ## Default: dash ## - #quality: hd720 + #quality: dash ## ## Default dash video quality. ## - ## Note: this setting only takes effet if the + ## Note: this setting only takes effect if the ## 'quality' parameter is set to "dash". ## ## Accepted values: @@ -842,7 +903,7 @@ default_user_preferences: ## Default: true ## #vr_mode: true - + ## ## Save the playback position ## Allow to continue watching at the previous position when @@ -949,4 +1010,4 @@ default_user_preferences: ## Accepted values: true, false ## Default: false ## - #extend_desc: false \ No newline at end of file + #extend_desc: false -- 2.52.0