v3.0.0 · immich-app immich · Discussion #29439

alextran1502 · GitHub

37 min read Original article ↗

v3.0.0

Welcome to Immich v3.0.0!

After months of hard work from the team and our amazing contributors, we're thrilled to announce the next major version of Immich: v3.0.0! 🎉

Breaking changes

This release includes several breaking changes; read the full migration guide here. It's worth mentioning that many of the breaking changes are updates to API endpoints and affect only third-party tools that integrate with Immich's API. For the vast majority of users, updating works exactly as it always has.

How to update

First, update the IMMICH_VERSION in your .env file to v3:

- IMMICH_VERSION=v2
+ IMMICH_VERSION=v3

Then run the usual update commands:

docker compose pull && docker compose up -d

Release candidates

If you missed it, v3.0.0 was the first time we used release candidates, also known as prereleases. Release candidates are tested but not yet official releases of Immich, and they allow us to find and fix any outstanding bugs before a final release. If you would like to be notified about release candidates directly through Immich, you can change the release channel from "Stable" to "Release candidate" in the Admin settings > Version check options (here).

New release channel option in version check settings

New Merch

As part of this release, we're happy to announce we also have some new swag for you!

  • Kids clothing: For those who are likely the reason for your Immich library's size
  • Colored embroidery: We now have clothes with a full color embroidered Immich logo
immich-store (1)

Check it out now at https://immich.store!

Highlights

Now, let's get right into all the new features in this release:

  • Mobile non-destructive editing
  • Workflows (preview)
  • Background backup improvement
  • Recently added page
  • Integrity checks
  • Slideshow on mobile app
  • HLS and real-time video transcoding (preview)
  • New video player for web
  • Open photo in Immich as gallery on Android
  • OCR on mobile app
  • Upload asset directly to album on the mobile app
  • Option to select image size when sharing on the mobile app
  • Timeline performance improvement for browsing a large amount of assets in a single month

Mobile non-destructive editing

image

This is a follow-up to Image Editing on the web, which was released in v2.5.0. This feature allows you to make non-destructive edits to your photos inside of Immich. Until now, the mobile editor used a completely different system that created new assets instead of editing the photo in place.

With this update, we bring a new, easier-to-use editor to mobile devices that has the same features as the web version. You can now edit photos directly in the mobile app, including cropping, rotating, and adjusting your images without ever touching the original file. Similar to the web, edits are non-destructive, so you can revisit or revert them at any time. You can even make edits on mobile and then adjust them on the web later!

Some features from the previous mobile editing implementation have been removed including:

  • Recoloring photos
  • Editing live photos
  • Editing local assets

We have plans to bring some of these capabilities back in future releases.

Workflows (preview)

The first preview of Workflows is here! Workflows let you automate actions in your library by chaining triggers, filters, and actions together with a drag-and-drop builder. This is the foundation for many exciting automations to come, and we'd love your feedback as we continue building on it.

You can access the feature from Utilities > Workflows on the web.

Workflows link on the utilities page

From there, you can either create a new blank workflow or browse the premade templates to get a basic understanding of how workflows can be used.

image

Workflows editor

Workflow editor with an example workflow

In the workflows editor, you can switch between the Visual or JSON editor. The visual editor is nice for building out the workflow; the JSON editor is nice for sharing and receiving workflow content from others.

In each workflow, there is a trigger and a sequence of steps.

  • Trigger: this is the entry point of each workflow; when the trigger occurs, the steps are evaluated.
  • Steps: they include Filters (conditions) and Actions (effects); they can be combined to produce the desired effect of the use case you aim for.

List of available workflow steps

Sharing a workflow

You can share the workflow you made with others in two ways: text and JSON. Text is nice for sharing on a forum or for show-and-tell content. JSON is nice for others to make an exact copy of your workflow's configuration.

You can copy the text in the workflows summary panel on the lower right of the screen

workflow summary in text

You can share the JSON content from the copy workflows button in the app bar, switch to the JSON editor, or use the Show schema button in the context menu in the workflows list

JSON editor Show workflow schema

Note

Please use this discussion thread to propose new ideas of triggers and actions. We are looking for extensive feedback and suggestions from you all.

Background backup improvements

