dovecot/original-hg/dovecot-1.2: dovecot-example.conf annotate

annotate dovecot-example.conf @ 5535:7aa36ab24c3b HEAD

Changed convert_skip_dotfiles to convert_skip_dotdirs. convert_skip_broken_mailboxes=yes is enough to skip non-mbox dotfiles.

author	Timo Sirainen <tss@iki.fi>
date	Tue, 10 Apr 2007 17:37:19 +0300
parents	c69786bd2017
children	fab24638eee7

rev	line source
3951 f504dbc84d38 Removed "1.0" version number. Timo Sirainen <tss@iki.fi> parents: 3918 diff changeset	1 ## Dovecot configuration file
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	2
4081 81d56edc16c8 Added link to QuickConfiguration. Timo Sirainen <tss@iki.fi> parents: 4080 diff changeset	3 # If you're in a hurry, see http://wiki.dovecot.org/QuickConfiguration
81d56edc16c8 Added link to QuickConfiguration. Timo Sirainen <tss@iki.fi> parents: 4080 diff changeset	4
5457 b0951692c45c Added a note about dovecot -n Timo Sirainen <tss@iki.fi> parents: 5451 diff changeset	5 # "dovecot -n" command gives a clean output of the changed settings. Use it
b0951692c45c Added a note about dovecot -n Timo Sirainen <tss@iki.fi> parents: 5451 diff changeset	6 # instead of copy&pasting this file when posting to the Dovecot mailing list.
b0951692c45c Added a note about dovecot -n Timo Sirainen <tss@iki.fi> parents: 5451 diff changeset	7
2231 58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	8 # '#' character and everything after it is treated as comments. Extra spaces
58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	9 # and tabs are ignored. If you want to use either of these explicitly, put the
58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	10 # value inside quotes, eg.: key = "# char and trailing whitespace "
58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	11
4484 d2c14175a509 Comment updates Timo Sirainen <tss@iki.fi> parents: 4483 diff changeset	12 # Default values are shown for each setting, it's not required to uncomment
d2c14175a509 Comment updates Timo Sirainen <tss@iki.fi> parents: 4483 diff changeset	13 # any of the lines. Exception to this are paths, they're just examples with
d2c14175a509 Comment updates Timo Sirainen <tss@iki.fi> parents: 4483 diff changeset	14 # the real defaults being based on configure options. The paths listed here
435 06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	15 # 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	16 # --with-ssldir=/etc/ssl
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	17
872 6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	18 # 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	19 #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	20
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	21 # Protocols we want to be serving: imap imaps pop3 pop3s
4627 60a081e2a1dc Comment about protocols=none. Timo Sirainen <tss@iki.fi> parents: 4588 diff changeset	22 # If you only want to use dovecot-auth, you can set this to "none".
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	23 #protocols = imap imaps
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	24
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	25 # 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	26 # 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	27 # "[::]" listens in all IPv6 interfaces, but may also listen in all IPv4
4080 89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	28 # interfaces depending on the operating system.
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	29 #
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	30 # If you want to specify ports for each service, you will need to configure
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	31 # these settings inside the protocol imap/pop3 { ... } section, so you can
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	32 # specify different ports for IMAP/POP3. For example:
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	33 # protocol imap {
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	34 # listen = *:10143
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	35 # ssl_listen = *:10943
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	36 # ..
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	37 # }
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	38 # protocol pop3 {
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	39 # listen = *:10100
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	40 # ..
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	41 # }
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	42 #listen = *
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	43
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	44 # Disable LOGIN command and all other plaintext authentications unless
4467 eaab43f6f65f Removed hardcoded 127.* and ::1 IP checks. Instead just check that local IP Timo Sirainen <tss@iki.fi> parents: 4456 diff changeset	45 # SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP
eaab43f6f65f Removed hardcoded 127.* and ::1 IP checks. Instead just check that local IP Timo Sirainen <tss@iki.fi> parents: 4456 diff changeset	46 # matches the local IP (ie. you're connecting from the same computer), the
eaab43f6f65f Removed hardcoded 127.* and ::1 IP checks. Instead just check that local IP Timo Sirainen <tss@iki.fi> parents: 4456 diff changeset	47 # connection is considered secure and plaintext authentication is allowed.
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	48 #disable_plaintext_auth = yes
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	49
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	50 # Should all IMAP and POP3 processes be killed when Dovecot master process
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	51 # shuts down. Setting this to "no" means that Dovecot can be upgraded without
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	52 # forcing existing client connections to close (although that could also be
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	53 # a problem if the upgrade is eg. because of a security fix). This however
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	54 # means that after master process has died, the client processes can't write
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	55 # to log files anymore.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	56 #shutdown_clients = yes
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	57
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	58 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	59 ## Logging
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	60 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	61
5142 ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	62 # Log file to use for error messages, instead of sending them to syslog.
ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	63 # /dev/stderr can be used to log into stderr.
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	64 #log_path =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	65
5142 ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	66 # Log file to use for informational and debug messages.
ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	67 # Default is the same as log_path.
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	68 #info_log_path =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	69
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	70 # Prefix for each line written to log file. % codes are in strftime(3)
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	71 # format.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	72 #log_timestamp = "%b %d %H:%M:%S "
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	73
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	74 # Syslog facility to use if you're logging to syslog. Usually if you don't
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	75 # want to use "mail", you'll use local0..local7. Also other standard
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	76 # facilities are supported.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	77 #syslog_facility = mail
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	78
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	79 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	80 ## SSL settings
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	81 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	82
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	83 # 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	84 # 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	85 #ssl_listen =
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	86
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	87 # Disable SSL/TLS support.
666 36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	88 #ssl_disable = no
36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	89
519 9e121e74c188 and a couple more fixes.. Timo Sirainen <tss@iki.fi> parents: 518 diff changeset	90 # 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	91 # 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	92 # 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	93 # 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	94 #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	95 #ssl_key_file = /etc/ssl/private/dovecot.pem
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	96
3889 c7462001227b Added support for password protected SSL private keys. The password can be Timo Sirainen <tss@iki.fi> parents: 3888 diff changeset	97 # If key file is password protected, give the password here. Alternatively
c7462001227b Added support for password protected SSL private keys. The password can be Timo Sirainen <tss@iki.fi> parents: 3888 diff changeset	98 # give it when starting dovecot with -p parameter.
c7462001227b Added support for password protected SSL private keys. The password can be Timo Sirainen <tss@iki.fi> parents: 3888 diff changeset	99 #ssl_key_password =
c7462001227b Added support for password protected SSL private keys. The password can be Timo Sirainen <tss@iki.fi> parents: 3888 diff changeset	100
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	101 # File containing trusted SSL certificate authorities. Usually not needed.
4695 07afd19bc53e Updates to ssl_ca_file and ssl_username_from_cert comments in Timo Sirainen <tss@iki.fi> parents: 4658 diff changeset	102 # The CAfile should contain the CA-certificate(s) followed by the matching
07afd19bc53e Updates to ssl_ca_file and ssl_username_from_cert comments in Timo Sirainen <tss@iki.fi> parents: 4658 diff changeset	103 # CRL(s). CRL checking is new in dovecot .rc1
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	104 #ssl_ca_file =
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	105
5245 b6be3258cf9d Added note about ssl_require_client_cert in ssl_verify_client_cert comments. Timo Sirainen <tss@iki.fi> parents: 5243 diff changeset	106 # Request client to send a certificate. If you also want to require it, set
b6be3258cf9d Added note about ssl_require_client_cert in ssl_verify_client_cert comments. Timo Sirainen <tss@iki.fi> parents: 5243 diff changeset	107 # ssl_require_client_cert=yes in auth section.
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	108 #ssl_verify_client_cert = no
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	109
615 0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	110 # 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	111 # 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	112 # entirely.
3888 650701d41cdf Generate DH parameters and use them. Changed default regeneration time to 1 Timo Sirainen <tss@iki.fi> parents: 3887 diff changeset	113 #ssl_parameters_regenerate = 168
615 0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	114
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	115 # SSL ciphers to use
4696 abf9a1234b99 Don't allow SSLv2 by default. Timo Sirainen <tss@iki.fi> parents: 4695 diff changeset	116 #ssl_cipher_list = ALL:!LOW:!SSLv2
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	117
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	118 # Show protocol level SSL errors.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	119 #verbose_ssl = no
3724 d22c883021da Added syslog_facility setting to config file. Timo Sirainen <tss@iki.fi> parents: 3718 diff changeset	120
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	121 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	122 ## Login processes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	123 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	124
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	125 # <doc/wiki/LoginProcess.txt>
5243 b931a7d3c576 Added LoginProcess wiki link. Timo Sirainen <tss@iki.fi> parents: 5215 diff changeset	126
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	127 # 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	128 # 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	129 # 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	130 # 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	131 #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	132
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	133 # chroot login process to the login_dir. Only reason not to do this is if you
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	134 # wish to run the whole Dovecot without roots. <doc/wiki/Rootless.txt>
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	135 #login_chroot = yes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	136
1582 498a9b7797f2 Comment updates Timo Sirainen <tss@iki.fi> parents: 1578 diff changeset	137 # 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	138 # 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	139 # only it has access, it's used to control access for authentication process.
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	140 # Note that this user is NOT used to access mails. <doc/wiki/UserIds.txt>
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	141 #login_user = dovecot
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	142
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	143 # 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	144 # 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	145 #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	146
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	147 # 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	148 # 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	149 # 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	150 # 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	151 #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	152
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	153 # Number of login processes to keep for listening new connections.
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	154 #login_processes_count = 3
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	155
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	156 # Maximum number of login processes to create. The listening process count
614 e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	157 # 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	158 # 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	159 # we check only once in a second if new processes should be created - if all
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	160 # of them are used at the time, we double their amount until the limit set by
9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	161 # this setting is reached.
614 e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	162 #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	163
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	164 # Maximum number of connections allowed per each login process. This setting
9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	165 # is used only if login_process_per_connection=no. Once the limit is reached,
9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	166 # the process notifies master so that it can create a new login process.
4561 c8177c854d65 Updated login_max_connections comment. Timo Sirainen <tss@iki.fi> parents: 4538 diff changeset	167 # You should make sure that the process has at least
c8177c854d65 Updated login_max_connections comment. Timo Sirainen <tss@iki.fi> parents: 4538 diff changeset	168 # 16 + login_max_connections * 2 available file descriptors.
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	169 #login_max_connections = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	170
2674 857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	171 # Greeting message for clients.
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	172 #login_greeting = Dovecot ready.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	173
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	174 # Space-separated list of elements we want to log. The elements which have
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	175 # a non-empty variable value are joined together to form a comma-separated
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	176 # string.
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	177 #login_log_format_elements = user=<%u> method=%m rip=%r lip=%l %c
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	178
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	179 # Login log format. %$ contains login_log_format_elements string, %s contains
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	180 # the data we want to log.
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	181 #login_log_format = %$: %s
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	182
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	183 ##
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	184 ## Mailbox locations and namespaces
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	185 ##
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	186
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	187 # Location for users' mailboxes. This is the same as the old default_mail_env
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	188 # setting. The default is empty, which means that Dovecot tries to find the
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	189 # mailboxes automatically. This won't work if the user doesn't have any mail
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	190 # yet, so you should explicitly tell Dovecot the full location.
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	191 #
4702 11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	192 # If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u)
11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	193 # isn't enough. You'll also need to tell Dovecot where the other mailboxes are
11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	194 # and where Dovecot can place its index files. This is called the "root mail
11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	195 # directory", and it must be the first path given in the mail_location setting.
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	196 #
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	197 # There are 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	198 #
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	199 # %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	200 # %n - user part in user@domain, same as %u if there's no domain
2447 be2e8dfe25be comment fix Timo Sirainen <tss@iki.fi> parents: 2417 diff changeset	201 # %d - domain part in user@domain, empty if there's no domain
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	202 # %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	203 #
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	204 # See doc/wiki/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	205 #
4702 11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	206 # mail_location = maildir:~/Maildir
11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	207 # mail_location = mbox:~/mail:INBOX=/var/mail/%u
11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	208 # mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%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	209 #
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	210 # <doc/wiki/MailLocation.txt>
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	211 #
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	212 #mail_location =
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	213
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	214 # If you need to set multiple mailbox locations or want to change default
5444 208c4fe8e1c9 Added a note about namespaces working only with IMAP. Timo Sirainen <tss@iki.fi> parents: 5441 diff changeset	215 # namespace settings, you can do it by defining namespace sections.
208c4fe8e1c9 Added a note about namespaces working only with IMAP. Timo Sirainen <tss@iki.fi> parents: 5441 diff changeset	216 # NOTE: Namespaces currently work ONLY with IMAP! POP3 and LDA currently ignore
208c4fe8e1c9 Added a note about namespaces working only with IMAP. Timo Sirainen <tss@iki.fi> parents: 5441 diff changeset	217 # namespaces completely, they use only the mail_location setting.
3144 33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	218 #
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	219 # You can have private, shared and public namespaces. The only difference
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	220 # between them is how Dovecot announces them to client via NAMESPACE
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	221 # extension. Shared namespaces are meant for user-owned mailboxes which are
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	222 # shared to other users, while public namespaces are for more globally
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	223 # accessible mailboxes.
3144 33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	224 #
33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	225 # REMEMBER: If you add any namespaces, the default namespace must be added
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	226 # explicitly, ie. mail_location does nothing unless you have a namespace
3144 33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	227 # without a location setting. Default namespace is simply done by having a
33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	228 # namespace with empty prefix.
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	229 #namespace private {
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	230 # Hierarchy separator to use. You should use the same separator for all
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	231 # namespaces or some clients get confused. '/' is usually a good one.
4483 e2521ee11147 Updated namespace separator's comments. Timo Sirainen <tss@iki.fi> parents: 4467 diff changeset	232 # The default however depends on the underlying mail storage format.
e2521ee11147 Updated namespace separator's comments. Timo Sirainen <tss@iki.fi> parents: 4467 diff changeset	233 #separator =
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	234
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	235 # Prefix required to access this namespace. This needs to be different for
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	236 # all namespaces. For example "Public/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	237 #prefix =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	238
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	239 # Physical location of the mailbox. This is in same format as
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	240 # mail_location, which is also the default for it.
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	241 #location =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	242
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	243 # There can be only one INBOX, and this setting defines which namespace
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	244 # has it.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	245 #inbox = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	246
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	247 # If namespace is hidden, it's not advertised to clients via NAMESPACE
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	248 # extension or shown in LIST replies. This is mostly useful when converting
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	249 # from another server with different namespaces which you want to depricate
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	250 # but still keep working. For example you can create hidden namespaces with
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	251 # prefixes "~/mail/", "~%u/mail/" and "mail/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	252 #hidden = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	253 #}
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	254
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	255 # Grant access to these extra groups for mail processes. Typical use would be
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	256 # to give "mail" group write access to /var/mail to be able to create dotlocks.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	257 #mail_extra_groups =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	258
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	259 # Allow full filesystem access to clients. There's no access checks other than
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	260 # what the operating system does for the active UID/GID. It works with both
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	261 # maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	262 # or ~user/.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	263 #mail_full_filesystem_access = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	264
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	265 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	266 ## Mail processes
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	267 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	268
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	269 # Enable mail process debugging. This can help you figure out why Dovecot
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	270 # isn't finding your mails.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	271 #mail_debug = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	272
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	273 # Log prefix for mail processes. See doc/wiki/Variables.txt for list of
9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	274 # possible variables you can use.
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	275 #mail_log_prefix = "%Us(%u): "
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	276
5098 176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	277 # Max. number of lines a mail process is allowed to log per second before it's
176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	278 # throttled. 0 means unlimited. Typically there's no need to change this
176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	279 # unless you're using mail_log plugin, which may log a lot.
176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	280 #mail_log_max_lines_per_sec = 10
176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	281
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	282 # Don't use mmap() at all. This is required if you store indexes to shared
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	283 # filesystems (NFS or clustered filesystem).
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	284 #mmap_disable = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	285
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	286 # Don't write() to mmaped files. This is required for some operating systems
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	287 # which use separate caches for them, such as OpenBSD.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	288 #mmap_no_write = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	289
4968 1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	290 # Rely on O_EXCL to work when creating dotlock files. The default is to use
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	291 # hard linking. O_EXCL makes the dotlocking faster, but it doesn't always
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	292 # work with NFS.
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	293 #dotlock_use_excl = no
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	294
4918 2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	295 # Don't use fsync() or fdatasync() calls. This makes the performance better
2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	296 # at the cost of potential data loss if the server (or the file server)
2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	297 # goes down.
2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	298 #fsync_disable = no
2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	299
5498 21199280aa3b Added mailbox_list_index_disable setting. Timo Sirainen <tss@iki.fi> parents: 5457 diff changeset	300 # Disable mailbox list indexing.
21199280aa3b Added mailbox_list_index_disable setting. Timo Sirainen <tss@iki.fi> parents: 5457 diff changeset	301 #mailbox_list_index_disable = no
21199280aa3b Added mailbox_list_index_disable setting. Timo Sirainen <tss@iki.fi> parents: 5457 diff changeset	302
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	303 # Locking method for index files. Alternatives are fcntl, flock and dotlock.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	304 # Dotlocking uses some tricks which may create more disk I/O than other locking
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	305 # methods. NOTE: If you use NFS, remember to change also mmap_disable setting!
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	306 #lock_method = fcntl
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	307
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	308 # Drop all privileges before exec()ing the mail process. This is mostly
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	309 # meant for debugging, otherwise you don't get core dumps. It could be a small
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	310 # security risk if you use single UID for multiple users, as the users could
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	311 # ptrace() each others processes then.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	312 #mail_drop_priv_before_exec = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	313
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	314 # Show more verbose process titles (in ps). Currently shows user name and
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	315 # IP address. Useful for seeing who are actually using the IMAP processes
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	316 # (eg. shared mailboxes or if same uid is used for multiple accounts).
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	317 #verbose_proctitle = no
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	318
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	319 # Valid UID range for users, defaults to 500 and above. This is mostly
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	320 # to make sure that users can't log in as daemons or other system users.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	321 # Note that denying root logins is hardcoded to dovecot binary and can't
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	322 # be done even if first_valid_uid is set to 0.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	323 #first_valid_uid = 500
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	324 #last_valid_uid = 0
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	325
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	326 # Valid GID range for users, defaults to non-root/wheel. Users having
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	327 # non-valid GID as primary group ID aren't allowed to log in. If user
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	328 # belongs to supplementary groups with non-valid GIDs, those groups are
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	329 # not set.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	330 #first_valid_gid = 1
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	331 #last_valid_gid = 0
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	332
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	333 # Maximum number of running mail processes. When this limit is reached,
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	334 # new users aren't allowed to log in.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	335 #max_mail_processes = 1024
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	336
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	337 # Set max. process size in megabytes. Most of the memory goes to mmap()ing
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	338 # files, so it shouldn't harm much even if this limit is set pretty high.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	339 #mail_process_size = 256
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	340
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	341 # Maximum allowed length for mail keyword name. It's only forced when trying
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	342 # to create new keywords.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	343 #mail_max_keyword_length = 50
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	344
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	345 # Default umask to use for mail files and directories.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	346 #umask = 0077
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	347
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	348 # ':' separated list of directories under which chrooting is allowed for mail
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	349 # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
5215 9914a148eea1 Updated valid_chroot_dirs and mail_chroot comments. Timo Sirainen <tss@iki.fi> parents: 5142 diff changeset	350 # This setting doesn't affect login_chroot or auth chroot variables.
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	351 # WARNING: Never add directories here which local users can modify, that
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	352 # may lead to root exploit. Usually this should be done only if you don't
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	353 # allow shell access for users. <doc/wiki/Chrooting.txt>
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	354 #valid_chroot_dirs =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	355
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	356 # Default chroot directory for mail processes. This can be overridden for
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	357 # specific users in user database by giving /./ in user's home directory
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	358 # (eg. /home/./user chroots into /home). Note that usually there is no real
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	359 # need to do chrooting, Dovecot doesn't allow users to access files outside
5441 9d36800df1ae Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org Timo Sirainen <tss@iki.fi> parents: 5439 diff changeset	360 # their mail directory anyway. <doc/wiki/Chrooting.txt>
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	361 #mail_chroot =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	362
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	363 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	364 ## Mailbox handling optimizations
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	365 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	366
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	367 # Space-separated list of fields to initially save into cache file. Currently
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	368 # these fields are allowed:
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	369 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	370 # flags, date.sent, date.received, size.virtual, size.physical
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	371 # mime.parts, imap.body, imap.bodystructure
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	372 #
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	373 # Different IMAP clients work in different ways, so they benefit from
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	374 # different cached fields. Some do not benefit from them at all. Caching more
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	375 # than necessary generates useless disk I/O, so you don't want to do that
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	376 # either.
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	377 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	378 # Dovecot attempts to automatically figure out what client wants and it keeps
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	379 # only that. However the first few times a mailbox is opened, Dovecot hasn't
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	380 # yet figured out what client needs, so it may not perform optimally. If you
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	381 # know what fields the majority of your clients need, it may be useful to set
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	382 # these fields by hand. If client doesn't actually use them, Dovecot will
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	383 # eventually drop them.
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	384 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	385 # Usually you should just leave this field alone. The potential benefits are
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	386 # typically unnoticeable.
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	387 #mail_cache_fields =
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	388
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	389 # Space-separated list of fields that Dovecot should never save to cache file.
987 cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	390 # 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	391 # needed.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	392 #mail_never_cache_fields =
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	393
3909 411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	394 # The minimum number of mails in a mailbox before updates are done to cache
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	395 # file. This allows optimizing Dovecot's behavior to do less disk writes at
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	396 # the cost of more disk reads.
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	397 #mail_cache_min_mail_count = 0
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	398
3726 ad1e6b8a5109 mailbox_idle_check_interval comment updated Timo Sirainen <tss@iki.fi> parents: 3724 diff changeset	399 # When IDLE command is running, mailbox is checked once in a while to see if
ad1e6b8a5109 mailbox_idle_check_interval comment updated Timo Sirainen <tss@iki.fi> parents: 3724 diff changeset	400 # there are any new mails or other changes. This setting defines the minimum
ad1e6b8a5109 mailbox_idle_check_interval comment updated Timo Sirainen <tss@iki.fi> parents: 3724 diff changeset	401 # time to wait between those checks. Dovecot is however able to use dnotify
ad1e6b8a5109 mailbox_idle_check_interval comment updated Timo Sirainen <tss@iki.fi> parents: 3724 diff changeset	402 # and inotify with Linux to reply immediately after the change occurs.
1177 dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	403 #mailbox_idle_check_interval = 30
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	404
472 2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	405 # 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	406 # 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	407 # But it also creates a bit more disk I/O which may just make it slower.
3648 2c19efe2ddb6 Added compatibility warning about mail_save_crlf. Timo Sirainen <tss@iki.fi> parents: 3636 diff changeset	408 # Also note that if other software reads the mboxes/maildirs, they may handle
2c19efe2ddb6 Added compatibility warning about mail_save_crlf. Timo Sirainen <tss@iki.fi> parents: 3636 diff changeset	409 # the extra CRs wrong and cause problems.
472 2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	410 #mail_save_crlf = no
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	411
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	412 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	413 ## Maildir-specific settings
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	414 ##
1920 d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	415
4959 4ba6b31ae15e Changed maildir_copy_with_hardlinks setting's description to be much more Timo Sirainen <tss@iki.fi> parents: 4954 diff changeset	416 # By default LIST command returns all entries in maildir beginning with a dot.
2078 b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	417 # 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	418 # 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	419 # (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	420 # done always regardless of this setting)
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	421 #maildir_stat_dirs = no
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	422
4959 4ba6b31ae15e Changed maildir_copy_with_hardlinks setting's description to be much more Timo Sirainen <tss@iki.fi> parents: 4954 diff changeset	423 # When copying a message, do it with hard links whenever possible. This makes
4ba6b31ae15e Changed maildir_copy_with_hardlinks setting's description to be much more Timo Sirainen <tss@iki.fi> parents: 4954 diff changeset	424 # the performance much better, and it's unlikely to have any side effects.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	425 #maildir_copy_with_hardlinks = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	426
4960 4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	427 # When copying a message, try to preserve the base filename. Only if the
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	428 # destination mailbox already contains the same name (ie. the mail is being
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	429 # copied there twice), a new name is given. The destination filename check is
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	430 # done only by looking at dovecot-uidlist file, so if something outside
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	431 # Dovecot does similar filename preserving copies, you may run into problems.
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	432 # NOTE: This setting requires maildir_copy_with_hardlinks = yes to work.
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	433 #maildir_copy_preserve_filename = no
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	434
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	435 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	436 ## mbox-specific settings
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	437 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	438
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	439 # Which locking methods to use for locking mbox. There are 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	440 # 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	441 # 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	442 # 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	443 # 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	444 # 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>

Mercurial > dovecot > original-hg > dovecot-1.2

annotate dovecot-example.conf @ 5535:7aa36ab24c3b HEAD