← Back to branch summary

~ubuntu-branches/ubuntu/wily/dovecot/wily

« back to all changes in this revision

Viewing changes to dovecot-example.conf

  • Committer: Bazaar Package Importer
  • Author(s): CHuck Short, Chuck Short
  • Date: 2009-11-06 00:47:29 UTC
  • mfrom: (4.1.9 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091106004729-i39n7v9e7d4h51f6
Tags: 1:1.2.6-1ubuntu1
https://launchpad.net/bugs/164837
https://launchpad.net/bugs/329878
https://launchpad.net/bugs/254721
* Merge from debian testing, remaining changes:
  Add new binary pkg dovecot-postfix that integrates postfix and dovecot
  automatically: (LP: #164837)
  + debian/control:
    - add new binary with short description
    - set Architecture all for dovecot-postfix (LP: #329878)
  + debian/dovecot-postfix.postinst:
    - create initial certificate symlinks to snakeoil.
    - set up postfix with postconf to:
      - use Maildir/ as the default mailbox.
      - use dovecot as the sasl authentication server.
      - use dovecot LDA (deliver).
      - use tls for smtp{d} services.
    - fix certificates paths in postfix' main.cf
    - add reject_unauth_destination to postfix' recipient restrictions
    - add reject_unknown_sender_domain to postfix' sender restrictions
    - rename configuration name on remove, delete on purge
    - restart dovecot after linking certificates
    - handle use case when postfix is unconfigurated
   + debian/dovecot-postfix.dirs: create backup directory for postfix's configuration
   + restart postfix and dovecot.
   + debian/dovecot-postfix.postrm:
     - remove all dovecot related configuration from postfix.
     - restart postfix and dovecot.
   + debian/dovecot-common.init:
     - check if /etc/dovecot/dovecot-postfix.conf exists and use it
       as the configuration file if so.
   + debian/patches/warning-ubuntu-postfix.dpatch
     - add warning about dovecot-postfix.conf in dovecot default 
       configuration file
   + debian/patches/dovecot-postfix.conf.diff:
     - Ubuntu server custom changes to the default dovecot configuration for
       better interfation with postfix
     - enable sieve plugin
   + debian/patches/dovecot-postfix.conf.diff:
     + Ubuntu server custom changes to the default dovecot configuration for
       better integration with postfix:
       - enable imap, pop3, imaps, pop3s and managesieve by default.
       - enable dovecot LDA (deliver).
       - enable SASL auth socket in postfix private directory.
   + debian/rules:
     - copy, patch and install dovecot-postfix.conf in /etc/dovecot/.
     - build architecure independent packages too
   + Use Snakeoil SSL certificates by default.
     - debian/control: Depend on ssl-cert.
     - debian/patches/ssl-cert-snakeoil.dpatch: Change default SSL cert
       paths to snakeoil.
     - debian/dovecot-common.postinst: Relax grep for SSL_* a bit.
   + Add autopkgtest to debian/tests/*.
   + Fast TearDown: Update the lsb init header to not stop in level 6.
   + Add ufw integration:
     - Created debian/dovecot-common.ufw.profile.
     - debian/rules:
       + install profile
     - debian/control:
       + Suggest ufw
   + debian/{control,rules}: enable PIE hardening.
   + dovecot-imapd, dovecot-pop3: Replaces dovecot-common (<< 1:1.1). LP: #254721
   + debian/control:
     - Update Vcs-* headers.
   + debian/rules:
     - Create emtpy stamp.h.in files in dovecot-sieve/ and dovecot-managesieve/
       if they're not there since empty files are not included in the diff.gz 
       file.
   + Add SMTP-AUTH support for Outlook (login auth mechanism)
   + Dropped:
     - debian/patches/security-CVE-2009-3235: Applied upstream.
     - debian/patches/fix-pop3-assertion.dpatch: Applied upstream.
     - dovecot-sieve and dovecot-managesieve: Use the debian patches instead.

  [Chuck Short]
  - Updated dovecot-sieve to 0.1.13.
  - Updated dovecot-managesieve to 0.11.9.

Show diffs side-by-side

added added

removed removed

Lines of Context:
dovecot-example.conf
10
10
# value inside quotes, eg.: key = "# char and trailing whitespace  "
11
11
 
12
12
# Default values are shown for each setting, it's not required to uncomment
13
 
# any of the lines. Exception to this are paths, they're just examples with
14
 
# the real defaults being based on configure options. The paths listed here
15
 
# are for configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
16
 
# --with-ssldir=/etc/ssl
 
13
# those. These are exceptions to this though: No sections (e.g. namespace {})
 
14
# or plugin settings are added by default, they're listed only as examples.
 
15
# Paths are also just examples with the real defaults being based on configure
 
16
# options. The paths listed here are for configure --prefix=/usr
 
17
# --sysconfdir=/etc --localstatedir=/var --with-ssldir=/etc/ssl
17
18
 
18
19
# Base directory where to store runtime data.
19
20
#base_dir = /var/run/dovecot/
84
85
# setting if not specified.
85
86
#ssl_listen =
86
87
 
87
 
# Disable SSL/TLS support. <doc/wiki/SSL>
88
 
#ssl_disable = no
 
88
# SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>
 
89
#ssl = yes
89
90
 
90
91
# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
91
92
# dropping root privileges, so keep the key file unreadable by anyone but
176
177
# Greeting message for clients.
177
178
#login_greeting = Dovecot ready.
178
179
 
 
180
# Space separated list of trusted network ranges. Connections from these
 
181
# IPs are allowed to override their IP addresses and ports (for logging and
 
182
# for authentication checks). disable_plaintext_auth is also ignored for
 
183
# these networks. Typically you'd specify your IMAP proxy servers here.
 
184
#login_trusted_networks =
 
185
 
179
186
# Space-separated list of elements we want to log. The elements which have
180
187
# a non-empty variable value are joined together to form a comma-separated
181
188
# string.
206
213
#   %d - domain part in user@domain, empty if there's no domain
207
214
#   %h - home directory
208
215
#
209
 
# See doc/wiki/Variables.txt for full list. Some examples:
 
216
# See <doc/wiki/Variables.txt> for full list. Some examples:
210
217
#
211
218
#   mail_location = maildir:~/Maildir
212
219
#   mail_location = mbox:~/mail:INBOX=/var/mail/%u
219
226
# If you need to set multiple mailbox locations or want to change default
220
227
# namespace settings, you can do it by defining namespace sections.
221
228
#
222
 
# You can have private, shared and public namespaces. The only difference
223
 
# between them is how Dovecot announces them to client via NAMESPACE
224
 
# extension. Shared namespaces are meant for user-owned mailboxes which are
225
 
# shared to other users, while public namespaces are for more globally
226
 
# accessible mailboxes.
 
229
# You can have private, shared and public namespaces. Private namespaces
 
230
# are for user's personal mails. Shared namespaces are for accessing other
 
231
# users' mailboxes that have been shared. Public namespaces are for shared
 
232
# mailboxes that are managed by sysadmin. If you create any shared or public
 
233
# namespaces you'll typically want to enable ACL plugin also, otherwise all
 
234
# users can access all the shared mailboxes, assuming they have permissions
 
235
# on filesystem level to do so.
227
236
#
228
237
# REMEMBER: If you add any namespaces, the default namespace must be added
229
238
# explicitly, ie. mail_location does nothing unless you have a namespace
256
265
 
257
266
   # Show the mailboxes under this namespace with LIST command. This makes the
258
267
   # namespace visible for clients that don't support NAMESPACE extension.
 
268
   # "children" value lists child mailboxes, but hides the namespace prefix.
259
269
   #list = yes
260
270
 
261
271
   # Namespace handles its own subscriptions. If set to "no", the parent
263
273
   #subscriptions = yes
264
274
#}
265
275
 
 
276
# Example shared namespace configuration
 
277
#namespace shared {
 
278
   #separator = /
 
279
 
 
280
   # Mailboxes are visible under "shared/user@domain/"
 
281
   # %%n, %%d and %%u are expanded to the destination user.
 
282
   #prefix = shared/%%u/
 
283
 
 
284
   # Mail location for other users' mailboxes. Note that %variables and ~/
 
285
   # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the
 
286
   # destination user's data.
 
287
   #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u
 
288
 
 
289
   # Use the default namespace for saving subscriptions.
 
290
   #subscriptions = no
 
291
 
 
292
   # List the shared/ namespace only if there are visible shared mailboxes.
 
293
   #list = children
 
294
#}
 
295
 
266
296
# System user and group used to access mails. If you use multiple, userdb
267
297
# can override these by returning uid or gid fields. You can use either numbers
268
 
# or names. <doc/wiki/UserIds>
 
298
# or names. <doc/wiki/UserIds.txt>
269
299
#mail_uid =
270
300
#mail_gid =
271
301
 
295
325
# isn't finding your mails.
296
326
#mail_debug = no
297
327
 
298
 
# Log prefix for mail processes. See doc/wiki/Variables.txt for list of
 
328
# Log prefix for mail processes. See <doc/wiki/Variables.txt> for list of
299
329
# possible variables you can use.
300
330
#mail_log_prefix = "%Us(%u): "
301
331
 
370
400
# ':' separated list of directories under which chrooting is allowed for mail
371
401
# processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
372
402
# This setting doesn't affect login_chroot, mail_chroot or auth chroot
373
 
# settings.
 
403
# settings. If this setting is empty, "/./" in home dirs are ignored.
374
404
# WARNING: Never add directories here which local users can modify, that
375
405
# may lead to root exploit. Usually this should be done only if you don't
376
406
# allow shell access for users. <doc/wiki/Chrooting.txt>
429
459
# NOTE: This setting requires maildir_copy_with_hardlinks = yes to work.
430
460
#maildir_copy_preserve_filename = no
431
461
 
 
462
# Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only
 
463
# when its mtime changes unexpectedly or when we can't find the mail otherwise.
 
464
#maildir_very_dirty_syncs = no
 
465
 
432
466
##
433
467
## mbox-specific settings
434
468
##
508
542
  # IMAP executable location. Changing this allows you to execute other
509
543
  # binaries before the imap process is executed.
510
544
  #
511
 
  # This would write rawlogs into ~/dovecot.rawlog/ directory:
 
545
  # This would write rawlogs into user's ~/dovecot.rawlog/, if it exists:
512
546
  #   mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
 
547
  # <doc/wiki/Debugging/Rawlog.txt>
513
548
  #
514
549
  # This would attach gdb into the imap process and write backtraces into
515
550
  # /tmp/gdbhelper.* files:
531
566
  #mail_plugins = 
532
567
  #mail_plugin_dir = /usr/lib/dovecot/imap
533
568
 
534
 
  # Send IMAP capabilities in greeting message. This makes it unnecessary for
535
 
  # clients to request it with CAPABILITY command, so it saves one round-trip.
536
 
  # Many clients however don't understand it and ask the CAPABILITY anyway.
537
 
  #login_greeting_capability = no
538
 
 
539
569
  # IMAP logout format string:
540
570
  #  %i - total number of bytes read from client
541
571
  #  %o - total number of bytes sent to client
544
574
  # Override the IMAP CAPABILITY response.
545
575
  #imap_capability = 
546
576
 
 
577
  # How many seconds to wait between "OK Still here" notifications when
 
578
  # client is IDLEing.
 
579
  #imap_idle_notify_interval = 120
 
580
 
 
581
  # ID field names and values to send to clients. Using * as the value makes
 
582
  # Dovecot use the default value. The following fields have default values
 
583
  # currently: name, version, os, os-version, support-url, support-email.
 
584
  #imap_id_send = 
 
585
 
 
586
  # ID fields sent by client to log. * means everything.
 
587
  #imap_id_log =
 
588
 
547
589
  # Workarounds for various client bugs:
548
590
  #   delay-newmail:
549
591
  #     Send EXISTS/RECENT new mail notifications only when replying to NOOP
596
638
 
597
639
  # POP3 UIDL (unique mail identifier) format to use. You can use following
598
640
  # variables, along with the variable modifiers described in
599
 
  # doc/wiki/Variables.txt (e.g. %Uf for the filename in uppercase)
 
641
  # <doc/wiki/Variables.txt> (e.g. %Uf for the filename in uppercase)
600
642
  #
601
643
  #  %v - Mailbox's IMAP UIDVALIDITY
602
644
  #  %u - Mail's IMAP UID
617
659
  #
618
660
  #pop3_uidl_format = %08Xu%08Xv
619
661
 
 
662
  # Permanently save UIDLs sent to POP3 clients, so pop3_uidl_format changes
 
663
  # won't change those UIDLs. Currently this works only with Maildir.
 
664
  #pop3_save_uidl = no
 
665
 
620
666
  # POP3 logout format string:
621
667
  #  %i - total number of bytes read from client
622
668
  #  %o - total number of bytes sent to client
682
728
 
683
729
  # Subject: header to use for rejection mails. You can use the same variables
684
730
  # as for rejection_reason below.
685
 
  #rejection_subject = Automatically rejected mail
 
731
  #rejection_subject = Rejected: %s
686
732
 
687
733
  # Human readable error message for rejection mails. You can use variables:
688
734
  #  %n = CRLF, %r = reason, %s = original subject, %t = recipient
712
758
# user's previous authentication was successful, but this one wasn't, the
713
759
# cache isn't used. For now this works only with plaintext authentication.
714
760
#auth_cache_ttl = 3600
715
 
# TTL for negative hits (user not found). 0 disables caching them completely.
 
761
# TTL for negative hits (user not found, password mismatch).
 
762
# 0 disables caching them completely.
716
763
#auth_cache_negative_ttl = 3600
717
764
 
718
765
# Space separated list of realms for SASL authentication mechanisms that need
753
800
# Username to use for users logging in with ANONYMOUS SASL mechanism
754
801
#auth_anonymous_username = anonymous
755
802
 
756
 
# More verbose logging. Useful for figuring out why authentication isn't
757
 
# working.
 
803
# Log unsuccessful authentication attempts and the reasons why they failed.
758
804
#auth_verbose = no
759
805
 
760
806
# Even more verbose logging for debugging purposes. Shows for example SQL
770
816
# automatically created and destroyed as needed.
771
817
#auth_worker_max_count = 30
772
818
 
773
 
# Number of auth requests to handle before destroying the process. This may
774
 
# be useful if PAM plugins leak memory.
775
 
#auth_worker_max_request_count = 0
776
 
 
777
819
# Host name to use in GSSAPI principal names. The default is to use the
778
 
# name returned by gethostname().
 
820
# name returned by gethostname(). Use "$ALL" to allow all keytab entries.
779
821
#auth_gssapi_hostname =
780
822
 
781
823
# Kerberos keytab to use for the GSSAPI mechanism. Will use the system 
782
824
# default (usually /etc/krb5.keytab) if not specified.
783
825
#auth_krb5_keytab = 
784
826
 
785
 
# Do NTLM authentication using Samba's winbind daemon and ntlm_auth helper.
786
 
# <doc/wiki/Authentication/Mechanisms/Winbind.txt>
787
 
#auth_ntlm_use_winbind = no
 
827
# Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and
 
828
# ntlm_auth helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>
 
829
#auth_use_winbind = no
788
830
 
789
831
# Path for Samba's ntlm_auth helper binary.
790
832
#auth_winbind_helper_path = /usr/bin/ntlm_auth
831
873
  # REMEMBER: You'll need /etc/pam.d/dovecot file created for PAM
832
874
  # authentication to actually work. <doc/wiki/PasswordDatabase.PAM.txt>
833
875
  passdb pam {
834
 
    # [session=yes] [setcred=yes] [failure_show_msg=yes]
 
876
    # [session=yes] [setcred=yes] [failure_show_msg=yes] [max_requests=<n>]
835
877
    # [cache_key=<key>] [<service name>]
836
878
    #
837
879
    # session=yes makes Dovecot open and immediately close PAM session. Some
841
883
    # need that. They aren't ever deleted though, so this isn't enabled by
842
884
    # default.
843
885
    #
 
886
    # max_requests specifies how many PAM lookups to do in one process before
 
887
    # recreating the process. The default is 100, because many PAM plugins
 
888
    # leak memory.
 
889
    #
844
890
    # cache_key can be used to enable authentication caching for PAM
845
891
    # (auth_cache_size also needs to be set). It isn't enabled by default
846
892
    # because PAM modules can do all kinds of checks besides checking password,
894
940
 
895
941
  # checkpassword executable authentication
896
942
  # NOTE: You will probably want to use "userdb prefetch" with this.
897
 
  # <doc/wiki/PasswordDatabase.CheckPassword.txt>
 
943
  # <doc/wiki/AuthDatabase.CheckPassword.txt>
898
944
  #passdb checkpassword {
899
945
    # Path for checkpassword binary
900
946
    #args = 
954
1000
    #args =
955
1001
  #}
956
1002
 
 
1003
  # checkpassword executable user database lookup
 
1004
  # <doc/wiki/AuthDatabase.CheckPassword.txt>
 
1005
  #userdb checkpassword {
 
1006
    # Path for checkpassword binary
 
1007
    #args = 
 
1008
  #}
 
1009
 
957
1010
  # static settings generated from template <doc/wiki/UserDatabase.Static.txt>
958
1011
  #userdb static {
959
1012
    # Template for the fields. Can return anything a userdb could normally
1058
1111
 
1059
1112
dict {
1060
1113
  #quota = mysql:/etc/dovecot-dict-quota.conf 
 
1114
  #expire = db:/var/lib/dovecot/expire.db
1061
1115
}
1062
1116
 
1063
1117
# Path to Berkeley DB's configuration file. See doc/dovecot-db-example.conf
1110
1164
  # to see if it changed.
1111
1165
  #acl = vfile:/etc/dovecot-acls:cache_secs=300
1112
1166
 
 
1167
  # To let users LIST mailboxes shared by other users, Dovecot needs a
 
1168
  # shared mailbox dictionary. For example:
 
1169
  #acl_shared_dict = file:/var/lib/dovecot/shared-mailboxes
 
1170
 
1113
1171
  # Convert plugin. If set, specifies the source storage path which is
1114
1172
  # converted to destination storage (mail_location) when the user logs in.
1115
1173
  # The existing mail directory is renamed to <dir>-converted.
1136
1194
  # you must set up:
1137
1195
  #   dovecot --exec-mail ext /usr/libexec/dovecot/expire-tool
1138
1196
  #expire = Trash 7 Spam 30
1139
 
  #expire_dict = db:/var/lib/dovecot/expire.db
 
1197
  #expire_dict = proxy::expire
1140
1198
 
1141
1199
  # Lazy expunge plugin. Currently works only with maildirs. When a user
1142
1200
  # expunges mails, the mails are moved to a mailbox in another namespace
1146
1204
  # and they're not deleted automatically (use a cronjob or something).
1147
1205
  #lazy_expunge = .EXPUNGED/ .DELETED/ .DELETED/.EXPUNGED/
1148
1206
 
1149
 
  # Events to log. Default is all.
 
1207
  # Events to log. Also available: flag_change append
1150
1208
  #mail_log_events = delete undelete expunge copy mailbox_delete mailbox_rename
1151
1209
  # Group events within a transaction to one line.
1152
 
  #mail_log_group_events = 
1153
 
  # Available fields: uid, box, msgid, size, vsize
 
1210
  #mail_log_group_events = no
 
1211
  # Available fields: uid, box, msgid, from, subject, size, vsize, flags
1154
1212
  # size and vsize are available only for expunge and copy events.
1155
1213
  #mail_log_fields = uid box msgid size
1156
1214
}
 
1215
 
 
1216
# Config files can also be included. deliver doesn't support them currently.
 
1217
#!include /etc/dovecot/conf.d/*.conf
 
1218
# Optional configurations, don't give an error if it's not found:
 
1219
#!include_try /etc/dovecot/extra.conf