config/config.example.toml

#####
# The configuration options listed below are able to be enabled as needed.
# The values in this example are the defaults. Some values can alternatively
# be set using an environment variable.
#
# In order to enable an option, make sure you uncomment both the option
# and the block header for the section it belongs to. Any other commented
# options will continue to use default values.
# See https://toml.io/en/ for details on the configuration format.
#####

# [server]
# port = 8282 # env variable: PORT
# host = "127.0.0.1" # env variable: HOST
# # Listens to a unix socket on instead of a TCP socket
# use_unix_socket = false # env variable: SERVER_USE_UNIX_SOCKET
# unix_socket_path = "/tmp/invidious-companion.sock" # env variable: SERVER_UNIX_SOCKET_PATH
# # Base path Invidious companion will serve from
# base_path = "/companion" # env variable: SERVER_BASE_PATH
# # secret key needs to be exactly 16 characters long
# secret_key = "CHANGE_ME" # env variable: SERVER_SECRET_KEY
# verify_requests = false # env variable: SERVER_VERIFY_REQUESTS
# encrypt_query_params = false # env variable: SERVER_ENCRYPT_QUERY_PARAMS
# enable_metrics = false # env variable: SERVER_ENABLE_METRICS
 
# [cache]
# enabled = true # env variable: CACHE_ENABLED
# # will get cached in /var/tmp/youtubei.js if you specify /var/tmp
# # you need to change the --allow-write from deno run too
# directory = "/var/tmp" # env variable: CACHE_DIRECTORY
 
# [networking]
## Proxy type supported: https://docs.deno.com/api/deno/~/Deno.Proxy
# #proxy = "" # env variable: PROXY
# # Enable automatic proxy fetching from antpeak.com (free proxies, auto-rotates when failed)
# # When enabled, ignores the `proxy` setting above and fetches proxies automatically
# auto_proxy = false # env variable: NETWORKING_AUTO_PROXY
# # IPv6 rotation settings - allows sending requests with unique IPv6 addresses
# # This requires IPv6 setup: https://github.com/iv-org/invidious-companion/wiki/How-to-send-IPv6-requests-with-a-new-IPv6-address-for-each-request-on-a-server-with-a-whole-IPv6-range
# # Randomizes all bits after the block prefix (e.g., /32 randomizes bits 33-128)
# #ipv6_block = "2001:db8::/32" # env variable: NETWORKING_IPV6_BLOCK

# [networking.videoplayback]
# # Enable YouTube new video format UMP
# ump = false # env variable: NETWORKING_VIDEOPLAYBACK_UMP
# # size of chunks to request from google servers for rate limiting reductions
# video_fetch_chunk_size_mb = 5 # env variable: NETWORKING_VIDEOPLAYBACK_VIDEO_FETCH_CHUNK_SIZE_MB
 
###
# Network call timeouts when talking to YouTube. 
# Needed in order to ensure Deno closes hanging connections
###
# [networking.fetch]
# timeout_ms = 30000 # env variable: NETWORKING_FETCH_TIMEOUT_MS
 
###
# Network call retries when talking to YouTube, using
# https://docs.deno.com/examples/exponential_backoff/
###
# [networking.fetch.retry]
# # enable retries on calls to YouTube
# enabled = false # env variable: NETWORKING_FETCH_RETRY_ENABLED
# # max number of times to retry
# times = 1 # env variable: NETWORKING_FETCH_RETRY_TIMES
# # minimum wait after first call (ms)
# initial_debounce = 0 # env variable: NETWORKING_FETCH_RETRY_INITIAL_DEBOUNCE
# # how much to back off after each retry (multiplier of initial_debounce)
# debounce_multiplier = 0 # env variable: NETWORKING_FETCH_RETRY_DEBOUNCE_MULTIPLIER
 
# [jobs]
 
# [jobs.youtube_session]
# # whether to generate PO tokens
# po_token_enabled = true # env variable: JOBS_YOUTUBE_SESSION_PO_TOKEN_ENABLED
# # frequency of PO token refresh in cron format
# frequency = "*/5 * * * *" # env variable: JOBS_YOUTUBE_SESSION_FREQUENCY
 
# [youtube_session]
# oauth_enabled = false # env variable: YOUTUBE_SESSION_OAUTH_ENABLED
# cookies = "" # env variable: YOUTUBE_SESSION_COOKIES