summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVyquos <75266055+Vyquos@users.noreply.github.com>2025-05-04 07:47:42 +0000
committerGitHub <noreply@github.com>2025-05-04 07:47:42 +0000
commit1f028fee0facfd51f1e2433ce808e2ea5198e2fd (patch)
tree4617adcb31248ce9a3af04173d5f75ba99e394f2
parent2c1400c41e3236b9aa9c84cf73d5864090d52af6 (diff)
downloadinvidious-1f028fee0facfd51f1e2433ce808e2ea5198e2fd.tar.gz
invidious-1f028fee0facfd51f1e2433ce808e2ea5198e2fd.tar.bz2
invidious-1f028fee0facfd51f1e2433ce808e2ea5198e2fd.zip
Reflect companion secret character limit in example config comment (#5269)
Update the comments in the example config to show that the companion secret key must be exactly 16 characters long as per https://github.com/iv-org/invidious-companion/pull/81#issuecomment-2750675405.
-rw-r--r--config/config.example.yml4
1 files changed, 2 insertions, 2 deletions
diff --git a/config/config.example.yml b/config/config.example.yml
index d6119f29..8d3e6212 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -90,14 +90,14 @@ db:
##
## API key for Invidious companion, used for securing the communication
## between Invidious and Invidious companion.
-## The size of the key needs to be more or equal to 16.
+## 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
+## Accepted values: a string (of length 16)
## Default: <none>
##
#invidious_companion_key: "CHANGE_ME!!"