Files
immich-magic-proxy/docs/config/index.md
T
Alan Grainger 6b0b193961 Docs WIP
2026-07-24 11:58:29 +12:00

2.1 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.

All options live under ipp.*, grouped into:

How to provide a config override

Note

You only need to include the keys you're changing. Anything you omit keeps its default. The defaults in IPP are always the most privacy-respecting option.

There are two ways to supply custom config.

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
        }
      }

How options are organised

All options live under ipp.*. The metadata groups (ipp.showMetadata.exif, ipp.showMetadata.location) are per-field opt-in: every field is off until you explicitly set its flag to true. Nothing is automatically exposed - including fields IPP adds in future versions.

You only need to include the keys you're changing. Anything you omit keeps its default.