Immich Versions Save

High performance self-hosted photo and video management solution.

v1.102.0

2 weeks ago

v1.102.0

⚠️ Breaking Changes (OPT-IN ONLY)

[!Caution] For people always pulling the latest compose file, this is a breaking change! Disregarding the notes will result in (temporary) data loss!

Background

In the past, we've seen many cases where people accidentally deleted their Postgres data by (unintentionally) deleting the docker volume (e.g., docker compose down -V). This is unfortunate as there is no way to recover that data (if you don't have a backup, MAKE BACKUPS!). We have been thinking about mounting the Postgres data to a local folder for a while but always hesitated, as this would break existing instances due to people not reading the change logs carefully. However, there have been too many issues, and we ultimately decided to make that change.

What do I have to do?

Nothing. You should only copy the compose file with every new release if we tell you to do so in the release notes. Generally, we don't recommend making changes to existing instances. If you have never had issues, attempting to migrate the data will put it at (an unnecessary) risk.

I want to migrate my docker volume to a local folder

Unfortunately there isn't a "proper" way to export a docker volume. The recommended method is to mount the volume and the directory (you want to copy your data to) to an arbitrary container, get a shell inside that container and copy the folder manually.

[!Caution] Take backups before attempting this. Especially make sure you have a current database dump (pg_dump)

[!Warning] Do not use a directory under /mnt for the postgres location if you are using WSL. Generally (on all operating systems) we recommend against using a network share for your database location. This is bound to break and cause all sorts of weird issues.

If you would like to opt-in to this change, there is an additional environment variable in the .env file as well as a modification in your existing docker-compose.yml file.

docker-compose.yml file

  database:
    container_name: immich_postgres
    image: registry.hub.docker.com/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
    environment:
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_DB: ${DB_DATABASE_NAME}
    volumes:
-      - pgdata:/var/lib/postgresql/data  
+      - ${DB_DATA_LOCATION}:/var/lib/postgresql/data
    restart: always

volumes:
- pgdata:
  model-cache:

.env file

[...]
 DB_HOSTNAME=immich_postgres
 DB_USERNAME=postgres
 DB_DATABASE_NAME=immich
+DB_DATA_LOCATION=./postgres

Highlights

Welcome to release version v1.102.0 of Immich. We reached 30,000 stars!!! Thank you so much for your continuous support. We are proud to bring you this release with a focus on QoL improvements and bug fixes across the web, mobile, and server. We hope you enjoy it. Some of the highlighted changes can be found below.

  • In-app language settings
  • Haptic feedback control
  • Enhanced UI/UX on the album list page
  • AV1 transcoding
  • Choose between WebP and JPEG for thumbnails and previews
  • Option to use embedded preview in RAW images
  • Option to fill the screen with slideshows view

In-app language settings

You can now keep your phone interface in a different language and have Immich's app in a different language with the new in-app language setting. It can be found in Settings > Languages. After making the change, the new language will propagate across the app.

language-setting

Haptic feedback control

We added an option in the mobile app to disable haptic feedback. It can be found under Settings > Preferences > Haptic Feedback

image

Web album page's UI/UX enhancement

Album Grouping

With this new feature, albums can now be grouped by year or owner (or not grouped at all). This can be very useful to not get lost when having a lot of albums, that even are sometimes similar.

GroupFeature

  • This works both on "Covers" and "List" views.

GroupFeatureList

  • Albums are first grouped, then sorted inside of those groups.
  • Group sorting can be either ascending or descending.
  • Group by drop-down is located next to the Sort by one. The two buttons on the right are Expand all and Collapse all. They are not displayed when No grouping is selected.

GroupByDropdown

  • Groups can be collapsed (saved in the local storage).

https://github.com/immich-app/immich/assets/9944639/a137fafd-805d-4e27-a3cc-dd982db29df5

Other UI Changes

  • Album cards now display the month and year of the photos.
    • Same month and year: Jan 2024
    • Different months, same year: Jan - Mar 2024
    • Different year: Sep 2023 - Feb 2024
  • Album cards now display the title over up to 2 lines. If the title is longer, it is cropped with an ellipsis (no change).

