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

annotate dovecot-example.conf @ 2057:5e0167577399 HEAD

Fixed var_expand() to take a table of variables rather than a few predefined ones. Added support for modifiers.

author	Timo Sirainen <tss@iki.fi>
date	Tue, 25 May 2004 01:33:50 +0300
parents	f0925b2271e1
children	d52c8cbf2b9d

rev	line source
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	1 ## Dovecot 1.0 configuration file
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	2
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	3 # Default values are shown after each value, it's not required to uncomment
435 06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	4 # any of the lines. Exception to this are paths, they're just examples
06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	5 # with real defaults being based on configure options. The paths listed here
06576f1d9e69 doc updates Timo Sirainen <tss@iki.fi> parents: 284 diff changeset	6 # are for configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
657 85a888d2766e Added script to easily generate self-signed certificate. Timo Sirainen <tss@iki.fi> parents: 644 diff changeset	7 # --with-ssldir=/etc/ssl
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	8
872 6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	9 # Base directory where to store runtime data.
6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	10 #base_dir = /var/run/dovecot/
6377d4f7a31c Added base_dir setting, so the configure time --localstatedir can be Timo Sirainen <tss@iki.fi> parents: 817 diff changeset	11
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	12 # Protocols we want to be serving:
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	13 # imap imaps pop3 pop3s
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	14 #protocols = imap imaps
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	15
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	16 # IP or host address where to listen in for connections. It's not currently
780 1cc947617c8b imap_listen and imaps_listen accepts now "" as "all IPv4 interfaces" and Timo Sirainen <tss@iki.fi>* parents: 779 diff changeset	17 # possible to specify multiple addresses. "*" listens in all IPv4 interfaces.
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	18 # "[::]" listens in all IPv6 interfaces, but may also listen in all IPv4
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	19 # interfaces depending on the operating system. You can specify ports with
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	20 # "host:port".
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	21 #listen = *
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	22
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	23 # IP or host address where to listen in for SSL connections. Defaults
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	24 # to above if not specified.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	25 #ssl_listen =
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	26
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	27 # Disable SSL/TLS support.
666 36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	28 #ssl_disable = no
36ac2fd352ff Added ssl_disable setting. Timo Sirainen <tss@iki.fi> parents: 661 diff changeset	29
519 9e121e74c188 and a couple more fixes.. Timo Sirainen <tss@iki.fi> parents: 518 diff changeset	30 # PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
518 1f9b96080525 Updated SSL certificate comments. Timo Sirainen <tss@iki.fi> parents: 472 diff changeset	31 # dropping root privileges, so keep the key file unreadable by anyone but
657 85a888d2766e Added script to easily generate self-signed certificate. Timo Sirainen <tss@iki.fi> parents: 644 diff changeset	32 # root. Included doc/mkcert.sh can be used to easily generate self-signed
85a888d2766e Added script to easily generate self-signed certificate. Timo Sirainen <tss@iki.fi> parents: 644 diff changeset	33 # certificate, just make sure to update the domains in dovecot-openssl.cnf
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	34 #ssl_cert_file = /etc/ssl/certs/dovecot.pem
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	35 #ssl_key_file = /etc/ssl/private/dovecot.pem
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	36
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	37 # File containing trusted SSL certificate authorities. Usually not needed.
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	38 #ssl_ca_file =
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	39
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	40 # Request client to send a certificate.
1997 1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	41 #ssl_verify_client_cert = no
1d0985f6bdd9 Added ssl_verify_client_cert setting. Timo Sirainen <tss@iki.fi> parents: 1996 diff changeset	42
615 0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	43 # SSL parameter file. Master process generates this file for login processes.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	44 # It contains Diffie Hellman and RSA parameters.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	45 #ssl_parameters_file = /var/run/dovecot/ssl-parameters.dat
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	46
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	47 # How often to regenerate the SSL parameters file. Generation is quite CPU
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	48 # intensive operation. The value is in hours, 0 disables regeneration
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	49 # entirely.
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	50 #ssl_parameters_regenerate = 24
0d852af6842e Master process generates DH/RSA parameters now and stores them into file Timo Sirainen <tss@iki.fi> parents: 614 diff changeset	51
1996 d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	52 # SSL ciphers to use
d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	53 #ssl_cipher_list = all:!low
d8f06a0c818e Added ssl_cipher_list setting. Timo Sirainen <tss@iki.fi> parents: 1986 diff changeset	54
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	55 # Disable LOGIN command and all other plaintext authentications unless
1725 cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	56 # SSL/TLS is used (LOGINDISABLED capability). Note that 127...* and
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	57 # IPv6 ::1 addresses are considered secure, this setting has no effect if
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	58 # you connect from those addresses.
cc0690f92d96 disable_plaintext_auth defaults to yes now. ipv4 127.* and ipv6 ::1 Timo Sirainen <tss@iki.fi> parents: 1707 diff changeset	59 #disable_plaintext_auth = yes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	60
1124 5e9430a39611 /dev/stderr works now in log paths. Timo Sirainen <tss@iki.fi> parents: 1113 diff changeset	61 # Use this logfile instead of syslog(). /dev/stderr can be used if you want to
5e9430a39611 /dev/stderr works now in log paths. Timo Sirainen <tss@iki.fi> parents: 1113 diff changeset	62 # use stderr for logging (ONLY /dev/stderr - otherwise it is closed).
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	63 #log_path =
b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	64
811 664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	65 # For informational messages, use this logfile instead of the default
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	66 #info_log_path =
664de3231e33 Added info_log_file setting and i_info() function to write to it. Default is Timo Sirainen <tss@iki.fi> parents: 788 diff changeset	67
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	68 # Prefix for each line written to log file. % codes are in strftime(3)
1647 d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or ' Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	69 # format.
d6288ae1a71b Spaces are now stripped from end of line in config file. You can use " or ' Timo Sirainen <tss@iki.fi> parents: 1622 diff changeset	70 #log_timestamp = "%b %d %H:%M:%S "
35 b420373f88f6 Added log_path and log_timestamp settings to config file. Removed -l command Timo Sirainen <tss@iki.fi> parents: 27 diff changeset	71
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	72 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	73 ## Login processes
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	74 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	75
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	76 # Directory where authentication process places authentication UNIX sockets
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	77 # which login needs to be able to connect to. The sockets are created when
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	78 # running as root, so you don't have to worry about permissions.
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	79 #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	80
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	81 # 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	82 # 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	83 #login_chroot = yes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	84
1582 498a9b7797f2 Comment updates Timo Sirainen <tss@iki.fi> parents: 1578 diff changeset	85 # 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	86 # 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	87 # 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	88 #login_user = dovecot
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	89
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	90 # 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	91 # login_process_per_connection you might need to grow this.
0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	92 #login_process_size = 16
0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	93
613 1906116a62ce Finally support for handling each login connection in it's own process. Timo Sirainen <tss@iki.fi> parents: 600 diff changeset	94 # 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	95 # 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	96 # 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	97 # 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	98 #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	99
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	100 # 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	101 # 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	102 #login_processes_count = 3
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	103
614 e60620644af3 login_process_per_connection = yes scales now better when multiple users are Timo Sirainen <tss@iki.fi> parents: 613 diff changeset	104 # 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	105 # 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	106 # 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	107 # 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	108 # 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	109 # 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	110 #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	111
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	112 # 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	113 # 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	114 # 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	115 # 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	116 #login_max_logging_users = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	117
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	118
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	119 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	120 ## Mail processes
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	121 ##
722 0438621d25ff Added virtual memory size limits to processes. Default values are pretty Timo Sirainen <tss@iki.fi> parents: 666 diff changeset	122
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	123 # Maximum number of running mail processes. When this limit is reached,
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	124 # 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	125 #max_mail_processes = 1024
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	126
596 ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	127 # 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	128 # 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	129 # (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	130 #verbose_proctitle = no
ab3590c3a7d9 Added verbose_proctitle setting: Show more verbose process titles (in ps). Timo Sirainen <tss@iki.fi> parents: 519 diff changeset	131
1236 5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	132 # Show protocol level SSL errors.
5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	133 #verbose_ssl = no
5c73e63c75f7 verbose_ssl here too Timo Sirainen <tss@iki.fi> parents: 1223 diff changeset	134
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	135 # 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	136 # 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	137 # 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	138 # be done even if first_valid_uid is set to 0.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	139 #first_valid_uid = 500
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	140 #last_valid_uid = 0
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	141
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	142 # 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	143 # 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	144 # 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	145 # not set.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	146 #first_valid_gid = 1
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	147 #last_valid_gid = 0
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	148
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	149 # ':' separated list of directories under which chrooting is allowed for mail
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	150 # 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	151 # This setting doesn't affect login_chroot or auth_chroot variables.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	152 # WARNING: Never add directories here which local users can modify, that
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	153 # 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	154 # allow shell access for users. See doc/configuration.txt for more information.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	155 #valid_chroot_dirs =
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	156
1734 d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	157 # Default chroot directory for mail processes. This can be overridden by
d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	158 # giving /./ in user's home directory (eg. /home/./user chroots into /home).
d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	159 #mail_chroot =
d83e16602418 Added mail_chroot setting to specify default chroot. Timo Sirainen <tss@iki.fi> parents: 1728 diff changeset	160
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	161 # 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	162 # dovecot tries to do some automatic detection as described in
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	163 # doc/mail-storages.txt. There's a few special variables you can use:
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	164 #
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	165 # %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	166 # %n - user part in user@domain, same as %u if there's no domain
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	167 # %d - domain part in user@domain, empty if user there's no domain
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	168 # %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	169 # %p - protocol (IMAP or POP3)
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined Timo Sirainen <tss@iki.fi> parents: 2039 diff changeset	170 #
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined Timo Sirainen <tss@iki.fi> parents: 2039 diff changeset	171 # You can apply a modifiers for each variable (eg. %Lp = pop3):
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined Timo Sirainen <tss@iki.fi> parents: 2039 diff changeset	172 # %L - lowercase
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined Timo Sirainen <tss@iki.fi> parents: 2039 diff changeset	173 # %U - uppercase
5e0167577399 Fixed var_expand() to take a table of variables rather than a few predefined Timo Sirainen <tss@iki.fi> parents: 2039 diff changeset	174 # %E - escape '"', "'" and '\' characters by inserting '\' before them.
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	175 #
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	176 # You can also limit a width of string by giving the number of max. characters
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	177 # after the '%' character. For example %1u gives the first character of
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	178 # username. Some examples:
493bc8da9e80 default_mail_env behaviour changed. We use %u instead of $U now. Added also Timo Sirainen <tss@iki.fi> parents: 811 diff changeset	179 #
1747 a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	180 # default_mail_env = maildir:/var/mail/%1u/%u/Maildir
a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	181 # default_mail_env = mbox:~/mail/:INBOX=/var/mail/%u
a1183185b013 comment changes Timo Sirainen <tss@iki.fi> parents: 1734 diff changeset	182 # 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	183 #
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	184 #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	185
462 67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	186 # 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	187 # 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	188 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	189 # 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	190 # 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	191 # 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	192 # 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	193 # 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	194 # 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	195 # 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	196 # 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	197 # 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	198 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	199 # 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	200 # 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	201 # 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	202 # 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	203 # 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	204 # 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	205 # 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	206 #
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	207 # 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	208 # 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	209 # 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	210
67d22b7b0918 Added mail_cache_fields and mail_never_cache_fields settings, plus settings Timo Sirainen <tss@iki.fi> parents: 435 diff changeset	211 #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	212
987 cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	213 # 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	214 # 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	215 # needed.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	216 #mail_never_cache_fields =
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	217
1138 340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	218 # Workarounds for various client bugs:
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	219 # oe6-fetch-no-newmail:
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	220 # Never send EXISTS/RECENT when replying to FETCH command. Outlook Express
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	221 # seems to think they are FETCH replies and gives user "Message no longer
1180 930452c85250 comment update Timo Sirainen <tss@iki.fi> parents: 1177 diff changeset	222 # in server" error. Note that OE6 still breaks even with this workaround
930452c85250 comment update Timo Sirainen <tss@iki.fi> parents: 1177 diff changeset	223 # if synchronization is set to "Headers Only".
1728 d1a6d9d24bd9 Added oe6-fetch-redundant-msgset workaround. Timo Sirainen <tss@iki.fi> parents: 1727 diff changeset	224 # oe6-fetch-redundant-msgset:
d1a6d9d24bd9 Added oe6-fetch-redundant-msgset workaround. Timo Sirainen <tss@iki.fi> parents: 1727 diff changeset	225 # If client requests "nextuid:*" messageset, don't return the last message
d1a6d9d24bd9 Added oe6-fetch-redundant-msgset workaround. Timo Sirainen <tss@iki.fi> parents: 1727 diff changeset	226 # as RFC3501 would require. This may considerably improve Dovecot's caching
d1a6d9d24bd9 Added oe6-fetch-redundant-msgset workaround. Timo Sirainen <tss@iki.fi> parents: 1727 diff changeset	227 # decisions for OE6 users.
1212 9ced30dda6c3 workaround: outlook-idle Timo Sirainen <tss@iki.fi> parents: 1199 diff changeset	228 # outlook-idle:
9ced30dda6c3 workaround: outlook-idle Timo Sirainen <tss@iki.fi> parents: 1199 diff changeset	229 # Outlook and Outlook Express never abort IDLE command, so if no mail
9ced30dda6c3 workaround: outlook-idle Timo Sirainen <tss@iki.fi> parents: 1199 diff changeset	230 # arrives in half a hour, Dovecot closes the connection. This is still
9ced30dda6c3 workaround: outlook-idle Timo Sirainen <tss@iki.fi> parents: 1199 diff changeset	231 # fine, except Outlook doesn't connect back so you don't see if new mail
9ced30dda6c3 workaround: outlook-idle Timo Sirainen <tss@iki.fi> parents: 1199 diff changeset	232 # arrives.
1138 340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	233 #client_workarounds =
340dea0150bf Added client_workarounds setting, with currently one workaround for OE6. Timo Sirainen <tss@iki.fi> parents: 1124 diff changeset	234
600 3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in Timo Sirainen <tss@iki.fi> parents: 596 diff changeset	235 # Dovecot can notify client of new mail in selected mailbox soon after it's
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in Timo Sirainen <tss@iki.fi> parents: 596 diff changeset	236 # received. This setting specifies the minimum interval in seconds between
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in Timo Sirainen <tss@iki.fi> parents: 596 diff changeset	237 # new mail notifications to client - internally they may be checked more or
3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in Timo Sirainen <tss@iki.fi> parents: 596 diff changeset	238 # less often. Setting this to 0 disables the checking.
788 5b2a247ed361 mailbox_check_interval is now disabled by default, at least Evolution breaks Timo Sirainen <tss@iki.fi> parents: 780 diff changeset	239 # NOTE: Evolution client breaks with this option when it's trying to APPEND.
5b2a247ed361 mailbox_check_interval is now disabled by default, at least Evolution breaks Timo Sirainen <tss@iki.fi> parents: 780 diff changeset	240 #mailbox_check_interval = 0
600 3b44bc64afd4 mailbox_check_interval setting: Dovecot can notify client of new mail in Timo Sirainen <tss@iki.fi> parents: 596 diff changeset	241
1177 dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	242 # Like mailbox_check_interval, but used for IDLE command.
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	243 #mailbox_idle_check_interval = 30
dee729f18aa1 IDLE setting. Timo Sirainen <tss@iki.fi> parents: 1168 diff changeset	244
1151 058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	245 # 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	246 # 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	247 # 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	248 # or ~user/.
058f6c26f405 Added mail_full_filesystem_access setting. Some of the setting variable Timo Sirainen <tss@iki.fi> parents: 1142 diff changeset	249 #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	250
1986 7ac0ef106427 s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1920 diff changeset	251 # 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	252 # to create new keywords.
7ac0ef106427 s/custom flags/keywords/ Timo Sirainen <tss@iki.fi> parents: 1920 diff changeset	253 #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	254
472 2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	255 # 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	256 # 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	257 # 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	258 #mail_save_crlf = no
2fa0bfb65268 Added setting mail_save_crlf. Few other settings cleanups. Timo Sirainen <tss@iki.fi> parents: 462 diff changeset	259
644 415498fa78d6 mail_read_mmaped: Use mmap() instead of read() to read mail files. read() Timo Sirainen <tss@iki.fi> parents: 643 diff changeset	260 # 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	261 # 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	262 # 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	263 #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	264
1918 ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	265 # 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	266 # filesystems (NFS or clustered filesystem).
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	267 #mmap_disable = no
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	268
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	269 # 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	270 # which use separate caches for them, such as OpenBSD.
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	271 #mmap_no_write = no
ef89efba1838 updated for mmap changes Timo Sirainen <tss@iki.fi> parents: 1911 diff changeset	272
1920 d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	273 # Don't use fcntl() locking. Alternatives are dotlocking and other tricks
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	274 # which may be slower. Required for NFS.
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	275 #fcntl_locks_disable = no
d11efbf1d341 Added fcntl_lock_disable setting to allow indexes to work with NFS. Some Timo Sirainen <tss@iki.fi> parents: 1918 diff changeset	276
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	277 # Copy mail to another folders using hard links. This is much faster than
987 cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	278 # actually copying the file. This is problematic only if something modifies
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	279 # the mail in one folder but doesn't want it modified in the others. I don't
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	280 # know any MUA which would modify mail files directly. IMAP protocol also
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	281 # requires that the mails don't change, so it would be problematic in any case.
cbf096fbb9f0 comment updates Timo Sirainen <tss@iki.fi> parents: 979 diff changeset	282 # If you care about performance, enable it.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	283 #maildir_copy_with_hardlinks = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	284
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	285 # Check if mails' content has been changed by external programs. This slows
882 38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new Timo Sirainen <tss@iki.fi> parents: 872 diff changeset	286 # down things as extra stat() needs to be called for each file. If changes are
38b3bc6ddcc4 Changed maildir_check_content_changes = yes now to treat the message as new Timo Sirainen <tss@iki.fi> parents: 872 diff changeset	287 # noticed, the message is treated as a new message, since IMAP protocol
1911 ac810e95cdd6 typofix Timo Sirainen <tss@iki.fi> parents: 1879 diff changeset	288 # specifies that existing messages are immutable.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	289 #maildir_check_content_changes = no
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	290
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	291 # Which locking methods to use for locking mbox. There's three available:
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	292 # dotlock: Create <mailbox>.lock file. This is the oldest and most NFS-safe
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	293 # solution. If you want to use /var/mail/ like directory, the users
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	294 # will need write access to that directory.
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	295 # fcntl : Use this if possible. Works with NFS too if lockd is used.
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	296 # flock : May not exist in all systems. Doesn't work with NFS.
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	297 #
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	298 # You can use both fcntl and flock too; if you do the order they're declared
4abeb0fa0fe7 Don't use flock() locking by default. Using both fcntl+flock doesn't work Timo Sirainen <tss@iki.fi> parents: 1055 diff changeset	299 # with is important to avoid deadlocks if other MTAs/MUAs are using both fcntl
1214 1429fcb2e577 updates Timo Sirainen <tss@iki.fi> parents: 1212 diff changeset	300 # and flock. Some operating systems don't allow using both of them
1429fcb2e577 updates Timo Sirainen <tss@iki.fi> parents: 1212 diff changeset	301 # simultaneously, eg. BSDs. If dotlock is used, it's always created first.
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	302 #mbox_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	303
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	304 # Should we create dotlock file even when we want only a read-lock? Setting
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	305 # this to yes hurts the performance when the mailbox is accessed simultaneously
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	306 # by multiple processes, but it's needed for reliable reading if no other
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	307 # locking methods are available.
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	308 #mbox_read_dotlock = no
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	309
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	310 # 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	311 #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	312
da34bdd4e0c6 Added mbox lock settings to config file. Support timeouting fcntl() and Timo Sirainen <tss@iki.fi> parents: 615 diff changeset	313 # 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	314 # 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	315 #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	316
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	317 # umask to use for mail files and directories
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	318 #umask = 0077
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	319
1223 52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	320 # 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	321 # 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	322 # 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	323 # ptrace() each others processes then.
1223 52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	324 #mail_drop_priv_before_exec = no
52e0830ade13 Added setting mail_drop_priv_before_exec. Timo Sirainen <tss@iki.fi> parents: 1218 diff changeset	325
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	326 # 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	327 # 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	328 #mail_process_size = 256
1465 03dd87873a81 Added support for dynamically loadable imap/pop3 modules. Timo Sirainen <tss@iki.fi> parents: 1437 diff changeset	329
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	330 ##
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	331 ## IMAP specific settings
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	332 ##
a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	333
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	334 protocol imap {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	335 # Login executable location.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	336 #login_executable = /usr/libexec/dovecot/imap-login
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	337
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	338 # IMAP executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	339 #mail_executable = /usr/libexec/dovecot/imap
1727 6d10ece6cf9f added rawlog example Timo Sirainen <tss@iki.fi> parents: 1725 diff changeset	340 # This would write rawlogs into ~/dovecot.rawlog/ directory:
6d10ece6cf9f added rawlog example Timo Sirainen <tss@iki.fi> parents: 1725 diff changeset	341 #mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	342
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	343 # Maximum IMAP command line length in bytes. Some clients generate very long
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	344 # command lines with huge mailboxes, so you may need to raise this if you get
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	345 # "Too long argument" or "IMAP command line too large" errors often.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	346 #imap_max_line_length = 65536
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	347
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	348 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	349 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	350 #mail_modules = /usr/lib/dovecot/imap
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	351 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	352
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	353 ##
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	354 ## POP3 specific settings
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	355 ##
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	356
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	357 protocol pop3 {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	358 # Login executable location.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	359 #login_executable = /usr/libexec/dovecot/pop3-login
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	360
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	361 # POP3 executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	362 #mail_executable = /usr/libexec/dovecot/pop3
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	363
2039 f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	364 # Don't try to set mails non-recent with POP3 sessions. This is mostly
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	365 # intended to reduce disk I/O. With maildir it doesn't move files from
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	366 # new/ to cur/, with mbox it doesn't write Status-header.
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	367 #pop3_mails_keep_recent = no
f0925b2271e1 Added pop3_mails_keep_recent option. Fixed recent assert crash. Timo Sirainen <tss@iki.fi> parents: 2027 diff changeset	368
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	369 # Support for dynamically loadable modules.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	370 #mail_use_modules = no
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	371 #mail_modules = /usr/lib/dovecot/pop3
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	372 }
1465 03dd87873a81 Added support for dynamically loadable imap/pop3 modules. Timo Sirainen <tss@iki.fi> parents: 1437 diff changeset	373
1055 a72bba3f8a55 Rewrote setting handling. Changed some existing settings also since POP3 Timo Sirainen <tss@iki.fi> parents: 1040 diff changeset	374 ##
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	375 ## Authentication processes
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	376 ##
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	377
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	378 # You can have multiple authentication processes. With plaintext authentication
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	379 # the password is checked against each process, the first one which succeeds is
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	380 # used. This is useful if you want to allow both system users (/etc/passwd)
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	381 # and virtual users to login without duplicating the system users into virtual
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	382 # database.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	383
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	384 # Executable location
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	385 #auth_executable = /usr/libexec/dovecot/dovecot-auth
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	386
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	387 # Set max. process size in megabytes.
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	388 #auth_process_size = 256
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	389
1328 0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	390 # Space separated list of realms for SASL authentication mechanisms that need
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	391 # them. You can leave it empty if you don't want to support multiple realms.
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	392 # Many clients simply use the first one listed here, so keep the default realm
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	393 # first.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	394 #auth_realms =
3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	395
1328 0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	396 # Default realm to use if none was specified.
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	397 #auth_default_realm =
0a524d229f50 Added auth_default_realm (based on patch by Kristian Hoffmann) Timo Sirainen <tss@iki.fi> parents: 1318 diff changeset	398
1330 7cde19dbe754 Moved auth_username_chars from db-pgsql to generic for all. Some other Timo Sirainen <tss@iki.fi> parents: 1328 diff changeset	399 # 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	400 # 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	401 # 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	402 # 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	403 # 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	404 #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	405
1437 c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	406 # 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	407 #auth_anonymous_username = anonymous
c27c6089e933 Added support for ANONYMOUS SASL mechanism. Timo Sirainen <tss@iki.fi> parents: 1330 diff changeset	408
999 070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	409 # More verbose logging. Useful for figuring out why authentication isn't
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	410 # working.
070aee0e5b9f Added auth_verbose Timo Sirainen <tss@iki.fi> parents: 987 diff changeset	411 #auth_verbose = no
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	412
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	413 auth default {
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	414 # Space separated list of wanted authentication mechanisms:
1879 6d37e8554dbb cram-md5 updates. Timo Sirainen <tss@iki.fi> parents: 1747 diff changeset	415 # plain digest-md5 cram-md5 anonymous
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	416 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	417
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	418 # 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	419 # 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	420 # 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	421 # 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	422 # 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	423 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	424 # pgsql <config path>: a PostgreSQL database, see doc/dovecot-pgsql.conf
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	425 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	426
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	427 # 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	428 # 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	429 # 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	430 # pam [<service> \| *]: PAM authentication
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	431 # 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	432 # 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	433 # ldap <config path>: LDAP, see doc/dovecot-ldap.conf
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	434 # pgsql <config path>: a PostgreSQL database, see doc/dovecot-pgsql.conf
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	435 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	436
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	437 # 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	438 # 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	439 # 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	440 # 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	441 # 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	442 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	443
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	444 # 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	445 # 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	446 #chroot =
1610 6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	447
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	448 # 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	449 #count = 1
2027 dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	450
dc5d0da1abe9 Added ssl_require_client_cert auth-specific setting. Hide Timo Sirainen <tss@iki.fi> parents: 1997 diff changeset	451 # 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	452 #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	453 }
6850142c4e25 New configuration file code. Some syntax changes, but tries to be somewhat Timo Sirainen <tss@iki.fi> parents: 1592 diff changeset	454
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	455 # 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	456 # 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	457 # userdb.
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	458
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	459 #auth onlypam {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	460 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	461 # 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	462 # passdb = pam
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	463 # 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	464 #}
0 3b1985cbc908 Initial revision Timo Sirainen <tss@iki.fi> parents: diff changeset	465
1707 ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	466 #auth ldap {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	467 # mechanisms = plain
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	468 # 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	469 # 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	470 # 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	471 #}
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	472
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	473 #auth virtualfile {
ba70d60987e2 We now support checking the password against all defined auth processes and Timo Sirainen <tss@iki.fi> parents: 1688 diff changeset	474 # 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	475 # 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	476 # 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	477 # 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	478 #}

Mercurial > dovecot > original-hg > dovecot-1.2

annotate dovecot-example.conf @ 2057:5e0167577399 HEAD