Update docs
This commit is contained in:
+13
-13
@@ -19,9 +19,9 @@ Serve full-resolution images both when zooming in the lightbox and when download
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
Change the headers sent with your web responses. The default is a 30-day `Cache-Control` and a permissive CORS header.
|
||||
These apply to photos, videos and static files. The "download all" zip is always sent with `Cache-Control: no-store`
|
||||
to prevent CDN issues, and the gallery page uses its own [`gallery.cacheTime`](/config/gallery#cachetime).
|
||||
Change the headers sent with photos, videos and static files. The default is a 30-day `Cache-Control` and a
|
||||
permissive CORS header. The "download all" zip is always sent with `Cache-Control: no-store`, and the gallery page
|
||||
uses its own [`gallery.cacheTime`](/config/gallery#cachetime).
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -51,11 +51,11 @@ Highest quality served for a download (the download button and "download all" zi
|
||||
Highest quality the lightbox loads when you zoom in past fit-to-screen.
|
||||
|
||||
- `"preview"` - keep the preview (default; zoom is capped to the preview's real pixels).
|
||||
- `"fullsize"` - upgrade to the full-resolution browser-displayable image on zoom, à la the Immich web viewer.
|
||||
- `"fullsize"` - load the full-resolution browser-displayable image on zoom, like the Immich web viewer.
|
||||
|
||||
`"original"` is intentionally not an option (it could be an unviewable RAW/DNG or a huge file).
|
||||
`"original"` is not an option here, because an original can be a RAW or DNG file the browser cannot display.
|
||||
|
||||
**Independent of [`allowDownload`](#allowdownload)** - your download UI can be off while zoom is on. It only does anything where Immich can serve full resolution: the share's **own** "allow downloads" toggle in Immich must be on (the full-res image comes from the original file, which Immich gates on that toggle), and the format must be **web-displayable** (JPEG/PNG/WebP). Otherwise (RAW/HEIF, or a share with Immich downloads off) the lightbox stays on the preview. To enable zoom-up, leave the Immich share's download permission on and use [`allowDownload`](#allowdownload) to control whether the download buttons appear.
|
||||
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`.
|
||||
|
||||
## `motionPhotos`
|
||||
|
||||
@@ -87,7 +87,7 @@ The filename of the downloaded image.
|
||||
|
||||
**Type:** `int` · **Default:** `0`
|
||||
|
||||
Show the download UI - the "download all" zip, the multi-select download, and the per-asset download button in the lightbox. Purely a UI switch; it has no effect on image quality (see [`maxZoomQuality`](#maxzoomquality) / [`maxDownloadQuality`](#maxdownloadquality)).
|
||||
Show the download buttons: the "download all" zip, the multi-select download, and the download button in the lightbox. This only shows or hides the buttons; image quality is set by [`maxDownloadQuality`](#maxdownloadquality) and [`maxZoomQuality`](#maxzoomquality).
|
||||
|
||||
- `0` - downloads off.
|
||||
- `1` - follow the Immich share's own download setting ([example](https://github.com/user-attachments/assets/79ea8c08-71ce-42ab-b025-10aec384938a)).
|
||||
@@ -96,13 +96,13 @@ Show the download UI - the "download all" zip, the multi-select download, and th
|
||||
The bulk-zip and per-asset buttons can be toggled independently once downloads are allowed - see [`gallery.showDownloadZip`](/config/gallery#showdownloadzip) and [`lightbox.showDownload`](/config/lightbox#showdownload).
|
||||
|
||||
> [!NOTE]
|
||||
> With `2`, IPP shows the download UI even on shares whose **own** download toggle in Immich is off - but Immich still refuses to serve those shares' original files, so IPP works around it where it can:
|
||||
> With `2`, IPP shows the download buttons even on shares whose own download toggle in Immich is off. Immich still refuses to serve those shares' original files, so on such a share:
|
||||
>
|
||||
> - **Videos** are downloaded as the transcoded playback file instead of the original (the same stream the visitor can already watch). The filename extension follows the transcoded format, typically `.mp4`.
|
||||
> - **Photos** download normally as long as [`maxDownloadQuality`](#maxdownloadquality) is below `original`; with `maxDownloadQuality: original` they fail, because the original file is exactly what Immich is refusing to serve.
|
||||
> - **Gifs** always download as the original file (their preview is a static frame), so they fail on these shares.
|
||||
> - **Videos** download as the playback version, usually an `.mp4`, instead of the original.
|
||||
> - **Photos** download at [`maxDownloadQuality`](#maxdownloadquality) if it is below `original`. With `original` they fail.
|
||||
> - **Gifs** always download as the original file, so they fail.
|
||||
>
|
||||
> To guarantee full-quality downloads of everything, leave the share's download permission on in Immich.
|
||||
> To be sure every download works at full quality, leave the share's download permission on in Immich.
|
||||
|
||||
## `uploadUrl`
|
||||
|
||||
@@ -110,7 +110,7 @@ The bulk-zip and per-asset buttons can be toggled independently once downloads a
|
||||
|
||||
Where the optional upload service (the `immich-public-proxy-upload` container) is served. A share whose "Allow public user to upload" option is on in Immich then shows an "Add photos" button in the gallery header, which opens that share's page on the upload service. To set up the service, see [Let visitors send photos back](/visitor-uploads).
|
||||
|
||||
- **A path**, such as the default `/upload`, means the service is on IPP's own hostname under that path. Before showing the button, the gallery page checks that the upload service answers `ok` at `<path>/healthcheck`, so an install without the upload container never shows a dead button. When nothing is routed there, IPP answers that path itself with an empty 204 rather than a 404, so the check is neither a browser console error nor a hit on the [404 policy](/config/error-responses).
|
||||
- **A path**, such as the default `/upload`, means the service is on IPP's own hostname under that path. Before showing the button, the gallery page checks that the upload service answers `ok` at `<path>/healthcheck`, so an install without the upload container never shows a dead button. When nothing is routed there, IPP answers that path itself with an empty 204.
|
||||
- **An absolute URL**, such as `https://upload.example.com`, means the service has a hostname of its own. It is trusted without a check. The URL may include a path, such as `https://photos.example.com/upload`, which points at the same place as the default but without the check.
|
||||
- **An empty string** never shows the button.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user