v3.2.0-rc.1

[danieldietzler]

Warning

Disclaimer

This is a release candidate, not a stable release. It is subject to change and may contain bugs or breaking changes. As always, make sure you have a backup of your database and library before upgrading to this version.

Welcome to the first release candidate of v3.2; v3.2.0-rc.1! Due to redoing the way we do releases, we had to sacrifice rc.0 unfortunately 😅. But, we are now able to backport changes from main to older releases. Especially, that also means no more PR merge freezes after a release, in case we need to release any patch fixes.

Release notes

Work-in-progress release notes can be found here:

https://pr-737.dev.immich.app/blog/v3.2.0-release

Server

To use this RC version on the server, update the IMMICH_VERSION in your .env file:

IMMICH_VERSION=v3.2.0-rc.1

or

IMMICH_VERSION=v3-rc

Then pull and restart:

docker compose pull && docker compose up -d

Mobile

To use this RC version on the mobile app, follow the appropriate link for your platform:

Android

You can download the APK in the release note below, or tap on "Join the beta" from the Google Play Immich page

iOS

The iOS app is available via Testflight: https://testflight.apple.com/join/JTSTucBd

If you run into any issues, please report them on GitHub so we can address them before the final release. Thank you for helping us test!

And as always, bugs are fixed, and many other improvements also come with this release.

What's Changed

🚀 Features

• feat: workflow logging by @benbeckford in feat: workflow logging #29878
• feat(web): new search ui by @benbeckford in feat(web): new search ui #30279
• feat: new config endpoints by @jrasm91 in feat: new config endpoints #30881
• feat: cluster groups by @jrasm91 in feat: cluster groups #30739
• feat: asset file apis by @jrasm91 in feat: asset file apis #25900
• feat: memories view by @benbeckford in feat: memories view #28675
• feat(mobile): show asset owner in asset details by @Lauritz-Tieste in feat(mobile): show asset owner in asset details #29302
• feat(server): new search API by @timonrieger in feat(server): new search API #30179

🌟 Enhancements

• feat: store null instead of empty string for album.description by @gPinato in feat: store null instead of empty string for album.description #30123
• feat: log hint about downgrades when migration is missing by @bo0tzz in feat: log hint about downgrades when migration is missing #30493
• feat(web): search album description in add-to-album modal by @djadji-gueye in feat(web): search album description in add-to-album modal #30462
• feat: Display the number of selected items in AlbumPickerModal title by @statox in feat: Display the number of selected items in AlbumPickerModal title #30485
• feat(widget): add toggle to match icon theme by @bwees in feat(widget): add toggle to match icon theme #30428
• feat: workflow asset tag trigger/filter/action by @benbeckford in feat: workflow asset tag trigger/filter/action #29043
• feat: iOS dynamic background ids by @mikes1991gh in feat: iOS dynamic background ids #30574
• feat: actions undo handling by @shenlong-tanwen in feat: actions undo handling #30481
• feat: rotate an API key by @bwees in feat: rotate an API key #30801
• fix(cli): enforce node engine version on start by @bo0tzz in fix(cli): enforce node engine version on start #30437
• chore(server): migrate library e2e tests by @etnoy in chore(server): migrate library e2e tests #27277
• feat: add oauth account management url by @sacha-c in feat: add oauth account management url #30873
• feat(web): tag renaming v2 by @jorbrock in feat(web): tag renaming v2 #27909
• chore: search filter animation improvement and reactive search cue example by @alextran1502 in chore: search filter animation improvement and reactive search cue example #30866
• perf(web): use hash-wasm SHA-1 with pure-JS fallback for upload hashing by @mosh-dev in perf(web): use hash-wasm SHA-1 with pure-JS fallback for upload hashing #30107
• fix: don't swallow fetch errors by @bo0tzz in fix: don't swallow fetch errors #30496
• feat(mobile): map asset number by @YarosMallorca in feat(mobile): map asset number #28911
• feat: allow users to re-run facial recognition for their group by @danieldietzler in feat: allow users to re-run facial recognition for their group #30965
• feat(web): view assets in map viewport by @rickytrevor in feat(web): view assets in map viewport #27492

🐛 Bug fixes

