Immich: Difference between revisions

Revision as of 22:21, 6 November 2024

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.

Setup

Note: The module is not yet part of the latest NixOS stable release (24.05) and is only available in unstable.

The following example configuration will enable Immich locally.

/etc/nixos/configuration.nix

services.immich = {
  enable = true;
  environment.IMMICH_MACHINE_LEARNING_URL = "http://localhost:3003";
};

To see more options, visit the Immich module's options page.

After applying the above configuration you will ba able to access Immich at http://localhost:3001.

Hardware Accelerated Transcoding using VA-API

Before anything else, make sure you have configured hardware acceleration on your system as described in Accelerated Video Playback.

To make use of hardware accelerated video transcoding using VA-API, add your Immich user to the render and video groups.

If you are using the default immich user, you can use the following snippet to enable VA-API support.

/etc/nixos/configuration.nix

users.users.immich.extraGroups = [ "video" "render" ];

@@ Line 1: / Line 1: @@
-[https://immich.app Immich] is an open-source software, 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 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.
 == Setup ==
-{{Note|The module is not yet part of the latest NixOS stable release and is currently in a PR at https://github.com/NixOS/nixpkgs/pull/324127}}
+{{Note|The module is not yet part of the latest NixOS stable release (24.05)  and is only available in unstable.}}
-The following example configuration will enable Immich locally
+The following example configuration will enable Immich locally.
 {{file|/etc/nixos/configuration.nix|nix|3=services.immich = {
@@ Line 11: / Line 11: @@
    environment.IMMICH_MACHINE_LEARNING_URL = "http://localhost:3003";
 };
-}}After applying the configuration you can access the instance via http://localhost:3001.
+}}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 ba able to access Immich at http://localhost:3001.
 === Hardware Accelerated Transcoding using VA-API ===
-First make sure you have configured hardware acceleration on your system as described in [[Accelerated Video Playback]].
+Before anything else, make sure you have configured hardware acceleration on your system as described in [[Accelerated Video Playback]].
+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.
-To make use of hardware accelerated video transcoding using VA-API, make sure to add your Immich user to the <code>render</code> and <code>video</code> groups. 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" ];
+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" ];
 }}
 [[Category:Server]]
 [[Category:Web Applications]]