From e9c354d5a34df636306b1819dd17fff9e01b1a1e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89milien=20=28perso=29?=
 <4016501+unixfox@users.noreply.github.com>
Date: Tue, 24 Dec 2024 17:43:54 +0000
Subject: [PATCH] Better doc for invidious_companion_key

---
 config/config.example.yml | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/config/config.example.yml b/config/config.example.yml
index b8cc3ed2..1257bb17 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -88,15 +88,18 @@ db:
 #    public_url: "http://localhost:8282"
 
 ##
-## API key for Invidious companion
+## 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.
 ##
-## Needed when invidious_companion is configured
+## 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: "http(s)://<IP-HOSTNAME>:<Port>"
+## Accepted values: a string
 ## Default: <none>
 ##
-
 #invidious_companion_key: "CHANGE_ME!!"
 
 #########################################