github-mirrors/invidious-companion
1
0
Fork 0
mirror of https://github.com/iv-org/invidious-companion.git synced 2026-02-06 23:42:06 -07:00
Code Issues Projects Releases Packages Wiki Activity
Page: Environment variables
Pages
Environment variables Finding a player_id to hardcode it into Invidious Companion Home How to communicate with Invidious companion with any client (HTTP API) How to send IPv6 requests with a new IPv6 address for each request on a server with a whole IPv6 range Setup Invidious companion on a separate subdomain server Systemd service Use a Google account for unblocking videos that are not loading Use specific fork from iv‐org YouTube.js Z ‐ Archive ‐ Design plan
9 Environment variables
Émilien (perso) edited this page 2025-09-16 13:49:59 +02:00
Table of Contents

New doc

Documentation is available in the config.toml file: https://github.com/iv-org/invidious-companion/blob/master/config/config.example.toml

Old doc (won't be updated but kept for archiving)

  • HOST:
    • Explanation: allow you to bind on a different interface
    • default: 127.0.0.1
  • PORT:
    • Explanation: allow you to bind on a different port
    • default: 8282
  • SERVER_SECRET_KEY:
    • Explanation:
      The secret key for Invidious companion, needs to be the same as invidious_companion_key from Invidious config.
      For security reasons, we do not recommend using the same as the HMAC_KEY.
    • example: a key for of a size of 16 characters
  • SERVER_BASE_URL:
    • Explanation:
      The base URL where Invidious companion is hosted.
      It is the same as the domain that you are using for Invidious (unless you have installed Invidious companion on a separate subdomain). And it is the same as the public_url parameter that you did set in Invidious config.yaml file.
    • default: http://localhost:8282
    • examples: https://myinvidiousdomain.com or http://192.168.1.100:8282