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

annotate dovecot-example.conf @ 5245:b6be3258cf9d HEAD

Added note about ssl_require_client_cert in ssl_verify_client_cert comments.

author	Timo Sirainen <tss@iki.fi>
date	Thu, 08 Mar 2007 15:42:25 +0200
parents	b931a7d3c576
children	8384f797c0fc

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
2231 58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	5 # '#' 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	6 # 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	7 # 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	8
4484 d2c14175a509 Comment updates Timo Sirainen <tss@iki.fi> parents: 4483 diff changeset	9 # 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	10 # 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	11 # 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	12 # 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	13 # --with-ssldir=/etc/ssl
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	14
872 6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	15 # 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	16 #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	17
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	18 # 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	19 # 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	20 #protocols = imap imaps
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	21
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	22 # 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	23 # 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	24 # "[::]" 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	25 # 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	26 #
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	27 # 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	28 # 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	29 # 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	30 # protocol imap {
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	31 # listen = *:10143
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	32 # ssl_listen = *:10943
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	33 # ..
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	34 # }
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	35 # protocol pop3 {
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	36 # listen = *:10100
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 # }
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	39 #listen = *
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	40
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	41 # 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	42 # 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	43 # 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	44 # 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	45 #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	46
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	47 # 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	48 # 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	49 # 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	50 # 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	51 # 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	52 # 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	53 #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	54
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	55 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	56 ## Logging
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
5142 ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	59 # 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	60 # /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	61 #log_path =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	62
5142 ce0a73d564f3 Cleaned up the log_file and info_log_file comments. Timo Sirainen <tss@iki.fi> parents: 5122 diff changeset	63 # 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	64 # 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	65 #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	66
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	67 # 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	68 # format.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	69 #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	70
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	71 # 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	72 # 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	73 # 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	74 #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	75
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	76 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	77 ## SSL settings
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
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	80 # 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	81 # 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	82 #ssl_listen =
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	83
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	84 # Disable SSL/TLS support.
666 36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	85 #ssl_disable = no
36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	86
519 9e121e74c188 and a couple more fixes.. Timo Sirainen <tss@iki.fi> parents: 518 diff changeset	87 # 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	88 # 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	89 # 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	90 # 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	91 #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	92 #ssl_key_file = /etc/ssl/private/dovecot.pem
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	93
3889 c7462001227b Added support for password protected SSL private keys. The password can be Timo Sirainen <tss@iki.fi> parents: 3888 diff changeset	94 # 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	95 # 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	96 #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	97
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	98 # 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	99 # 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	100 # 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	101 #ssl_ca_file =
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	102
5245 b6be3258cf9d Added note about ssl_require_client_cert in ssl_verify_client_cert comments. Timo Sirainen <tss@iki.fi> parents: 5243 diff changeset	103 # 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	104 # 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	105 #ssl_verify_client_cert = no
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	106
615 0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	107 # 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	108 # 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	109 # entirely.
3888 650701d41cdf Generate DH parameters and use them. Changed default regeneration time to 1 Timo Sirainen <tss@iki.fi> parents: 3887 diff changeset	110 #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	111
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	112 # SSL ciphers to use
4696 abf9a1234b99 Don't allow SSLv2 by default. Timo Sirainen <tss@iki.fi> parents: 4695 diff changeset	113 #ssl_cipher_list = ALL:!LOW:!SSLv2
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	114
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	115 # 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	116 #verbose_ssl = no
3724 d22c883021da Added syslog_facility setting to config file. Timo Sirainen <tss@iki.fi> parents: 3718 diff changeset	117
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	118 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	119 ## Login processes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	120 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	121
5243 b931a7d3c576 Added LoginProcess wiki link. Timo Sirainen <tss@iki.fi> parents: 5215 diff changeset	122 # http://wiki.dovecot.org/LoginProcess
b931a7d3c576 Added LoginProcess wiki link. Timo Sirainen <tss@iki.fi> parents: 5215 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 # 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	125 # 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	126 # 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	127 # 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	128 #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	129
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	130 # 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	131 # wish to run the whole Dovecot without roots.
3028 16183e87beaf Added wiki references. Timo Sirainen <tss@iki.fi> parents: 3027 diff changeset	132 # http://wiki.dovecot.org/Rootless
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	133 #login_chroot = yes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	134
1582 498a9b7797f2 Comment updates Timo Sirainen <tss@iki.fi> parents: 1578 diff changeset	135 # 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	136 # 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	137 # only it has access, it's used to control access for authentication process.
3026 80f7050c8bb5 Updated comments. Timo Sirainen <tss@iki.fi> parents: 3021 diff changeset	138 # Note that this user is NOT used to access mails.
3028 16183e87beaf Added wiki references. Timo Sirainen <tss@iki.fi> parents: 3027 diff changeset	139 # http://wiki.dovecot.org/UserIds
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	140 #login_user = dovecot
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	141
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	142 # 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	143 # 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	144 #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	145
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	146 # 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	147 # 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	148 # 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	149 # 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	150 #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	151
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	152 # 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	153 #login_processes_count = 3
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	154
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	155 # 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	156 # 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	157 # 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	158 # 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	159 # 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	160 # 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	161 #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	162
4538 9d9e72374164 Fixes to login process handling, especially with Timo Sirainen <tss@iki.fi> parents: 4526 diff changeset	163 # 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	164 # 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	165 # 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	166 # 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	167 # 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	168 #login_max_connections = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	169
2674 857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	170 # Greeting message for clients.
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	171 #login_greeting = Dovecot ready.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	172
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	173 # 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	174 # 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	175 # string.
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	176 #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	177
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	178 # 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	179 # 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	180 #login_log_format = %$: %s
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	181
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	182 ##
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	183 ## 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	184 ##
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	185
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	186 # 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	187 # 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	188 # 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	189 # 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	190 #
4702 11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	191 # 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	192 # 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	193 # 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	194 # 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	195 #
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	196 # 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	197 #
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 # %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	199 # %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	200 # %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	201 # %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	202 #
2097 4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	203 # 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	204 #
4702 11f080e5eff4 Use the name "mail root directory" to describe where the non-INBOX mbox Timo Sirainen <tss@iki.fi> parents: 4701 diff changeset	205 # 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	206 # 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	207 # 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	208 #
4701 190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	209 # http://wiki.dovecot.org/MailLocation
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	210 #
190a66df2f82 Renamed default_mail_env to mail_location. Keep the default_mail_env working Timo Sirainen <tss@iki.fi> parents: 4697 diff changeset	211 #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	212
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	213 # If you need to set multiple mailbox locations or want to change default
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	214 # namespace settings, you can do it by defining namespace sections:
3144 33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	215 #
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	216 # 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	217 # 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	218 # 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	219 # 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	220 # accessible mailboxes.
3144 33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	221 #
33cbe3dec3b8 Added a reminder about needing a default namespace. Timo Sirainen <tss@iki.fi> parents: 3142 diff changeset	222 # 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	223 # 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	224 # 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	225 # namespace with empty prefix.
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	226 #namespace private {
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	227 # 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	228 # 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	229 # 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	230 #separator =
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	231
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	232 # 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	233 # all namespaces. For example "Public/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	234 #prefix =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	235
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	236 # 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	237 # 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	238 #location =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	239
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	240 # 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	241 # has it.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	242 #inbox = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	243
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	244 # 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	245 # 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	246 # 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	247 # 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	248 # prefixes "~/mail/", "~%u/mail/" and "mail/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	249 #hidden = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	250 #}
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	251
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	252 # 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	253 # 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	254 #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	255
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	256 # 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	257 # 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	258 # 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	259 # or ~user/.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	260 #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	261
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	262 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	263 ## Mail processes
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 # 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	267 # 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	268 #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	269
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	270 # Log prefix for mail processes. See doc/variables.txt for list of possible
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	271 # variables you can use.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	272 #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	273
5098 176c28ad604c Added mail_log_max_lines_per_sec setting. Timo Sirainen <tss@iki.fi> parents: 5032 diff changeset	274 # 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	275 # 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	276 # 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	277 #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	278
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	279 # 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	280 # 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	281 #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	282
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	283 # 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	284 # 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	285 #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	286
4968 1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	287 # 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	288 # 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	289 # work with NFS.
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	290 #dotlock_use_excl = no
1baf9dd3fc40 Added dotlock_use_excl setting. Timo Sirainen <tss@iki.fi> parents: 4960 diff changeset	291
4918 2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	292 # 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	293 # 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	294 # goes down.
2f9173e103fd Added fsync_disable setting. Also added missing fsync()ing to dbox when Timo Sirainen <tss@iki.fi> parents: 4913 diff changeset	295 #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	296
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	297 # 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	298 # 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	299 # 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	300 #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	301
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	302 # 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	303 # 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	304 # 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	305 # 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	306 #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	307
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	308 # 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	309 # 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	310 # (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	311 #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	312
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	313 # 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	314 # 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	315 # 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	316 # 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	317 #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	318 #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	319
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	320 # 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	321 # 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	322 # 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	323 # not set.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	324 #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	325 #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	326
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	327 # 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	328 # 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	329 #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	330
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	331 # 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	332 # 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	333 #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	334
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	335 # 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	336 # 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	337 #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	338
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	339 # 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	340 #umask = 0077
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	341
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	342 # ':' 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	343 # 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	344 # 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	345 # 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	346 # may lead to root exploit. Usually this should be done only if you don't
5215 9914a148eea1 Updated valid_chroot_dirs and mail_chroot comments. Timo Sirainen <tss@iki.fi> parents: 5142 diff changeset	347 # allow shell access for users.
9914a148eea1 Updated valid_chroot_dirs and mail_chroot comments. Timo Sirainen <tss@iki.fi> parents: 5142 diff changeset	348 # http://wiki.dovecot.org/Chrooting
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	349 #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	350
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	351 # 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	352 # 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	353 # (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	354 # need to do chrooting, Dovecot doesn't allow users to access files outside
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	355 # their mail directory anyway.
5215 9914a148eea1 Updated valid_chroot_dirs and mail_chroot comments. Timo Sirainen <tss@iki.fi> parents: 5142 diff changeset	356 # http://wiki.dovecot.org/Chrooting
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	357 #mail_chroot =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	358
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	359 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	360 ## 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	361 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	362
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	363 # 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	364 # 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	365 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	366 # 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	367 # 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	368 #
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	369 # 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	370 # 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	371 # 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	372 # either.
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	373 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	374 # 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	375 # 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	376 # 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	377 # 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	378 # 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	379 # 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	380 #
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	381 # 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	382 # typically unnoticeable.
b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	383 #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	384
3021 b987319c7ce3 Updated mail_cache_fields and mail_never_cache_fields comments. Timo Sirainen <tss@iki.fi> parents: 2996 diff changeset	385 # 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	386 # 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	387 # needed.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	388 #mail_never_cache_fields =
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	389
3909 411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	390 # 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	391 # 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	392 # the cost of more disk reads.
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	393 #mail_cache_min_mail_count = 0
411f20e72a8f Added mail_cache_min_mail_count setting. Timo Sirainen <tss@iki.fi> parents: 3902 diff changeset	394
3726 ad1e6b8a5109 mailbox_idle_check_interval comment updated Timo Sirainen <tss@iki.fi> parents: 3724 diff changeset	395 # 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	396 # 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	397 # 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	398 # and inotify with Linux to reply immediately after the change occurs.
1177 dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	399 #mailbox_idle_check_interval = 30
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	400
472 2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	401 # 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	402 # 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	403 # 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	404 # 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	405 # 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	406 #mail_save_crlf = no
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	407
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	408 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	409 ## 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	410 ##
1920 d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	411
4959 4ba6b31ae15e Changed maildir_copy_with_hardlinks setting's description to be much more Timo Sirainen <tss@iki.fi> parents: 4954 diff changeset	412 # 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	413 # 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	414 # 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	415 # (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	416 # done always regardless of this setting)
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	417 #maildir_stat_dirs = no
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	418
4959 4ba6b31ae15e Changed maildir_copy_with_hardlinks setting's description to be much more Timo Sirainen <tss@iki.fi> parents: 4954 diff changeset	419 # 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	420 # 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	421 #maildir_copy_with_hardlinks = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	422
4960 4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	423 # 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	424 # 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	425 # 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	426 # 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	427 # 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	428 # 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	429 #maildir_copy_preserve_filename = no
4714befe2604 Added maildir_copy_preserve_filename setting. Timo Sirainen <timo.sirainen@movial.fi> parents: 4959 diff changeset	430
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	431 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	432 ## 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	433 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	434
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	435 # 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	436 # 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	437 # 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	438 # 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	439 # 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	440 # 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	441 # 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	442 #
2103 879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and Timo Sirainen <tss@iki.fi> parents: 2097 diff changeset	443 # 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	444 # 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	445 # 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	446 # them simultaneously.
2103 879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and Timo Sirainen <tss@iki.fi> parents: 2097 diff changeset	447 #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	448 #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	449
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	450 # 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	451 #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	452
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	453 # 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	454 # lock file after this many seconds.
4010 6519f3c7bd63 Updated mbox_dotlock_change_timeout default value to 120. Also the mbox Timo Sirainen <timo.sirainen@movial.fi> parents: 3976 diff changeset	455 #mbox_dotlock_change_timeout = 120
643 da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	456
2511 710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	457 # When mbox changes unexpectedly we have to fully read it to find out what
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	458 # changed. If the mbox is large this can take a long time. Since the change
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	459 # is usually just a newly appended mail, it'd be faster to simply read the
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	460 # new mails. If this setting is enabled, Dovecot does this but still safely
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	461 # fallbacks to re-reading the whole mbox file whenever something in mbox isn't
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	462 # how it's expected to be. The only real downside to this setting is that if
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	463 # some other MUA changes message flags, Dovecot doesn't notice it immediately.
2666 0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	464 # Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK
0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	465 # commands.
2511 710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	466 #mbox_dirty_syncs = yes
710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	467
2967 b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	468 # Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE,
b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	469 # EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored.
b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	470 #mbox_very_dirty_syncs = no
b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	471
2666 0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	472 # Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK
0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	473 # commands and when closing the mailbox). This is especially useful for POP3
0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	474 # where clients often delete all mails. The downside is that our changes
0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	475 # aren't immediately visible to other MUAs.
2662 add94f9aa9e1 Added mbox_lazy_writes setting. Timo Sirainen <tss@iki.fi> parents: 2652 diff changeset	476 #mbox_lazy_writes = yes
add94f9aa9e1 Added mbox_lazy_writes setting. Timo Sirainen <tss@iki.fi> parents: 2652 diff changeset	477
3912 fc0b638330a4 Added mbox_min_index_size setting. Timo Sirainen <tss@iki.fi> parents: 3909 diff changeset	478 # If mbox size is smaller than this (in kilobytes), don't write index files.
fc0b638330a4 Added mbox_min_index_size setting. Timo Sirainen <tss@iki.fi> parents: 3909 diff changeset	479 # If an index file already exists it's still read, just not updated.
fc0b638330a4 Added mbox_min_index_size setting. Timo Sirainen <tss@iki.fi> parents: 3909 diff changeset	480 #mbox_min_index_size = 0
fc0b638330a4 Added mbox_min_index_size setting. Timo Sirainen <tss@iki.fi> parents: 3909 diff changeset	481
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	482 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	483 ## dbox-specific settings
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	484 ##
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	485
3813 74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	486 # Maximum dbox file size in kilobytes until it's rotated.
74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	487 #dbox_rotate_size = 2048
74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	488
3845 18a786df5815 Added dbox_rotate_min_size and fixed rotation checks. Timo Sirainen <tss@iki.fi> parents: 3813 diff changeset	489 # Minimum dbox file size in kilobytes before it's rotated
18a786df5815 Added dbox_rotate_min_size and fixed rotation checks. Timo Sirainen <tss@iki.fi> parents: 3813 diff changeset	490 # (overrides dbox_rotate_days)
18a786df5815 Added dbox_rotate_min_size and fixed rotation checks. Timo Sirainen <tss@iki.fi> parents: 3813 diff changeset	491 #dbox_rotate_min_size = 16
18a786df5815 Added dbox_rotate_min_size and fixed rotation checks. Timo Sirainen <tss@iki.fi> parents: 3813 diff changeset	492
3813 74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	493 # Maximum dbox file age in days until it's rotated. Day always begins from
74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	494 # midnight, so 1 = today, 2 = yesterday, etc. 0 = check disabled.
74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	495 #dbox_rotate_days = 0
74289963b8a7 Added dbox_rotate_size and dbox_rotate_days settings. Timo Sirainen <tss@iki.fi> parents: 3801 diff changeset	496
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	497 ##
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	498 ## IMAP specific settings
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	499 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	500
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	501 protocol imap {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	502 # 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	503 #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	504
3864 6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	505 # IMAP executable location. Changing this allows you to execute other
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	506 # binaries before the imap process is executed.
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	507 #
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	508 # This would write rawlogs into ~/dovecot.rawlog/ directory:
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	509 # mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	510 #
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	511 # This would attach gdb into the imap process and write backtraces into
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	512 # /tmp/gdbhelper.* files:
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	513 # mail_executable = /usr/libexec/dovecot/gdbhelper /usr/libexec/dovecot/imap
6124ca416a6c Added gdbhelper binary. Timo Sirainen <tss@iki.fi> parents: 3845 diff changeset	514 #
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	515 #mail_executable = /usr/libexec/dovecot/imap
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	516
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	517 # 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	518 # 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	519 # "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	520 #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	521
4074 dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	522 # Support for dynamically loadable plugins. mail_plugins is a space separated
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	523 # list of plugins to load.
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	524 #mail_plugins =
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	525 #mail_plugin_dir = /usr/lib/dovecot/imap
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	526
2674 857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	527 # Send IMAP capabilities in greeting message. This makes it unnecessary for
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	528 # clients to request it with CAPABILITY command, so it saves one round-trip.
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	529 # Many clients however don't understand it and ask the CAPABILITY anyway.
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	530 #login_greeting_capability = no
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	531
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	532 # Override the IMAP CAPABILITY response.
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	533 #imap_capability =
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	534
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	535 # Workarounds for various client bugs:
3204 c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	536 # delay-newmail:
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	537 # Send EXISTS/RECENT new mail notifications only when replying to NOOP
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	538 # and CHECK commands. Some clients ignore them otherwise, for example
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	539 # OSX Mail. Outlook Express breaks more badly though, without this it
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	540 # may show user "Message no longer in server" errors. Note that OE6 still
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	541 # breaks even with this workaround if synchronization is set to
c8fffa286b6a Renamed oe6-fetch-no-newmail workaround to delay-newmail and changed it to Timo Sirainen <tss@iki.fi> parents: 3183 diff changeset	542 # "Headers Only".
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	543 # outlook-idle:
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	544 # Outlook and Outlook Express never abort IDLE command, so if no mail
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	545 # arrives in half a hour, Dovecot closes the connection. This is still
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	546 # fine, except Outlook doesn't connect back so you don't see if new mail
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	547 # arrives.
2448 f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	548 # netscape-eoh:
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	549 # Netscape 4.x breaks if message headers don't end with the empty "end of
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	550 # headers" line. Normally all messages have this, but setting this
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	551 # workaround makes sure that Netscape never breaks by adding the line if
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	552 # it doesn't exist. This is done only for FETCH BODY[HEADER.FIELDS..]
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	553 # commands. Note that RFC says this shouldn't be done.
3505 0e05687892dc Added tb-extra-mailbox-sep IMAP workaround. Timo Sirainen <tss@iki.fi> parents: 3384 diff changeset	554 # tb-extra-mailbox-sep:
0e05687892dc Added tb-extra-mailbox-sep IMAP workaround. Timo Sirainen <tss@iki.fi> parents: 3384 diff changeset	555 # With mbox storage a mailbox can contain either mails or submailboxes,
3510 2910fde2725d Updated behavior of tb-extra-mailbox-sep Timo Sirainen <tss@iki.fi> parents: 3509 diff changeset	556 # but not both. Thunderbird separates these two by forcing server to
2910fde2725d Updated behavior of tb-extra-mailbox-sep Timo Sirainen <tss@iki.fi> parents: 3509 diff changeset	557 # accept '/' suffix in mailbox names in subscriptions list.
3788 b412da0eb27c Clarify that workaround lists are space separated. But allow commas as Timo Sirainen <tss@iki.fi> parents: 3764 diff changeset	558 # The list is space-separated.
2726 8ba8f672dc3e Enable outlook-idle workaround by default. Timo Sirainen <tss@iki.fi> parents: 2723 diff changeset	559 #imap_client_workarounds = outlook-idle
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	560 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	561
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	562 ##
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	563 ## 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	564 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	565
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	566 protocol pop3 {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	567 # 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	568 #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	569
4588 364c9179bb46 Updated pop3's mail_executable comment Timo Sirainen <tss@iki.fi> parents: 4561 diff changeset	570 # POP3 executable location. See IMAP's mail_executable above for examples
364c9179bb46 Updated pop3's mail_executable comment Timo Sirainen <tss@iki.fi> parents: 4561 diff changeset	571 # how this could be changed.
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	572 #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	573
2719 f8adc5cb2508 Renamed pop3_mails_keep_recent to pop3_no_flag_updates which includes Timo Sirainen <tss@iki.fi> parents: 2674 diff changeset	574 # Don't try to set mails non-recent or seen with POP3 sessions. This is
f8adc5cb2508 Renamed pop3_mails_keep_recent to pop3_no_flag_updates which includes Timo Sirainen <tss@iki.fi> parents: 2674 diff changeset	575 # mostly intended to reduce disk I/O. With maildir it doesn't move files
f8adc5cb2508 Renamed pop3_mails_keep_recent to pop3_no_flag_updates which includes Timo Sirainen <tss@iki.fi> parents: 2674 diff changeset	576 # from new/ to cur/, with mbox it doesn't write Status-header.
f8adc5cb2508 Renamed pop3_mails_keep_recent to pop3_no_flag_updates which includes Timo Sirainen <tss@iki.fi> parents: 2674 diff changeset	577 #pop3_no_flag_updates = no
2039 f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	578
2621 c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	579 # Support LAST command which exists in old POP3 specs, but has been removed
c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	580 # from new ones. Some clients still wish to use this though. Enabling this
c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	581 # makes RSET command clear all \Seen flags from messages.
c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	582 #pop3_enable_last = no
4153 690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	583
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	584 # If mail has X-UIDL header, use it as the mail's UIDL.
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	585 #pop3_reuse_xuidl = no
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	586
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	587 # Keep the mailbox locked for the entire POP3 session.
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	588 #pop3_lock_session = no
690c72358cd5 Added pop3_lock_session setting. Timo Sirainen <tss@iki.fi> parents: 4145 diff changeset	589
4925 15fd97d86693 Updated pop3_uidl_format comments. Timo Sirainen <tss@iki.fi> parents: 4918 diff changeset	590 # POP3 UIDL (unique mail identifier) format to use. You can use following
15fd97d86693 Updated pop3_uidl_format comments. Timo Sirainen <tss@iki.fi> parents: 4918 diff changeset	591 # variables:
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	592 #
4925 15fd97d86693 Updated pop3_uidl_format comments. Timo Sirainen <tss@iki.fi> parents: 4918 diff changeset	593 # %v - Mailbox's IMAP UIDVALIDITY
15fd97d86693 Updated pop3_uidl_format comments. Timo Sirainen <tss@iki.fi> parents: 4918 diff changeset	594 # %u - Mail's IMAP UID
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	595 # %m - MD5 sum of the mailbox headers in hex (mbox only)
2996 9219e788d774 Added %f pop3_uidl_format for maildir. Patch by Andrey Panin. Timo Sirainen <tss@iki.fi> parents: 2976 diff changeset	596 # %f - filename (maildir only)
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	597 #
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	598 # If you want UIDL compatibility with other POP3 servers, use:
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	599 # UW's ipop3d : %08Xv%08Xu
2996 9219e788d774 Added %f pop3_uidl_format for maildir. Patch by Andrey Panin. Timo Sirainen <tss@iki.fi> parents: 2976 diff changeset	600 # Courier version 0 : %f
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	601 # Courier version 1 : %u
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	602 # Courier version 2 : %v-%u
3142 2bac730c250f small updates Timo Sirainen <tss@iki.fi> parents: 3033 diff changeset	603 # Cyrus (<= 2.1.3) : %u
2bac730c250f small updates Timo Sirainen <tss@iki.fi> parents: 3033 diff changeset	604 # Cyrus (>= 2.1.4) : %v.%u
3661 a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	605 # Older Dovecots : %v.%u
4456 9577a99b7fef Added tpop3d's pop3_uidl_format. Timo Sirainen <tss@iki.fi> parents: 4400 diff changeset	606 # tpop3d : %Mf
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	607 #
3661 a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	608 # Note that Outlook 2003 seems to have problems with %v.%u format which was
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	609 # Dovecot's default, so if you're building a new server it would be a good
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	610 # idea to change this. %08Xu%08Xv should be pretty fail-safe.
3661 a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	611 #
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	612 # NOTE: Nowadays this is required to be set explicitly, since the old
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	613 # default was bad but it couldn't be changed without breaking existing
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	614 # installations. %08Xu%08Xv will be the new default, so use it for new
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	615 # installations.
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	616 #
a745511d591e pop3_uidl_format is now required to be explicitly set. There is no default Timo Sirainen <tss@iki.fi> parents: 3659 diff changeset	617 #pop3_uidl_format =
2621 c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	618
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	619 # POP3 logout format string:
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	620 # %t - number of TOP commands
4118 b66da5c1a94b Replaced %T and %R with %p and %b. %R was already used by string-reversion, Timo Sirainen <tss@iki.fi> parents: 4108 diff changeset	621 # %p - number of bytes sent to client as a result of TOP command
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	622 # %r - number of RETR commands
4118 b66da5c1a94b Replaced %T and %R with %p and %b. %R was already used by string-reversion, Timo Sirainen <tss@iki.fi> parents: 4108 diff changeset	623 # %b - number of bytes sent to client as a result of RETR command
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	624 # %d - number of deleted messages
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	625 # %m - number of messages (before deletion)
3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	626 # %s - mailbox size in bytes (before deletion)
4118 b66da5c1a94b Replaced %T and %R with %p and %b. %R was already used by string-reversion, Timo Sirainen <tss@iki.fi> parents: 4108 diff changeset	627 #pop3_logout_format = top=%t/%p, retr=%r/%b, del=%d/%m, size=%s
3384 3b75956d20c4 Added configurable logging for login process. Added configurable pop3 logout Timo Sirainen <tss@iki.fi> parents: 3259 diff changeset	628
4074 dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	629 # Support for dynamically loadable plugins. mail_plugins is a space separated
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	630 # list of plugins to load.
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	631 #mail_plugins =
dadc6e2cccb8 Replaced mail_use_modules and mail_modules settings with mail_plugins and Timo Sirainen <tss@iki.fi> parents: 4030 diff changeset	632 #mail_plugin_dir = /usr/lib/dovecot/pop3
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	633
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	634 # Workarounds for various client bugs:
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	635 # outlook-no-nuls:
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	636 # Outlook and Outlook Express hang if mails contain NUL characters.
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	637 # This setting replaces them with 0x80 character.
2952 546214c0e6e9 Added oe-ns-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2805 diff changeset	638 # oe-ns-eoh:
546214c0e6e9 Added oe-ns-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2805 diff changeset	639 # Outlook Express and Netscape Mail breaks if end of headers-line is
546214c0e6e9 Added oe-ns-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2805 diff changeset	640 # missing. This option simply sends it if it's missing.
3788 b412da0eb27c Clarify that workaround lists are space separated. But allow commas as Timo Sirainen <tss@iki.fi> parents: 3764 diff changeset	641 # The list is space-separated.
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	642 #pop3_client_workarounds =
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	643 }
1465 03dd87873a81 Added support for dynamically loadable imap/pop3 modules. Timo Sirainen <tss@iki.fi> parents: 1437 diff changeset	644
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	645 ##
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	646 ## LDA specific settings
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	647 ##
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	648
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	649 protocol lda {
4365 74bde164ae1b Updated postmaster_address and hostname setting descriptions. Timo Sirainen <tss@iki.fi> parents: 4364 diff changeset	650 # Address to use when sending rejection mails.
4364 ed35a04c34fe Changed default postmaster_address to @example.com Timo Sirainen <tss@iki.fi> parents: 4362 diff changeset	651 postmaster_address = postmaster@example.com
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	652
4365 74bde164ae1b Updated postmaster_address and hostname setting descriptions. Timo Sirainen <tss@iki.fi> parents: 4364 diff changeset	653 # Hostname to use in various parts of sent mails, eg. in Message-Id.
74bde164ae1b Updated postmaster_address and hostname setting descriptions. Timo Sirainen <tss@iki.fi> parents: 4364 diff changeset	654 # Default is the system's real hostname.
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	655 #hostname =
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	656
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	657 # Support for dynamically loadable plugins. mail_plugins is a space separated
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	658 # list of plugins to load.
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	659 #mail_plugins =
4383 dc1f912bbf10 Default mail_plugin_dir was wrong for lda. Timo Sirainen <tss@iki.fi> parents: 4366 diff changeset	660 #mail_plugin_dir = /usr/lib/dovecot/lda
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	661
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	662 # Binary to use for sending mails.
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	663 #sendmail_path = /usr/lib/sendmail
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	664
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	665 # UNIX socket path to master authentication server to find users.
4366 5f0d649c26c3 Updated LDA's default auth_socket_path Timo Sirainen <tss@iki.fi> parents: 4365 diff changeset	666 #auth_socket_path = /var/run/dovecot/auth-master
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	667 }
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	668
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	669 ##
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	670 ## Authentication processes
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	671 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	672
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	673 # Executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	674 #auth_executable = /usr/libexec/dovecot/dovecot-auth
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	675
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	676 # 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	677 #auth_process_size = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	678
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	679 # Authentication cache size in kilobytes. 0 means it's disabled.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	680 # Note that bsdauth, PAM and vpopmail require cache_key to be set for caching
4954 8bc6aeec99d9 auth_cache_size comment updated. It no longer has problems with identical Timo Sirainen <tss@iki.fi> parents: 4925 diff changeset	681 # to be used.
2798 54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	682 #auth_cache_size = 0
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	683 # Time to live in seconds for cached data. After this many seconds the cached
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	684 # record is no longer used, except if the main database lookup returns
4658 3b49b9ec87dc auth_cache: Try to handle changing passwords automatically: If password Timo Sirainen <tss@iki.fi> parents: 4627 diff changeset	685 # internal failure. We also try to handle password changes automatically: If
3b49b9ec87dc auth_cache: Try to handle changing passwords automatically: If password Timo Sirainen <tss@iki.fi> parents: 4627 diff changeset	686 # user's previous authentication was successful, but this one wasn't, the
3b49b9ec87dc auth_cache: Try to handle changing passwords automatically: If password Timo Sirainen <tss@iki.fi> parents: 4627 diff changeset	687 # cache isn't used. For now this works only with plaintext authentication.
2798 54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	688 #auth_cache_ttl = 3600
54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	689
1328 0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	690 # 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	691 # 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	692 # 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	693 # first.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	694 #auth_realms =
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	695
2133 6e662d7188e9 comment update Timo Sirainen <tss@iki.fi> parents: 2103 diff changeset	696 # 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	697 # 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	698 #auth_default_realm =
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	699
1330 7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other Timo Sirainen <tss@iki.fi> parents: 1328 diff changeset	700 # 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	701 # 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	702 # 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	703 # 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	704 # 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	705 #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	706
2510 0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	707 # Username character translations before it's looked up from databases. The
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	708 # value contains series of from -> to characters. For example "#@/@" means
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	709 # that '#' and '/' characters are translated to '@'.
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	710 #auth_username_translation =
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	711
4168 3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	712 # Username formatting before it's looked up from databases. You can use
3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	713 # the standard variables here, eg. %Lu would lowercase the username, %n would
3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	714 # drop away the domain if it was given, or "%n-AT-%d" would change the '@' into
3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	715 # "-AT-". This translation is done after auth_username_translation changes.
3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	716 #auth_username_format =
3f27bf7832a2 Added auth_username_format setting. Timo Sirainen <tss@iki.fi> parents: 4165 diff changeset	717
4108 e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	718 # If you want to allow master users to log in by specifying the master
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	719 # username within the normal username string (ie. not using SASL mechanism's
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	720 # support for it), you can specify the separator character here. The format
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	721 # is then <username><separator><master username>. UW-IMAP uses "*" as the
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	722 # separator, so that could be a good choice.
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	723 #auth_master_user_separator =
e1774d677536 Added auth_master_user_separator setting which allows giving the master username inside the normal username. Timo Sirainen <timo.sirainen@movial.fi> parents: 4104 diff changeset	724
1437 c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	725 # 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	726 #auth_anonymous_username = anonymous
c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	727
999 070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	728 # More verbose logging. Useful for figuring out why authentication isn't
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	729 # working.
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	730 #auth_verbose = no
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	731
2417 af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	732 # Even more verbose logging for debugging purposes. Shows for example SQL
3918 40a461d554e6 Added auth_debug_passwords setting. If it's not enabled, hide all password Timo Sirainen <tss@iki.fi> parents: 3912 diff changeset	733 # queries.
2417 af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	734 #auth_debug = no
af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	735
3918 40a461d554e6 Added auth_debug_passwords setting. If it's not enabled, hide all password Timo Sirainen <tss@iki.fi> parents: 3912 diff changeset	736 # In case of password mismatches, log the passwords and used scheme so the
40a461d554e6 Added auth_debug_passwords setting. If it's not enabled, hide all password Timo Sirainen <tss@iki.fi> parents: 3912 diff changeset	737 # problem can be debugged. Requires auth_debug=yes to be set.
40a461d554e6 Added auth_debug_passwords setting. If it's not enabled, hide all password Timo Sirainen <tss@iki.fi> parents: 3912 diff changeset	738 #auth_debug_passwords = no
40a461d554e6 Added auth_debug_passwords setting. If it's not enabled, hide all password Timo Sirainen <tss@iki.fi> parents: 3912 diff changeset	739
3166 e6a487d80288 Restructuring of auth code. Balancer auth processes were a bad idea. Usually Timo Sirainen <tss@iki.fi> parents: 3144 diff changeset	740 # Maximum number of dovecot-auth worker processes. They're used to execute
e6a487d80288 Restructuring of auth code. Balancer auth processes were a bad idea. Usually Timo Sirainen <tss@iki.fi> parents: 3144 diff changeset	741 # blocking passdb and userdb queries (eg. MySQL and PAM). They're
e6a487d80288 Restructuring of auth code. Balancer auth processes were a bad idea. Usually Timo Sirainen <tss@iki.fi> parents: 3144 diff changeset	742 # automatically created and destroyed as needed.
e6a487d80288 Restructuring of auth code. Balancer auth processes were a bad idea. Usually Timo Sirainen <tss@iki.fi> parents: 3144 diff changeset	743 #auth_worker_max_count = 30
e6a487d80288 Restructuring of auth code. Balancer auth processes were a bad idea. Usually Timo Sirainen <tss@iki.fi> parents: 3144 diff changeset	744
3683 28cca6317829 Added GSSAPI support. Patch by Jelmer Vernooij and some fixes by Timo Sirainen <tss@iki.fi> parents: 3679 diff changeset	745 # Kerberos keytab to use for the GSSAPI mechanism. Will use the system
28cca6317829 Added GSSAPI support. Patch by Jelmer Vernooij and some fixes by Timo Sirainen <tss@iki.fi> parents: 3679 diff changeset	746 # default (usually /etc/krb5.keytab) if not specified.
28cca6317829 Added GSSAPI support. Patch by Jelmer Vernooij and some fixes by Timo Sirainen <tss@iki.fi> parents: 3679 diff changeset	747 #auth_krb5_keytab =
28cca6317829 Added GSSAPI support. Patch by Jelmer Vernooij and some fixes by Timo Sirainen <tss@iki.fi> parents: 3679 diff changeset	748
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	749 auth default {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	750 # Space separated list of wanted authentication mechanisms:
4802 723cd21a56f8 Added otp and skey to supported mechanisms list. Timo Sirainen <tss@iki.fi> parents: 4776 diff changeset	751 # plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi otp skey
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	752 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	753
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	754 #
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	755 # Password database is used to verify user's password (and nothing more).
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	756 # You can have multiple passdbs and userdbs. This is useful if you want to
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	757 # allow both system users (/etc/passwd) and virtual users to login without
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	758 # duplicating the system users into virtual database.
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	759 #
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	760 # http://wiki.dovecot.org/PasswordDatabase
4145 469a60254c79 Updated mechanism list. Added link to MasterPassword in wiki. Timo Sirainen <tss@iki.fi> parents: 4120 diff changeset	761 #
4030 faf83f3e19b5 Added support for "master users" who can log in as other people. Currently works only with SASL PLAIN authentication by giving it authorization ID string. Timo Sirainen <timo.sirainen@movial.fi> parents: 4010 diff changeset	762 # By adding master=yes setting inside a passdb you make the passdb a list
4104 77e10f1d2cb2 Removed master_no_passdb setting. Added pass setting which can be used to do Timo Sirainen <tss@iki.fi> parents: 4098 diff changeset	763 # of "master users", who can log in as anyone else. Unless you're using PAM,
77e10f1d2cb2 Removed master_no_passdb setting. Added pass setting which can be used to do Timo Sirainen <tss@iki.fi> parents: 4098 diff changeset	764 # you probably still want the destination user to be looked up from passdb
77e10f1d2cb2 Removed master_no_passdb setting. Added pass setting which can be used to do Timo Sirainen <tss@iki.fi> parents: 4098 diff changeset	765 # that it really exists. This can be done by adding pass=yes setting to the
77e10f1d2cb2 Removed master_no_passdb setting. Added pass setting which can be used to do Timo Sirainen <tss@iki.fi> parents: 4098 diff changeset	766 # master passdb.
4030 faf83f3e19b5 Added support for "master users" who can log in as other people. Currently works only with SASL PLAIN authentication by giving it authorization ID string. Timo Sirainen <timo.sirainen@movial.fi> parents: 4010 diff changeset	767 #
4145 469a60254c79 Updated mechanism list. Added link to MasterPassword in wiki. Timo Sirainen <tss@iki.fi> parents: 4120 diff changeset	768 # http://wiki.dovecot.org/MasterPassword
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	769
3609 ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	770 # Users can be temporarily disabled by adding a passdb with deny=yes.
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	771 # If the user is found from that database, authentication will fail.
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	772 # The deny passdb should always be specified before others, so it gets
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	773 # checked first. Here's an example:
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	774
3609 ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	775 #passdb passwd-file {
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	776 # File contains a list of usernames, one per line
3610 24d9c17b4cb6 imap.deny -> dovecot.deny Timo Sirainen <tss@iki.fi> parents: 3609 diff changeset	777 #args = /etc/dovecot.deny
3609 ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	778 #deny = yes
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	779 #}
ea2266d0a07f Added deny password databases. Timo Sirainen <tss@iki.fi> parents: 3599 diff changeset	780
4080 89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	781 # PAM authentication. Preferred nowadays by most systems.
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	782 # Note that PAM can only be used to verify if user's password is correct,
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	783 # so it can't be used as userdb. If you don't want to use a separate user
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	784 # database (passwd usually), you can use static userdb.
4080 89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	785 # REMEMBER: You'll need /etc/pam.d/dovecot file created for PAM
89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	786 # authentication to actually work.
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	787 # http://wiki.dovecot.org/PasswordDatabase/PAM
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	788 passdb pam {
5121 cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	789 # [blocking=yes] [session=yes] [setcred=yes]
cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	790 # [cache_key=<key>] [<service name>]
cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	791 #
cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	792 # By default a new process is forked from dovecot-auth for each PAM lookup.
cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	793 # Setting blocking=yes uses the alternative way: dovecot-auth worker
cf996f8e9c89 Added blocking=yes to PAM passdb to use auth workers instead of forking a Timo Sirainen <tss@iki.fi> parents: 5098 diff changeset	794 # processes do the PAM lookups.
3509 5cec18e2ddd1 Update about PAM -session. Timo Sirainen <tss@iki.fi> parents: 3505 diff changeset	795 #
3764 852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	796 # session=yes makes Dovecot open and immediately close PAM session. Some
852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	797 # PAM plugins need this to work, such as pam_mkhomedir.
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	798 #
4357 ffb59f920018 Don't call pam_setcred() unless setcred=yes PAM passdb argument was given. Timo Sirainen <tss@iki.fi> parents: 4210 diff changeset	799 # setcred=yes makes Dovecot establish PAM credentials if some PAM plugins
ffb59f920018 Don't call pam_setcred() unless setcred=yes PAM passdb argument was given. Timo Sirainen <tss@iki.fi> parents: 4210 diff changeset	800 # need that. They aren't ever deleted though, so this isn't enabled by
ffb59f920018 Don't call pam_setcred() unless setcred=yes PAM passdb argument was given. Timo Sirainen <tss@iki.fi> parents: 4210 diff changeset	801 # default.
ffb59f920018 Don't call pam_setcred() unless setcred=yes PAM passdb argument was given. Timo Sirainen <tss@iki.fi> parents: 4210 diff changeset	802 #
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	803 # cache_key can be used to enable authentication caching for PAM
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	804 # (auth_cache_size also needs to be set). It isn't enabled by default
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	805 # because PAM modules can do all kinds of checks besides checking password,
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	806 # such as checking IP address. Dovecot can't know about these checks
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	807 # without some help. cache_key is simply a list of variables (see
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	808 # doc/variables.txt) which must match for the cached data to be used.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	809 # Here are some examples:
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	810 # %u - Username must match. Probably sufficient for most uses.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	811 # %u%r - Username and remote IP address must match.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	812 # %u%s - Username and service (ie. IMAP, POP3) must match.
3509 5cec18e2ddd1 Update about PAM -session. Timo Sirainen <tss@iki.fi> parents: 3505 diff changeset	813 #
5cec18e2ddd1 Update about PAM -session. Timo Sirainen <tss@iki.fi> parents: 3505 diff changeset	814 # If service name is "*", it means the authenticating service name
4080 89c94b5ac90e Added notes about changing ports and about /etc/pam.d/dovecot Timo Sirainen <tss@iki.fi> parents: 4074 diff changeset	815 # is used, eg. pop3 or imap (/etc/pam.d/pop3, /etc/pam.d/imap).
3764 852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	816 #
852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	817 # Some examples:
852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	818 # args = session=yes *
852274ab176d PAM: Changed -session to session=yes to be more consistent with other Timo Sirainen <tss@iki.fi> parents: 3739 diff changeset	819 # args = cache_key=%u dovecot
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	820 #args = dovecot
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	821 }
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	822
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	823 # /etc/passwd or similar, using getpwnam()
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	824 # In many systems nowadays this uses Name Service Switch, which is
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	825 # configured in /etc/nsswitch.conf.
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	826 # http://wiki.dovecot.org/AuthDatabase/Passwd
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	827 #passdb passwd {
5122 419b206fd10c Added blocking=yes setting to userdb passwd. Timo Sirainen <tss@iki.fi> parents: 5121 diff changeset	828 # [blocking=yes] - By default the lookups are done in the main dovecot-auth
419b206fd10c Added blocking=yes setting to userdb passwd. Timo Sirainen <tss@iki.fi> parents: 5121 diff changeset	829 # process. This setting causes the lookups to be done in auth worker
419b206fd10c Added blocking=yes setting to userdb passwd. Timo Sirainen <tss@iki.fi> parents: 5121 diff changeset	830 # proceses. Useful with remote NSS lookups that may block.
419b206fd10c Added blocking=yes setting to userdb passwd. Timo Sirainen <tss@iki.fi> parents: 5121 diff changeset	831 #args =
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	832 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	833
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	834 # /etc/shadow or similiar, using getspnam(). Deprecated by PAM nowadays.
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	835 # http://wiki.dovecot.org/PasswordDatabase/Shadow
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	836 #passdb shadow {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	837 #}
3142 2bac730c250f small updates Timo Sirainen <tss@iki.fi> parents: 3033 diff changeset	838
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	839 # PAM-like authentication for OpenBSD.
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	840 # http://wiki.dovecot.org/PasswordDatabase/BSDAuth
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	841 #passdb bsdauth {
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	842 # [cache_key=<key>] - See cache_key in PAM for explanation.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	843 #args =
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	844 #}
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	845
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	846 # passwd-like file with specified location
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	847 # http://wiki.dovecot.org/AuthDatabase/PasswdFile
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	848 #passdb passwd-file {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	849 # Path for passwd-file
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	850 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	851 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	852
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	853 # checkpassword executable authentication
3667 b7569a6a4ada Renamed userdb passdb to prefetch. Timo Sirainen <tss@iki.fi> parents: 3661 diff changeset	854 # NOTE: You will probably want to use "userdb prefetch" with this.
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	855 # http://wiki.dovecot.org/PasswordDatabase/CheckPassword
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	856 #passdb checkpassword {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	857 # Path for checkpassword binary
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	858 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	859 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	860
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	861 # SQL database
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	862 # http://wiki.dovecot.org/AuthDatabase/SQL
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	863 #passdb sql {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	864 # Path for SQL configuration file, see doc/dovecot-sql.conf for example
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	865 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	866 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	867
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	868 # LDAP database
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	869 # http://wiki.dovecot.org/AuthDatabase/LDAP
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	870 #passdb ldap {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	871 # Path for LDAP configuration file, see doc/dovecot-ldap.conf for example
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	872 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	873 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	874
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	875 # vpopmail authentication
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	876 # http://wiki.dovecot.org/AuthDatabase/VPopMail
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	877 #passdb vpopmail {
3656 fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	878 # [cache_key=<key>] - See cache_key in PAM for explanation.
fda241fa5d77 Make auth caching work with non-sql/ldap passdbs too. Timo Sirainen <tss@iki.fi> parents: 3648 diff changeset	879 #args =
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	880 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	881
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	882 #
3026 80f7050c8bb5 Updated comments. Timo Sirainen <tss@iki.fi> parents: 3021 diff changeset	883 # User database specifies where mails are located and what user/group IDs
80f7050c8bb5 Updated comments. Timo Sirainen <tss@iki.fi> parents: 3021 diff changeset	884 # own them. For single-UID configuration use "static".
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	885 #
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	886 # http://wiki.dovecot.org/UserDatabase
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	887 #
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	888
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	889 # /etc/passwd or similar, using getpwnam()
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	890 # In many systems nowadays this uses Name Service Switch, which is
4757 8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	891 # configured in /etc/nsswitch.conf. WARNING: nss_ldap is known to be broken
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	892 # with Dovecot. Don't use it, or users might log in as each others!
8df9c973dcc3 Added missing imap_capability setting. Timo Sirainen <tss@iki.fi> parents: 4702 diff changeset	893 # http://wiki.dovecot.org/AuthDatabase/Passwd
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	894 userdb passwd {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	895 }
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	896
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	897 # passwd-like file with specified location
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	898 # http://wiki.dovecot.org/AuthDatabase/PasswdFile
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	899 #userdb passwd-file {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	900 # Path for passwd-file
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	901 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	902 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	903
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	904 # static settings generated from template
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	905 # http://wiki.dovecot.org/UserDatabase/Static
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	906 #userdb static {
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	907 # Template for the fields. Can return anything a userdb could normally
7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	908 # return. For example:
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	909 #
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	910 # args = uid=500 gid=500 home=/var/mail/%u
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	911 #
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	912 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	913 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	914
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	915 # SQL database
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	916 # http://wiki.dovecot.org/AuthDatabase/SQL
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	917 #userdb sql {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	918 # Path for SQL configuration file, see doc/dovecot-sql.conf for example
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	919 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	920 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	921
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	922 # LDAP database
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	923 # http://wiki.dovecot.org/AuthDatabase/LDAP
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	924 #userdb ldap {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	925 # Path for LDAP configuration file, see doc/dovecot-ldap.conf for example
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	926 #args =
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	927 #}
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	928
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	929 # vpopmail
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	930 # http://wiki.dovecot.org/AuthDatabase/VPopMail
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	931 #userdb vpopmail {
16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	932 #}
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	933
3667 b7569a6a4ada Renamed userdb passdb to prefetch. Timo Sirainen <tss@iki.fi> parents: 3661 diff changeset	934 # "prefetch" user database means that the passdb already provided the
3595 4d2ee2274c70 Added information about userdb passdb. Timo Sirainen <tss@iki.fi> parents: 3568 diff changeset	935 # needed information and there's no need to do a separate userdb lookup.
3739 ab929802ad6c Added some more information about prefetch userdb. Timo Sirainen <tss@iki.fi> parents: 3726 diff changeset	936 # This can be made to work with SQL and LDAP databases, see their example
ab929802ad6c Added some more information about prefetch userdb. Timo Sirainen <tss@iki.fi> parents: 3726 diff changeset	937 # configuration files for more information how to do it.
4776 7abf3fbcda90 Comment updates, wiki link updates. Timo Sirainen <tss@iki.fi> parents: 4757 diff changeset	938 # http://wiki.dovecot.org/UserDatabase/Prefetch
3718 c62c573560c1 "userdb prefetch" should be commented out by default. Timo Sirainen <tss@iki.fi> parents: 3683 diff changeset	939 #userdb prefetch {
c62c573560c1 "userdb prefetch" should be commented out by default. Timo Sirainen <tss@iki.fi> parents: 3683 diff changeset	940 #}
3595 4d2ee2274c70 Added information about userdb passdb. Timo Sirainen <tss@iki.fi> parents: 3568 diff changeset	941
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	942 # 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	943 # 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	944 # 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	945 # authentication with BSDs internally accesses shadow files, which also
3026 80f7050c8bb5 Updated comments. Timo Sirainen <tss@iki.fi> parents: 3021 diff changeset	946 # requires roots. Note that this user is NOT used to access mails.
80f7050c8bb5 Updated comments. Timo Sirainen <tss@iki.fi> parents: 3021 diff changeset	947 # That user is specified by userdb above.
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	948 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	949
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	950 # 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	951 # work if this is set, and there's no point chrooting if auth_user is root.
3183 16ea551957ed Replaced userdb/passdb settings with blocks so it's possible to give Timo Sirainen <tss@iki.fi> parents: 3166 diff changeset	952 # Note that valid_chroot_dirs isn't needed to use this setting.
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	953 #chroot =
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	954
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	955 # 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	956 #count = 1
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	957
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	958 # 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	959 #ssl_require_client_cert = no
3635 c12df370e1b2 Added ssl_username_from_cert setting. Not actually tested yet.. Timo Sirainen <tss@iki.fi> parents: 3610 diff changeset	960
4695 07afd19bc53e Updates to ssl_ca_file and ssl_username_from_cert comments in Timo Sirainen <tss@iki.fi> parents: 4658 diff changeset	961 # Take the username from client's SSL certificate, using
07afd19bc53e Updates to ssl_ca_file and ssl_username_from_cert comments in Timo Sirainen <tss@iki.fi> parents: 4658 diff changeset	962 # X509_NAME_get_text_by_NID() which returns the subject's DN's
07afd19bc53e Updates to ssl_ca_file and ssl_username_from_cert comments in Timo Sirainen <tss@iki.fi> parents: 4658 diff changeset	963 # CommonName.
3635 c12df370e1b2 Added ssl_username_from_cert setting. Not actually tested yet.. Timo Sirainen <tss@iki.fi> parents: 3610 diff changeset	964 #ssl_username_from_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	965
4359 92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	966 # It's possible to export the authentication interface to other programs:
4360 7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	967 #socket listen {
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	968 #master {
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	969 # Master socket is typically used to give Dovecot's local delivery
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	970 # agent access to userdb so it can find mailbox locations. It can
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	971 # however also be used to disturb regular user authentications.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	972 # WARNING: Giving untrusted users access to master socket may be a
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	973 # security risk, don't give too wide permissions to it!
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	974 #path = /var/run/dovecot/auth-master
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	975 #mode = 0600
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	976 # Default user/group is the one who started dovecot-auth (root)
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	977 #user =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	978 #group =
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	979 #}
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	980 #client {
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	981 # The client socket is generally safe to export to everyone. Typical use
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	982 # is to export it to your SMTP server so it can do SMTP AUTH lookups
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	983 # using it.
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	984 #path = /var/run/dovecot/auth-client
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	985 #mode = 0660
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	986 #}
7b18bb6b6450 Moved around settings and added some main groups to them, hopefully making Timo Sirainen <tss@iki.fi> parents: 4359 diff changeset	987 #}
4359 92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	988 }
2236 43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	989
4359 92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	990 # If you wish to use another authentication server than dovecot-auth, you can
92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	991 # use connect sockets. They assumed to be already running, Dovecot's master
2236 43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	992 # process only tries to connect to them. They don't need any other settings
4359 92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	993 # than the path for the master socket, as the configuration is done elsewhere.
92ad9dbcde85 Moved the socket listen example into auth default instead of having its own Timo Sirainen <tss@iki.fi> parents: 4357 diff changeset	994 # Note that the client sockets must exist in the login_dir.
2236 43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	995 #auth external {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	996 # socket connect {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	997 # master {
4209 ca14a26d28b4 Changed auth-master example socket to /var/run/dovecot/auth-master again. Timo Sirainen <tss@iki.fi> parents: 4168 diff changeset	998 # path = /var/run/dovecot/auth-master
2236 43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	999 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	1000 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	1001 #}
3975 9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1002
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	1003 ##
4393 9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1004 ## Dictionary server settings
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1005 ##
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1006
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1007 # Dictionary can be used by some plugins to store key=value lists.
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1008 # Currently this is only used by dict quota backend. The dictionary can be
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1009 # used either directly or though a dictionary server. The following dict block
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1010 # maps dictionary names to URIs when the server is used. These can then be
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1011 # referenced using URIs in format "proxy:<name>".
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1012
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1013 dict {
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1014 #quota = mysql:/etc/dovecot-dict-quota.conf
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1015 }
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1016
9928ebb54719 Instead of passing URIs directly to dictionary server, it now accepts only Timo Sirainen <tss@iki.fi> parents: 4383 diff changeset	1017 ##
4362 fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	1018 ## Plugin settings
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	1019 ##
fde5c7704ee2 Added protocol lda section and did some other cleanups Timo Sirainen <tss@iki.fi> parents: 4361 diff changeset	1020
3975 9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1021 plugin {
9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1022 # Here you can give some extra environment variables to mail processes.
9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1023 # This is mostly meant for passing parameters to plugins. %variable
9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1024 # expansion is done for all values.
9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1025
4098 59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1026 # Quota plugin. Multiple backends are supported:
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1027 # dirsize: Find and sum all the files found from mail directory
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1028 # dict: Keep quota stored in dictionary (eg. SQL)
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1029 # maildir: Maildir++ quota
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1030 # fs: Read-only support for filesystem quota
4509 e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1031 #
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1032 # Quota limits are set using "quota_rule" parameters, either in here or in
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1033 # userdb. It's also possible to give mailbox-specific limits, for example:
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1034 # quota_rule = *:storage=1048576
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1035 # quota_rule2 = Trash:storage=102400
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1036 # User has now 1GB quota, but when saving to Trash mailbox the user gets
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1037 # additional 100MB.
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1038 #
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1039 # Multiple quota roots are also possible, for example:
4871 a922f89a9e92 Updated dict quota examples. Timo Sirainen <tss@iki.fi> parents: 4860 diff changeset	1040 # quota = dict:user::proxy::quota
a922f89a9e92 Updated dict quota examples. Timo Sirainen <tss@iki.fi> parents: 4860 diff changeset	1041 # quota2 = dict:domain:%d:proxy::quota_domain
4509 e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1042 # quota_rule = *:storage=102400
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1043 # quota2_rule = *:storage=1048576
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1044 # Gives each user their own 100MB quota and one shared 1GB quota within
e5e79558ac2d Added support for multiple quota roots, rules and storages. The configuration Timo Sirainen <timo.sirainen@movial.fi> parents: 4484 diff changeset	1045 # the domain.
4098 59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1046 #quota = maildir
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1047
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1048 # ACL plugin. vfile backend reads ACLs from "dovecot-acl" file from maildir
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1049 # directory. You can also optionally give a global ACL directory path where
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1050 # ACLs are applied to all users' mailboxes. The global ACL directory contains
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1051 # one file for each mailbox, eg. INBOX or sub.mailbox.
59883de6c516 Added ACL plugin comments and updated quota comments. Timo Sirainen <tss@iki.fi> parents: 4081 diff changeset	1052 #acl = vfile:/etc/dovecot-acls
3976 7272c083dca8 Updated plugin section Timo Sirainen <tss@iki.fi> parents: 3975 diff changeset	1053
7272c083dca8 Updated plugin section Timo Sirainen <tss@iki.fi> parents: 3975 diff changeset	1054 # Convert plugin. If set, specifies the source storage path which is
4860 87ae4d41bc10 Create storages with MAIL_STORAGE_FLAG_NO_AUTOCREATE flag so we don't keep Timo Sirainen <tss@iki.fi> parents: 4802 diff changeset	1055 # converted to destination storage (mail_location) when the user logs in.
87ae4d41bc10 Create storages with MAIL_STORAGE_FLAG_NO_AUTOCREATE flag so we don't keep Timo Sirainen <tss@iki.fi> parents: 4802 diff changeset	1056 # The existing mail directory is renamed to <dir>-converted.
3976 7272c083dca8 Updated plugin section Timo Sirainen <tss@iki.fi> parents: 3975 diff changeset	1057 #convert_mail = mbox:%h/mail
4860 87ae4d41bc10 Create storages with MAIL_STORAGE_FLAG_NO_AUTOCREATE flag so we don't keep Timo Sirainen <tss@iki.fi> parents: 4802 diff changeset	1058 # Skip mailboxes which we can't open successfully instead of aborting.
87ae4d41bc10 Create storages with MAIL_STORAGE_FLAG_NO_AUTOCREATE flag so we don't keep Timo Sirainen <tss@iki.fi> parents: 4802 diff changeset	1059 #convert_skip_broken_mailboxes = no
4400 593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1060
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1061 # Trash plugin. When saving a message would make user go over quota, this
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1062 # plugin automatically deletes the oldest mails from configured mailboxes
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1063 # until the message can be saved within quota limits. The configuration file
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1064 # is a text file where each line is in format: <priority> <mailbox name>
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1065 # Mails are first deleted in lowest -> highest priority number order
593523f53500 Removed hardcoded trash plugin configuration paths. Added information about Timo Sirainen <tss@iki.fi> parents: 4393 diff changeset	1066 #trash = /etc/dovecot-trash.conf
4523 99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1067
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1068 # Expire plugin. Mails are expunged from mailboxes after being there the
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1069 # configurable time. The first expiration date for each mailbox is stored in
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1070 # a dictionary so it can be quickly determined which mailboxes contain
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1071 # expired mails. The actual expunging is done in a nightly cronjob, which
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1072 # you must set up:
4526 38f9daea3279 s/expire-mails/expire-tool/ Timo Sirainen <tss@iki.fi> parents: 4523 diff changeset	1073 # dovecot --exec-mail ext /usr/libexec/dovecot/expire-tool
4523 99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1074 #expire = Trash 7 Spam 30
99699cf9df43 Initial import of expire plugin code. Seems to work with at least one user. :) Timo Sirainen <timo.sirainen@movial.fi> parents: 4509 diff changeset	1075 #expire_dict = db:/var/lib/dovecot/expire.db
4913 dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1076
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1077 # Lazy expunge plugin. Currently works only with maildirs. When a user
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1078 # expunges mails, the mails are moved to a mailbox in another namespace
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1079 # (1st). When a mailbox is deleted, the mailbox is moved to another namespace
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1080 # (2nd) as well. Also if the deleted mailbox had any expunged messages,
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1081 # they're moved to a 3rd namespace. The mails won't be counted in quota,
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1082 # and they're not deleted automatically (use a cronjob or something).
dea1c8fa53f4 Added lazy expunge plugin. Timo Sirainen <timo.sirainen@movial.fi> parents: 4871 diff changeset	1083 #lazy_expunge = .EXPUNGED/ .DELETED/ .DELETED/.EXPUNGED/
3975 9de8bce1077e Added plugin {} section to dovecot.conf for passing extra environment Timo Sirainen <tss@iki.fi> parents: 3951 diff changeset	1084 }

Mercurial > dovecot > original-hg > dovecot-1.2

annotate dovecot-example.conf @ 5245:b6be3258cf9d HEAD