Check the config reference pages against config.json when the docs build

This commit is contained in:
Alan Grainger
2026-10-08 21:52:34 +13:00
parent 360c46fbc8
commit 19e10337b8
12 changed files with 656 additions and 35 deletions
+4
View File
@@ -1,3 +1,7 @@
---
prefix: ipp.gallery
---
# Gallery
Options that control how the gallery page is rendered. Configured under `ipp.gallery`.
+5 -1
View File
@@ -1,3 +1,7 @@
---
prefix: ipp
---
# General options
Top-level options under `ipp.*` that don't belong to the [Gallery](/config/gallery), [Lightbox](/config/lightbox) or [Metadata](/config/metadata) groups.
@@ -174,6 +178,6 @@ Description / EXIF / location reveal controls. See [Metadata](/config/metadata).
## `customInvalidResponse`
**Type:** various
**Type:** `various` · **Default:** `false`
Send a custom response instead of the default 404. See [Error responses](/config/error-responses).
+4
View File
@@ -1,3 +1,7 @@
---
prefix: ipp.lightbox
---
# Lightbox
The gallery's lightbox is powered by [PhotoSwipe](https://photoswipe.com/). Configured under `ipp.lightbox`.
+29 -25
View File
@@ -1,3 +1,7 @@
---
prefix: ipp.showMetadata
---
# Metadata
Configured under `ipp.showMetadata`. The lightbox includes a slide-in info sidebar (toggle with the **i** key or the info button in the toolbar) that surfaces whatever metadata you opt into here.
@@ -46,10 +50,10 @@ The info sidebar and its toolbar button only appear when at least one field is t
Under `ipp.showMetadata.description`.
| Option | Type | Description |
|-----------|--------|-------------------------------------------------------------|
| `caption` | `bool` | Show the description below the photo as a lightbox caption. |
| `sidebar` | `bool` | Show the description at the top of the info sidebar. |
| Option | Type | Default | Description |
|-----------|--------|---------|-------------------------------------------------------------|
| `caption` | `bool` | `false` | Show the description below the photo as a lightbox caption. |
| `sidebar` | `bool` | `false` | Show the description at the top of the info sidebar. |
Set both to show in both places; set neither and the description is not included at all.
@@ -57,29 +61,29 @@ Set both to show in both places; set neither and the description is not included
Under `ipp.showMetadata.exif`. Every flag defaults to `false`.
| Option | Type | Description |
|--------------------|--------|------------------------------------------------------------------------------------------------------------------|
| `dateTimeOriginal` | `bool` | Show the date the photo was taken (per EXIF), in the photographer's local time - matching Immich's own sidebar. |
| `timeZone` | `bool` | Show and use the photo's timezone when formatting the date. Only applies when `dateTimeOriginal` is also enabled. |
| `fileName` | `bool` | Show the original filename. |
| `dimensions` | `bool` | Show width x height and megapixel count. |
| `fileSize` | `bool` | Show the file size. |
| `make` | `bool` | Camera manufacturer (e.g. "Canon"). |
| `model` | `bool` | Camera model (e.g. "EOS R5"). |
| `lensModel` | `bool` | Lens model. |
| `exposureTime` | `bool` | Shutter speed (e.g. "1/200"). |
| `iso` | `bool` | ISO sensitivity. |
| `fNumber` | `bool` | Aperture f-number. |
| `focalLength` | `bool` | Focal length in millimetres. |
| Option | Type | Default | Description |
|--------------------|--------|---------|-------------------------------------------------------------------------------------------------------------------|
| `dateTimeOriginal` | `bool` | `false` | Show the date the photo was taken (per EXIF), in the photographer's local time - matching Immich's own sidebar. |
| `timeZone` | `bool` | `false` | Show and use the photo's timezone when formatting the date. Only applies when `dateTimeOriginal` is also enabled. |
| `fileName` | `bool` | `false` | Show the original filename. |
| `dimensions` | `bool` | `false` | Show width x height and megapixel count. |
| `fileSize` | `bool` | `false` | Show the file size. |
| `make` | `bool` | `false` | Camera manufacturer (e.g. "Canon"). |
| `model` | `bool` | `false` | Camera model (e.g. "EOS R5"). |
| `lensModel` | `bool` | `false` | Lens model. |
| `exposureTime` | `bool` | `false` | Shutter speed (e.g. "1/200"). |
| `iso` | `bool` | `false` | ISO sensitivity. |
| `fNumber` | `bool` | `false` | Aperture f-number. |
| `focalLength` | `bool` | `false` | Focal length in millimetres. |
## Location group
Under `ipp.showMetadata.location`. Every flag defaults to `false`, except `webLink` which defaults to `true`.
| Option | Type | Description |
|-----------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `city` | `bool` | Show city. |
| `state` | `bool` | Show state / region. |
| `country` | `bool` | Show country. |
| `gps` | `bool` | Show GPS coordinates. |
| `webLink` | `bool` | Show an "Open in OpenStreetMap" link below the coordinates. The link does not pass the share URL on to the map provider. Has no effect unless `gps` is also `true`. Default `true`. |
| Option | Type | Default | Description |
|-----------|--------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `city` | `bool` | `false` | Show city. |
| `state` | `bool` | `false` | Show state / region. |
| `country` | `bool` | `false` | Show country. |
| `gps` | `bool` | `false` | Show GPS coordinates. |
| `webLink` | `bool` | `true` | Show an "Open in OpenStreetMap" link below the coordinates. The link does not pass the share URL on to the map provider. Has no effect unless `gps` is also `true`. |
+4
View File
@@ -1,3 +1,7 @@
---
prefix: ipp.upload
---
# Upload service
Settings for the optional upload service, the `immich-public-proxy-upload` container, which lets visitors send photos