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

annotate dovecot-example.conf @ 2976:96a4ab34c8f1 HEAD

Added pop3_uidl_format setting.

author	Timo Sirainen <tss@iki.fi>
date	Wed, 15 Dec 2004 22:05:15 +0200
parents	b31f48d152c4
children	9219e788d774

rev	line source
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	1 ## Dovecot 1.0 configuration file
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	2
2231 58fc6765027c Add a comment about # chars and whitespace. Timo Sirainen <tss@iki.fi> parents: 2218 diff changeset	3 # '#' 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	4 # 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	5 # 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	6
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	7 # Default values are shown after each value, it's not required to uncomment
435 06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	8 # any of the lines. Exception to this are paths, they're just examples
06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	9 # with real defaults being based on configure options. The paths listed here
06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	10 # 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	11 # --with-ssldir=/etc/ssl
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	12
872 6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	13 # 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	14 #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	15
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	16 # Protocols we want to be serving:
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	17 # imap imaps pop3 pop3s
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	18 #protocols = imap imaps
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	19
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	20 # 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	21 # 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	22 # "[::]" listens in all IPv6 interfaces, but may also listen in all IPv4
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	23 # interfaces depending on the operating system. You can specify ports with
2218 8864dbc17cfa comment update for setting ports in listen Timo Sirainen <tss@iki.fi> parents: 2205 diff changeset	24 # "host:port", although with multiple protocols you probably want to move this
8864dbc17cfa comment update for setting ports in listen Timo Sirainen <tss@iki.fi> parents: 2205 diff changeset	25 # setting inside protocol imap/pop3 { ... } section, so you can specify
8864dbc17cfa comment update for setting ports in listen Timo Sirainen <tss@iki.fi> parents: 2205 diff changeset	26 # different ports for IMAP/POP3.
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	27 #listen = *
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	28
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	29 # 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	30 # 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	31 #ssl_listen =
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	32
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	33 # Disable SSL/TLS support.
666 36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	34 #ssl_disable = no
36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	35
519 9e121e74c188 and a couple more fixes.. Timo Sirainen <tss@iki.fi> parents: 518 diff changeset	36 # 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	37 # 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	38 # 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	39 # 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	40 #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	41 #ssl_key_file = /etc/ssl/private/dovecot.pem
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	42
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	43 # File containing trusted SSL certificate authorities. Usually not needed.
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	44 #ssl_ca_file =
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	45
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	46 # Request client to send a certificate.
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	47 #ssl_verify_client_cert = no
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	48
615 0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	49 # SSL parameter file. Master process generates this file for login processes.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	50 # It contains Diffie Hellman and RSA parameters.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	51 #ssl_parameters_file = /var/run/dovecot/ssl-parameters.dat
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	52
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	53 # 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	54 # 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	55 # entirely.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	56 #ssl_parameters_regenerate = 24
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	57
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	58 # SSL ciphers to use
d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	59 #ssl_cipher_list = all:!low
d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	60
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	61 # Disable LOGIN command and all other plaintext authentications unless
1725 cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	62 # SSL/TLS is used (LOGINDISABLED capability). Note that 127...* and
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	63 # IPv6 ::1 addresses are considered secure, this setting has no effect if
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	64 # you connect from those addresses.
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	65 #disable_plaintext_auth = yes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	66
1124 5e9430a39611 /dev/stderr works now in log paths. Timo Sirainen <tss@iki.fi> parents: 1113 diff changeset	67 # Use this logfile instead of syslog(). /dev/stderr can be used if you want to
5e9430a39611 /dev/stderr works now in log paths. Timo Sirainen <tss@iki.fi> parents: 1113 diff changeset	68 # use stderr for logging (ONLY /dev/stderr - otherwise it is closed).
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	69 #log_path =
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	70
811 664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	71 # For informational messages, use this logfile instead of the default
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	72 #info_log_path =
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	73
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	74 # Prefix for each line written to log file. % codes are in strftime(3)
1647 d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or ' Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	75 # format.
d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or ' Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	76 #log_timestamp = "%b %d %H:%M:%S "
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	77
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	78 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	79 ## Login processes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	80 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	81
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	82 # 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	83 # 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	84 # 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	85 # 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	86 #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	87
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	88 # 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	89 # wish to run the whole Dovecot without roots.
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	90 #login_chroot = yes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	91
1582 498a9b7797f2 Comment updates Timo Sirainen <tss@iki.fi> parents: 1578 diff changeset	92 # 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	93 # 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	94 # only it has access, it's used to control access for authentication process.
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	95 #login_user = dovecot
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	96
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	97 # 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	98 # 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	99 #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	100
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	101 # 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	102 # 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	103 # 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	104 # 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	105 #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	106
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	107 # Number of login processes to create. If login_process_per_user is
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	108 # yes, this is the number of extra processes waiting for users to log in.
1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	109 #login_processes_count = 3
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	110
614 e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	111 # Maximum number of extra login processes to create. The extra process count
e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	112 # 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	113 # 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	114 # we check only once in a second if new processes should be created - if all
e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	115 # of them are used at the time, we double their amount until limit set by this
e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	116 # setting is reached. This setting is used only if login_process_per_use is yes.
e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	117 #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	118
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	119 # Maximum number of connections allowed in login state. When this limit is
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	120 # reached, the oldest connections are dropped. If login_process_per_user
1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	121 # is no, this is a per-process value, so the absolute maximum number of users
1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	122 # logging in actually login_processes_count * max_logging_users.
1555 b566a1ba703e s/max_logging_users/login_max_logging_users/ Timo Sirainen <tss@iki.fi> parents: 1506 diff changeset	123 #login_max_logging_users = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	124
2674 857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	125 # Greeting message for clients.
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	126 #login_greeting = Dovecot ready.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	127
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	128 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	129 ## Mail processes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	130 ##
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	131
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	132 # Maximum number of running mail processes. When this limit is reached,
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	133 # new users aren't allowed to log in.
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	134 #max_mail_processes = 1024
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	135
596 ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	136 # Show more verbose process titles (in ps). Currently shows user name and
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	137 # IP address. Useful for seeing who are actually using the IMAP processes
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	138 # (eg. shared mailboxes or if same uid is used for multiple accounts).
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	139 #verbose_proctitle = no
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	140
1236 5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	141 # Show protocol level SSL errors.
5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	142 #verbose_ssl = no
5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	143
1506 e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	144 # Valid UID range for users, defaults to 500 and above. This is mostly
1295 cc9b61b9959e updated first_valid_uid comment Timo Sirainen <tss@iki.fi> parents: 1283 diff changeset	145 # to make sure that users can't log in as daemons or other system users.
1506 e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	146 # Note that denying root logins is hardcoded to dovecot binary and can't
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	147 # be done even if first_valid_uid is set to 0.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	148 #first_valid_uid = 500
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	149 #last_valid_uid = 0
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	150
1506 e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	151 # Valid GID range for users, defaults to non-root/wheel. Users having
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	152 # non-valid GID as primary group ID aren't allowed to log in. If user
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	153 # belongs to supplementary groups with non-valid GIDs, those groups are
e7c627bacaaf Allow first_valid_gid to be 0. Drop any supplementary groups not in valid Timo Sirainen <tss@iki.fi> parents: 1465 diff changeset	154 # not set.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	155 #first_valid_gid = 1
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	156 #last_valid_gid = 0
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	157
2141 8690d2000e33 Added mail_extra_groups setting. Timo Sirainen <tss@iki.fi> parents: 2137 diff changeset	158 # Grant access to these extra groups for mail processes. Typical use would be
8690d2000e33 Added mail_extra_groups setting. Timo Sirainen <tss@iki.fi> parents: 2137 diff changeset	159 # to give "mail" group write access to /var/mail to be able to create dotlocks.
8690d2000e33 Added mail_extra_groups setting. Timo Sirainen <tss@iki.fi> parents: 2137 diff changeset	160 #mail_extra_groups =
8690d2000e33 Added mail_extra_groups setting. Timo Sirainen <tss@iki.fi> parents: 2137 diff changeset	161
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	162 # ':' separated list of directories under which chrooting is allowed for mail
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	163 # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
978 d3433363bcaa comment update Timo Sirainen <tss@iki.fi> parents: 882 diff changeset	164 # This setting doesn't affect login_chroot or auth_chroot variables.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	165 # WARNING: Never add directories here which local users can modify, that
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	166 # may lead to root exploit. Usually this should be done only if you don't
979 fd1438d43443 comment update Timo Sirainen <tss@iki.fi> parents: 978 diff changeset	167 # allow shell access for users. See doc/configuration.txt for more information.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	168 #valid_chroot_dirs =
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	169
2652 3b24284e4e36 comment updates Timo Sirainen <tss@iki.fi> parents: 2621 diff changeset	170 # Default chroot directory for mail processes. This can be overridden for
3b24284e4e36 comment updates Timo Sirainen <tss@iki.fi> parents: 2621 diff changeset	171 # specific users in user database by giving /./ in user's home directory
3b24284e4e36 comment updates Timo Sirainen <tss@iki.fi> parents: 2621 diff changeset	172 # (eg. /home/./user chroots into /home). Note that usually there is no real
3b24284e4e36 comment updates Timo Sirainen <tss@iki.fi> parents: 2621 diff changeset	173 # need to do chrooting, Dovecot doesn't allow users to access files outside
3b24284e4e36 comment updates Timo Sirainen <tss@iki.fi> parents: 2621 diff changeset	174 # their mail directory anyway.
1734 d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	175 #mail_chroot =
d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	176
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	177 # Default MAIL environment to use when it's not set. By leaving this empty
f126b666859e New setting: default_mail_env which can be used to specify where to find Timo Sirainen <tss@iki.fi> parents: 722 diff changeset	178 # dovecot tries to do some automatic detection as described in
2097 4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	179 # doc/mail-storages.txt. There's a few special variables you can use, eg.:
813 493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	180 #
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	181 # %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	182 # %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	183 # %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	184 # %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	185 #
2097 4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	186 # 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	187 #
1747 a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	188 # default_mail_env = maildir:/var/mail/%1u/%u/Maildir
a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	189 # default_mail_env = mbox:~/mail/:INBOX=/var/mail/%u
a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	190 # default_mail_env = mbox:/var/mail/%d/%n/:INDEX=/var/indexes/%d/%n
813 493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	191 #
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	192 #default_mail_env =
f126b666859e New setting: default_mail_env which can be used to specify where to find Timo Sirainen <tss@iki.fi> parents: 722 diff changeset	193
2673 5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	194 # 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	195 # namespace settings, you can do it by defining namespace sections:
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	196
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	197 # 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	198 # 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	199 # 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	200 # 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	201 # accessible mailboxes.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	202 #namespace private {
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	203 # 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	204 # namespaces or some clients get confused. '/' is usually a good one.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	205 #separator = /
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	206
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	207 # 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	208 # all namespaces. For example "Public/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	209 #prefix =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	210
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	211 # Physical location of the mailbox. This is in same format as
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	212 # default_mail_env, which is also the default for it.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	213 #location =
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	214
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	215 # 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	216 # has it.
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	217 #inbox = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	218
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	219 # 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	220 # 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	221 # 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	222 # 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	223 # prefixes "~/mail/", "~%u/mail/" and "mail/".
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	224 #hidden = yes
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	225 #}
5f2c5b65b0cd Added example namespace with comments. Timo Sirainen <tss@iki.fi> parents: 2666 diff changeset	226
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	227 # Space-separated list of fields to cache for all mails. Currently these
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	228 # fields are allowed followed by a list of commands they speed up:
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	229 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	230 # Envelope - FETCH ENVELOPE and SEARCH FROM, TO, CC, BCC, SUBJECT,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	231 # SENTBEFORE, SENTON, SENTSINCE, HEADER MESSAGE-ID,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	232 # HEADER IN-REPLY-TO
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	233 # Body - FETCH BODY
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	234 # Bodystructure - FETCH BODY, BODYSTRUCTURE
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	235 # MessagePart - FETCH BODY[1.2.3] (ie. body parts), RFC822.SIZE,
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	236 # SEARCH SMALLER, LARGER, also speeds up BODY/BODYSTRUCTURE
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	237 # generation. This is always set with mbox mailboxes, and
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	238 # also default with Maildir.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	239 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	240 # Different IMAP clients work in different ways, that's why Dovecot by default
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	241 # only caches MessagePart which speeds up most operations. Whenever client
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	242 # does something where caching could be used, the field is automatically marked
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	243 # to be cached later. For example after FETCH BODY the BODY will be cached
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	244 # for all new messages. Normally you should leave this alone, unless you know
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	245 # what most of your IMAP clients are. Caching more fields than needed makes
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	246 # the index files larger and generate useless I/O.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	247 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	248 # With maildir there's one extra optimization - if nothing is cached, indexing
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	249 # the maildir becomes much faster since it's not opening any of the mail files.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	250 # This could be useful if your IMAP clients access only new mails.
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	251
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	252 #mail_cache_fields = MessagePart
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	253
987 cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	254 # Space-separated list of fields that Dovecot should never set to be cached.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	255 # 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	256 # needed.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	257 #mail_never_cache_fields =
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	258
1177 dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	259 # Like mailbox_check_interval, but used for IDLE command.
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	260 #mailbox_idle_check_interval = 30
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	261
1151 058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	262 # Allow full filesystem access to clients. There's no access checks other than
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	263 # what the operating system does for the active UID/GID. It works with both
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	264 # maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	265 # or ~user/.
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	266 #mail_full_filesystem_access = no
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	267
1986 7ac0ef106427 s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1920 diff changeset	268 # Maximum allowed length for mail keyword name. It's only forced when trying
7ac0ef106427 s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1920 diff changeset	269 # to create new keywords.
7ac0ef106427 s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1920 diff changeset	270 #mail_max_keyword_length = 50
1168 03f1455664d7 Added setting to limit length of custom flag names. Timo Sirainen <tss@iki.fi> parents: 1151 diff changeset	271
472 2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	272 # 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	273 # 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	274 # But it also creates a bit more disk I/O which may just make it slower.
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	275 #mail_save_crlf = no
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	276
644 415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read() Timo Sirainen <tss@iki.fi> parents: 643 diff changeset	277 # Use mmap() instead of read() to read mail files. read() seems to be a bit
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read() Timo Sirainen <tss@iki.fi> parents: 643 diff changeset	278 # faster with my Linux/x86 and it's better with NFS, so that's the default.
1622 d22e03714d36 index_mmap_invalidate = yes now invalidate memory maps before accessing Timo Sirainen <tss@iki.fi> parents: 1615 diff changeset	279 # Note that OpenBSD 3.3 and older don't work right with mail_read_mmaped = yes.
644 415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read() Timo Sirainen <tss@iki.fi> parents: 643 diff changeset	280 #mail_read_mmaped = no
415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read() Timo Sirainen <tss@iki.fi> parents: 643 diff changeset	281
1918 ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	282 # Don't use mmap() at all. This is required if you store indexes in remote
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	283 # filesystems (NFS or clustered filesystem).
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	284 #mmap_disable = no
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	285
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	286 # Don't write() to mmaped files. This is required for some operating systems
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	287 # which use separate caches for them, such as OpenBSD.
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	288 #mmap_no_write = no
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	289
2723 12b503fbb8af Replaced fcntl_locks_disable with lock_method, so it's now possible to use Timo Sirainen <tss@iki.fi> parents: 2719 diff changeset	290 # Locking method for index files. Alternatives are fcntl, flock and dotlock.
12b503fbb8af Replaced fcntl_locks_disable with lock_method, so it's now possible to use Timo Sirainen <tss@iki.fi> parents: 2719 diff changeset	291 # Dotlocking uses some tricks which may create more disk I/O than other locking
12b503fbb8af Replaced fcntl_locks_disable with lock_method, so it's now possible to use Timo Sirainen <tss@iki.fi> parents: 2719 diff changeset	292 # methods.
12b503fbb8af Replaced fcntl_locks_disable with lock_method, so it's now possible to use Timo Sirainen <tss@iki.fi> parents: 2719 diff changeset	293 #lock_method = fcntl
1920 d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	294
2078 b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	295 # By default LIST command returns all entries in maildir beginning with dot.
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	296 # 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	297 # 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	298 # (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	299 # done always regardless of this setting)
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	300 #maildir_stat_dirs = no
b3daf55df932 Added maildir_stat_dirs option. Timo Sirainen <tss@iki.fi> parents: 2068 diff changeset	301
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	302 # Copy mail to another folders using hard links. This is much faster than
987 cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	303 # actually copying the file. This is problematic only if something modifies
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	304 # the mail in one folder but doesn't want it modified in the others. I don't
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	305 # know any MUA which would modify mail files directly. IMAP protocol also
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	306 # requires that the mails don't change, so it would be problematic in any case.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	307 # If you care about performance, enable it.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	308 #maildir_copy_with_hardlinks = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	309
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	310 # Check if mails' content has been changed by external programs. This slows
882 38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new Timo Sirainen <tss@iki.fi> parents: 872 diff changeset	311 # down things as extra stat() needs to be called for each file. If changes are
38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new Timo Sirainen <tss@iki.fi> parents: 872 diff changeset	312 # noticed, the message is treated as a new message, since IMAP protocol
1911 ac810e95cdd6 typofix Timo Sirainen <tss@iki.fi> parents: 1879 diff changeset	313 # specifies that existing messages are immutable.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	314 #maildir_check_content_changes = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	315
2103 879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and Timo Sirainen <tss@iki.fi> parents: 2097 diff changeset	316 # Which locking methods to use for locking mbox. There's four available:
1113 4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	317 # 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	318 # 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	319 # 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	320 # 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	321 # 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	322 # 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	323 #
2103 879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and Timo Sirainen <tss@iki.fi> parents: 2097 diff changeset	324 # 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	325 # 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	326 # 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	327 # them simultaneously.
2103 879b0b9ed5d4 Separate mbox_locks/mbox_read_dotlock to mbox_read_locks and Timo Sirainen <tss@iki.fi> parents: 2097 diff changeset	328 #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	329 #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	330
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	331 # 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	332 #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	333
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	334 # 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	335 # lock file after this many seconds.
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	336 #mbox_dotlock_change_timeout = 30
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	337
2511 710e0bf25bf8 Added mbox_dirty_syncs setting which delays re-reading the whole mbox when Timo Sirainen <tss@iki.fi> parents: 2510 diff changeset	338 # 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	339 # 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	340 # 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	341 # 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	342 # 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	343 # 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	344 # 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	345 # 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	346 # 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	347 #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	348
2967 b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	349 # 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	350 # 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	351 #mbox_very_dirty_syncs = no
b31f48d152c4 Added mbox_very_dirty_syncs setting. Timo Sirainen <tss@iki.fi> parents: 2952 diff changeset	352
2666 0ba82d7a5aba Updated mbox_dirty_syncs and mbox_lazy_writes comments. Timo Sirainen <tss@iki.fi> parents: 2662 diff changeset	353 # 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	354 # 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	355 # 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	356 # aren't immediately visible to other MUAs.
2662 add94f9aa9e1 Added mbox_lazy_writes setting. Timo Sirainen <tss@iki.fi> parents: 2652 diff changeset	357 #mbox_lazy_writes = yes
add94f9aa9e1 Added mbox_lazy_writes setting. Timo Sirainen <tss@iki.fi> parents: 2652 diff changeset	358
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	359 # umask to use for mail files and directories
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	360 #umask = 0077
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	361
1223 52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	362 # Drop all privileges before exec()ing the mail process. This is mostly
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	363 # meant for debugging, otherwise you don't get core dumps. It could be a small
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	364 # security risk if you use single UID for multiple users, as the users could
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	365 # ptrace() each others processes then.
1223 52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	366 #mail_drop_priv_before_exec = no
52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	367
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	368 # Set max. process size in megabytes. Most of the memory goes to mmap()ing
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	369 # files, so it shouldn't harm much even if this limit is set pretty high.
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	370 #mail_process_size = 256
1465 03dd87873a81 Added support for dynamically loadable imap/pop3 modules. Timo Sirainen <tss@iki.fi> parents: 1437 diff changeset	371
2097 4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	372 # Log prefix for mail processes. See doc/variables.txt for list of possible
4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	373 # variables you can use.
2805 100ecc609dd1 mail_log_prefix was using old %p, changed it to %s.. Timo Sirainen <tss@iki.fi> parents: 2802 diff changeset	374 #mail_log_prefix = "%Us(%u): "
2097 4e77cb0aff21 Added %l, %r and %P variables and mail_log_prefix setting. Timo Sirainen <tss@iki.fi> parents: 2078 diff changeset	375
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	376 ##
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	377 ## IMAP specific settings
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	378 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	379
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	380 protocol imap {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	381 # 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	382 #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	383
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	384 # IMAP executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	385 #mail_executable = /usr/libexec/dovecot/imap
1727 6d10ece6cf9f added rawlog example Timo Sirainen <tss@iki.fi> parents: 1725 diff changeset	386 # This would write rawlogs into ~/dovecot.rawlog/ directory:
6d10ece6cf9f added rawlog example Timo Sirainen <tss@iki.fi> parents: 1725 diff changeset	387 #mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	388
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	389 # 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	390 # 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	391 # "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	392 #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	393
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	394 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	395 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	396 #mail_modules = /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	397
2674 857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	398 # 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	399 # 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	400 # 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	401 #login_greeting_capability = no
857f5f7b512b Added login_greeting and login_greeting_capability settings. Timo Sirainen <tss@iki.fi> parents: 2673 diff changeset	402
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	403 # 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	404 # oe6-fetch-no-newmail:
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	405 # Never send EXISTS/RECENT when replying to FETCH command. Outlook Express
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	406 # seems to think they are FETCH replies and gives user "Message no longer
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	407 # in server" error. Note that OE6 still breaks even with this workaround
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	408 # if synchronization is set to "Headers Only".
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	409 # 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	410 # 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	411 # 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	412 # 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	413 # arrives.
2448 f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	414 # netscape-eoh:
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	415 # 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	416 # headers" line. Normally all messages have this, but setting this
f1e4c99cbb2b Added netscape-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2447 diff changeset	417 # 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	418 # 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	419 # commands. Note that RFC says this shouldn't be done.
2792 7cc03b8278a8 Added tb-negative-fetch workaround. Timo Sirainen <tss@iki.fi> parents: 2726 diff changeset	420 # tb-negative-fetch:
7cc03b8278a8 Added tb-negative-fetch workaround. Timo Sirainen <tss@iki.fi> parents: 2726 diff changeset	421 # Thunderbird sometimes messed up some calculations and wants to read
7cc03b8278a8 Added tb-negative-fetch workaround. Timo Sirainen <tss@iki.fi> parents: 2726 diff changeset	422 # the message past it's end, giving negative size to FETCH BODY[]<..>
7cc03b8278a8 Added tb-negative-fetch workaround. Timo Sirainen <tss@iki.fi> parents: 2726 diff changeset	423 # command. This workaround just hides the error message.
2726 8ba8f672dc3e Enable outlook-idle workaround by default. Timo Sirainen <tss@iki.fi> parents: 2723 diff changeset	424 #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	425 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	426
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	427 ##
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	428 ## 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	429 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	430
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	431 protocol pop3 {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	432 # 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	433 #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	434
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	435 # POP3 executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	436 #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	437
2719 f8adc5cb2508 Renamed pop3_mails_keep_recent to pop3_no_flag_updates which includes Timo Sirainen <tss@iki.fi> parents: 2674 diff changeset	438 # 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	439 # 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	440 # 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	441 #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	442
2621 c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	443 # 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	444 # 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	445 # 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	446 #pop3_enable_last = no
2976 96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	447
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	448 # POP3 UIDL format to use. You can use following variables:
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	449 #
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	450 # %v - Mailbox UIDVALIDITY
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	451 # %u - Mail UID
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	452 # %m - MD5 sum of the mailbox headers in hex (mbox only)
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	453 #
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	454 # 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	455 # UW's ipop3d : %08Xv%08Xu
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	456 # Courier version 0 : (maildir filename, not supported)
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	457 # Courier version 1 : %u
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	458 # Courier version 2 : %v-%u
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	459 # Cyrus (old) : %u
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	460 # Cyrus (new) : %v.%u
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	461 #
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	462 # Note that Outlook 2003 seems to have problems with %v.%u format which is
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	463 # 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	464 # idea to change this. %08Xu%08Xv should be pretty fail-safe.
96a4ab34c8f1 Added pop3_uidl_format setting. Timo Sirainen <tss@iki.fi> parents: 2967 diff changeset	465 #pop3_uidl_format = %v.%u
2621 c6cc163344c3 Added pop3_enable_last setting to enable deprecated LAST command. Timo Sirainen <tss@iki.fi> parents: 2595 diff changeset	466
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	467 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	468 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	469 #mail_modules = /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	470
1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	471 # 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	472 # 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	473 # 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	474 # This setting replaces them with 0x80 character.
2952 546214c0e6e9 Added oe-ns-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2805 diff changeset	475 # oe-ns-eoh:
546214c0e6e9 Added oe-ns-eoh workaround. Timo Sirainen <tss@iki.fi> parents: 2805 diff changeset	476 # 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	477 # missing. This option simply sends it if it's missing.
2316 1c1ed4494aa4 Split client_workarounds to imap_ and pop3_ ones. Added outlook-no-nuls POP3 Timo Sirainen <tss@iki.fi> parents: 2288 diff changeset	478 #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	479 }
1465 03dd87873a81 Added support for dynamically loadable imap/pop3 modules. Timo Sirainen <tss@iki.fi> parents: 1437 diff changeset	480
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	481 ##
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	482 ## Authentication processes
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	483 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	484
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	485 # You can have multiple authentication processes. With plaintext authentication
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	486 # the password is checked against each process, the first one which succeeds is
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	487 # used. This is useful if you want to allow both system users (/etc/passwd)
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	488 # and virtual users to login without duplicating the system users into virtual
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	489 # database.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	490
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	491 # Executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	492 #auth_executable = /usr/libexec/dovecot/dovecot-auth
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	493
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	494 # 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	495 #auth_process_size = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	496
2798 54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	497 # Authentication cache size in kilobytes.
54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	498 #auth_cache_size = 0
54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	499 # Time to live in seconds for cached data. After this many seconds a cached
54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	500 # record is forced out of cache.
54b29901a793 Added simple LRU cache for auth requests. Currently only for sql passdb. Timo Sirainen <tss@iki.fi> parents: 2792 diff changeset	501 #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	502
1328 0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	503 # 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	504 # 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	505 # 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	506 # first.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	507 #auth_realms =
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	508
2133 6e662d7188e9 comment update Timo Sirainen <tss@iki.fi> parents: 2103 diff changeset	509 # 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	510 # 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	511 #auth_default_realm =
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	512
1330 7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other Timo Sirainen <tss@iki.fi> parents: 1328 diff changeset	513 # 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	514 # 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	515 # 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	516 # 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	517 # 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	518 #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	519
2510 0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	520 # 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	521 # 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	522 # that '#' and '/' characters are translated to '@'.
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	523 #auth_username_translation =
0f660149c7ef Added auth_username_translation setting. Timo Sirainen <tss@iki.fi> parents: 2448 diff changeset	524
1437 c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	525 # 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	526 #auth_anonymous_username = anonymous
c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	527
999 070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	528 # More verbose logging. Useful for figuring out why authentication isn't
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	529 # working.
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	530 #auth_verbose = no
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	531
2417 af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	532 # Even more verbose logging for debugging purposes. Shows for example SQL
af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	533 # queries.
af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	534 #auth_debug = no
af0e73fc6658 Added auth_debug setting. Timo Sirainen <tss@iki.fi> parents: 2316 diff changeset	535
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	536 auth default {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	537 # Space separated list of wanted authentication mechanisms:
2267 d2e186f716d8 Added APOP authentication for POP3. Patch by Andrey Panin. Timo Sirainen <tss@iki.fi> parents: 2236 diff changeset	538 # plain digest-md5 cram-md5 apop anonymous
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	539 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	540
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	541 # Where user database is kept:
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	542 # passwd: /etc/passwd or similiar, using getpwnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	543 # passwd-file <path>: passwd-like file with specified location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	544 # static uid=<uid> gid=<gid> home=<dir template>: static settings
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	545 # vpopmail: vpopmail library
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	546 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
2802 bdfccd54a077 mysql/pgsql -> sql Timo Sirainen <tss@iki.fi> parents: 2798 diff changeset	547 # sql <config path>: SQL database, see doc/dovecot-sql.conf
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	548 userdb = passwd
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	549
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	550 # Where password database is kept:
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	551 # passwd: /etc/passwd or similiar, using getpwnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	552 # shadow: /etc/shadow or similiar, using getspnam()
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	553 # pam [<service> \| *]: PAM authentication
2163 506302b8b2fb comment update Timo Sirainen <tss@iki.fi> parents: 2141 diff changeset	554 # checkpassword <path>: checkpassword executable authentication
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	555 # passwd-file <path>: passwd-like file with specified location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	556 # vpopmail: vpopmail authentication
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	557 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
2802 bdfccd54a077 mysql/pgsql -> sql Timo Sirainen <tss@iki.fi> parents: 2798 diff changeset	558 # sql <config path>: SQL database, see doc/dovecot-sql.conf
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	559 passdb = pam
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	560
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	561 # 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	562 # 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	563 # 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	564 # authentication with BSDs internally accesses shadow files, which also
a8dc875a8918 Included comment about passwd+BSD requiring roots. Timo Sirainen <tss@iki.fi> parents: 1610 diff changeset	565 # requires roots.
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	566 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	567
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	568 # 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	569 # work if this is set, and there's no point chrooting if auth_user is root.
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	570 #chroot =
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	571
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	572 # 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	573 #count = 1
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	574
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	575 # 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	576 #ssl_require_client_cert = no
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	577 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	578
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	579 # PAM doesn't provide a way to get uid, gid or home directory. If you don't
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	580 # want to use a separate user database (passwd usually), you can use static
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	581 # userdb.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	582
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	583 #auth onlypam {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	584 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	585 # userdb = static uid=500 gid=500 home=/var/mail/%u
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	586 # passdb = pam
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	587 # user = dovecot-auth
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	588 #}
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	589
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	590 #auth ldap {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	591 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	592 # userdb = ldap /etc/dovecot-ldap.conf
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	593 # passdb = ldap /etc/dovecot-ldap.conf
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	594 # user = dovecot-auth
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	595 #}
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	596
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	597 #auth virtualfile {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	598 # mechanisms = plain digest-md5
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	599 # userdb = passwd-file /etc/passwd.imap
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	600 # passdb = passwd-file /etc/passwd.imap
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	601 # user = dovecot-auth
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	602 #}
2236 43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	603
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	604 # It's possible to export the authentication interface to other programs,
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	605 # for example SMTP server which supports talking to Dovecot. Client socket
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	606 # handles the actual authentication - you give it a username and password
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	607 # and it returns OK or failure. So it's pretty safe to allow anyone access to
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	608 # it. Master socket is used to a) query if given client was successfully
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	609 # authenticated, b) userdb lookups.
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	610
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	611 # listener sockets will be created by Dovecot's master process using the
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	612 # settings given inside the auth section
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	613 #auth default_with_listener {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	614 # mechanisms = plain
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	615 # passdb = passwd
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	616 # userdb = pam
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	617 # socket listen {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	618 # master {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	619 # path = /var/run/dovecot/auth-master
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	620 # #mode = 0600
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	621 # # Default user/group is the one who started dovecot-auth (root)
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	622 # #user =
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	623 # #group =
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	624 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	625 # client {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	626 # path = /var/run/dovecot-auth-client
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	627 # mode = 0660
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	628 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	629 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	630 #}
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	631
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	632 # connect sockets are assumed to be already running, Dovecot's master
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	633 # process only tries to connect to them. They don't need any other settings
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	634 # than path for the master socket, as the configuration is done elsewhere.
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	635 # Note that the client sockets must exist in login_dir.
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	636 #auth external {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	637 # socket connect {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	638 # master {
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	639 # path = /var/run/dovecot/auth-master
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	640 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	641 # }
43b82a35888d Dovecot can now connect to externally running dovecot-auth. Timo Sirainen <tss@iki.fi> parents: 2231 diff changeset	642 #}

Mercurial > dovecot > original-hg > dovecot-1.2

annotate dovecot-example.conf @ 2976:96a4ab34c8f1 HEAD