Skip to content

Sympa

services.sympa.database.createLocally

Whether to create a local database automatically. Type: boolean

Default

true

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

services.sympa.database.host

Database host address.

For MySQL, use localhost to connect using Unix domain socket.

For PostgreSQL, use path to directory (e.g. {file}/run/postgresql) to connect using Unix domain socket located in this directory.

Use null to fall back on Sympa default, or when using {option}services.sympa.database.createLocally.

Type: null or string

Default

null

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

services.sympa.database.name

Database name. When using SQLite this must be an absolute path to the database file.

Type: string

Default

if database.type == "SQLite" then "/var/lib/sympa/sympa.sqlite" else "sympa"

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

services.sympa.database.passwordFile

A file containing the password for {option}services.sympa.database.name.

Type: null or path

Default

null

Example

"/run/keys/sympa-dbpassword"

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

services.sympa.database.port

Database port. Use null for default port. Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

null

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

services.sympa.database.type

Database engine to use. Type: one of "SQLite", "PostgreSQL", "MySQL"

Default

"SQLite"

Example

"MySQL"

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

services.sympa.database.user

Database user. The system user name is used as a default. Type: null or string

Default

"sympa"

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

services.sympa.domains

Email domains handled by this instance. There have to be MX records for keys of this attribute set.

Type: attribute set of (submodule)

Example

{"lists.example.org" = {webHost = "lists.example.org";webLocation = "/";};"sympa.example.com" = {webHost = "example.com";webLocation = "/sympa";};}

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

services.sympa.domains.<name>.settings

The {file}robot.conf configuration file as key value set. See https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html for list of configuration parameters.

Type: attribute set of (string or signed integer or boolean)

Default

{ }

Example

{default_max_list_members = 3;}

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

services.sympa.domains.<name>.webHost

Domain part of the web interface URL (no web interface for this domain if null). DNS record of type A (or AAAA or CNAME) has to exist with this value.

Type: null or string

Default

null

Example

"archive.example.org"

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

services.sympa.domains.<name>.webLocation

URL path part of the web interface. Type: string

Default

"/"

Example

"/sympa"

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

services.sympa.enable

Whether to enable Sympa mailing list manager. Type: boolean

Default

false

Example

true

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

services.sympa.lang

Default Sympa language. See https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa for available options.

Type: string

Default

"en_US"

Example

"cs"

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

services.sympa.listMasters

The list of the email addresses of the listmasters (users authorized to perform global server commands).

Type: list of string

Example

["postmaster@sympa.example.org"]

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

services.sympa.mainDomain

Main domain to be used in {file}sympa.conf. If null, one of the {option}services.sympa.domains is chosen for you.

Type: null or string

Default

null

Example

"lists.example.org"

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

services.sympa.mta.type

Mail transfer agent (MTA) integration. Use none if you want to configure it yourself.

The postfix integration sets up local Postfix instance that will pass incoming messages from configured domains to Sympa. You still need to configure at least outgoing message handling using e.g. {option}services.postfix.relayHost.

Type: one of "postfix", "none"

Default

"postfix"

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

services.sympa.settings

The {file}sympa.conf configuration file as key value set. See https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html for list of configuration parameters.

Type: attribute set of (string or signed integer or boolean)

Default

{ }

Example

{default_home = "lists";viewlogs_page_size = 50;}

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

services.sympa.settingsFile

Set of files to be linked in {file}/var/lib/sympa. Type: attribute set of (submodule)

Default

{ }

Example

{"list_data/lists.example.org/help" = {text = "subject This list provides help to users";};}

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

services.sympa.settingsFile.<name>.enable

Whether this file should be generated. This option allows specific files to be disabled. Type: boolean

Default

true

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

services.sympa.settingsFile.<name>.source

Path of the source file. Type: path

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

services.sympa.settingsFile.<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/sympa.nix

services.sympa.web.enable

Whether to enable Sympa web interface. Type: boolean

Default

true

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

services.sympa.web.fcgiProcs

Number of FastCGI processes to fork. Type: positive integer, meaning >0

Default

2

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

services.sympa.web.https

Whether to use HTTPS. When nginx integration is enabled, this option forces SSL and enables ACME. Please note that Sympa web interface always uses https links even when this option is disabled.

Type: boolean

Default

true

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

services.sympa.web.server

The webserver used for the Sympa web interface. Set it to none if you want to configure it yourself. Further nginx configuration can be done by adapting {option}services.nginx.virtualHosts.«name».

Type: one of "nginx", "none"

Default

"nginx"

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