Skip to content

pocketid

Stack Options

nps.stacks.pocketid.containers.pocketid

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

Type
plaintext
submodule
Declaration

nps.stacks.pocketid.enable

Whether to enable pocketid.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration

nps.stacks.pocketid.env

Additional environment variables passed to the Pocket ID container See https://pocket-id.org/docs/configuration/environment-variables

Type
plaintext
unspecified value
Default
nix
{ }
Declaration

nps.stacks.pocketid.extraEnv

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

See https://pocket-id.org/docs/configuration/environment-variables

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Example
nix
{
  FOO = "bar";
  MAXMIND_LICENSE_KEY = {
    fromFile = "/run/secrets/maxmind_key";
  };
}
Declaration

nps.stacks.pocketid.ldap.enableSynchronisation

Whether to sync users and groups from an the LDAP server. Requires the LLDAP stack to be enabled.

Type
plaintext
boolean
Default
nix
config.nps.stacks.lldap.enable
Declaration

nps.stacks.pocketid.ldap.passwordFile

The password for the LDAP user that is used when connecting to the LDAP backend.

Type
plaintext
absolute path
Default
nix
config.nps.stacks.lldap.adminPasswordFile
Declaration

nps.stacks.pocketid.ldap.username

The username that will be used when binding to the LDAP backend.

Type
plaintext
string
Default
nix
config.nps.stacks.lldap.adminUsername
Declaration

nps.stacks.pocketid.traefikIntegration.clientId

The client ID used by the Traefik OIDC middleware.

Type
plaintext
string
Example
nix
"traefik"
Declaration

nps.stacks.pocketid.traefikIntegration.clientSecretFile

The file containing the client secret used by the Traefik OIDC middleware.

Type
plaintext
absolute path
Declaration

nps.stacks.pocketid.traefikIntegration.enable

Whether to setup a pocketid middleware in Traefik. The middleware will use the https://github.com/sevensolutions/traefik-oidc-auth plugin to secure upstream services.

Type
plaintext
boolean
Default
nix
config.nps.stacks.traefik.enable
Declaration

nps.stacks.pocketid.traefikIntegration.encryptionSecretFile

The file containing the encryption secret used by the Traefik OIDC middleware. This should be a random secret.

See https://traefik-oidc-auth.sevensolutions.cc/docs/getting-started/middleware-configuration

Type
plaintext
absolute path
Declaration