High performance self-hosted photo and video management solution. immich.app
Go to file
trommegutten 7e6cd48783
docs: improve and clarify XMP sidecar behavior (#20334)
* docs: improve and clarify XMP sidecar behavior

- Simplified and reorganized the documentation for XMP sidecars
- Clearly separated CLI import vs. external library behavior
- Clarified what metadata fields are stored in the database
- Documented filename rules and storage behavior
- Explained write-back behavior, including permission requirements

* Clarify sidecar write-back behavior for external libraries

Updated documentation to reflect that Immich does not write metadata to sidecar files in external libraries unless the mount is writable.

Mentions silent fail behavior as described in Issue #10538.

* Update xmp-sidecars.md

* Refactor section 1: clarify XMP fields Immich reads and writes

- Rewrote section 1 with a simplified 3-column table: Metadata · Writes to · Reads from
- Corrected date field logic with prioritized read order
- Clarified that Immich only updates fields that have changed
- Removed incorrect mention of dc:title

* docs: clarify tag reading priority (TagsList, HierarchicalSubject, IPTC:Keywords)

Updated the documentation for tag metadata extraction to clarify the prioritized order in which Immich reads tags from imported media:

1. digiKam:TagsList
2. lr:HierarchicalSubject
3. IPTC:Keywords

This reflects the actual logic used in the getTagList()
2025-09-11 14:00:53 +00:00
.devcontainer fix(devcontainer): logging typo (#21415) 2025-08-29 20:54:42 +00:00
.github chore: 10 minute timeout for translations merge (#21810) 2025-09-11 13:22:25 +02:00
.vscode chore: use pnpm for builds (#19752) 2025-08-19 08:55:24 -04:00
cli chore: remove unused dependencies (#21736) 2025-09-09 20:38:17 -04:00
deployment chore(deps): update terraform cloudflare to v4.52.3 (#21701) 2025-09-09 10:18:26 +01:00
design chore: update readme screenshot (#8182) 2024-03-22 04:31:36 +00:00
docker chore(deps): update docker.io/valkey/valkey:8-bookworm docker digest to fea8b3e (#21281) 2025-09-10 08:36:44 -04:00
docs docs: improve and clarify XMP sidecar behavior (#20334) 2025-09-11 14:00:53 +00:00
e2e fix: prefer Creation Date over Create Date (#21756) 2025-09-09 22:58:46 -04:00
fastlane Added required setup for f-droid (#88) 2022-03-29 14:13:47 -05:00
i18n chore(web): update translations (#21624) 2025-09-11 10:28:48 +00:00
machine-learning fix(deps): update machine-learning (#21704) 2025-09-10 14:51:11 -04:00
misc/release fix: fix docker perms for dev (#21359) 2025-08-28 22:07:29 -04:00
mobile fix: repeat timeline migration for first time user (#21794) 2025-09-10 16:27:00 -05:00
open-api chore: deprecate (#21791) 2025-09-10 15:35:41 -04:00
readme_i18n chore: update README (#21718) 2025-09-10 08:28:01 -04:00
server fix(server): validate token permission (#21802) 2025-09-11 08:09:58 -04:00
web fix(web): map in album shared link (#21793) 2025-09-10 20:19:43 +00:00
.dockerignore chore: dockerfile layout changes (#19673) 2025-07-18 17:56:26 -04:00
.editorconfig chore: linting (#7532) 2024-02-29 11:26:55 -05:00
.gitattributes chore: do not render drift migration auto gen files (#20060) 2025-07-21 16:48:22 -05:00
.gitignore feat(web): use timeline in geolocation manager (#21492) 2025-09-09 21:26:26 -04:00
.gitmodules chore: update submodule (#11789) 2024-08-14 22:06:11 +00:00
.pnpmfile.cjs fix: isolate docker host/container filesystem for node_modules and build output (#21167) 2025-08-24 13:09:45 -05:00
CODE_OF_CONDUCT.md Added Code of conduct 2024-07-05 15:31:13 +00:00
CODEOWNERS chore: @danieldietzler web codeowners (#21813) 2025-09-11 14:28:20 +02:00
install.sh fix: bash install.sh script for mac os (#15874) 2025-02-03 16:41:42 -06:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
Makefile fix: docker upload_location perm fix for dev (#21501) 2025-09-03 18:27:30 +01:00
mise.lock feat: use mise for core dev tools (#21566) 2025-09-04 12:58:42 -04:00
mise.toml chore(deps): update node.js to v22.19.0 (#21509) 2025-09-05 08:43:58 -04:00
package.json chore: use pnpm for builds (#19752) 2025-08-19 08:55:24 -04:00
pnpm-lock.yaml fix(web): memory viewer arrow navigation (#19400) 2025-09-10 09:47:38 -04:00
pnpm-workspace.yaml chore(deps): bump sharp to 0.34.3 (#21596) 2025-09-04 13:23:13 -05:00
README.md chore: remove demo box spec from README.md (#17367) 2025-04-03 18:09:29 -04:00
renovate.json chore: shared renovate configuration (#16903) 2025-03-25 14:56:54 +00:00
SECURITY.md chore: use immich.app email for security reports (#10594) 2024-06-24 07:25:48 -07:00


License: AGPLv3 Discord

High performance self-hosted photo and video management solution



Català Español Français Italiano 日本語 한국어 Deutsch Nederlands Türkçe 中文 Українська Русский Português Brasileiro Svenska العربية Tiếng Việt ภาษาไทย

Disclaimer

  • ⚠️ The project is under very active development.
  • ⚠️ Expect bugs and breaking changes.
  • ⚠️ Do not use the app as the only way to store your photos and videos.
  • ⚠️ Always follow 3-2-1 backup plan for your precious photos and videos!

Note

You can find the main documentation, including installation guides, at https://immich.app/.

Demo

Access the demo here. For the mobile app, you can use https://demo.immich.app for the Server Endpoint URL.

Login credentials

Email Password
demo@immich.app demo

Features

Features Mobile Web
Upload and view videos and photos Yes Yes
Auto backup when the app is opened Yes N/A
Prevent duplication of assets Yes Yes
Selective album(s) for backup Yes N/A
Download photos and videos to local device Yes Yes
Multi-user support Yes Yes
Album and Shared albums Yes Yes
Scrubbable/draggable scrollbar Yes Yes
Support raw formats Yes Yes
Metadata view (EXIF, map) Yes Yes
Search by metadata, objects, faces, and CLIP Yes Yes
Administrative functions (user management) No Yes
Background backup Yes N/A
Virtual scroll Yes Yes
OAuth support Yes Yes
API Keys N/A Yes
LivePhoto/MotionPhoto backup and playback Yes Yes
Support 360 degree image display No Yes
User-defined storage structure Yes Yes
Public Sharing Yes Yes
Archive and Favorites Yes Yes
Global Map Yes Yes
Partner Sharing Yes Yes
Facial recognition and clustering Yes Yes
Memories (x years ago) Yes Yes
Offline support Yes No
Read-only gallery Yes Yes
Stacked Photos Yes Yes
Tags No Yes
Folder View Yes Yes

Translations

Read more about translations here.

Translation status

Repository activity

Activities

Star history

Star History Chart

Contributors