Skip to content

Rspamd

services.rspamd.debug

Whether to run the rspamd daemon in debug mode. Type: boolean

Default

false

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

services.rspamd.enable

Whether to enable rspamd, the Rapid spam filtering system. Type: boolean

Default

false

Example

true

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

services.rspamd.extraConfig

Extra configuration to add at the end of the rspamd configuration file.

Type: strings concatenated with "\n"

Default

""

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

services.rspamd.group

Group to use when no root privileges are required.

Type: string

Default

"rspamd"

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

services.rspamd.localLuaRules

Path of file to link to {file}/etc/rspamd/rspamd.local.lua for local rules written in Lua

Type: null or path

Default

null

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

services.rspamd.locals

Local configuration files, written into {file}/etc/rspamd/local.d/{name}.

Type: attribute set of (submodule)

Default

{ }

Example

{ "redis.conf".source = "/nix/store/.../etc/dir/redis.conf";"arc.conf".text = "allow_envfrom_empty = true;";}

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

services.rspamd.locals.<name>.enable

Whether this file locals should be generated. This option allows specific locals files to be disabled.

Type: boolean

Default

true

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

services.rspamd.locals.<name>.source

Path of the source file. Type: path

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

services.rspamd.locals.<name>.text

Text of the file. Type: null or strings concatenated with "\n"

Default

null

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

services.rspamd.overrides

Overridden configuration files, written into {file}/etc/rspamd/override.d/{name}.

Type: attribute set of (submodule)

Default

{ }

Example

{ "redis.conf".source = "/nix/store/.../etc/dir/redis.conf";"arc.conf".text = "allow_envfrom_empty = true;";}

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

services.rspamd.overrides.<name>.enable

Whether this file overrides should be generated. This option allows specific overrides files to be disabled.

Type: boolean

Default

true

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

services.rspamd.overrides.<name>.source

Path of the source file. Type: path

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

services.rspamd.overrides.<name>.text

Text of the file. Type: null or strings concatenated with "\n"

Default

null

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

services.rspamd.postfix.config

Addon to postfix configuration

Type: attribute set of (boolean or string or list of string)

Default

{non_smtpd_milters = ["unix:/run/rspamd/rspamd-milter.sock"];smtpd_milters = ["unix:/run/rspamd/rspamd-milter.sock"];}

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

services.rspamd.postfix.enable

Add rspamd milter to postfix main.conf Type: boolean

Default

false

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

services.rspamd.user

User to use when no root privileges are required.

Type: string

Default

"rspamd"

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

services.rspamd.workers

Attribute set of workers to start.

Type: attribute set of (submodule)

Default

{controller = { };normal = { };}

Example

{normal = {includes = [ "$CONFDIR/worker-normal.inc" ];bindSockets = [{socket = "/run/rspamd/rspamd.sock";mode = "0660";owner = "${config.services.rspamd.user}";group = "${config.services.rspamd.group}";}];};controller = {includes = [ "$CONFDIR/worker-controller.inc" ];bindSockets = [ "[::1]:11334" ];};}

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

services.rspamd.workers.<name>.bindSockets

List of sockets to listen, in format acceptable by rspamd

Type: list of (string or (submodule))

Default

[ ]

Example

[{mode = "0666";owner = "rspamd";socket = "/run/rspamd.sock";}"*:11333"]

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

services.rspamd.workers.<name>.count

Number of worker instances to run

Type: null or signed integer

Default

null

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

services.rspamd.workers.<name>.enable

Whether to run the rspamd worker. Type: null or boolean

Default

null

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

services.rspamd.workers.<name>.extraConfig

Additional entries to put verbatim into worker section of rspamd config file. Type: strings concatenated with "\n"

Default

""

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

services.rspamd.workers.<name>.includes

List of files to include in configuration

Type: list of string

Default

[ ]

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

services.rspamd.workers.<name>.name

Name of the worker Type: null or string

Default

"‹name›"

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

services.rspamd.workers.<name>.type

The type of this worker. The type proxy is deprecated and only kept for backwards compatibility and should be replaced with rspamd_proxy.

Type: null or one of "normal", "controller", "fuzzy", "rspamd_proxy", "lua", "proxy"

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