Cluster Settings

See Settings for list of all setting groups.

Common Settings

These settings are for both Dovecot proxies and backends.

cluster_geodb

  • Default: <empty>

  • Values: String

Dictionary URI used for the globally shared GeoDB. This typically points to Cassandra.

cluster_local_site

  • Default: <empty>

  • Values: String

Name of the local site. This must be the same name as used by doveadm cluster site commands.

cluster_localdb

  • Default: <empty>

  • Values: String

Dictionary URI used for the server-specific local database. This typically points to SQLite under /dev/shm.

cluster_backend_test_username

  • Default: <empty>

  • Values: String

This setting is used for two purposes:

  1. Username used by proxy for logging into backends to see if it’s up or down. %{backend_host} variable expands to the hostname of the backend.

  2. Username used by backend for running doveadm cluster group access command. This command just needs any existing user to work - it doesn’t matter that it’s not actually in the accessed group.

Proxy Settings

These settings are only for Dovecot proxies. Don’t set them in backends.

cluster_proxy_check_backends

If enabled, this proxy runs checks to see whether backends are up or down. If disabled, this proxy never sets any backends offline. This setting is used only by proxies.

cluster_backend_test_password

  • Default: <empty>

  • Values: String

Password used for logging into backends to see if it’s up or down.

cluster_default_group_count

Number of user groups that may be automatically created. This is used for creating a group for a user that doesn’t yet have one. The group will be named default-N where N is between 1 and cluster_default_group_count.

cluster_user_move_timeout

  • Default: <empty>

  • Values: Time

If user moving hasn’t finished by this timeout, just assume it finished and continue to the next user.

Backend Settings

These settings are only for Dovecot backends. Don’t set them in proxies.

cluster_backend_name

  • Default: <empty>

  • Values: String

Host name of the backend. This must be the same name as used by doveadm cluster backend commands.