AlbumCard

  • "Edit Album" modal design has been slightly changed.

EditAlbumModal

Quality of Life

Album List
  • The context menu now has 4 options: Download, Edit, Share and Delete.

AlbumContextMenu

  • The context menu can now be displayed by right-clicking on an album card.
  • The context menu is now available on the list view (both Edit and Remove buttons have been removed).
  • The context menu is now available on the "Sharing" page, with only 1 option: Download.
  • The search feature now ignores accents.
Album View
  • When one and only one photo is selected, the context menu now displays the option Set as album cover.

SetAsAlbumCover

AV1 transcoding

This release adds support for the next-gen AV1 format using the SVT-AV1 encoder. AV1 promises smaller files at the same quality as the other codecs we support, especially for high resolution videos. Note that client support for AV1 is more limited, so we recommend trying it on one (server-only) video and confirming it plays before transcoding your full library with it.

New image settings

image

Before this release, all preview images were JPEG, and all thumbnails were WebP. This is now customizable, so you can set them as you like. This also paves the way for adding other formats with minimal change.

There's also a new option to use the embedded preview in RAW images instead of converting the RAW image itself. This is particularly useful if the converted images from a camera don't look quite right or if you have custom-developed previews you'd like to use instead.

Option to fill the screen with slideshows view

We added a new option in the slideshow settings to fill the screen with the slideshow view, this will give you a more immersive viewing experience.

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

⚠️ Breaking Changes

🗄️ Server

📱 Mobile

🖥️ Web

⚡ CLI

📓 Documentation

🔨 Maintenance

Other changes

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.101.0...

v1.101.0

4 weeks ago

v1.101.0

Highlights

Welcome to release v1.101.0 of Immich. This release includes a new feature on the mobile app and minor enhancements across the server and the web, and we hope you like it.

Enhanced search on the mobile app

We have built a dedicated screen for a better search experience on the mobile app. You can now apply advanced filtering similar to the web's mechanism to find your desired photo.

Search enhancement mobile

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.100.0...

v1.100.0

1 month ago

v1.100.0

Highlights

Welcome to release v1.100.0, not yet v2.0 :stuck_out_tongue: of Immich. This release includes mostly bug fixes, code refactoring, and nice web QoL improvements. Some of the highlights include:

  • Ability to view different album ownership on the album page.
  • Better user experience when creating a new album.
  • Context menu items now come with associated icons.
  • Slideshow control improvement.
  • Added job metrics for Prometheus.
  • Notable fix: Scroll stickiness on the mobile app.

Album ownership toggle

On the album page on the web, you can now view all albums - i.e., shared or, owned or both - on the same page by using the toggle options.

https://github.com/immich-app/immich/assets/27055614/348b0605-6b4e-41cd-b9b7-12c64514c801

Better user experience when creating a new album

The notification on the web now includes a button to go to the album after you add new photos or videos to an album.

https://github.com/immich-app/immich/assets/27055614/d049b56b-ccf9-4ffd-975e-ce9cd3c08001

Context menu with associated icons

We added icons to the context menu to make the distinction between the options clearer.

image

Slideshow control improvement

After 10 seconds of inactivity, the cursor and control bar will be hidden, and a button will allow you to return to full screen.

Job metrics

You can now monitor the successful, skipped, and failed jobs for particular job types in Prometheus and the number of active jobs being processed in each queue.

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

⚡ CLI

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.99.0...v1.100.0

v1.99.0

1 month ago

v1.99.0

The new logo is now rolled out on all platforms, including the web, mobile, and documentation pages. If you are a content creator, you can grab the logo vector and raster files in the repository's design folder.

Social Preview

Highlights

