Update docs

This commit is contained in:
Alan Grainger
2026-10-08 08:44:47 +13:00
parent efa7faa8aa
commit 6aa675e3ef
7 changed files with 21 additions and 14 deletions
+2 -2
View File
@@ -4,7 +4,7 @@ To avoid giving information away about your server, IPP responds with a limited
| Code | Reason |
|------|-------------------------------------------------------------------------------------------------|
| 503 | Healthcheck failed: Immich is not accessible. Only on the `/healthcheck` route. |
| 503 | Healthcheck failed: Immich is not accessible. Only on `/share/healthcheck` (and the older `/healthcheck`). |
| 401 | Invalid password provided for a password-protected share link. |
| 204 | No upload service at `/upload/healthcheck`. The gallery checks this path before showing the "Add photos" button; see [`uploadUrl`](/config/ipp-options#uploadurl). |
| 404 | All other invalid requests, e.g. album doesn't exist, share link is expired, non-existing file. |
@@ -24,7 +24,7 @@ If you want to send a custom 404 page, you would do that with either of the belo
## Custom function
You can also write your own function. Take a copy of `app/dist/invalidRequestHandler.js` from the image of the IPP
You can also write your own function. Take a copy of `/app/dist/invalidRequestHandler.js` from the image of the IPP
version you run, edit it, and mount it back into the container at the same path. A copy from an earlier major
version can fail to load.
+1 -1
View File
@@ -72,7 +72,7 @@ Language for the [`showExpiryDate`](#showexpirydate) date when the format uses n
Group the gallery's thumbnails by date, with a header above each group.
- `false` - no grouping (default).
- `"month"` - month headers like "December 2024".
- `"month"` - month headers like "December 2024". `true` means the same.
- `"day"` - day headers like "Wed, 25 Dec 2024" (matching Immich's own timeline format).
Grouping uses the date each photo was taken, as in Immich's own timeline. Groups follow the album's sort order in Immich, and newest first for shares without one. Photos with no date go under an "Undated" header at the end.
+1 -1
View File
@@ -55,7 +55,7 @@ Highest quality the lightbox loads when you zoom in past fit-to-screen.
`"original"` is not an option here, because an original can be a RAW or DNG file the browser cannot display.
This setting is independent of [`allowDownload`](#allowdownload): the download buttons can be off while zoom is on. The full-resolution image is only available when the share's own "Allow downloads" toggle in Immich is on, and the photo is a JPEG, PNG or WebP. For other formats, or shares with downloads off in Immich, the lightbox stays on the preview. To get full-resolution zoom without showing download buttons, leave downloads on in Immich and set [`allowDownload`](#allowdownload) to `0`.
This setting is independent of [`allowDownload`](#allowdownload): the download buttons can be off while zoom is on. The full-resolution image is only available when the share's own "Allow downloads" toggle in Immich is on; with it off, the lightbox stays on the preview. For a JPEG, PNG or WebP the zoom loads the original file. For other formats (RAW, HEIF, ...) it loads Immich's converted full-size image, which exists only if full-size previews are enabled in Immich's image settings; otherwise Immich serves the preview. To get full-resolution zoom without showing download buttons, leave downloads on in Immich and set [`allowDownload`](#allowdownload) to `0`.
## `motionPhotos`
+5 -3
View File
@@ -85,10 +85,11 @@ If IPP can't connect to Immich even though the container clearly can, you'll see
```
Unable to reach Immich on http://immich_server:2283
From the server IPP is running on, see if you can curl to http://immich_server:2283/api/server/ping and receive a JSON result.
From the container IPP is running in, run this and check you receive a JSON result: node -e "fetch('http://immich_server:2283/api/server/ping').then(r => r.text()).then(console.log).catch(console.error)"
Avoid testing with curl - curl uses its own DNS resolver and can succeed even when the resolver Node/IPP uses (musl getaddrinfo) fails.
```
yet running that same `curl` from a shell inside the container succeeds:
yet `curl` from a shell inside the container succeeds:
```
/app $ curl http://immich_server:2283/api/server/ping
@@ -99,7 +100,8 @@ This happens with both Docker Compose service names (like `immich_server`) and h
(for example an AdGuard Home or dnsmasq CNAME rewrite). The cause is the DNS lookup, not IPP: Node asks for the IPv4
and IPv6 addresses at once, and if your resolver answers the IPv6 query with `NXDOMAIN` instead of an empty `NOERROR`,
the Alpine base image fails the whole lookup even though the IPv4 address is fine. `curl` tolerates this, which is why
it works from a shell. The underlying error is `getaddrinfo ENOTFOUND`.
it works from a shell and why the log suggests the `node -e` command instead: it uses the same resolver as IPP, so it
fails the same way. The underlying error is `getaddrinfo ENOTFOUND`.
The reliable fix is to disable IPv6 for the container, so only the IPv4 lookup happens. Add the `sysctls` block to
your service in `docker-compose.yml`: