Update docs

This commit is contained in:
Alan Grainger
2026-10-07 14:53:14 +13:00
parent b1dab610a4
commit daa099aca1
8 changed files with 69 additions and 99 deletions
+2 -2
View File
@@ -108,9 +108,9 @@ The bulk-zip and per-asset buttons can be toggled independently once downloads a
**Type:** `string` · **Default:** `""`
The public URL of the optional upload service (the `immich-public-proxy-upload` container), for example `https://upload.example.com`. When it is set, a share whose "Allow public user to upload" option is on in Immich shows an "Add photos" button in the gallery header. The button opens that share's page on the upload service. Leave it empty to show no button.
The public URL of the optional upload service (the `immich-public-proxy-upload` container), for example `https://photos.example.com/upload`. When it is set, a share whose "Allow public user to upload" option is on in Immich shows an "Add photos" button in the gallery header. The button opens that share's page on the upload service. Leave it empty to show no button.
The value is the same as the upload service's [`PUBLIC_BASE_URL`](/config/upload-service#public-base-url). To set up the service, see [Let visitors send photos back](/visitor-uploads).
The value is wherever your reverse proxy serves the upload service, with the path if it has one. To set up the service, see [Let visitors send photos back](/visitor-uploads).
## `allowSlugLinks`
+5 -10
View File
@@ -26,16 +26,7 @@ Accept files up to 2 GB, and send a notification to a Gotify server for each sto
## Environment variables
`IMMICH_URL`, `IPP_PORT`, `IPP_CONFIG` and `CONFIG` mean the same as for IPP; see
[Environment variables](/config/environment-variables). `IMMICH_URL` is required. The service has two more:
### `PUBLIC_BASE_URL`
**Required**
The public URL of the upload service, for example `https://upload.example.com`. If it includes a path, such as
`https://photos.example.com/upload`, the service serves its pages under that path, and the reverse proxy must forward
the path unchanged. The healthcheck is served at `/healthcheck` at the root as well, so a container healthcheck works
either way.
[Environment variables](/config/environment-variables). `IMMICH_URL` is required. The service has one more:
### `GALLERY_URL`
@@ -44,6 +35,10 @@ either way.
The public URL of IPP, for example `https://photos.example.com`. When set, the upload page has a back button to the
share's gallery.
The service has no setting for its own public URL. It serves its pages both under `/upload` and at the root, so the
reverse proxy decides where it lives: a path on the IPP hostname (`photos.example.com/upload`) or a hostname of its
own (`upload.example.com`). See [Route it through your reverse proxy](/visitor-uploads#route-it-through-your-reverse-proxy).
## Options
### `maxFileSize`