Welcome to release v1.99.0 of Immich. This release adds the new logo, fixes many bugs, and improves the application. Some of the highlights include:

  • [WEB] Sort photos and videos to display direction in an album.
  • On-disk cache on the mobile app to provide a better viewing experience.
  • There is a new endpoint for OpenTelemetry metrics to monitor performance.
  • Optimized queries for large libraries.
  • Add upload progress and speed indicator.
  • XMP sidecar file is now recognized with both photo.ext.xmp and photo.xmp extensions.
  • Drag to select - Now press your thumb to drag and select in the selection mode.
  • Improve user feedback in the mobile app's backup and album selection screen.
  • Various improvements for the library scanning process.

Asset's display direction in the album

We added an option to change the order of the assets in the album so you can view the assets from older to newest and vice versa.

https://github.com/immich-app/immich/assets/27055614/7ed828c3-9bd1-4caa-8152-a7dc66a15cc5

Mobile asset caching

Improving cache for remote thumbnails and the images, they now stay on disk so that they can load faster and give a better experience while used offline. You should feel a faster loading experience across the app.

Performance monitoring with OpenTelemetry integration

Immich provides a variety of performance metrics to allow for local monitoring and insights. This integration is primarily in the form of Prometheus metrics. However, exporting traces is also possible due to OpenTelemetry instrumentation. Please visit the documentation to learn how to enable this feature

[!NOTE] This opt-in feature allows you to monitor Immich's performance. This data isn't sent anywhere beyond what you've configured.

File size progress and upload speed indicator

We added an indicator to show the file's size that has been uploaded and the upload speed under the progress bar in the backup screen.

https://github.com/immich-app/immich/assets/7256684/5f06adc6-bd7f-4d82-9750-ba8a14628821

Drag to select

You can now drag to select in the mobile app when in selection mode; this will help make selecting in bulk easier.

https://github.com/immich-app/immich/assets/139912620/e3c401bb-1221-4e33-acf2-de165ad30b38

And lastly, I want to express my gratitude to @immich-app/contributor who make this behemoth of a release happen 🎉

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

🧠 Machine Learning

⚡ CLI

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.98.2...v1.99.0

v1.98.2

1 month ago

v1.98.2

Hotfixes

  • Fixed an issue with the library re-scanning assets if the library has more than 65,000 assets.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.98.1...v1.98.2

v1.98.1

1 month ago

v1.98.1

Hotfixes

  • Fixed an issue with syncing the assets from the server on the mobile app
  • Fixed archive assets are not properly allocated on the mobile app
  • Fixed caching issue on the mobile app, causing jerkiness when scrolling on the timeline

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.98.0...

v1.98.0

1 month ago

v1.98.0

Announcement

The logo design contest has ended on March 4th, 2024.

We had an internal voting round with the core team members and contributors. The winner is @tyree, with the design below.

Tyree's design

We are planning to roll out the new logo in the near future.

Thank you all for your contributions and discussions. We are very happy to have such strong community engagement.

Highlights

Welcome to release v1.98.0 of Immich. We are pleased to introduce many new features, quality of life improvements and bug fixes in this release—some of the highlights below.

  • Move library settings to the Administration page - Simplify the external library setup process.
  • Context search with people filtering.
  • File name and file extension search.
  • Add an option to disable the required password change when creating a new user.
  • Show people in the information sheet on the mobile app.
  • A configurable timer is used to delete a user permanently.

Move library settings to the Administration page

We moved all library settings under the Admin settings to reduce the complexity of setting up external libraries and lay the groundwork for sharing external libraries between users.

image

Context search with people filtering

Thanks to @michelheusschen's help in solving the technical challenges of combining contextual search results with people filtering, it is now possible to search for "person in red dress" and choose only the people that you would like to see in a red dress.

You can now search for file name and file extension again as free text search. For example, you can search for all Nikon photos with NEF or nef, or search for file names such as IMG_1234.JPG with 123 or 234 as the search query.

image

Show people the information sheet on the mobile app.

You can now see the people detected in a photo/video in the detail sheet on the mobile app.

Option to disable required password change for new user creation

image

Configurable timer for user deletion

This setting can be found in the server settings in the Administration page. You can now adjust how long until a user gets permanently removed from the server.

image

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

🧠 Machine Learning

⚡ CLI

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.97.0...v1.98.0

