dovecot.conf revision 0992011130e9d0a498ca860ddbe4028398a530c5
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher## Dovecot configuration file
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# If you're in a hurry, see http://wiki2.dovecot.org/QuickConfiguration
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# "doveconf -n" command gives a clean output of the changed settings. Use it
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# instead of copy&pasting files when posting to the Dovecot mailing list.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# '#' character and everything after it is treated as comments. Extra spaces
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# and tabs are ignored. If you want to use either of these explicitly, put the
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# value inside quotes, eg.: key = "# char and trailing whitespace "
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Default values are shown for each setting, it's not required to uncomment
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# those. These are exceptions to this though: No sections (e.g. namespace {})
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# or plugin settings are added by default, they're listed only as examples.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Paths are also just examples with the real defaults being based on configure
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# options. The paths listed here are for configure --prefix=/usr
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# --sysconfdir=/etc --localstatedir=/var
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Protocols we want to be serving.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#protocols = imap pop3 lmtp
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# A comma separated list of IPs or hosts where to listen in for connections.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# "*" listens in all IPv4 interfaces, "::" listens in all IPv6 interfaces.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# If you want to specify non-default ports or anything more complex,
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# edit conf.d/master.conf.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#listen = *, ::
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Base directory where to store runtime data.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#base_dir = /var/run/dovecot/
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Greeting message for clients.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#login_greeting = Dovecot ready.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Space separated list of trusted network ranges. Connections from these
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# IPs are allowed to override their IP addresses and ports (for logging and
749cfb5d3270b5daf389d51a0dbd3fd2aec6e05dJakub Hrozek# for authentication checks). disable_plaintext_auth is also ignored for
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# these networks. Typically you'd specify your IMAP proxy servers here.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#login_trusted_networks =
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
9aa117a93e315f790a1922d9ac7bd484878b621eJakub Hrozek# Sepace separated list of login access check sockets (e.g. tcpwrap)
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#login_access_sockets =
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Show more verbose process titles (in ps). Currently shows user name and
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# IP address. Useful for seeing who are actually using the IMAP processes
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# (eg. shared mailboxes or if same uid is used for multiple accounts).
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#verbose_proctitle = no
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Should all processes be killed when Dovecot master process shuts down.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Setting this to "no" means that Dovecot can be upgraded without
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# forcing existing client connections to close (although that could also be
ca344fdecdf127c80ad1074047aeba21e1165313Jakub Hrozek# a problem if the upgrade is e.g. because of a security fix).
ca344fdecdf127c80ad1074047aeba21e1165313Jakub Hrozek#shutdown_clients = yes
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# If non-zero, run mail commands via this many connections to doveadm server,
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# instead of running them directly in the same process.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#doveadm_worker_count = 0
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# UNIX socket or host:port used for connecting to doveadm server
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#doveadm_socket_path = doveadm-server
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Space separated list of environment variables that are preserved on Dovecot
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# startup and passed down to all of its child processes. You can also give
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# key=value pairs to always set specific settings.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher#import_environment = TZ
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher##
749cfb5d3270b5daf389d51a0dbd3fd2aec6e05dJakub Hrozek## Dictionary server settings
9aa117a93e315f790a1922d9ac7bd484878b621eJakub Hrozek##
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Dictionary can be used to store key=value lists. This is used by several
ca344fdecdf127c80ad1074047aeba21e1165313Jakub Hrozek# plugins. The dictionary can be accessed either directly or though a
ca344fdecdf127c80ad1074047aeba21e1165313Jakub Hrozek# dictionary server. The following dict block maps dictionary names to URIs
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# when the server is used. These can then be referenced using URIs in format
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# "proxy::<name>".
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagherdict {
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher #quota = mysql:/etc/dovecot/dovecot-dict-sql.conf.ext
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher #expire = sqlite:/etc/dovecot/dovecot-dict-sql.conf.ext
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher}
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# Most of the actual configuration gets included below. The filenames are
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# first sorted by their ASCII value and parsed in that order. The 00-prefixes
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher# in filenames are intended to make it easier to understand the ordering.
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher!include conf.d/*.conf
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher
749cfb5d3270b5daf389d51a0dbd3fd2aec6e05dJakub Hrozek# A config file can also tried to be included without giving an error if
9aa117a93e315f790a1922d9ac7bd484878b621eJakub Hrozek# it's not found:
796463906a54e259bd5b582ce84af4297a58eafcStephen Gallagher!include_try local.conf
749cfb5d3270b5daf389d51a0dbd3fd2aec6e05dJakub Hrozek