2.2 KiB
Configuration
Tip
You can see all of the configurable options by looking at the default config.json. A description of each option is on the pages in this section.
Connection settings (the Immich URL, public URL, port and config file location) are
environment variables. Everything else is JSON config under ipp.*, grouped into:
- General options - downloads, zoom quality, slug links, the upload link, response headers.
- Gallery - how the gallery page is rendered.
- Lightbox - the PhotoSwipe image viewer.
- Metadata - description / EXIF / location reveal controls.
- Error responses - customise what invalid requests return.
- Upload service - the optional container that lets visitors send photos back.
- Renamed config keys - old keys and their current names.
How to provide a config override
Note
You only need to include the keys you're changing. Anything you omit keeps its default, and the defaults are always the most privacy-respecting option. In particular the metadata groups are per-field opt-in: nothing is exposed until you set its flag to
true, including fields IPP adds in future versions.
There are two ways to supply custom config. If both are present, CONFIG wins and the file is not read.
Mount a file
Recommended for anything non-trivial. Make a copy of config.json next to your docker-compose.yml, edit it, then add a volume:
volumes:
- ./config.json:/app/config.json
Restart the container and your custom configuration becomes active.
Inline via env var
For one-off or single-key overrides, pass the configuration inline from your docker-compose.yml using the CONFIG environment variable:
environment:
PUBLIC_BASE_URL: https://your-proxy-url.com
IMMICH_URL: http://your-internal-immich-server:2283
CONFIG: |
{
"ipp": {
"showHomePage": false
}
}