Skip to content

Commit

Permalink
Better doc for invidious_companion_key
Browse files Browse the repository at this point in the history
  • Loading branch information
unixfox authored Dec 24, 2024
1 parent 0dba767 commit e9c354d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions config/config.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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!!"

#########################################
Expand Down

0 comments on commit e9c354d

Please sign in to comment.