Mercurial > dovecot > original-hg > dovecot-1.2

annotate dovecot-example.conf @ 2205:821fbe3e892b HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Don't require dotlocking to be first in locking list.
author Timo Sirainen <tss@iki.fi>
date Sun, 20 Jun 2004 13:37:44 +0300
parents 506302b8b2fb
children 8864dbc17cfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
1 ## Dovecot 1.0 configuration file
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
2
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3 # Default values are shown after each value, it's not required to uncomment
435
06576f1d9e69 doc updates
Timo Sirainen <tss@iki.fi>
parents: 284
diff changeset
4 # any of the lines. Exception to this are paths, they're just examples
06576f1d9e69 doc updates
Timo Sirainen <tss@iki.fi>
parents: 284
diff changeset
5 # with real defaults being based on configure options. The paths listed here
06576f1d9e69 doc updates
Timo Sirainen <tss@iki.fi>
parents: 284
diff changeset
6 # are for configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
657
85a888d2766e Added script to easily generate self-signed certificate.
Timo Sirainen <tss@iki.fi>
parents: 644
diff changeset
7 # --with-ssldir=/etc/ssl
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
8
872
6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be
Timo Sirainen <tss@iki.fi>
parents: 817
diff changeset
9 # Base directory where to store runtime data.
6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be
Timo Sirainen <tss@iki.fi>
parents: 817
diff changeset
10 #base_dir = /var/run/dovecot/
6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be
Timo Sirainen <tss@iki.fi>
parents: 817
diff changeset
11
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
12 # Protocols we want to be serving:
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
13 # imap imaps pop3 pop3s
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
14 #protocols = imap imaps
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
15
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
16 # IP or host address where to listen in for connections. It's not currently
780
1cc947617c8b imap_listen and imaps_listen accepts now "*" as "all IPv4 interfaces" and
Timo Sirainen <tss@iki.fi>
parents: 779
diff changeset
17 # possible to specify multiple addresses. "*" listens in all IPv4 interfaces.
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
18 # "[::]" listens in all IPv6 interfaces, but may also listen in all IPv4
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
19 # interfaces depending on the operating system. You can specify ports with
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
20 # "host:port".
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
21 #listen = *
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
22
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
23 # IP or host address where to listen in for SSL connections. Defaults
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
24 # to above if not specified.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
25 #ssl_listen =
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
26
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
27 # Disable SSL/TLS support.
666
36ac2fd352ff Added ssl_disable setting.
Timo Sirainen <tss@iki.fi>
parents: 661
diff changeset
28 #ssl_disable = no
36ac2fd352ff Added ssl_disable setting.
Timo Sirainen <tss@iki.fi>
parents: 661
diff changeset
29
519
9e121e74c188 and a couple more fixes..
Timo Sirainen <tss@iki.fi>
parents: 518
diff changeset
30 # PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
518
1f9b96080525 Updated SSL certificate comments.
Timo Sirainen <tss@iki.fi>
parents: 472
diff changeset
31 # dropping root privileges, so keep the key file unreadable by anyone but
657
85a888d2766e Added script to easily generate self-signed certificate.
Timo Sirainen <tss@iki.fi>
parents: 644
diff changeset
32 # root. Included doc/mkcert.sh can be used to easily generate self-signed
85a888d2766e Added script to easily generate self-signed certificate.
Timo Sirainen <tss@iki.fi>
parents: 644
diff changeset
33 # certificate, just make sure to update the domains in dovecot-openssl.cnf
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
34 #ssl_cert_file = /etc/ssl/certs/dovecot.pem
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
35 #ssl_key_file = /etc/ssl/private/dovecot.pem
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
36
1997
1d0985f6bdd9 Added ssl_verify_client_cert setting.
Timo Sirainen <tss@iki.fi>
parents: 1996
diff changeset
37 # File containing trusted SSL certificate authorities. Usually not needed.
1d0985f6bdd9 Added ssl_verify_client_cert setting.
Timo Sirainen <tss@iki.fi>
parents: 1996
diff changeset
38 #ssl_ca_file =
1d0985f6bdd9 Added ssl_verify_client_cert setting.
Timo Sirainen <tss@iki.fi>
parents: 1996
diff changeset
39
2027
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
40 # Request client to send a certificate.
1997
1d0985f6bdd9 Added ssl_verify_client_cert setting.
Timo Sirainen <tss@iki.fi>
parents: 1996
diff changeset
41 #ssl_verify_client_cert = no
1d0985f6bdd9 Added ssl_verify_client_cert setting.
Timo Sirainen <tss@iki.fi>
parents: 1996
diff changeset
42
615
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
43 # SSL parameter file. Master process generates this file for login processes.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
44 # It contains Diffie Hellman and RSA parameters.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
45 #ssl_parameters_file = /var/run/dovecot/ssl-parameters.dat
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
46
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
47 # How often to regenerate the SSL parameters file. Generation is quite CPU
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
48 # intensive operation. The value is in hours, 0 disables regeneration
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
49 # entirely.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
50 #ssl_parameters_regenerate = 24
0d852af6842e Master process generates DH/RSA parameters now and stores them into file
Timo Sirainen <tss@iki.fi>
parents: 614
diff changeset
51
1996
d8f06a0c818e Added ssl_cipher_list setting.
Timo Sirainen <tss@iki.fi>
parents: 1986
diff changeset
52 # SSL ciphers to use
d8f06a0c818e Added ssl_cipher_list setting.
Timo Sirainen <tss@iki.fi>
parents: 1986
diff changeset
53 #ssl_cipher_list = all:!low
d8f06a0c818e Added ssl_cipher_list setting.
Timo Sirainen <tss@iki.fi>
parents: 1986
diff changeset
54
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
55 # Disable LOGIN command and all other plaintext authentications unless
1725
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1
Timo Sirainen <tss@iki.fi>
parents: 1707
diff changeset
56 # SSL/TLS is used (LOGINDISABLED capability). Note that 127.*.*.* and
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1
Timo Sirainen <tss@iki.fi>
parents: 1707
diff changeset
57 # IPv6 ::1 addresses are considered secure, this setting has no effect if
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1
Timo Sirainen <tss@iki.fi>
parents: 1707
diff changeset
58 # you connect from those addresses.
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1
Timo Sirainen <tss@iki.fi>
parents: 1707
diff changeset
59 #disable_plaintext_auth = yes
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
60
1124
5e9430a39611 /dev/stderr works now in log paths.
Timo Sirainen <tss@iki.fi>
parents: 1113
diff changeset
61 # Use this logfile instead of syslog(). /dev/stderr can be used if you want to
5e9430a39611 /dev/stderr works now in log paths.
Timo Sirainen <tss@iki.fi>
parents: 1113
diff changeset
62 # use stderr for logging (ONLY /dev/stderr - otherwise it is closed).
35
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents: 27
diff changeset
63 #log_path =
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents: 27
diff changeset
64
811
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is
Timo Sirainen <tss@iki.fi>
parents: 788
diff changeset
65 # For informational messages, use this logfile instead of the default
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is
Timo Sirainen <tss@iki.fi>
parents: 788
diff changeset
66 #info_log_path =
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is
Timo Sirainen <tss@iki.fi>
parents: 788
diff changeset
67
35
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents: 27
diff changeset
68 # Prefix for each line written to log file. % codes are in strftime(3)
1647
d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or '
Timo Sirainen <tss@iki.fi>
parents: 1622
diff changeset
69 # format.
d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or '
Timo Sirainen <tss@iki.fi>
parents: 1622
diff changeset
70 #log_timestamp = "%b %d %H:%M:%S "
35
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents: 27
diff changeset
71
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
72 ##
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
73 ## Login processes
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
74 ##
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
75
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
76 # Directory where authentication process places authentication UNIX sockets
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
77 # which login needs to be able to connect to. The sockets are created when
2163
506302b8b2fb comment update
Timo Sirainen <tss@iki.fi>
parents: 2141
diff changeset
78 # running as root, so you don't have to worry about permissions. Note that
506302b8b2fb comment update
Timo Sirainen <tss@iki.fi>
parents: 2141
diff changeset
79 # everything in this directory is deleted when Dovecot is started.
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
80 #login_dir = /var/run/dovecot/login
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
81
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
82 # chroot login process to the login_dir. Only reason not to do this is if you
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
83 # wish to run the whole Dovecot without roots.
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
84 #login_chroot = yes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
85
1582
498a9b7797f2 Comment updates
Timo Sirainen <tss@iki.fi>
parents: 1578
diff changeset
86 # User to use for the login process. Create a completely new user for this,
498a9b7797f2 Comment updates
Timo Sirainen <tss@iki.fi>
parents: 1578
diff changeset
87 # and don't use it anywhere else. The user must also belong to a group where
498a9b7797f2 Comment updates
Timo Sirainen <tss@iki.fi>
parents: 1578
diff changeset
88 # only it has access, it's used to control access for authentication process.
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
89 #login_user = dovecot
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
90
722
0438621d25ff Added virtual memory size limits to processes. Default values are pretty
Timo Sirainen <tss@iki.fi>
parents: 666
diff changeset
91 # Set max. process size in megabytes. If you don't use
0438621d25ff Added virtual memory size limits to processes. Default values are pretty
Timo Sirainen <tss@iki.fi>
parents: 666
diff changeset
92 # login_process_per_connection you might need to grow this.
2137
7d625d6b33aa Raised login_process_size default from 16MB -> 32MB
Timo Sirainen <tss@iki.fi>
parents: 2133
diff changeset
93 #login_process_size = 32
722
0438621d25ff Added virtual memory size limits to processes. Default values are pretty
Timo Sirainen <tss@iki.fi>
parents: 666
diff changeset
94
613
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
95 # Should each login be processed in it's own process (yes), or should one
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
96 # login process be allowed to process multiple connections (no)? Yes is more
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
97 # secure, espcially with SSL/TLS enabled. No is faster since there's no need
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
98 # to create processes all the time.
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
99 #login_process_per_connection = yes
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
100
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
101 # Number of login processes to create. If login_process_per_user is
613
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
102 # yes, this is the number of extra processes waiting for users to log in.
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
103 #login_processes_count = 3
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
104
614
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
105 # Maximum number of extra login processes to create. The extra process count
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
106 # usually stays at login_processes_count, but when multiple users start logging
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
107 # in at the same time more extra processes are created. To prevent fork-bombing
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
108 # we check only once in a second if new processes should be created - if all
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
109 # of them are used at the time, we double their amount until limit set by this
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
110 # setting is reached. This setting is used only if login_process_per_use is yes.
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
111 #login_max_processes_count = 128
e60620644af3 login_process_per_connection = yes scales now better when multiple users are
Timo Sirainen <tss@iki.fi>
parents: 613
diff changeset
112
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
113 # Maximum number of connections allowed in login state. When this limit is
613
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
114 # reached, the oldest connections are dropped. If login_process_per_user
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
115 # is no, this is a per-process value, so the absolute maximum number of users
1906116a62ce Finally support for handling each login connection in it's own process.
Timo Sirainen <tss@iki.fi>
parents: 600
diff changeset
116 # logging in actually login_processes_count * max_logging_users.
1555
b566a1ba703e s/max_logging_users/login_max_logging_users/
Timo Sirainen <tss@iki.fi>
parents: 1506
diff changeset
117 #login_max_logging_users = 256
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
118
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
119
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
120 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
121 ## Mail processes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
122 ##
722
0438621d25ff Added virtual memory size limits to processes. Default values are pretty
Timo Sirainen <tss@iki.fi>
parents: 666
diff changeset
123
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
124 # Maximum number of running mail processes. When this limit is reached,
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
125 # new users aren't allowed to log in.
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
126 #max_mail_processes = 1024
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
127
596
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents: 519
diff changeset
128 # Show more verbose process titles (in ps). Currently shows user name and
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents: 519
diff changeset
129 # IP address. Useful for seeing who are actually using the IMAP processes
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents: 519
diff changeset
130 # (eg. shared mailboxes or if same uid is used for multiple accounts).
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents: 519
diff changeset
131 #verbose_proctitle = no
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents: 519
diff changeset
132
1236
5c73e63c75f7 verbose_ssl here too
Timo Sirainen <tss@iki.fi>
parents: 1223
diff changeset
133 # Show protocol level SSL errors.
5c73e63c75f7 verbose_ssl here too
Timo Sirainen <tss@iki.fi>
parents: 1223
diff changeset
134 #verbose_ssl = no
5c73e63c75f7 verbose_ssl here too
Timo Sirainen <tss@iki.fi>
parents: 1223
diff changeset
135
1506
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
136 # Valid UID range for users, defaults to 500 and above. This is mostly
1295
cc9b61b9959e updated first_valid_uid comment
Timo Sirainen <tss@iki.fi>
parents: 1283
diff changeset
137 # to make sure that users can't log in as daemons or other system users.
1506
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
138 # Note that denying root logins is hardcoded to dovecot binary and can't
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
139 # be done even if first_valid_uid is set to 0.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
140 #first_valid_uid = 500
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
141 #last_valid_uid = 0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
142
1506
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
143 # Valid GID range for users, defaults to non-root/wheel. Users having
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
144 # non-valid GID as primary group ID aren't allowed to log in. If user
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
145 # belongs to supplementary groups with non-valid GIDs, those groups are
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
146 # not set.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
147 #first_valid_gid = 1
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
148 #last_valid_gid = 0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
149
2141
8690d2000e33 Added mail_extra_groups setting.
Timo Sirainen <tss@iki.fi>
parents: 2137
diff changeset
150 # Grant access to these extra groups for mail processes. Typical use would be
8690d2000e33 Added mail_extra_groups setting.
Timo Sirainen <tss@iki.fi>
parents: 2137
diff changeset
151 # to give "mail" group write access to /var/mail to be able to create dotlocks.
8690d2000e33 Added mail_extra_groups setting.
Timo Sirainen <tss@iki.fi>
parents: 2137
diff changeset
152 #mail_extra_groups =
8690d2000e33 Added mail_extra_groups setting.
Timo Sirainen <tss@iki.fi>
parents: 2137
diff changeset
153
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
154 # ':' separated list of directories under which chrooting is allowed for mail
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
155 # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
978
d3433363bcaa comment update
Timo Sirainen <tss@iki.fi>
parents: 882
diff changeset
156 # This setting doesn't affect login_chroot or auth_chroot variables.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
157 # WARNING: Never add directories here which local users can modify, that
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
158 # may lead to root exploit. Usually this should be done only if you don't
979
fd1438d43443 comment update
Timo Sirainen <tss@iki.fi>
parents: 978
diff changeset
159 # allow shell access for users. See doc/configuration.txt for more information.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
160 #valid_chroot_dirs =
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
161
1734
d83e16602418 Added mail_chroot setting to specify default chroot.
Timo Sirainen <tss@iki.fi>
parents: 1728
diff changeset
162 # Default chroot directory for mail processes. This can be overridden by
d83e16602418 Added mail_chroot setting to specify default chroot.
Timo Sirainen <tss@iki.fi>
parents: 1728
diff changeset
163 # giving /./ in user's home directory (eg. /home/./user chroots into /home).
d83e16602418 Added mail_chroot setting to specify default chroot.
Timo Sirainen <tss@iki.fi>
parents: 1728
diff changeset
164 #mail_chroot =
d83e16602418 Added mail_chroot setting to specify default chroot.
Timo Sirainen <tss@iki.fi>
parents: 1728
diff changeset
165
779
f126b666859e New setting: default_mail_env which can be used to specify where to find
Timo Sirainen <tss@iki.fi>
parents: 722
diff changeset
166 # Default MAIL environment to use when it's not set. By leaving this empty
f126b666859e New setting: default_mail_env which can be used to specify where to find
Timo Sirainen <tss@iki.fi>
parents: 722
diff changeset
167 # dovecot tries to do some automatic detection as described in
2097
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
168 # doc/mail-storages.txt. There's a few special variables you can use, eg.:
813
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
169 #
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
170 # %u - username
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
171 # %n - user part in user@domain, same as %u if there's no domain
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
172 # %d - domain part in user@domain, empty if user there's no domain
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
173 # %h - home directory
2057
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined
Timo Sirainen <tss@iki.fi>
parents: 2039
diff changeset
174 #
2097
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
175 # See doc/variables.txt for full list. Some examples:
813
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
176 #
1747
a1183185b013 comment changes
Timo Sirainen <tss@iki.fi>
parents: 1734
diff changeset
177 # default_mail_env = maildir:/var/mail/%1u/%u/Maildir
a1183185b013 comment changes
Timo Sirainen <tss@iki.fi>
parents: 1734
diff changeset
178 # default_mail_env = mbox:~/mail/:INBOX=/var/mail/%u
a1183185b013 comment changes
Timo Sirainen <tss@iki.fi>
parents: 1734
diff changeset
179 # default_mail_env = mbox:/var/mail/%d/%n/:INDEX=/var/indexes/%d/%n
813
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also
Timo Sirainen <tss@iki.fi>
parents: 811
diff changeset
180 #
779
f126b666859e New setting: default_mail_env which can be used to specify where to find
Timo Sirainen <tss@iki.fi>
parents: 722
diff changeset
181 #default_mail_env =
f126b666859e New setting: default_mail_env which can be used to specify where to find
Timo Sirainen <tss@iki.fi>
parents: 722
diff changeset
182
462
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
183 # Space-separated list of fields to cache for all mails. Currently these
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
184 # fields are allowed followed by a list of commands they speed up:
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
185 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
186 # Envelope - FETCH ENVELOPE and SEARCH FROM, TO, CC, BCC, SUBJECT,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
187 # SENTBEFORE, SENTON, SENTSINCE, HEADER MESSAGE-ID,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
188 # HEADER IN-REPLY-TO
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
189 # Body - FETCH BODY
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
190 # Bodystructure - FETCH BODY, BODYSTRUCTURE
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
191 # MessagePart - FETCH BODY[1.2.3] (ie. body parts), RFC822.SIZE,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
192 # SEARCH SMALLER, LARGER, also speeds up BODY/BODYSTRUCTURE
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
193 # generation. This is always set with mbox mailboxes, and
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
194 # also default with Maildir.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
195 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
196 # Different IMAP clients work in different ways, that's why Dovecot by default
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
197 # only caches MessagePart which speeds up most operations. Whenever client
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
198 # does something where caching could be used, the field is automatically marked
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
199 # to be cached later. For example after FETCH BODY the BODY will be cached
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
200 # for all new messages. Normally you should leave this alone, unless you know
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
201 # what most of your IMAP clients are. Caching more fields than needed makes
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
202 # the index files larger and generate useless I/O.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
203 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
204 # With maildir there's one extra optimization - if nothing is cached, indexing
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
205 # the maildir becomes much faster since it's not opening any of the mail files.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
206 # This could be useful if your IMAP clients access only new mails.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
207
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
208 #mail_cache_fields = MessagePart
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents: 435
diff changeset
209
987
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
210 # Space-separated list of fields that Dovecot should never set to be cached.
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
211 # Useful if you want to save disk space at the cost of more I/O when the fields
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
212 # needed.
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
213 #mail_never_cache_fields =
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
214
1138
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
215 # Workarounds for various client bugs:
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
216 # oe6-fetch-no-newmail:
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
217 # Never send EXISTS/RECENT when replying to FETCH command. Outlook Express
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
218 # seems to think they are FETCH replies and gives user "Message no longer
1180
930452c85250 comment update
Timo Sirainen <tss@iki.fi>
parents: 1177
diff changeset
219 # in server" error. Note that OE6 still breaks even with this workaround
930452c85250 comment update
Timo Sirainen <tss@iki.fi>
parents: 1177
diff changeset
220 # if synchronization is set to "Headers Only".
1212
9ced30dda6c3 workaround: outlook-idle
Timo Sirainen <tss@iki.fi>
parents: 1199
diff changeset
221 # outlook-idle:
9ced30dda6c3 workaround: outlook-idle
Timo Sirainen <tss@iki.fi>
parents: 1199
diff changeset
222 # Outlook and Outlook Express never abort IDLE command, so if no mail
9ced30dda6c3 workaround: outlook-idle
Timo Sirainen <tss@iki.fi>
parents: 1199
diff changeset
223 # arrives in half a hour, Dovecot closes the connection. This is still
9ced30dda6c3 workaround: outlook-idle
Timo Sirainen <tss@iki.fi>
parents: 1199
diff changeset
224 # fine, except Outlook doesn't connect back so you don't see if new mail
9ced30dda6c3 workaround: outlook-idle
Timo Sirainen <tss@iki.fi>
parents: 1199
diff changeset
225 # arrives.
1138
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
226 #client_workarounds =
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6.
Timo Sirainen <tss@iki.fi>
parents: 1124
diff changeset
227
600
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents: 596
diff changeset
228 # Dovecot can notify client of new mail in selected mailbox soon after it's
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents: 596
diff changeset
229 # received. This setting specifies the minimum interval in seconds between
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents: 596
diff changeset
230 # new mail notifications to client - internally they may be checked more or
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents: 596
diff changeset
231 # less often. Setting this to 0 disables the checking.
788
5b2a247ed361 mailbox_check_interval is now disabled by default, at least Evolution breaks
Timo Sirainen <tss@iki.fi>
parents: 780
diff changeset
232 # NOTE: Evolution client breaks with this option when it's trying to APPEND.
5b2a247ed361 mailbox_check_interval is now disabled by default, at least Evolution breaks
Timo Sirainen <tss@iki.fi>
parents: 780
diff changeset
233 #mailbox_check_interval = 0
600
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents: 596
diff changeset
234
1177
dee729f18aa1 IDLE setting.
Timo Sirainen <tss@iki.fi>
parents: 1168
diff changeset
235 # Like mailbox_check_interval, but used for IDLE command.
dee729f18aa1 IDLE setting.
Timo Sirainen <tss@iki.fi>
parents: 1168
diff changeset
236 #mailbox_idle_check_interval = 30
dee729f18aa1 IDLE setting.
Timo Sirainen <tss@iki.fi>
parents: 1168
diff changeset
237
1151
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
238 # Allow full filesystem access to clients. There's no access checks other than
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
239 # what the operating system does for the active UID/GID. It works with both
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
240 # maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
241 # or ~user/.
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
242 #mail_full_filesystem_access = no
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable
Timo Sirainen <tss@iki.fi>
parents: 1142
diff changeset
243
1986
7ac0ef106427 s/custom flags/keywords/
Timo Sirainen <tss@iki.fi>
parents: 1920
diff changeset
244 # Maximum allowed length for mail keyword name. It's only forced when trying
7ac0ef106427 s/custom flags/keywords/
Timo Sirainen <tss@iki.fi>
parents: 1920
diff changeset
245 # to create new keywords.
7ac0ef106427 s/custom flags/keywords/
Timo Sirainen <tss@iki.fi>
parents: 1920
diff changeset
246 #mail_max_keyword_length = 50
1168
03f1455664d7 Added setting to limit length of custom flag names.
Timo Sirainen <tss@iki.fi>
parents: 1151
diff changeset
247
472
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents: 462
diff changeset
248 # Save mails with CR+LF instead of plain LF. This makes sending those mails
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents: 462
diff changeset
249 # take less CPU, especially with sendfile() syscall with Linux and FreeBSD.
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents: 462
diff changeset
250 # But it also creates a bit more disk I/O which may just make it slower.
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents: 462
diff changeset
251 #mail_save_crlf = no
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents: 462
diff changeset
252
644
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read()
Timo Sirainen <tss@iki.fi>
parents: 643
diff changeset
253 # Use mmap() instead of read() to read mail files. read() seems to be a bit
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read()
Timo Sirainen <tss@iki.fi>
parents: 643
diff changeset
254 # faster with my Linux/x86 and it's better with NFS, so that's the default.
1622
d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing
Timo Sirainen <tss@iki.fi>
parents: 1615
diff changeset
255 # Note that OpenBSD 3.3 and older don't work right with mail_read_mmaped = yes.
644
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read()
Timo Sirainen <tss@iki.fi>
parents: 643
diff changeset
256 #mail_read_mmaped = no
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read()
Timo Sirainen <tss@iki.fi>
parents: 643
diff changeset
257
1918
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
258 # Don't use mmap() at all. This is required if you store indexes in remote
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
259 # filesystems (NFS or clustered filesystem).
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
260 #mmap_disable = no
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
261
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
262 # Don't write() to mmaped files. This is required for some operating systems
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
263 # which use separate caches for them, such as OpenBSD.
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
264 #mmap_no_write = no
ef89efba1838 updated for mmap changes
Timo Sirainen <tss@iki.fi>
parents: 1911
diff changeset
265
1920
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some
Timo Sirainen <tss@iki.fi>
parents: 1918
diff changeset
266 # Don't use fcntl() locking. Alternatives are dotlocking and other tricks
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some
Timo Sirainen <tss@iki.fi>
parents: 1918
diff changeset
267 # which may be slower. Required for NFS.
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some
Timo Sirainen <tss@iki.fi>
parents: 1918
diff changeset
268 #fcntl_locks_disable = no
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some
Timo Sirainen <tss@iki.fi>
parents: 1918
diff changeset
269
2078
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
270 # By default LIST command returns all entries in maildir beginning with dot.
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
271 # Enabling this option makes Dovecot return only entries which are directories.
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
272 # This is done by stat()ing each entry, so it causes more disk I/O.
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
273 # (For systems setting struct dirent->d_type, this check is free and it's
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
274 # done always regardless of this setting)
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
275 #maildir_stat_dirs = no
b3daf55df932 Added maildir_stat_dirs option.
Timo Sirainen <tss@iki.fi>
parents: 2068
diff changeset
276
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
277 # Copy mail to another folders using hard links. This is much faster than
987
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
278 # actually copying the file. This is problematic only if something modifies
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
279 # the mail in one folder but doesn't want it modified in the others. I don't
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
280 # know any MUA which would modify mail files directly. IMAP protocol also
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
281 # requires that the mails don't change, so it would be problematic in any case.
cbf096fbb9f0 comment updates
Timo Sirainen <tss@iki.fi>
parents: 979
diff changeset
282 # If you care about performance, enable it.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
283 #maildir_copy_with_hardlinks = no
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
284
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
285 # Check if mails' content has been changed by external programs. This slows
882
38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new
Timo Sirainen <tss@iki.fi>
parents: 872
diff changeset
286 # down things as extra stat() needs to be called for each file. If changes are
38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new
Timo Sirainen <tss@iki.fi>
parents: 872
diff changeset
287 # noticed, the message is treated as a new message, since IMAP protocol
1911
ac810e95cdd6 typofix
Timo Sirainen <tss@iki.fi>
parents: 1879
diff changeset
288 # specifies that existing messages are immutable.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
289 #maildir_check_content_changes = no
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
290
2103
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
291 # Which locking methods to use for locking mbox. There's four available:
1113
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
292 # dotlock: Create <mailbox>.lock file. This is the oldest and most NFS-safe
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
293 # solution. If you want to use /var/mail/ like directory, the users
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
294 # will need write access to that directory.
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
295 # fcntl : Use this if possible. Works with NFS too if lockd is used.
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
296 # flock : May not exist in all systems. Doesn't work with NFS.
2103
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
297 # lockf : May not exist in all systems. Doesn't work with NFS.
1113
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work
Timo Sirainen <tss@iki.fi>
parents: 1055
diff changeset
298 #
2103
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
299 # You can use multiple locking methods; if you do the order they're declared
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
300 # in is important to avoid deadlocks if other MTAs/MUAs are using multiple
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
301 # locking methods as well. Some operating systems don't allow using some of
2205
821fbe3e892b Don't require dotlocking to be first in locking list.
Timo Sirainen <tss@iki.fi>
parents: 2163
diff changeset
302 # them simultaneously.
2103
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
303 #mbox_read_locks = fcntl
879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and
Timo Sirainen <tss@iki.fi>
parents: 2097
diff changeset
304 #mbox_write_locks = dotlock fcntl
643
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
305
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
306 # Maximum time in seconds to wait for lock (all of them) before aborting.
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
307 #mbox_lock_timeout = 300
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
308
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
309 # If dotlock exists but the mailbox isn't modified in any way, override the
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
310 # lock file after this many seconds.
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
311 #mbox_dotlock_change_timeout = 30
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and
Timo Sirainen <tss@iki.fi>
parents: 615
diff changeset
312
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
313 # umask to use for mail files and directories
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
314 #umask = 0077
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
315
1223
52e0830ade13 Added setting mail_drop_priv_before_exec.
Timo Sirainen <tss@iki.fi>
parents: 1218
diff changeset
316 # Drop all privileges before exec()ing the mail process. This is mostly
2027
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
317 # meant for debugging, otherwise you don't get core dumps. It could be a small
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
318 # security risk if you use single UID for multiple users, as the users could
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
319 # ptrace() each others processes then.
1223
52e0830ade13 Added setting mail_drop_priv_before_exec.
Timo Sirainen <tss@iki.fi>
parents: 1218
diff changeset
320 #mail_drop_priv_before_exec = no
52e0830ade13 Added setting mail_drop_priv_before_exec.
Timo Sirainen <tss@iki.fi>
parents: 1218
diff changeset
321
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
322 # Set max. process size in megabytes. Most of the memory goes to mmap()ing
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
323 # files, so it shouldn't harm much even if this limit is set pretty high.
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
324 #mail_process_size = 256
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1437
diff changeset
325
2097
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
326 # Log prefix for mail processes. See doc/variables.txt for list of possible
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
327 # variables you can use.
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
328 #mail_log_prefix = "%Up(%u): "
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting.
Timo Sirainen <tss@iki.fi>
parents: 2078
diff changeset
329
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
330 ##
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
331 ## IMAP specific settings
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
332 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
333
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
334 protocol imap {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
335 # Login executable location.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
336 #login_executable = /usr/libexec/dovecot/imap-login
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
337
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
338 # IMAP executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
339 #mail_executable = /usr/libexec/dovecot/imap
1727
6d10ece6cf9f added rawlog example
Timo Sirainen <tss@iki.fi>
parents: 1725
diff changeset
340 # This would write rawlogs into ~/dovecot.rawlog/ directory:
6d10ece6cf9f added rawlog example
Timo Sirainen <tss@iki.fi>
parents: 1725
diff changeset
341 #mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
342
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
343 # Maximum IMAP command line length in bytes. Some clients generate very long
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
344 # command lines with huge mailboxes, so you may need to raise this if you get
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
345 # "Too long argument" or "IMAP command line too large" errors often.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
346 #imap_max_line_length = 65536
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
347
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
348 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
349 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
350 #mail_modules = /usr/lib/dovecot/imap
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
351 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
352
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
353 ##
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
354 ## POP3 specific settings
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
355 ##
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
356
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
357 protocol pop3 {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
358 # Login executable location.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
359 #login_executable = /usr/libexec/dovecot/pop3-login
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
360
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
361 # POP3 executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
362 #mail_executable = /usr/libexec/dovecot/pop3
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
363
2039
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash.
Timo Sirainen <tss@iki.fi>
parents: 2027
diff changeset
364 # Don't try to set mails non-recent with POP3 sessions. This is mostly
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash.
Timo Sirainen <tss@iki.fi>
parents: 2027
diff changeset
365 # intended to reduce disk I/O. With maildir it doesn't move files from
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash.
Timo Sirainen <tss@iki.fi>
parents: 2027
diff changeset
366 # new/ to cur/, with mbox it doesn't write Status-header.
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash.
Timo Sirainen <tss@iki.fi>
parents: 2027
diff changeset
367 #pop3_mails_keep_recent = no
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash.
Timo Sirainen <tss@iki.fi>
parents: 2027
diff changeset
368
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
369 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
370 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
371 #mail_modules = /usr/lib/dovecot/pop3
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
372 }
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1437
diff changeset
373
1055
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3
Timo Sirainen <tss@iki.fi>
parents: 1040
diff changeset
374 ##
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
375 ## Authentication processes
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
376 ##
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
377
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
378 # You can have multiple authentication processes. With plaintext authentication
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
379 # the password is checked against each process, the first one which succeeds is
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
380 # used. This is useful if you want to allow both system users (/etc/passwd)
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
381 # and virtual users to login without duplicating the system users into virtual
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
382 # database.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
383
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
384 # Executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
385 #auth_executable = /usr/libexec/dovecot/dovecot-auth
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
386
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
387 # Set max. process size in megabytes.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
388 #auth_process_size = 256
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
389
1328
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
390 # Space separated list of realms for SASL authentication mechanisms that need
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
391 # them. You can leave it empty if you don't want to support multiple realms.
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
392 # Many clients simply use the first one listed here, so keep the default realm
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
393 # first.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
394 #auth_realms =
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
395
2133
6e662d7188e9 comment update
Timo Sirainen <tss@iki.fi>
parents: 2103
diff changeset
396 # Default realm/domain to use if none was specified. This is used for both
6e662d7188e9 comment update
Timo Sirainen <tss@iki.fi>
parents: 2103
diff changeset
397 # SASL realms and appending @domain to username in plaintext logins.
1328
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
398 #auth_default_realm =
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann)
Timo Sirainen <tss@iki.fi>
parents: 1318
diff changeset
399
1330
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
400 # List of allowed characters in username. If the user-given username contains
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
401 # a character not listed in here, the login automatically fails. This is just
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
402 # an extra check to make sure user can't exploit any potential quote escaping
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
403 # vulnerabilities with SQL/LDAP databases. If you want to allow all characters,
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
404 # set this value to empty.
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
405 #auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@
7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other
Timo Sirainen <tss@iki.fi>
parents: 1328
diff changeset
406
1437
c27c6089e933 Added support for ANONYMOUS SASL mechanism.
Timo Sirainen <tss@iki.fi>
parents: 1330
diff changeset
407 # Username to use for users logging in with ANONYMOUS SASL mechanism
c27c6089e933 Added support for ANONYMOUS SASL mechanism.
Timo Sirainen <tss@iki.fi>
parents: 1330
diff changeset
408 #auth_anonymous_username = anonymous
c27c6089e933 Added support for ANONYMOUS SASL mechanism.
Timo Sirainen <tss@iki.fi>
parents: 1330
diff changeset
409
999
070aee0e5b9f Added auth_verbose
Timo Sirainen <tss@iki.fi>
parents: 987
diff changeset
410 # More verbose logging. Useful for figuring out why authentication isn't
070aee0e5b9f Added auth_verbose
Timo Sirainen <tss@iki.fi>
parents: 987
diff changeset
411 # working.
070aee0e5b9f Added auth_verbose
Timo Sirainen <tss@iki.fi>
parents: 987
diff changeset
412 #auth_verbose = no
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
413
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
414 auth default {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
415 # Space separated list of wanted authentication mechanisms:
1879
6d37e8554dbb cram-md5 updates.
Timo Sirainen <tss@iki.fi>
parents: 1747
diff changeset
416 # plain digest-md5 cram-md5 anonymous
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
417 mechanisms = plain
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
418
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
419 # Where user database is kept:
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
420 # passwd: /etc/passwd or similiar, using getpwnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
421 # passwd-file <path>: passwd-like file with specified location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
422 # static uid=<uid> gid=<gid> home=<dir template>: static settings
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
423 # vpopmail: vpopmail library
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
424 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
425 # pgsql <config path>: a PostgreSQL database, see doc/dovecot-pgsql.conf
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
426 userdb = passwd
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
427
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
428 # Where password database is kept:
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
429 # passwd: /etc/passwd or similiar, using getpwnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
430 # shadow: /etc/shadow or similiar, using getspnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
431 # pam [<service> | *]: PAM authentication
2163
506302b8b2fb comment update
Timo Sirainen <tss@iki.fi>
parents: 2141
diff changeset
432 # checkpassword <path>: checkpassword executable authentication
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
433 # passwd-file <path>: passwd-like file with specified location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
434 # vpopmail: vpopmail authentication
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
435 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
436 # pgsql <config path>: a PostgreSQL database, see doc/dovecot-pgsql.conf
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
437 passdb = pam
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
438
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
439 # User to use for the process. This user needs access to only user and
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
440 # password databases, nothing else. Only shadow and pam authentication
1615
a8dc875a8918 Included comment about passwd+BSD requiring roots.
Timo Sirainen <tss@iki.fi>
parents: 1610
diff changeset
441 # requires roots, so use something else if possible. Note that passwd
a8dc875a8918 Included comment about passwd+BSD requiring roots.
Timo Sirainen <tss@iki.fi>
parents: 1610
diff changeset
442 # authentication with BSDs internally accesses shadow files, which also
a8dc875a8918 Included comment about passwd+BSD requiring roots.
Timo Sirainen <tss@iki.fi>
parents: 1610
diff changeset
443 # requires roots.
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
444 user = root
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
445
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
446 # Directory where to chroot the process. Most authentication backends don't
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
447 # work if this is set, and there's no point chrooting if auth_user is root.
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
448 #chroot =
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
449
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
450 # Number of authentication processes to create
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
451 #count = 1
2027
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
452
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
453 # Require a valid SSL client certificate or the authentication fails.
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide
Timo Sirainen <tss@iki.fi>
parents: 1997
diff changeset
454 #ssl_require_client_cert = no
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
455 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
456
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
457 # PAM doesn't provide a way to get uid, gid or home directory. If you don't
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
458 # want to use a separate user database (passwd usually), you can use static
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
459 # userdb.
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
460
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
461 #auth onlypam {
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
462 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
463 # userdb = static uid=500 gid=500 home=/var/mail/%u
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
464 # passdb = pam
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
465 # user = dovecot-auth
1610
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat
Timo Sirainen <tss@iki.fi>
parents: 1592
diff changeset
466 #}
0
3b1985cbc908 Initial revision
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
467
1707
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
468 #auth ldap {
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
469 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
470 # userdb = ldap /etc/dovecot-ldap.conf
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
471 # passdb = ldap /etc/dovecot-ldap.conf
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
472 # user = dovecot-auth
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
473 #}
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
474
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
475 #auth virtualfile {
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
476 # mechanisms = plain digest-md5
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
477 # userdb = passwd-file /etc/passwd.imap
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
478 # passdb = passwd-file /etc/passwd.imap
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
479 # user = dovecot-auth
ba70d60987e2 We now support checking the password against all defined auth processes and
Timo Sirainen <tss@iki.fi>
parents: 1688
diff changeset
480 #}