NixOS Wiki

Immich: Difference between revisions

← Older edit
VisualWikitext
drop 24.05 compat
Arnecc (talk | contribs)
4 edits
added fixes for 25.05 upgrade issue
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[https://immich.app Immich] is an open source photo and video management solution, designed to provide a self-hosted alternative for managing and backing up photos and videos, with a focus on privacy and ease of use.
[https://immich.app Immich] is a self-hosted photo and video management solution.


== Setup ==
== Installation ==
To install Immich, add the following to your NixOS configuration:
{{file|/etc/nixos/configuration.nix|nix|3=services.immich.enable = true;
services.immich.port = 2283;}}
More options are available: {{nixos:option|services.immich.}}


The following example configuration will enable Immich locally.
== Tips and Tricks ==


{{file|/etc/nixos/configuration.nix|nix|3=services.immich = {
=== Enabling Hardware Accelerated Video Transcoding ===
  enable = true;
Add the Immich user to the <code>render</code> and <code>video</code> groups, override the <code>PrivateDevices</code> service config setting to allow the service to access <code>/dev/dri/</code> and enable [[Accelerated Video Playback]] on your system:{{file|/etc/nixos/configuration.nix|nix|3=# `null` will give access to all devices.
  environment.IMMICH_MACHINE_LEARNING_URL = "http://localhost:3003";
# You may want to restrict this by using something like `[ "/dev/dri/renderD128" ]`
services.immich.accelerationDevices = null;
 
hardware.graphics = {
# ...
# See: https://wiki.nixos.org/wiki/Accelerated_Video_Playback
};
};
}}To see more options, visit the [https://search.nixos.org/options?channel=unstable&query=services.immich Immich module's options page].


After applying the above configuration you will be able to access Immich at http://localhost:2283.
users.users.immich.extraGroups = [ "video" "render" ]; }}
 
=== Using Immich behind Nginx ===


=== Hardware Accelerated Transcoding using VA-API ===
This is a typical [[Nginx]] configuration for Immich:
Before anything else, make sure you have configured hardware acceleration on your system as described in [[Accelerated Video Playback]].
{{file|/etc/nixos/configuration.nix|nix|3=services.nginx.virtualHosts."immich.example.com" = {
  enableACME = true;
  forceSSL = true;
  locations."/" = {
    proxyPass = "http://[::1]:${toString config.services.immich.port}";
    proxyWebsockets = true;
    recommendedProxySettings = true;
    extraConfig = ''
      client_max_body_size 50000M;
      proxy_read_timeout  600s;
      proxy_send_timeout  600s;
      send_timeout        600s;
    '';
  };
};
}}
== Troubleshooting ==


To make use of hardware accelerated video transcoding using VA-API,  add your Immich user to the <code>render</code> and <code>video</code> groups.
=== Fixing postgresql database issue after 25.05 upgrade ===


If you are using the default <code>immich</code> user, you can use the following snippet to enable VA-API support.{{file|/etc/nixos/configuration.nix|nix|3=users.users.immich.extraGroups = [ "video" "render" ];
==== Postgresql collation version mismatch ====
}}
After upgrading you might run into an issue like this, leading to immich-server continuously failing and restarting: <syntaxhighlight>Jul 01 14:23:12 server2 immich[178592]: Postgres notice: {
Jul 01 14:23:12 server2 immich[178592]:  severity_local: 'WARNING',
Jul 01 14:23:12 server2 immich[178592]:  severity: 'WARNING',
Jul 01 14:23:12 server2 immich[178592]:  code: '01000',
Jul 01 14:23:12 server2 immich[178592]:  message: 'database "immich" has a collation version mismatch',
Jul 01 14:23:12 server2 immich[178592]:  detail: 'The database was created using collation version 2.39, but the operating system provides version 2.40.',
Jul 01 14:23:12 server2 immich[178592]:  hint: 'Rebuild all objects in this database that use the default collation and run ALTER DATABASE immich REFRESH COLLATION VERSION,>
Jul 01 14:23:12 server2 immich[178592]:  file: 'postinit.c',
Jul 01 14:23:12 server2 immich[178592]:  line: '477',
Jul 01 14:23:12 server2 immich[178592]:  routine: 'CheckMyDatabase'
Jul 01 14:23:12 server2 immich[178592]: }</syntaxhighlight>To fix this, run <code>sudo -u immich psql -d immich</code> and execute these to commands:<syntaxhighlight lang="sql" line="1">
ALTER DATABASE immich REFRESH COLLATION VERSION;
REINDEX DATABASE immich;
</syntaxhighlight>
 
==== Upgrading pgvecto.rs ====
If you still run into issues after restarting postgresql and immich-server services, some additional postgresql database changes might be necessary to [https://web.archive.org/web/20240910231531/https://docs.pgvecto.rs/admin/upgrading.html#upgrading upgrade pgvecto.rs table]:
 
Run <code>sudo -u postgresql psql</code> and execute consecutively:<syntaxhighlight lang="sql" line="1">
CREATE EXTENSION IF NOT EXISTS unaccent;
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";  
CREATE EXTENSION IF NOT EXISTS vectors;
CREATE EXTENSION IF NOT EXISTS cube;
CREATE EXTENSION IF NOT EXISTS earthdistance;
CREATE EXTENSION IF NOT EXISTS pg_trgm;
ALTER EXTENSION vectors UPDATE;
SELECT pgvectors_upgrade();
</syntaxhighlight>Finally, restart postgresql and immich: <code>systemctl restart postgresql && systemctl restart immich-server</code>
[[Category:Server]]
[[Category:Server]]
[[Category:Web Applications]]
[[Category:Web Applications]]
Retrieved from "https://wiki.nixos.org/wiki/Immich"