Skip to content

Roundcube

services.roundcube.configureNginx

Configure nginx as a reverse proxy for roundcube. Type: boolean

Default

true

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

services.roundcube.database.dbname

Name of the postgresql database Type: string

Default

"roundcube"

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

services.roundcube.database.host

Host of the postgresql server. If this is not set to localhost, you have to create the postgresql user and database yourself, with appropriate permissions.

Type: string

Default

"localhost"

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

services.roundcube.database.password

Password for the postgresql connection. Do not use: the password will be stored world readable in the store; use passwordFile instead. Type: string

Default

""

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

services.roundcube.database.passwordFile

Password file for the postgresql connection. Must be formatted according to PostgreSQL .pgpass standard (see https://www.postgresql.org/docs/current/libpq-pgpass.html) but only one line, no comments and readable by user nginx. Ignored if database.host is set to localhost, as peer authentication will be used.

Type: string

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

services.roundcube.database.username

Username for the postgresql connection. If database.host is set to localhost, a unix user and group of the same name will be created as well.

Type: string

Default

"roundcube"

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

services.roundcube.dicts

List of aspell dictionaries for spell checking. If empty, spell checking is disabled.

Type: list of package

Default

[ ]

Example

with pkgs.aspellDicts; [ en fr de ]

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

services.roundcube.enable

Whether to enable roundcube.

Also enables nginx virtual host management. Further nginx configuration can be done by adapting services.nginx.virtualHosts.<name>. See for further information.

Type: boolean

Default

false

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

services.roundcube.extraConfig

Extra configuration for roundcube webmail instance Type: strings concatenated with "\n"

Default

""

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

services.roundcube.hostName

Hostname to use for the nginx vhost Type: string

Example

"webmail.example.com"

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

services.roundcube.maxAttachmentSize

The maximum attachment size in MB.

::: {.note} Since there is some overhead in base64 encoding applied to attachments, + 37% will be added to the value set in this option in order to offset the overhead. For example, setting maxAttachmentSize to 100 would result in 137M being the real value in the configuration. See upstream issue comment for more details on the motivations behind this. :::

Type: signed integer

Default

18

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

services.roundcube.package

The roundcube package to use. Type: package

Default

pkgs.roundcube

Example

roundcube.withPlugins (plugins: [ plugins.persistent_login ])

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

services.roundcube.plugins

List of roundcube plugins to enable. Currently, only those directly shipped with Roundcube are supported.

Type: list of string

Default

[ ]

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