Nix Podman Stacks
Search K

Appearance

outline ​

Example ​

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

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

Stack Options ​

nps.stacks.outline.containers.outline ​

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

Type
plaintext
submodule
Declaration
<nps/modules/outline>

nps.stacks.outline.containers.outline-db ​

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

Type
plaintext
submodule
Declaration
<nps/modules/outline>

nps.stacks.outline.db.passwordFile ​

Path to the file containing the database password

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

nps.stacks.outline.db.username ​

Database user name

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

nps.stacks.outline.enable ​

Whether to enable outline.

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

nps.stacks.outline.extraEnv ​

Extra environment variables to set for the container. Can be used to pass secrets such as the TMDB_ACCESS_TOKEN.

See https://github.com/outline/outline/blob/main/.env.sample

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Example
nix
{
  DEFAULT_LANGUAGE = "en_US";
  TMDB_ACCESS_TOKEN = {
    fromFile = "/run/secrets/tmdb_access_token";
  };
}
Declaration
<nps/modules/outline>

nps.stacks.outline.oidc.clientSecretFile ​

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

Type
plaintext
string
Declaration
<nps/modules/outline>

nps.stacks.outline.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/outline>

nps.stacks.outline.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/outline>

nps.stacks.outline.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"outline_user"
Declaration
<nps/modules/outline>

nps.stacks.outline.secretKeyFile ​

Path to the file containing the secret key. Can be generated using openssl rand -hex 32

See https://github.com/outline/outline/blob/main/.env.sample

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

nps.stacks.outline.utilsSecretFile ​

Path to the file containing the utils secret. Can be generated using openssl rand -hex 32

See https://github.com/outline/outline/blob/main/.env.sample

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