# ============ docker compose (docker-compose.yml) ============ # copy to .env and fill these in # Three setups (README, "Quick start"): # your domain, Caddy gets the certificate: TUBEHAUS_SITE=tube.example.com (the defaults below) # plain HTTP on a LAN: TUBEHAUS_SITE=:80 TUBEHAUS_HTTP_BIND=8080 # TUBEHAUS_URL=http://192.168.1.10:8080 # behind your own nginx/Traefik: TUBEHAUS_SITE=:80 TUBEHAUS_HTTP_BIND=127.0.0.1:8080 TUBEHAUS_HTTPS_BIND=127.0.0.1:8443 # (TUBEHAUS_URL = what your proxy serves) # what Caddy answers inside the container: a domain for automatic HTTPS, or ":80" for plain HTTP TUBEHAUS_SITE=tube.example.com # where browsers open TubeHaus TUBEHAUS_URL=https://tube.example.com # the host ports Caddy is published on: a port ("8080") or an address and port ("127.0.0.1:8080") TUBEHAUS_HTTP_BIND=80 TUBEHAUS_HTTPS_BIND=443 # optional built-in login (recommended before exposing TubeHaus to the internet) # TUBEHAUS_AUTH=basic: one shared password. Set a user name and a bcrypt hash from: # docker compose run --rm caddy caddy hash-password # (in this file every $ in the hash must be written as $) # TUBEHAUS_AUTH=accounts: everyone signs up with a name and password and gets their own # subscriptions, history and playlists. The first account keeps the library that was there. # TUBEHAUS_MAX_ACCOUNTS=4 closes sign-ups once everyone in the household has one. TUBEHAUS_AUTH=none TUBEHAUS_USER= TUBEHAUS_PASSWORD_HASH= # single sign-on (with TUBEHAUS_AUTH=accounts): a "Continue with ..." button for your own identity # provider (Authentik, Authelia, Keycloak, Pocket ID, Google, ...). Make an OpenID Connect client there # with the redirect URI /api/p/auth/oidc/callback. A first sign-in makes that person's # account. TUBEHAUS_OIDC_ONLY=1 turns passwords off, so only the provider signs people in. # TUBEHAUS_OIDC_ISSUER=https://auth.example.com/application/o/tubehaus/ # TUBEHAUS_OIDC_CLIENT_ID= # TUBEHAUS_OIDC_CLIENT_SECRET= # TUBEHAUS_OIDC_NAME=Authentik # TUBEHAUS_OIDC_ONLY=0 # running a public instance for strangers? set this to 1: every visitor keeps their own # library in their browser, the server stores none, and send-to-TV / server downloads are off. # Read "Running a public instance" in the README first. TUBEHAUS_PUBLIC=0 # look up the videos you're likely to click next, so they start at once (0 = only what you ask for, # the least traffic to YouTube) # TUBEHAUS_PREFETCH=4 # deploy/docker-compose.public.yml only: key for the Anubis bot check (openssl rand -hex 32) ANUBIS_KEY= # load limits (0 = no limit). For a public instance something like 50 viewers and 1080p is sensible. # people watching at once; newcomers beyond it get "busy, try again in a few minutes" TUBEHAUS_MAX_VIEWERS=0 # highest quality offered, e.g. 1080 (bandwidth) TUBEHAUS_MAX_HEIGHT=0 # API requests per visitor per minute (empty: 120 on public instances, off otherwise) TUBEHAUS_RATE_PER_MIN= # your instance's own name in the page title and menu (empty: TubeHaus) TUBEHAUS_NAME= # extra links in the side menu, as JSON, e.g. [{"name":"Home hub","url":"https://hub.example.com/"}] TUBEHAUS_LINKS= # translated subtitles target / live caption language TUBEHAUS_SUB_LANG=en TUBEHAUS_CAPTION_LANG=auto # ============ running the server without docker (deploy/tubehaus.service) ============ # HT_BIND=127.0.0.1 # HT_PORT=3010 # HT_STATE=./state # library and subtitle cache # HT_PUBLIC_URL=https://tube.example.com # where browsers open TubeHaus # HT_YT_PROXY=127.0.0.1:40000 # Cloudflare WARP in proxy mode ("" = direct) # HT_WARP_ROTATE=1 # reconnect WARP when YouTube blocks the address # HT_REGION=US # the default region of searches and the trending page # HT_HL= # YouTube's language for its texts ("3 days ago"); empty = English # HT_YTDLP=yt-dlp # + bgutil-ytdlp-pot-provider, for live streams # HT_WHISPER_BIN=/opt/whisper/build/bin/whisper-cli # HT_WHISPER_MODEL=/opt/whisper/models/ggml-base-q5_1.bin # HT_WHISPER_LANG=auto # HT_SUB_LANG=en # HT_LIBRETRANSLATE= # optional translation fallback # HT_DOWNLOAD_DIR=/var/tmp/tubehaus-dl # offline save (needs ffmpeg, ~10 GB free) # HT_PUBLIC_PROXIES=0 # proxies with public addresses in front of yours # HT_MAX_BODY_MB=64 # largest request body