From c2536492cf321c93ba93e0167661eced382426b8 Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Fri, 9 Oct 2026 09:17:21 +1300 Subject: [PATCH] Update docs --- docs/redirect-root-to-share.md | 2 +- docs/reverse-proxy.md | 10 +++++----- docs/troubleshooting.md | 4 ++-- docs/visitor-uploads.md | 19 ++++++++++--------- 4 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/redirect-root-to-share.md b/docs/redirect-root-to-share.md index f6800e8..bc94b42 100644 --- a/docs/redirect-root-to-share.md +++ b/docs/redirect-root-to-share.md @@ -19,7 +19,7 @@ photos.yourdomain.net { redir / /s/example-share 302 # Alternatively you could rewrite, so the gallery appears at the root: #rewrite / /s/example-share - reverse_proxy immich-public-proxy:3000 + reverse_proxy ipp-address:port } ``` diff --git a/docs/reverse-proxy.md b/docs/reverse-proxy.md index 872c1db..077299a 100644 --- a/docs/reverse-proxy.md +++ b/docs/reverse-proxy.md @@ -17,14 +17,14 @@ whichever you use. - **Allow large uploads** only if you run the [upload service](/visitor-uploads). IPP itself needs no request size settings. See [Request size limits](/visitor-uploads#request-size-limits). -The examples reach the container as `immich-public-proxy:3000`, which works when the proxy shares a Docker network -with it. From the host, use the published port instead: `localhost:3000` with the default compose file. +In the examples, `ipp-address:port` is the address your reverse proxy reaches the IPP container on: the server's IP +or hostname and the published port, `3000` with the default compose file. ## Caddy ``` photos.example.com { - reverse_proxy immich-public-proxy:3000 + reverse_proxy ipp-address:port } ``` @@ -38,7 +38,7 @@ server { server_name photos.example.com; location / { - proxy_pass http://immich-public-proxy:3000; + proxy_pass http://ipp-address:port; proxy_set_header Host $host; } } @@ -56,7 +56,7 @@ http: ipp: loadBalancer: servers: - - url: "http://immich-public-proxy:3000" + - url: "http://ipp-address:port" routers: ipp: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1c480f2..b68d40f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -62,12 +62,12 @@ its links without that prefix, so the page's script and its password form go to service. The password is accepted by IPP, which the gallery had already unlocked, and the upload service never sees it. -In nginx the cause is a trailing slash on the upload `proxy_pass`: `proxy_pass http://ipp-upload:3000/;` replaces +In nginx the cause is a trailing slash on the upload `proxy_pass`: `proxy_pass http://ipp-upload-address:port/;` replaces the matched `/upload/` with that `/`. Remove the slash so the path is passed as is: ```nginx location /upload/ { - proxy_pass http://ipp-upload:3000; + proxy_pass http://ipp-upload-address:port; } ``` diff --git a/docs/visitor-uploads.md b/docs/visitor-uploads.md index 5227fe6..a618e32 100644 --- a/docs/visitor-uploads.md +++ b/docs/visitor-uploads.md @@ -104,8 +104,9 @@ Start it with `docker-compose up -d`. The full list of settings is on [Upload se ## Route it through your reverse proxy The upload service serves its pages both under `/upload` and at the root, so it fits either of these shapes with no -URL setting. The examples reach the container as `ipp-upload:3000`, which works when the proxy shares a Docker -network with it. From the host, use the published port instead: `localhost:3001` with the compose file above. +URL setting. In the examples, `ipp-address:port` is whatever address your reverse proxy already uses to reach IPP, +and `ipp-upload-address:port` is the same for the upload service: the same host, on the port you published for it, +`3001` with the compose file above. ### Path on the IPP hostname @@ -119,17 +120,17 @@ Use `handle`, which keeps the path; `handle_path` would strip it. ``` photos.example.com { handle /upload/* { - reverse_proxy ipp-upload:3000 + reverse_proxy ipp-upload-address:port } handle { - reverse_proxy immich-public-proxy:3000 + reverse_proxy ipp-address:port } } ``` #### nginx -No trailing slash on the upload `proxy_pass`. With `proxy_pass http://ipp-upload:3000/;`, nginx replaces the +No trailing slash on the upload `proxy_pass`. With `proxy_pass http://ipp-upload-address:port/;`, nginx replaces the `/upload/` prefix with that `/` and the service receives `/share/` instead of `/upload/share/`. It then writes every link on its pages without `/upload`, so the browser sends them to IPP instead: the page's script is a 404 and the password form posts to the wrong service, which asks for the password again. @@ -142,11 +143,11 @@ server { location /upload/ { client_max_body_size 500m; proxy_request_buffering off; - proxy_pass http://ipp-upload:3000; + proxy_pass http://ipp-upload-address:port; } location / { - proxy_pass http://immich-public-proxy:3000; + proxy_pass http://ipp-address:port; } } ``` @@ -159,7 +160,7 @@ Send everything on a separate upload hostname to the upload service. ``` upload.example.com { - reverse_proxy ipp-upload:3000 + reverse_proxy ipp-upload-address:port } ``` @@ -174,7 +175,7 @@ server { proxy_request_buffering off; location / { - proxy_pass http://ipp-upload:3000; + proxy_pass http://ipp-upload-address:port; } } ```