• fix: make sure iOS memory widget render by @alextran1502 in fix: make sure iOS memory widget render #30172
• fix: calendar heatmap permissions by @danieldietzler in fix: calendar heatmap permissions #30310
• fix: calendar heatmap api key permissions by @danieldietzler in fix: calendar heatmap api key permissions #30314
• fix(deployment): matplotlib in rootless deployments by @mmomjian in fix(deployment): matplotlib in rootless deployments #30328
• fix(mobile): refresh person thumbnail when the featured photo changes by @santoshakil in fix(mobile): refresh person thumbnail when the featured photo changes #29350
• fix: assetFileFilter path matching by @benbeckford in fix: assetFileFilter path matching #30394
• fix: shared check for server setup availability by @bo0tzz in fix: shared check for server setup availability #30311
• fix(mobile): resolve owned assets when partner owns identical asset by @agg23 in fix(mobile): resolve owned assets when partner owns identical asset #30137
• fix(web): Fix face thumbnail when swapping merge direction by @lhvy in fix(web): Fix face thumbnail when swapping merge direction #30466
• fix(server): reject invalid or deleted user when creating a partner by @djadji-gueye in fix(server): reject invalid or deleted user when creating a partner #30431
• fix(server): remove the asset row when an upload fails after creating it by @santoshakil in fix(server): remove the asset row when an upload fails after creating it #30349
• fix(mobile): correct mislabeled Bengali locale entry by @DrHaque in fix(mobile): correct mislabeled Bengali locale entry #30519
• fix(mobile): sync stack changes from the websocket by @santoshakil in fix(mobile): sync stack changes from the websocket #30479
• fix: metadata extraction as LensModel can be a float by @danieldietzler in fix: metadata extraction as LensModel can be a float #30512
• fix(mobile): run one more sync round when a request arrives mid sync by @santoshakil in fix(mobile): run one more sync round when a request arrives mid sync #30478
• fix: use setRequireOriginal on SDK 29 and above by @shenlong-tanwen in fix: use setRequireOriginal on SDK 29 and above #29072
• fix(mobile): stale local renders after editing a photo on device by @santoshakil in fix(mobile): stale local renders after editing a photo on device #30415
• fix(mobile): stop websocket reconnect loop draining battery when server is unreachable by @santoshakil in fix(mobile): stop websocket reconnect loop draining battery when server is unreachable #29901
• fix(mobile): stop long images squishing on ios by @santoshakil in fix(mobile): stop long images squishing on ios #29367
• fix(mobile): keep backup remainder from going negative by @santoshakil in fix(mobile): keep backup remainder from going negative #29011
• fix(mobile): handle asset websocket events by @santoshakil in fix(mobile): handle asset websocket events #30499
• fix(mobile): stop disabling androidx.startup initializers by @shenlong-tanwen in fix(mobile): stop disabling androidx.startup initializers #30559
• fix: map not updating after viewing an asset by @shenlong-tanwen in fix: map not updating after viewing an asset #30601
• fix(deployment): Add huggingface cache directory to Dockerfile by @mmomjian in fix(deployment): Add huggingface cache directory to Dockerfile #30357
• fix(mobile): video playback controls dead for backed up videos opened from search by @santoshakil in fix(mobile): video playback controls dead for backed up videos opened from search #30587
• fix(mobile): decode remote thumbnails at displayed size by @santoshakil in fix(mobile): decode remote thumbnails at displayed size #29965
• fix(mobile): don't let a frozen sync block syncing on resume by @santoshakil in fix(mobile): don't let a frozen sync block syncing on resume #29870
• fix: face label clipping by @danieldietzler in fix: face label clipping #30712
• fix: owner cascade delete album by @danieldietzler in fix: owner cascade delete album #30692
• fix(mobile): prevent iOS status bar scroll to top during transitions by @agg23 in fix(mobile): prevent iOS status bar scroll to top during transitions #30717
• fix(mobile): disable iOS smart quotes/dashes in email/password inputs by @agg23 in fix(mobile): disable iOS smart quotes/dashes in email/password inputs #30767
• fix(mobile): prevent snapping to center on pinch-to-zoom release (Pinch to zoom centers the image #29207) by @cmdPromptCritical in fix(mobile): prevent snapping to center on pinch-to-zoom release (#29207) #29343
• fix: shared link create validation by @danieldietzler in fix: shared link create validation #30762
• fix(mobile): mark finished downloads complete instead of leaving them stuck by @santoshakil in fix(mobile): mark finished downloads complete instead of leaving them stuck #29023
• fix: freeze on navigating back album description by @YarosMallorca in fix: freeze on navigating back album description #30781
• fix(server): guard createAll against empty values list by @tech00exploere in fix(server): guard createAll against empty values list #30837
• fix(server): respect backpressure in the sync stream by @enol5423 in fix(server): respect backpressure in the sync stream #30764
• fix(server): update ocr & faces after asset edit by @YarosMallorca in fix(server): update ocr & faces after asset edit #29303
• fix(mobile): resend an upload once when the connection dies before a response by @santoshakil in fix(mobile): resend an upload once when the connection dies before a response #30843
• fix(mobile): cannot deep link to memory lane (Cannot deep link to memory lane #30634) by @nikhilpodila in fix(mobile): cannot deep link to memory lane (#30634) #30787
• fix: redis cli ping command by @mmomjian in fix: redis cli ping command #30329
• fix(server): do not throw on unparsable DB_URL when building backup arguments by @NoiceHax in fix(server): do not throw on unparsable DB_URL when building backup arguments #30759
• fix(server): Sort stacked assets by creation date by @timonrieger in fix(server): Sort stacked assets by creation date #24033
• fix(web): gracefully handle map errors when WebGL is disabled by @meesfrensel in fix(web): gracefully handle map errors when WebGL is disabled #26538
• fix(server): unicode email validation by @YarosMallorca in fix(server): unicode email validation #30871
• fix(mobile): order album/place/person timelines by local date by @santoshakil in fix(mobile): order album/place/person timelines by local date #29338
• chore(mobile): update flutter-maplibre-gl to 0.27.0 by @agg23 in chore(mobile): update flutter-maplibre-gl to 0.27.0 #30892
• fix(web): download archives via html POST forms by @diogotcorreia in fix(web): download archives via html POST forms #30021
• fix(server): library exclusion patterns can soft-delete assets outside their directory by @PAtreju in fix(server): library exclusion patterns can soft-delete assets outside their directory #30850
• fix(mobile): dedupe stale remote_asset rows on sync by @santoshakil in fix(mobile): dedupe stale remote_asset rows on sync #28445
• fix(server): correct asset dimensions from exif metadata by @fuergaosi233 in fix(server): correct asset dimensions from exif metadata #29244
• fix: quote database owner in restore by @danieldietzler in fix: quote database owner in restore #30905
• fix(mobile): permanently delete local copies when moving to the locked folder by @santoshakil in fix(mobile): permanently delete local copies when moving to the locked folder #29730
• fix(server): let a second metadata extraction replace stored AV metadata by @RxChi1d in fix(server): let a second metadata extraction replace stored AV metadata #30900
• fix: do not exit search screen on back during multiselect by @YarosMallorca in fix: do not exit search screen on back during multiselect #30689
• fix(mobile): respect 24h system setting by @YarosMallorca in fix(mobile): respect 24h system setting #30792
• fix: maintentance return URL sanitization by @bwees in fix: maintentance return URL sanitization #30948
• fix: remove partner assets from existing memories by @shenlong-tanwen in fix: remove partner assets from existing memories #28950
• fix(server): correct tag create operations by @jorbrock in fix(server): correct tag create operations #30877
• fix: thumbnail generation for specific SVGs by @danieldietzler in fix: thumbnail generation for specific SVGs #30908
• fix(mobile): aspect ratio change by @ferraridamiano in fix(mobile): aspect ratio change #30939
• fix: throw a typed error on malformed api responses by @bo0tzz in fix: throw a typed error on malformed api responses #31006
• fix(web): restore timeline scroll when the asset id cannot be resolved by @thejeff77 in fix(web): restore timeline scroll when the asset id cannot be resolved #30916
• fix(web): do not play memory video if the MemoryVideoViewer element is not visible by @Zlendy in fix(web): do not play memory video if the MemoryVideoViewer element is not visible #30947
• fix(web): preserve slideshow pause state when viewing video slides by @tech00exploere in fix(web): preserve slideshow pause state when viewing video slides #30278
• fix: draggable Immich logo by @danieldietzler in fix: draggable Immich logo #31055
• fix(server): kill pg_dump when a backup fails so it stops holding table locks by @justadityaraj in fix(server): kill pg_dump when a backup fails so it stops holding table locks #30851
• fix(web): misleading toast notification by @brn-lin in fix(web): misleading toast notification  #30976
• fix(web): map by @jrasm91 in fix(web): map #31056
• fix: external library statistics for excluded assets by @stevenjoezhang in fix: external library statistics for excluded assets #28462
• feat: same-second photos now sub-sort by filename by @andydotmp3 in feat: same-second photos now sub-sort by filename #29528

📚 Documentation

• fix(docs): remove listing unraid as an "official" deployment by @mmomjian in fix(docs): remove listing unraid as an "official" deployment #30323
• fix(docs): Revise config file instructions and notes by @mmomjian in fix(docs): Revise config file instructions and notes #30418
• docs: fix identity provider examples in oauth guide by @fredrikekre in docs: fix identity provider examples in oauth guide #30828
• docs: Update backup script to match manual/automatic backups by @Quantum-Cucumber in docs: Update backup script to match manual/automatic backups #26810
• docs: update remote-machine-learning.md by @Aviatorpaal in docs: update remote-machine-learning.md #28728

🌐 Translations

• feat: add cantonese for mobile by @danieldietzler in feat: add cantonese for mobile #30318
• chore(web): update translations by @weblate in chore(web): update translations #30296

New Contributors

• @jaegeral made their first contribution in fix: minor typos #30385
• @deveshkolte made their first contribution in fix(server): store null instead of empty string for user password #30223
• @gPinato made their first contribution in feat: store null instead of empty string for album.description #30123
• @lhvy made their first contribution in fix(web): Fix face thumbnail when swapping merge direction #30466
• @djadji-gueye made their first contribution in feat(web): search album description in add-to-album modal #30462
• @DrHaque made their first contribution in fix(mobile): correct mislabeled Bengali locale entry #30519
• @statox made their first contribution in feat: Display the number of selected items in AlbumPickerModal title #30485
• @ihmcsm made their first contribution in fix: typos in debug log messages #30742
• @baseballyama made their first contribution in chore: speed up lint ~4x by enabling svelte-eslint-parser's ts.sys hook #30782
• @enol5423 made their first contribution in fix(server): respect backpressure in the sync stream #30764
• @mikes1991gh made their first contribution in feat: iOS dynamic background ids #30574
• @nikhilpodila made their first contribution in fix(mobile): cannot deep link to memory lane (#30634) #30787
• @fredrikekre made their first contribution in docs: fix identity provider examples in oauth guide #30828
• @NoiceHax made their first contribution in fix(server): do not throw on unparsable DB_URL when building backup arguments #30759
• @Quantum-Cucumber made their first contribution in docs: Update backup script to match manual/automatic backups #26810
• @sacha-c made their first contribution in feat: add oauth account management url #30873
• @PAtreju made their first contribution in fix(server): library exclusion patterns can soft-delete assets outside their directory #30850
• @fuergaosi233 made their first contribution in fix(server): correct asset dimensions from exif metadata #29244
• @jorbrock made their first contribution in feat(web): tag renaming v2 #27909
• @RxChi1d made their first contribution in fix(server): let a second metadata extraction replace stored AV metadata #30900
• @mosh-dev made their first contribution in perf(web): use hash-wasm SHA-1 with pure-JS fallback for upload hashing #30107
• @thejeff77 made their first contribution in fix(web): restore timeline scroll when the asset id cannot be resolved #30916
• @brn-lin made their first contribution in fix(web): misleading toast notification  #30976
• @Aviatorpaal made their first contribution in docs: update remote-machine-learning.md #28728
• @stevenjoezhang made their first contribution in fix: external library statistics for excluded assets #28462
• @andydotmp3 made their first contribution in feat: same-second photos now sub-sort by filename #29528
• @rickytrevor made their first contribution in feat(web): view assets in map viewport #27492
• @immich-push-o-matic[bot] made their first contribution in fix: run codeql and weblate checks on release branches #31066

Full Changelog: v3.1.0...v3.2.0-rc.1

[nkrabben]

From the release notes, I didn't understand what resetting the facial recognition for a cluster would involve. Since the time to reset that data can be significant, I want to make sure I understand it before trying it out.

If we create a cluster, does the first member get to retain their IDs? If not, does that mean that I have to rename and remerge all of the identified face groups? Will manually added face boxes and person clusters remain?

I'm not sure if other people will be as confused as I, but it feels like that part of the note could use a rewrite or additional signposting about the potential for data loss.

[jrasm91]

It is similar to the admin job that does the same thing, just isolated to the users in the group. I believe mentally tagged faces are not impacted.

[nkrabben]

First, please never correct that typo. It's nice to have the Immich looking after my mental acuity.

Second, if I understand right, the process for joining a cluster would include

• losing all non-manual detected faces and any associated name/bday data
• renaming and merging the newly detected faces

I have to figure out how much time that data migration will take. I have 300+ names. That feels like a big enough hassle to wait and see on future migration features.