|
61 | 61 | ## When this setting is commented out, Invidious companion is not used. |
62 | 62 | ## Otherwise, Invidious will proxy the requests to Invidious companion. |
63 | 63 | ## |
64 | | -## Note: multiple URL can be configured. In this case, invidious will |
| 64 | +## Note: multiple URL can be configured. In this case, Invidious will |
65 | 65 | ## randomly pick one every time video data needs to be retrieved. This |
66 | 66 | ## URL is then kept in the video metadata cache to allow video playback |
67 | 67 | ## to work. Once said cache has expired, requesting that video's data |
68 | 68 | ## again will cause a new companion URL to be picked. |
69 | 69 | ## |
70 | | -## The parameter private_url needs to be configured for the internal |
71 | | -## communication between the companion and Invidious. |
72 | | -## And public_url is the public URL from which companion is listening |
73 | | -## to the requests from the user(s). |
| 70 | +## The parameter private_url is required for the internal communication |
| 71 | +## between Invidious companion and Invidious. |
74 | 72 | ## |
75 | | -## If you are using a reverse proxy then you will probably need to |
76 | | -## configure the public_url to be the same as the domain used for Invidious. |
77 | | -## Also apply when used from an external IP address (without a domain). |
78 | | -## Examples: https://MYINVIDIOUSDOMAIN/companion or http://192.168.1.100:8282/companion |
79 | | -## |
80 | | -## Both parameter can have identical URL when Invidious is hosted in |
81 | | -## an internal network or at home or locally (localhost). |
82 | | -## |
83 | | -## NOTE: If public_url is omitted, Invidious will use its built-in proxy |
84 | | -## to route companion requests through /companion, which is useful for |
85 | | -## simple setups where companion runs on the same network. When using |
86 | | -## the built-in proxy, CSP headers are not modified since requests |
87 | | -## stay within the same domain. |
| 73 | +## The optional parameter public_url is the public URL from which |
| 74 | +## Invidious companion is listening to the requests from the user(s). |
| 75 | +## When this setting is commented out, Invidious proxy all requests to |
| 76 | +## Invidious companion. Useful for simple setups. |
| 77 | +## Otherwise, requests from the user(s) will reach Invidious companion directly. |
| 78 | +## And you will need to configure a reverse proxy with separate routes |
| 79 | +## for Invidious and Invidious companion. |
| 80 | +## Read the post-install documentation for advanced reverse proxy |
| 81 | +## documentation: https://docs.invidious.io/installation/#post-install-configuration |
88 | 82 | ## |
89 | 83 | ## Accepted values: "http(s)://<IP-HOSTNAME>:<Port>" |
90 | 84 | ## Default: <none> |
91 | 85 | ## |
92 | 86 | #invidious_companion: |
93 | 87 | # - private_url: "http://localhost:8282/companion" |
94 | | -# public_url: "http://localhost:8282/companion" |
95 | | -# # Example with built-in proxy (omit public_url): |
96 | | -# # - private_url: "http://localhost:8282/companion" |
| 88 | +# # Uncomment for advanced reverse proxy configuration (see above). |
| 89 | +# # public_url: "http://localhost:8282/companion" |
97 | 90 |
|
98 | 91 | ## |
99 | 92 | ## API key for Invidious companion, used for securing the communication |
|
0 commit comments