immich/docs
Charlie Savage 2e1fd4555b feat(server): export faces to xmp sidecars
Adds an opt-in `metadata.faces.export` setting. When enabled, the people
Immich knows about are written to an asset's XMP sidecar as
`mwg-rs:RegionInfo` whenever its faces change, so external libraries stay
in sync with naming, merging, reassigning and deleting people.

Turning the setting on writes out every asset that already has a named
person, so it does not appear to do nothing until faces happen to change.

Only faces that resolve to a named person are written, and regions are
removed from a sidecar only when it already has them, so a sidecar is
never created just to hold an empty list.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-10 22:08:37 -07:00
..
docs feat(server): export faces to xmp sidecars 2026-08-10 22:08:37 -07:00
src fix: privacy policy link (#30344) 2026-07-28 21:12:10 -04:00
static fix: privacy policy link (#30344) 2026-07-28 21:12:10 -04:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
.prettierignore ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js fix: privacy policy link (#30344) 2026-07-28 21:12:10 -04:00
mise.lock fix(deps): update typescript-projects (#29633) 2026-07-16 20:14:05 +02:00
mise.toml fix(deps): update typescript-projects (#30305) 2026-07-31 12:55:30 +02:00
package.json chore(deps): update dependency typescript to v7 (#29903) 2026-07-21 13:36:57 +02:00
README.md chore: update docs to use pnpm (#21113) 2025-08-21 15:25:05 -05:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js fix: privacy policy link (#30344) 2026-07-28 21:12:10 -04:00
tsconfig.json chore(deps): update dependency typescript to v6 (#27577) 2026-04-07 17:15:55 +02:00

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ pnpm install

Local Development

$ pnpm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ pnpm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true pnpm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> pnpm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.