From f7ba02d4fe91386f99754a33b2b8e1b2d8db1e2f Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Fri, 4 Sep 2026 11:52:12 +1200 Subject: [PATCH] Update docs --- docs/installation.md | 2 +- docs/troubleshooting.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 7eb039b..034e9ab 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -32,7 +32,7 @@ you. > [!WARNING] > If you're using Cloudflare, please make sure to set your `/share/video/*` path to Bypass Cache, otherwise you may -> run into video playback issues. See [Troubleshooting](#troubleshooting) for more information. +> run into video playback issues. See [Troubleshooting](/troubleshooting) for more information. ### Running alongside Immich on a single domain diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index b16220c..5d5e3cb 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -10,6 +10,23 @@ set to bypass cache. I ran into this issue myself, and found I use Linux/Android, so this project is tested with BrowserStack for Apple/Windows devices. +## Link previews show `http://` or a private IP + +The gallery itself uses relative URLs, so it works behind any reverse proxy. The one place IPP needs a fully qualified +URL is the `og:image` tag that messaging apps use for link previews. Without `PUBLIC_BASE_URL`, IPP builds it from the +incoming request, and behind a TLS-terminating reverse proxy that request arrives as plain `http://` on whatever +hostname or IP the proxy used. + +Set `PUBLIC_BASE_URL` in your `docker-compose.yml` to the public address of IPP, without a trailing slash: + +```yaml +environment: + PUBLIC_BASE_URL: https://your-proxy-url.com +``` + +If you serve IPP from several domains, leave it unset and make sure your reverse proxy forwards the original `Host` +header. See [Running on a single domain](/running-on-single-domain). + ## Can't reach Immich using `localhost:2283` This is a normal Docker thing, nothing to do with IPP.