Nix Podman Stacks
Search K

Appearance

karakeep ​

Example ​

nix
{config, ...}: {
  karakeep = {
    enable = true;

    oidc = {
      enable = true;
      clientSecretHash = "$pbkdf2-sha512$...";
      clientSecretFile = config.sops.secrets."karakeep/authelia/client_secret".path;
    };
    nextauthSecretFile = config.sops.secrets."karakeep/nextauth_secret".path;
    meiliMasterKeyFile = config.sops.secrets."karakeep/meili_master_key".path;

    containers.karakeep.extraEnv = {
      DISABLE_SIGNUPS = true;
      DISABLE_PASSWORD_AUTH = true;
    };
  };
}

Stack Options ​

nps.stacks.karakeep.containers.karakeep ​

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

Type
plaintext
submodule
Declaration
<nps/modules/karakeep>

nps.stacks.karakeep.containers.karakeep-chrome ​

Alias of {option}services.podman.containers.karakeep-chrome.

Type
plaintext
submodule
Declaration
<nps/modules/karakeep>

nps.stacks.karakeep.containers.karakeep-meilisearch ​

Alias of {option}services.podman.containers.karakeep-meilisearch.

Type
plaintext
submodule
Declaration
<nps/modules/karakeep>

nps.stacks.karakeep.enable ​

Whether to enable karakeep.

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

nps.stacks.karakeep.meiliMasterKeyFile ​

Path to file containing the MEILI_MASTER_KEY

See https://docs.karakeep.app/configuration/

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

nps.stacks.karakeep.nextauthSecretFile ​

Path to file containing the NEXTAUTH_SECRET

See https://docs.karakeep.app/configuration/

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

nps.stacks.karakeep.oidc.clientSecretFile ​

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

Type
plaintext
string
Declaration
<nps/modules/karakeep>

nps.stacks.karakeep.oidc.clientSecretHash ​

The hashed client_secret. Will be set in the Authelia client config. 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
Declaration
<nps/modules/karakeep>

nps.stacks.karakeep.oidc.enable ​

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

For details, see:

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

nps.stacks.karakeep.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"karakeep_user"
Declaration
<nps/modules/karakeep>