v1.97.0

2 months ago

v1.97.0

Highlights

Welcome to release v1.97.0 of Immich. This release contains bug fixes and minor improvements in asset rendering on the mobile app.

  • Remove the polling option for library watcher due to the number of issues it brings outweighing the advantages
  • Fix the issue with the toggle button on the web app that doesn't conform to state change.
  • Fix the wrong aspect ratio of the preview image in the memory view

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.96.0...v1.97.0

v1.96.0

2 months ago

v1.96.0

Highlights

Welcome to release v1.96.0 of Immich. This release adds more enhancements for search, optimizes the mobile app and includes a handful of bug fixes. Some of the key highlights include:

  • Search filter form improvement
  • Search by location when editing the place for the asset.
  • Optimization of asset rendering on the mobile app.
  • Slideshow options (web)
  • Notable fix (mobile app): Stop sending users to the login page for unrelated authentication errors.
  • Notable fix: Smart Search when using OpenVINO.

Improved Search Form

After receiving users' feedback, we make the search filter a little more compact with minor UI/UX changes to make the process of selecting/deselecting the filter's content more intuitive.

search-filter

Search location when editing place for the asset.

We have implemented the lookup-on-type mechanism to quicky search for a location on the map when adding or edding location of the asset. This process happens entirely on your server

https://github.com/immich-app/immich/assets/27055614/7960d897-fc85-44f5-bbb0-03c6d16effa9

[Web] Slideshow options

We added additional options for the slideshow feature on the web, so you can make it fit your needs when showing of your gallery

image

Optimized asset rendering on the mobile app

We add a blur thumbnail loading step to help the transition from black/white placeholder to the image a more pleasant experience and fix a bug that sometimes the HTTP client would timeout and show the broken icon on the thumbnail.

https://github.com/immich-app/immich/assets/27055614/38c77700-4666-4686-bce2-8229203978d6

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

🧠 Machine Learning

📓 Documentation

🔨 Maintenance

New Contributors

Full Changelog: https://github.com/immich-app/immich/compare/v1.95.1...

v1.95.1

2 months ago

v1.95.1

Hotfixes

  • fixed search result not return correctly with the combination of not in album filter and context search
  • fixed search results return archived assets by default
  • fixed flashing issue in memory view on the mobile app
  • fixed presenting add to album modal removes the browser's scroll ability

Include the release note from v1.95.0 below for your convenience.

v1.95.0

[!WARNING]

⚠️ Breaking Changes ⚠️

Step 1: Change the docker-compose.yml database image from 0.1.11 to 0.2.0

[...]

  database:
    container_name: immich_postgres
-   image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee 
+   image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
    environment:
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_DB: ${DB_DATABASE_NAME}
    volumes:
      - pgdata:/var/lib/postgresql/data
    restart: always

[...]

Step 2: Perform docker compose pull

Step 3:

a) If Immich is a Postgres superuser (default)

Bring the stack up with docker compose up

When the server starts up, it will log a message like this:

WARN [DatabaseService] Could not run vector reindexing checks. If the extension was updated, please restart the Postgres instance.

warn

This is normal. Continue to Step 4.

b) If Immich is not a Postgres superuser

If Immich doesn't have superuser permissions, you'll need to bring up the database and run a few commands manually:

BEGIN;

CREATE SCHEMA IF NOT EXISTS vectors;
ALTER DATABASE immich SET search_path TO "$user", public, vectors;
SET search_path TO "$user", public, vectors;

UPDATE pg_catalog.pg_extension SET extversion = '0.1.11' WHERE extname = 'vectors';
UPDATE pg_catalog.pg_extension SET extrelocatable = true WHERE extname = 'vectors';
ALTER EXTENSION vectors SET SCHEMA vectors;
UPDATE pg_catalog.pg_extension SET extrelocatable = false WHERE extname = 'vectors';
ALTER EXTENSION vectors UPDATE TO '0.2.0';

SELECT pgvectors_upgrade();

COMMIT;

Step 4: Terminate and restart the stack

