From 96c32bf26242c627a70b9ead4ea039fdbe200d5e Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Mon, 16 Feb 2026 21:53:22 +1300 Subject: [PATCH] #151 #96 Add album descriptions --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 229df42..e249f73 100644 --- a/README.md +++ b/README.md @@ -149,18 +149,19 @@ Alternatively, you can [pass the configuration inline](docs/inline-configuration ### Immich Public Proxy options -| Option | Type | Description | -|-------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `responseHeaders` | `object` | Change the headers sent with your web responses. By default there is `cache-control` and CORS added. | -| `singleImageGallery` | `bool` | By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item. | -| `downloadOriginalPhoto` | `bool` | Set to `false` if you only want people to be able to download the 'preview' quality photo, rather than your original photo. | -| `downloadedFilename` | `int` | The filename of the downloaded image.
`0` for the original filename if available, falling back to the Immich asset ID
`1` for the Immich asset ID number
`2` for a shortened version of the asset ID: `img_` plus the first 8 characters of the asset ID | -| `showGalleryTitle` | `bool` | Show a title on the gallery page. | -| `allowDownloadAll` | `int` | Allow visitors to download all files as a zip.
`0` disable downloads
`1` follow Immich setting per share ([example](https://github.com/user-attachments/assets/79ea8c08-71ce-42ab-b025-10aec384938a))
`2` always allowed | -| `allowSlugLinks` | `bool` | Enable/disable the custom URL links. | -| `showHomePage` | `bool` | Set to `false` to remove the IPP shield page at `/` and at `/share` | -| `showMetadata` | `object` | See the [Metadata](#metadata) section below. | -| `customInvalidResponse` | various | Send a custom response instead of the default 404 - see [Custom responses](docs/custom-responses.md) for more details. | +| Option | Type | Description | +|--------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `responseHeaders` | `object` | Change the headers sent with your web responses. By default there is `cache-control` and CORS added. | +| `singleImageGallery` | `bool` | By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item. | +| `downloadOriginalPhoto` | `bool` | Set to `false` if you only want people to be able to download the 'preview' quality photo, rather than your original photo. | +| `downloadedFilename` | `int` | The filename of the downloaded image.
`0` for the original filename if available, falling back to the Immich asset ID
`1` for the Immich asset ID number
`2` for a shortened version of the asset ID: `img_` plus the first 8 characters of the asset ID | +| `showGalleryTitle` | `bool` | Show a title on the gallery page. This is taken from the album title if it is an album being shared, otherwise the "Description" from the shared link will be used. | +| `showGalleryDescription` | `bool` | Show the album description below the title. This only applies if it is an album which is being shared. | +| `allowDownloadAll` | `int` | Allow visitors to download all files as a zip.
`0` disable downloads
`1` follow Immich setting per share ([example](https://github.com/user-attachments/assets/79ea8c08-71ce-42ab-b025-10aec384938a))
`2` always allowed | +| `allowSlugLinks` | `bool` | Enable/disable the custom URL links. | +| `showHomePage` | `bool` | Set to `false` to remove the IPP shield page at `/` and at `/share` | +| `showMetadata` | `object` | See the [Metadata](#metadata) section below. | +| `customInvalidResponse` | various | Send a custom response instead of the default 404 - see [Custom responses](docs/custom-responses.md) for more details. | For example, to disable the home page at `/` and at `/share` you need to change `showHomePage` to `false`: