Skip to content

Listmonk

services.listmonk.database.createLocally

Create the PostgreSQL database and database user locally. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.mutableSettings

Database settings will be reset to the value set in this module if this is not enabled. Enable this if you want to persist changes you have done in the application.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings

Dynamic settings in the PostgreSQL database, set by a SQL script, see https://github.com/knadh/listmonk/blob/master/schema.sql#L177-L230 for details. Type: null or ((list of string) or list of attribute set of anything or string or signed integer or boolean)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings."app.notify_emails"

Administrator emails for system notifications Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings."bounce.mailboxes"

List of bounce mailboxes Type: list of (list of attribute set of anything)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings."privacy.domain_blocklist"

E-mail addresses with these domains are disallowed from subscribing. Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings."privacy.exportable"

List of fields which can be exported through an automatic export request Type: list of string

Default

["profile""subscriptions""campaign_views""link_clicks"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.messengers

List of messengers, see: https://github.com/knadh/listmonk/blob/master/models/settings.go#L64-L74 for options. Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp

List of outgoing SMTP servers Type: list of (attribute set of anything)

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp.*.enabled

Whether to enable this SMTP server for listmonk. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp.*.host

Hostname for the SMTP server Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp.*.max_conns

Maximum number of simultaneous connections, defaults to 1 Type: signed integer

Default

1

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp.*.port

Port for the SMTP server Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.database.settings.smtp.*.tls_type

Type of TLS authentication with the SMTP server Type: one of "none", "STARTTLS", "TLS"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.enable

Whether to enable Listmonk, this module assumes a reverse proxy to be set. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.package

The listmonk package to use. Type: package

Default

pkgs.listmonk

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.secretFile

A file containing secrets as environment variables. See https://listmonk.app/docs/configuration/#environment-variables for details on supported values. Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix

services.listmonk.settings

Static settings set in the config.toml, see https://github.com/knadh/listmonk/blob/master/config.toml.sample for details. You can set secrets using the secretFile option with environment variables following https://listmonk.app/docs/configuration/#environment-variables.

Type: TOML value

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/listmonk.nix