Nix Podman Stacks
Search K

Appearance

memos ​

Note-taking service

Example ​

nix
{
  nps.stacks.memos = {
    enable = true;

    oidc = {
      registerClient = true;
      clientSecretHash = "$pbkdf2-sha512$...";
    };
  };
}

Stack Options ​

nps.stacks.memos.containers.memos ​

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

Type
plaintext
submodule
Declaration
<nps/modules/memos>

nps.stacks.memos.containers.memos-db ​

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

Type
plaintext
submodule
Declaration
<nps/modules/memos>

nps.stacks.memos.db.passwordFile ​

The file containing the PostgreSQL password for the database. Only used if db.type is set to "postgres".

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

nps.stacks.memos.db.type ​

Type of the database to use. Can be set to "sqlite" or "postgres". If set to "postgres", the passwordFile option must be set.

Type
plaintext
one of "sqlite", "postgres"
Default
nix
"sqlite"
Declaration
<nps/modules/memos>

nps.stacks.memos.db.username ​

The PostgreSQL user to use for the database. Only used if db.type is set to "postgres".

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

nps.stacks.memos.enable ​

Whether to enable memos.

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

nps.stacks.memos.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)
Type
plaintext
string or (submodule)
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; }
Declaration
<nps/modules/memos>

nps.stacks.memos.oidc.registerClient ​

Whether to register an OIDC client in Authelia. If enabled you need to provide a hashed secret in the client_secret option.

To enable OIDC Login for Memos, you will have to configure it in the Web UI.

For details, see:

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

nps.stacks.memos.oidc.userGroup ​

Users of this group will be able to log in

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