alangrainger/immich-public-proxy v2.4.0

2.4.0

on GitHub

A non-breaking but important change to the config format from 2.3.0

Yesterday I released 2.3.0 which added a sidebar and allowed you to show EXIF and other metadata.

@mFIND rightly pointed out in #244 that if you turned on the master enabled switch, new fields in future versions of Immich would automatically be enabled. This is the opposite of what we want as a default (new, unknown fields should be off), so I had to make a new release to reverse all of that.

Under the new configuration style you must opt-in to each individual field. Yes it's more verbose, but it protects against a future Immich field appearing in your production IPP without you realising.

{
  "ipp": {
    "showMetadata": {
      "exif": { 
        "make": true,
        "model": true,
        "lensModel": true,
        "exposureTime": true,
        "iso": true,
      },
      "location": { 
        "city": true,
        "country": true
      }
    }
  }
}

Migration

A compatibility shim runs at startup so existing 2.3.0 configs keep working without edits, and a deprecation notice is logged at startup. Legacy ipp.showMetadata.{exif,location}.enabled is rewritten in memory like so:

• enabled: true defaults every unset per-field flag in the group to true, matching the old "everything visible" behaviour. Per-field flags you had explicitly set to false (the "all except X" pattern) are preserved.
• enabled: false clears any per-field flags that were true, matching the old "nothing visible" behaviour and stopping leftover documentation flags from the shipped 2.3.0 config.json from becoming live opt-ins on upgrade.