Update docs

This commit is contained in:
Alan Grainger
2026-10-09 09:17:21 +13:00
parent 49fcff86df
commit c2536492cf
4 changed files with 18 additions and 17 deletions
+1 -1
View File
@@ -19,7 +19,7 @@ photos.yourdomain.net {
redir / /s/example-share 302 redir / /s/example-share 302
# Alternatively you could rewrite, so the gallery appears at the root: # Alternatively you could rewrite, so the gallery appears at the root:
#rewrite / /s/example-share #rewrite / /s/example-share
reverse_proxy immich-public-proxy:3000 reverse_proxy ipp-address:port
} }
``` ```
+5 -5
View File
@@ -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 - **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). 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 In the examples, `ipp-address:port` is the address your reverse proxy reaches the IPP container on: the server's IP
with it. From the host, use the published port instead: `localhost:3000` with the default compose file. or hostname and the published port, `3000` with the default compose file.
## Caddy ## Caddy
``` ```
photos.example.com { photos.example.com {
reverse_proxy immich-public-proxy:3000 reverse_proxy ipp-address:port
} }
``` ```
@@ -38,7 +38,7 @@ server {
server_name photos.example.com; server_name photos.example.com;
location / { location / {
proxy_pass http://immich-public-proxy:3000; proxy_pass http://ipp-address:port;
proxy_set_header Host $host; proxy_set_header Host $host;
} }
} }
@@ -56,7 +56,7 @@ http:
ipp: ipp:
loadBalancer: loadBalancer:
servers: servers:
- url: "http://immich-public-proxy:3000" - url: "http://ipp-address:port"
routers: routers:
ipp: ipp:
+2 -2
View File
@@ -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 service. The password is accepted by IPP, which the gallery had already unlocked, and the upload service never
sees it. 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: the matched `/upload/` with that `/`. Remove the slash so the path is passed as is:
```nginx ```nginx
location /upload/ { location /upload/ {
proxy_pass http://ipp-upload:3000; proxy_pass http://ipp-upload-address:port;
} }
``` ```
+10 -9
View File
@@ -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 ## 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 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 URL setting. In the examples, `ipp-address:port` is whatever address your reverse proxy already uses to reach IPP,
network with it. From the host, use the published port instead: `localhost:3001` with the compose file above. 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 ### Path on the IPP hostname
@@ -119,17 +120,17 @@ Use `handle`, which keeps the path; `handle_path` would strip it.
``` ```
photos.example.com { photos.example.com {
handle /upload/* { handle /upload/* {
reverse_proxy ipp-upload:3000 reverse_proxy ipp-upload-address:port
} }
handle { handle {
reverse_proxy immich-public-proxy:3000 reverse_proxy ipp-address:port
} }
} }
``` ```
#### nginx #### 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/<key>` instead of `/upload/share/<key>`. It then `/upload/` prefix with that `/` and the service receives `/share/<key>` instead of `/upload/share/<key>`. It then
writes every link on its pages without `/upload`, so the browser sends them to IPP instead: the page's script is a 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. 404 and the password form posts to the wrong service, which asks for the password again.
@@ -142,11 +143,11 @@ server {
location /upload/ { location /upload/ {
client_max_body_size 500m; client_max_body_size 500m;
proxy_request_buffering off; proxy_request_buffering off;
proxy_pass http://ipp-upload:3000; proxy_pass http://ipp-upload-address:port;
} }
location / { 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 { upload.example.com {
reverse_proxy ipp-upload:3000 reverse_proxy ipp-upload-address:port
} }
``` ```
@@ -174,7 +175,7 @@ server {
proxy_request_buffering off; proxy_request_buffering off;
location / { location / {
proxy_pass http://ipp-upload:3000; proxy_pass http://ipp-upload-address:port;
} }
} }
``` ```