immich-public-proxy

v3.0.0 Breaking

This release includes breaking changes for platform teams planning a safe upgrade.

Published 27d Media Servers

View tool

✓ No known CVEs patched

Read the diff → Tool health → What is this tool? →

✓ No known CVEs patched in this version

Affected surfaces

breaking_upgrade

Summary

AI summary

Adds configurable lightbox zoom, changes mouse‑scroll behavior, and renames two config keys with deprecation shims.

Full changelog

Compatible with Immich v3

This release adds compatibility with the upcoming Immich 3.0. It will still remain compatible with Immich 2.x #256

Changes

#162 #258 Allow zooming to fullsize image in the lightbox (configurable). IMPORTANT: due to how Immich works, you can only zoom to fullsize if the Immich album allows downloads. There is no way for IPP to get access to the full-size image if downloads are disabled in Immich.
Zoom is now via mouse scroll rather than Alt + scroll, to match Immich behaviour.

Config changes

Two new keys for controlling the image quality:

| Key | Values | Default | Purpose |
|---|---|---|---|
| maxZoomQuality | preview | fullsize | preview | Quality the lightbox loads on zoom |
| maxDownloadQuality | preview | fullsize | original | original | Quality a download serves |

Two renames - old keys still work via a startup deprecation notice (shims removed in v4.0):

allowDownloadAll → allowDownload (same 0/1/2). Now purely the download-UI switch (zip + multi-select + per-asset button); no effect on image quality.
downloadOriginalPhoto → maxDownloadQuality (true → "original", false → "preview").

See docs/configuration.md for the full table and migration notes.

View diff on GitHub

Weekly OSS security release digest.

The CVE patches and breaking changes that affected production tools this week. One email, every Sunday.

No spam, unsubscribe anytime.

Share this release

Share on X Share on Bluesky

Track immich-public-proxy

Get notified when new releases ship.

About immich-public-proxy

Share your Immich photos and albums in a safe way without exposing your Immich instance to the public.

All releases →

Related context

Related tools

Earlier breaking changes

v2.4.0 Configuration format changed to require explicit per-field opt‑ins for metadata display.
v2.2.0 Deprecates `?password=...` query-param for shared links; requires Immich v2.6.0 or later.
v2.1.0 Removes dynamic public URL setting via HTTP header in IPP config.
v2.0.0 Gallery title now shown by default; hide with showTitle=false in config.json