From 979a3b0e8c4c0fe5b4c7a3301046ccd640a500f3 Mon Sep 17 00:00:00 2001 From: blade Date: Thu, 7 May 2026 20:52:08 +0200 Subject: [PATCH] Document companion deployment support Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc239386..bb691189 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ - Invidious is optional. * Enjoy Materialious without a Invidious instance via our YouTube backend. * Local video fallback if Invidious fails loading videos. -- Invidious companion support. +- Invidious companion support, including direct companion-base deployments via `VITE_DEFAULT_COMPANION_INSTANCE`. - Android TV support. - Support for disabling certificate validation for homelab users. - Sync your watch progress between Invidious sessions. @@ -53,6 +53,8 @@ This version of Materialious is feature rich, has its own account system (option # Legacy Docker deployment, Invidious only. This version of Materialious is still **fully** supported, but is purely just a Invidious frontend without any fancy bells and whistles, this version is harder to deploy... +If your Invidious instance enforces local/proxied playback through companion endpoints, set `VITE_DEFAULT_COMPANION_INSTANCE` to your instance's `/companion` base URL and keep the player defaults aligned with proxied playback (`proxyVideos` and `dashEnabled`). This avoids relying on unsigned root-level media redirects and matches the working companion flow used by Invidious itself. + [Please read the guide here](./docs/DOCKER.md) # Installing as a app