Background backup on Android is now significantly more reliable. Previously, the background backup on Android was limited to newly taken photos. Now, the app uses a new periodic task scheduler, which allows you to upload your entire library in the background, and it plays nicer with Android's background execution limits, properly cleans up tasks, and warns you when battery optimization and notification settings might interfere with backups.

On iOS, the background refresh task now runs its sync and upload work in parallel, so uploads actually start within the short time window iOS allows.

Enable backup option on mobile

Recently added page

A new "Recently Added" page on the web and mobile lets you browse your library sorted by when assets were added to Immich, rather than when they were taken. This makes it easier to find what's new when browsing a new batch of imports. You can find the new page in the "Explore" tab on the web and in the "Search" tab on mobile.

Recently added

Integrity checks

The maintenance page has gotten a new addition: integrity reports! Immich will scan its directories on your file system, and compare it to what it has stored in its database. If there are deviations, they will be surfaced as

  • untracked, if there is a file in Immich's directories that Immich does not know of
  • missing, if Immich references a file in its database that does not exist in that place (anymore)
  • a checksum mismatch, if the checksum of the file on disk does not match the checksum Immich has stored for that file. Typically, this would happen through file corruption but could also be the result of a bad rename.
Integrity report on the maintenance page showing a count of untracked and missing files, as well as checksum mismatches.

You can configure when and how long the job runs each night.

image

Slideshow (mobile)

The slideshow experience comes to mobile! You can now sit back and let your photos and videos play across the screen, just like on the web.

Slideshow view on mobile

HLS and Real-Time Video transcoding (preview)

Immich can now transcode videos on-the-fly without needing to generate offline transcodes. This has been a long-requested feature with many benefits:

  • Quality switching (both manual and automatic)
  • Transcoding to the best codecs supported by the client
  • Lower storage overhead when offline transcoding is disabled
  • HDR for compatible clients (not implemented yet)
  • Remuxing rather than transcoding the original when bandwidth allows it (not implemented yet)

Please note that this feature is still experimental and can change behavior from version to version. It's currently only implemented in the web app, with the mobile app implementation in progress.

To enable real-time transcoding, go to the video transcoding settings (scroll down). Offline transcoding isn't directly affected by enabling it, so if you'd like to disable offline transcoding, you should also adjust the transcode policy.

Note

For assets imported prior to v3, you will also need to re-run Metadata Extraction in the job panel for them to be re-processed.

HLS Transcoding settings

Keep in mind that your server needs to be powerful enough to transcode in real-time for this feature to work well. Hardware acceleration is recommended, but not required, when using this feature.

New video player for web

A new custom video player on the web app ensures all your devices share the same controls and layout, matching the Immich design. Some basic functions, like changing the playback rate, are available. This should also fix a lot of the problems on iOS, where the OS's controls are hidden behind the Immich navbar.

Open photos in Immich as a gallery on Android

Immich can now act as a gallery/image viewer app on Android. Tap a photo or video in another app, choose Immich, and it opens directly in the asset viewer with options to share the file or upload it to your library.

This is the first iteration of the feature, and refinements to how Immich recognizes files that are already in your library are on the way

image image

OCR on the mobile app

The asset viewer now has a toggle that highlights recognized text in a photo, and you can select and copy it directly from the image.

OCR in the mobile app

Upload assets directly to an album on mobile

You can now upload local photos directly to an album in the mobile app, including from the asset bottom sheet, instead of uploading first and organizing later. A small change that removes a lot of friction from the backup-and-organize flow.

Select image size when sharing on mobile

When sharing photos from the mobile app, you can now choose the image size before sending; it is handy for keeping shared files small for messaging apps while preserving the option to share at full quality when needed.

You can change the default behavior in the App Settings > Preferences

Share file's size settings

You can also pick the option when sharing on-the-fly by long pressing the Share button

On-the-fly picker

Timeline performance Improvements

Browsing months with a large number of assets is now dramatically smoother and prevents the browser tab from locking up when your instance encounters that scenario.

Support Immich

If you find the project helpful, you can support Immich by purchasing a product key at https://buy.immich.app or our merchandise at https://immich.store

What's Changed

🚨 Breaking Changes

🫥 Deprecated Changes

🔒 Security

🚀 Features

🌟 Enhancements

🐛 Bug fixes

📚 Documentation

🌐 Translations

New Contributors

Full Changelog: v2.7.5...v3.0.0

This discussion was created from the release v3.0.0.