Bring the stack down (or terminate with ctrl + c) with:

docker compose down

Then bring it back up:

docker compose up

You'll run into a message saying:

[DatabaseRepository] Could not reindex index face_index. Attempting to auto-fix.

image

This is normal. The server will do some magic and start to work.

Step 5: Enjoy the new ✨search enhancements✨

2. OAuth encryption algorithm setting changes

OAuth setups using HS256 (mainly Authentik) will need to either (1) update the signing algorithm in Immich or (2) specify a signing key in the provider settings (so that it uses RS256 instead).

Specify a signing key in Authentik:

Screencast from 02-02-2024 12:05:04 AM.webm

New Immich OAuth Setting

image

Background

RS256 is generally better than HS256. RS256 is pretty much the most commonly used algorithm. The client library we use for open-id defaults to RS256. It's very easy to setup Authentik without specifying a signing key, which will default to use HS256. The original implementation added a hack/fallback to HS256 in some conditions to try to handle that situation. The current code removes the fallback, and adds a specific Signing Algortithm setting which can be explicitly set. Alternatively, the issue could be fixed by specifying a signing key in Authentik.

References:

Highlights

Welcome to version v1.95.0 of Immich. This is one of the longest stretches since the last release of Immich for the past year, we only had 150+ PRs merged since the last release. There are many new improvements and features in this release that we are very excited to introduce to you.

  • (Web) Search enhancement - Introduced filter to incorporate advanced search.
  • (Web) Improve user experience in search view - Infinite scrolling and justified layout in search result view.
  • (Web) Show partner's photos and videos on the map - Option to show shared partners assets on the map
  • (Mobile) Playing video in Memory view - Videos now auto play while viewing memories on the mobile app.
  • (Mobile) Gradient placeholder - A much more pleasant placeholder while scrolling through your timeline.
  • (Mobile) iOS background backup on WIFI option - The iOS mobile app can restrict your backups to only work while on WIFI.
  • Notable fix: Issue with unresponsive swiping in gallery view fixed on iOS.

Enhanced search feature

This feature is available on the Web only as of this release

This release adds a highly anticipated feature - advanced search with filters by date, location and more. What's more is that these filters are also compatible with smart search, so you can add text to sort by relevance at the same time.

Results are also no longer capped at 100 - scrolling down will fetch more and more assets.

filter

pgvector compatibility

As part of the upgrade to pgvecto.rs 0.2, we've also added pgvector support for environments where pgvecto.rs can't be used. Adding DB_VECTOR_EXTENSION=pgvector to the .env file will use pgvector instead (assuming your Postgres instance has pgvector installed). We'd like to give a special shoutout to the pgvecto.rs team for adding a compatibility mode that makes it easier for us to support both extensions.

Please note that the extension cannot be changed after a successful startup (i.e., migrations have run). This means you can't switch to pgvector from an existing instance with pgvecto.rs. It must be a new instance or an instance coming from 1.90.2 or older. Additionally, some features may not work quite as well with pgvector.

If you're upgrading from an old version of Immich, the migrations will take some time - don't worry if the server doesn't start up immediately.

Show partner's photos and videos on the map

This feature is available on the Web only as of this release

You can now toggle the option to include partners' assets on the map view.

Gradient placeholder on the mobile app

iOS background backup on WIFI option

You can now toggle this option only to allow background backup while the device is connected to the WIFI network.

External library import path validation

Several users struggle with getting import paths correct with external libraries. This version adds several checks and validations so that the user gets feedback on what went wrong.

image

CLI release

New CLI version 2.0.8. This version supports running inside Docker without needing Node.js installed, which helps on some platforms. Under the hood, it has been migrated to the new API version, uses vitest instead of jest, and has seen several improvements and bug fixes.

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

Please consider supporting the project.

Support

If you find the project helpful, you can support Immich via the following channels.

It is a great way to let me know that you want me to continue developing and working on this project for years to come.

What's Changed

🗄️ Server

📱 Mobile

🖥️ Web

Full Changelog: https://github.com/immich-app/immich/compare/v1.95.0...