Nix Podman Stacks
Search K

Appearance

immich ​

Photo and video management solution

Example ​

nix
{config, lib, ...}: {
  nps.stacks.immich = {
    enable = true;

    oidc = {
      enable = true;
      clientSecretFile = config.sops.secrets."immich/authelia/client_secret".path;
      clientSecretHash = "$pbkdf2-sha512$...";
    };
    db.passwordFile = config.sops.secrets."immich/db_password".path;

    settings = {
      oauth.autoLaunch = true;
      passwordLogin.enabled = false;
    };
  };
}

Stack Options ​

nps.stacks.immich.containers.immich ​

Alias of {option}services.podman.containers.immich.

Type
plaintext
submodule
Declaration
<nps/modules/immich>

nps.stacks.immich.containers.immich-db ​

Alias of {option}services.podman.containers.immich-db.

Type
plaintext
submodule
Declaration
<nps/modules/immich>

nps.stacks.immich.containers.immich-machine-learning ​

Alias of {option}services.podman.containers.immich-machine-learning.

Type
plaintext
submodule
Declaration
<nps/modules/immich>

nps.stacks.immich.containers.immich-redis ​

Alias of {option}services.podman.containers.immich-redis.

Type
plaintext
submodule
Declaration
<nps/modules/immich>

nps.stacks.immich.db.passwordFile ​

Path to the file containing the database password

Type
plaintext
absolute path
Declaration
<nps/modules/immich>

nps.stacks.immich.enable ​

Whether to enable immich.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/immich>

nps.stacks.immich.oidc.adminGroup ​

Users of this group will be assigned admin rights in Immich. The role is only used on user creation and not synchronized after that.

See https://immich.app/docs/administration/oauth/

Type
plaintext
string
Default
nix
"immich_admin"
Declaration
<nps/modules/immich>

nps.stacks.immich.oidc.clientSecretFile ​

The file containing the client secret for the OIDC client that will be registered in Authelia.

For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type
plaintext
string
Example
nix
config.sops.secrets."immich/authelia/client_secret".path"
Declaration
<nps/modules/immich>

nps.stacks.immich.oidc.clientSecretHash ​

The client secret hash. For examples on how to generate a client secret, see https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

The value can be passed in multiple ways:

  1. As a literal string
  2. As an absolute path to a file containing the hash (toFile)
  3. As an absolute oath to a file containing the client_secret, in which case the hash will be automatically computed (toHash)
  4. As null

If left unset (null), the client secret will be read from the file specified in the clientSecretFile option and hashed automatically before being passed to the Authelia container.

Type
plaintext
null or string or (submodule)
Default
nix
null
Example
nix
# Literal String:
"$pbkdf2-sha512$310000$cbOAIWbfz3vCVXIPIp6d2A$J0klwULa6TvPRCU1HAfuKua/dMKTl8gbTYJz2N73ejGUu0LUGz/y3kwmJLuKuAYGg3WQOT0q9ZzVHHUvpKpgvQ"

# Client secret hash stored in a file
{ fromFile = config.sops.secrets."immich/client_secret_hash".path; }

# Client secret stored in a file: Hash will be computed dynamically
{ toHash = config.sops.secrets."immich/client_secret".path; }

# Null (default): Hash will be computed automatically based on the clientSecretFile option
# Equivalent to { toHash = cfg.oidc.clientSecretFile; }
null
Declaration
<nps/modules/immich>

nps.stacks.immich.oidc.enable ​

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary configuration in Immich.

For details, see:

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/immich>

nps.stacks.immich.oidc.userGroup ​

Users of this group will be able to log in to Immich

Type
plaintext
string
Default
nix
"immich_user"
Declaration
<nps/modules/immich>

nps.stacks.immich.settings ​

Settings that will be written to the 'config.json' file. If you want to configure settings through the UI, set this option to null. In that case, no managed config.json will be provided.

For details to the config file see https://immich.app/docs/install/config-file/

Type
plaintext
null or JSON value
Declaration
<nps/modules/immich>