Public inbox

`services.public-inbox.enable`

Whether to enable the public-inbox mail archiver. Type: boolean

Default

false

Example

true

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

`services.public-inbox.http.args`

Command-line arguments to pass to {manpage}public-inbox-httpd(1). Type: list of string

Default

[ ]

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

`services.public-inbox.http.enable`

Whether to enable the public-inbox HTTP server. Type: boolean

Default

false

Example

true

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

`services.public-inbox.http.mounts`

Root paths or URLs that public-inbox will be served on. If domain parts are present, only requests to those domains will be accepted.

Type: list of string

Default

["/"]

Example

["/lists/archives"]

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

`services.public-inbox.http.port`

Listening port or systemd's ListenStream= entry to be used as a reverse proxy, eg. in nginx: locations."/inbox".proxyPass = "http://unix:${config.services.public-inbox.http.port}:/inbox"; Set to null and use systemd.sockets.public-inbox-httpd.listenStreams if you need a more advanced listening.

Type: null or string or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

80

Example

"/run/public-inbox-httpd.sock"

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

`services.public-inbox.imap.args`

Command-line arguments to pass to {manpage}public-inbox-imapd(1). Type: list of string

Default

[ ]

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

`services.public-inbox.imap.cert`

Path to TLS certificate to use for connections to {manpage}public-inbox-imapd(1). Type: null or string

Default

null

Example

"/path/to/fullchain.pem"

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

`services.public-inbox.imap.enable`

Whether to enable the public-inbox IMAP server. Type: boolean

Default

false

Example

true

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

`services.public-inbox.imap.key`

Path to TLS key to use for connections to {manpage}public-inbox-imapd(1). Type: null or string

Default

null

Example

"/path/to/key.pem"

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

`services.public-inbox.imap.port`

Listening port. Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not. Set to null and use systemd.sockets.public-inbox-imapd.listenStreams if you need a more advanced listening.

Type: null or string or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

993

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

`services.public-inbox.inboxes`

Inboxes to configure, where attribute names are inbox names.

Type: attribute set of (attribute set of (INI atom (null, bool, int, float or string) or a list of them for duplicate keys))

Default

{ }

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

`services.public-inbox.inboxes.<name>.address`

The email addresses of the public-inbox. Type: list of string

Example

"example-discuss@example.org"

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

`services.public-inbox.inboxes.<name>.coderepo`

Nicknames of a 'coderepo' section associated with the inbox. Type: list of coderepo names

Default

[ ]

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

`services.public-inbox.inboxes.<name>.description`

User-visible description for the repository. Type: string

Example

"user/dev discussion of public-inbox itself"

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

`services.public-inbox.inboxes.<name>.inboxdir`

The absolute path to the directory which hosts the public-inbox. Type: string

Default

"/var/lib/public-inbox/inboxes/‹name›"

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

`services.public-inbox.inboxes.<name>.newsgroup`

NNTP group name for the inbox. Type: null or string

Default

null

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

`services.public-inbox.inboxes.<name>.url`

URL where this inbox can be accessed over HTTP. Type: non-empty string

Example

"https://example.org/lists/example-discuss"

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

`services.public-inbox.inboxes.<name>.watch`

Paths for {manpage}public-inbox-watch(1) to monitor for new mail. Type: list of string

Default

[ ]

Example

["maildir:/path/to/test.example.com.git"]

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

`services.public-inbox.inboxes.<name>.watchheader`

If specified, {manpage}public-inbox-watch(1) will only process mail containing a matching header.

Type: null or string

Default

null

Example

"List-Id:<test@example.com>"

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

`services.public-inbox.mda.args`

Command-line arguments to pass to {manpage}public-inbox-mda(1). Type: list of string

Default

[ ]

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

`services.public-inbox.mda.enable`

Whether to enable the public-inbox Mail Delivery Agent. Type: boolean

Default

false

Example

true

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

`services.public-inbox.nntp.args`

Command-line arguments to pass to {manpage}public-inbox-nntpd(1). Type: list of string

Default

[ ]

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

`services.public-inbox.nntp.cert`

Path to TLS certificate to use for connections to {manpage}public-inbox-nntpd(1). Type: null or string

Default

null

Example

"/path/to/fullchain.pem"

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

`services.public-inbox.nntp.enable`

Whether to enable the public-inbox NNTP server. Type: boolean

Default

false

Example

true

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

`services.public-inbox.nntp.key`

Path to TLS key to use for connections to {manpage}public-inbox-nntpd(1). Type: null or string

Default

null

Example

"/path/to/key.pem"

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

`services.public-inbox.nntp.port`

Listening port. Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not. Set to null and use systemd.sockets.public-inbox-nntpd.listenStreams if you need a more advanced listening.

Type: null or string or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

563

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

`services.public-inbox.openFirewall`

Whether to enable opening the firewall when using a port option. Type: boolean

Default

false

Example

true

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

`services.public-inbox.package`

The public-inbox package to use. Type: package

Default

pkgs.public-inbox

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

`services.public-inbox.path`

Additional packages to place in the path of public-inbox-mda, public-inbox-watch, etc.

Type: list of package

Default

[ ]

Example

with pkgs; [ spamassassin ]

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

`services.public-inbox.postfix.enable`

Whether to enable the integration into Postfix. Type: boolean

Default

false

Example

true

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

`services.public-inbox.settings`

Settings for the public-inbox config file.

Type: attribute set of attribute set of ((INI atom (null, bool, int, float or string) or a list of them for duplicate keys) or attribute set of (INI atom (null, bool, int, float or string) or a list of them for duplicate keys))

Default

{ }

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

`services.public-inbox.settings.coderepo`

code repositories Type: attribute set of (attribute set of (INI atom (null, bool, int, float or string) or a list of them for duplicate keys))

Default

{ }

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

`services.public-inbox.settings.coderepo.<name>.cgitUrl`

URL of a cgit instance Type: string

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

`services.public-inbox.settings.coderepo.<name>.dir`

Path to a git repository Type: string

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

`services.public-inbox.settings.publicinbox`

public inboxes Type: attribute set of ((INI atom (null, bool, int, float or string) or a list of them for duplicate keys) or attribute set of (INI atom (null, bool, int, float or string) or a list of them for duplicate keys))