Mercurial > dovecot > core-2.2

annotate doc/example-config/dovecot.conf @ 22633:9284bdc3c5c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
director: Don't recreate timeout on every user lookup Recreate it only when the timeout should change.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Sat, 04 Nov 2017 01:34:02 +0200
parents 73d67860db85
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
1 ## Dovecot configuration file
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
2
12926
b6a705c42001 Changed wiki.dovecot.org links to wiki2.dovecot.org
Timo Sirainen <tss@iki.fi>
parents: 12900
diff changeset
3 # If you're in a hurry, see http://wiki2.dovecot.org/QuickConfiguration
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4
11653
8c52ebde02a6 example-config: Mention `doveconf -n` instead of `dovecot -n`
Pascal Volk <user@localhost.localdomain.org>
parents: 11638
diff changeset
5 # "doveconf -n" command gives a clean output of the changed settings. Use it
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 # instead of copy&pasting files when posting to the Dovecot mailing list.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
7
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
8 # '#' character and everything after it is treated as comments. Extra spaces
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 # and tabs are ignored. If you want to use either of these explicitly, put the
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 # value inside quotes, eg.: key = "# char and trailing whitespace "
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11
15499
8863e68291bd example-config: Added a note about protocol/local/remote {} sections.
Timo Sirainen <tss@iki.fi>
parents: 14350
diff changeset
12 # Most (but not all) settings can be overridden by different protocols and/or
8863e68291bd example-config: Added a note about protocol/local/remote {} sections.
Timo Sirainen <tss@iki.fi>
parents: 14350
diff changeset
13 # source/destination IPs by placing the settings inside sections, for example:
8863e68291bd example-config: Added a note about protocol/local/remote {} sections.
Timo Sirainen <tss@iki.fi>
parents: 14350
diff changeset
14 # protocol imap { }, local 127.0.0.1 { }, remote 10.0.0.0/8 { }
8863e68291bd example-config: Added a note about protocol/local/remote {} sections.
Timo Sirainen <tss@iki.fi>
parents: 14350
diff changeset
15
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
16 # Default values are shown for each setting, it's not required to uncomment
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 # those. These are exceptions to this though: No sections (e.g. namespace {})
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
18 # or plugin settings are added by default, they're listed only as examples.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 # Paths are also just examples with the real defaults being based on configure
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 # options. The paths listed here are for configure --prefix=/usr
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 # --sysconfdir=/etc --localstatedir=/var
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 # Protocols we want to be serving.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 #protocols = imap pop3 lmtp
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 # A comma separated list of IPs or hosts where to listen in for connections.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 # "*" listens in all IPv4 interfaces, "::" listens in all IPv6 interfaces.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 # If you want to specify non-default ports or anything more complex,
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 # edit conf.d/master.conf.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 #listen = *, ::
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 # Base directory where to store runtime data.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 #base_dir = /var/run/dovecot/
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34
14131
b9e74767cd39 example-config: Updated instance_name setting's comments.
Timo Sirainen <tss@iki.fi>
parents: 13972
diff changeset
35 # Name of this instance. In multi-instance setup doveadm and other commands
b9e74767cd39 example-config: Updated instance_name setting's comments.
Timo Sirainen <tss@iki.fi>
parents: 13972
diff changeset
36 # can use -i <instance_name> to select which instance is used (an alternative
b9e74767cd39 example-config: Updated instance_name setting's comments.
Timo Sirainen <tss@iki.fi>
parents: 13972
diff changeset
37 # to -c <config_path>). The instance name is also added to Dovecot processes
b9e74767cd39 example-config: Updated instance_name setting's comments.
Timo Sirainen <tss@iki.fi>
parents: 13972
diff changeset
38 # in ps output.
13972
e1f21a4ef417 master: Added instance_name setting, which is used to prefix processes in ps output.
Timo Sirainen <tss@iki.fi>
parents: 12926
diff changeset
39 #instance_name = dovecot
e1f21a4ef417 master: Added instance_name setting, which is used to prefix processes in ps output.
Timo Sirainen <tss@iki.fi>
parents: 12926
diff changeset
40
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 # Greeting message for clients.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 #login_greeting = Dovecot ready.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 # Space separated list of trusted network ranges. Connections from these
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 # IPs are allowed to override their IP addresses and ports (for logging and
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 # for authentication checks). disable_plaintext_auth is also ignored for
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 # these networks. Typically you'd specify your IMAP proxy servers here.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 #login_trusted_networks =
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49
16321
73d67860db85 example-config: Typofix
Timo Sirainen <tss@iki.fi>
parents: 15499
diff changeset
50 # Space separated list of login access check sockets (e.g. tcpwrap)
10647
51a978045f47 Added support for tcpwrappers and potentially other login access checks.
Timo Sirainen <tss@iki.fi>
parents: 10268
diff changeset
51 #login_access_sockets =
51a978045f47 Added support for tcpwrappers and potentially other login access checks.
Timo Sirainen <tss@iki.fi>
parents: 10268
diff changeset
52
14350
b2643c587f5b example-config: Added auth_proxy_self setting.
Timo Sirainen <tss@iki.fi>
parents: 14131
diff changeset
53 # With proxy_maybe=yes if proxy destination matches any of these IPs, don't do
b2643c587f5b example-config: Added auth_proxy_self setting.
Timo Sirainen <tss@iki.fi>
parents: 14131
diff changeset
54 # proxying. This isn't necessary normally, but may be useful if the destination
b2643c587f5b example-config: Added auth_proxy_self setting.
Timo Sirainen <tss@iki.fi>
parents: 14131
diff changeset
55 # IP is e.g. a load balancer's IP.
b2643c587f5b example-config: Added auth_proxy_self setting.
Timo Sirainen <tss@iki.fi>
parents: 14131
diff changeset
56 #auth_proxy_self =
b2643c587f5b example-config: Added auth_proxy_self setting.
Timo Sirainen <tss@iki.fi>
parents: 14131
diff changeset
57
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 # Show more verbose process titles (in ps). Currently shows user name and
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 # IP address. Useful for seeing who are actually using the IMAP processes
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 # (eg. shared mailboxes or if same uid is used for multiple accounts).
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 #verbose_proctitle = no
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 # Should all processes be killed when Dovecot master process shuts down.
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 # Setting this to "no" means that Dovecot can be upgraded without
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 # forcing existing client connections to close (although that could also be
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 # a problem if the upgrade is e.g. because of a security fix).
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 #shutdown_clients = yes
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68
11897
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
69 # If non-zero, run mail commands via this many connections to doveadm server,
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
70 # instead of running them directly in the same process.
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
71 #doveadm_worker_count = 0
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
72 # UNIX socket or host:port used for connecting to doveadm server
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
73 #doveadm_socket_path = doveadm-server
b60e225386bf doveadm: Added client/server architecture support for running mail commands.
Timo Sirainen <tss@iki.fi>
parents: 11653
diff changeset
74
12814
dfd5a2efd7df example-config: Added import_environment.
Timo Sirainen <tss@iki.fi>
parents: 12410
diff changeset
75 # Space separated list of environment variables that are preserved on Dovecot
dfd5a2efd7df example-config: Added import_environment.
Timo Sirainen <tss@iki.fi>
parents: 12410
diff changeset
76 # startup and passed down to all of its child processes. You can also give
dfd5a2efd7df example-config: Added import_environment.
Timo Sirainen <tss@iki.fi>
parents: 12410
diff changeset
77 # key=value pairs to always set specific settings.
dfd5a2efd7df example-config: Added import_environment.
Timo Sirainen <tss@iki.fi>
parents: 12410
diff changeset
78 #import_environment = TZ
dfd5a2efd7df example-config: Added import_environment.
Timo Sirainen <tss@iki.fi>
parents: 12410
diff changeset
79
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 ##
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 ## Dictionary server settings
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 ##
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
83
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 # Dictionary can be used to store key=value lists. This is used by several
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 # plugins. The dictionary can be accessed either directly or though a
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 # dictionary server. The following dict block maps dictionary names to URIs
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 # when the server is used. These can then be referenced using URIs in format
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
88 # "proxy::<name>".
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 dict {
11374
c23fb6cc5bb5 example-config: Fixed example dict config filenames.
Timo Sirainen <tss@iki.fi>
parents: 11143
diff changeset
91 #quota = mysql:/etc/dovecot/dovecot-dict-sql.conf.ext
c23fb6cc5bb5 example-config: Fixed example dict config filenames.
Timo Sirainen <tss@iki.fi>
parents: 11143
diff changeset
92 #expire = sqlite:/etc/dovecot/dovecot-dict-sql.conf.ext
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 }
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94
12410
638db56a53ec example-config: Moved include conf.d/*.conf last in dovecot.conf.
Timo Sirainen <tss@iki.fi>
parents: 11897
diff changeset
95 # Most of the actual configuration gets included below. The filenames are
638db56a53ec example-config: Moved include conf.d/*.conf last in dovecot.conf.
Timo Sirainen <tss@iki.fi>
parents: 11897
diff changeset
96 # first sorted by their ASCII value and parsed in that order. The 00-prefixes
638db56a53ec example-config: Moved include conf.d/*.conf last in dovecot.conf.
Timo Sirainen <tss@iki.fi>
parents: 11897
diff changeset
97 # in filenames are intended to make it easier to understand the ordering.
638db56a53ec example-config: Moved include conf.d/*.conf last in dovecot.conf.
Timo Sirainen <tss@iki.fi>
parents: 11897
diff changeset
98 !include conf.d/*.conf
638db56a53ec example-config: Moved include conf.d/*.conf last in dovecot.conf.
Timo Sirainen <tss@iki.fi>
parents: 11897
diff changeset
99
10268
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 # A config file can also tried to be included without giving an error if
c1d8e1b02f89 example-config: Dropped ".ext" extension from dovecot.conf
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 # it's not found:
12900
0dcbd2357451 example-config: Uncommented !include_try local.conf
Timo Sirainen <tss@iki.fi>
parents: 12814
diff changeset
102 !include_try local.conf