diff options
Diffstat (limited to 'config/config.example.yml')
| -rw-r--r-- | config/config.example.yml | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/config/config.example.yml b/config/config.example.yml index b04e0a30..8484c6be 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -54,6 +54,53 @@ db: ## #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 needs to be configured for the internal +## communication between the companion and Invidious. +## And public_url is the public URL from which companion is listening +## to the requests from the user(s). +## +## If you are using a reverse proxy then you will probably need to +## configure the public_url to be the same as the domain used for Invidious. +## Also apply when used from an external IP address (without a domain). +## Examples: https://MYINVIDIOUSDOMAIN or http://192.168.1.100:8282 +## +## Both parameter can have identical URL when Invidious is hosted in +## an internal network or at home or locally (localhost). +## +## Accepted values: "http(s)://<IP-HOSTNAME>:<Port>" +## Default: <none> +## +#invidious_companion: +# - private_url: "http://localhost:8282" +# public_url: "http://localhost:8282" + +## +## 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. +## +## 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 +## Default: <none> +## +#invidious_companion_key: "CHANGE_ME!!" ######################################### # |