From: Vincent Kenbeek Date: Thu, 28 Nov 2024 08:58:38 +0000 (+0100) Subject: doc: Replace example config with minimal config X-Git-Tag: 2.4.0~167 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5941699b277d762d98c202928cf5b5c8c70bc359;p=thirdparty%2Fdovecot%2Fcore.git doc: Replace example config with minimal config --- diff --git a/INSTALL.md b/INSTALL.md index acb761606a..77b6f524e7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -22,11 +22,7 @@ See [Compiling Dovecot From Sources](https://doc.dovecot.org/installation_guide/ Running ======= -Start with the example configuration: - -``` -cp -r /usr/local/share/doc/dovecot/example-config/* /usr/local/etc/dovecot/ -``` +Start with the minimal configuration installed in `/usr/local/etc/dovecot/`. Read through, and make needed modifications. diff --git a/configure.ac b/configure.ac index 36e972d040..56b21e655c 100644 --- a/configure.ac +++ b/configure.ac @@ -790,8 +790,6 @@ Makefile doc/Makefile doc/man/Makefile doc/index.html -doc/example-config/Makefile -doc/example-config/conf.d/Makefile doc/dovecot.conf src/Makefile src/lib/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index de9c79efe5..87b52dbe46 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,4 @@ -SUBDIRS = . example-config man -DOCDIRS = example-config +SUBDIRS = . man docfiles = \ thread-refs.txt \ diff --git a/doc/example-config/Makefile.am b/doc/example-config/Makefile.am deleted file mode 100644 index 9e107ce8c5..0000000000 --- a/doc/example-config/Makefile.am +++ /dev/null @@ -1,31 +0,0 @@ -SUBDIRS = conf.d - -pkgsysconfdir = $(sysconfdir)/dovecot -nodist_pkgsysconf_DATA = README -# nodist_ prefix just doesn't seem to work, so rm it directly: -dist-hook: - rm -f $(distdir)/README $(distdir)/dovecot.conf - -README: README.in Makefile - $(AM_V_GEN)cat $(srcdir)/README.in | sed "s|@exampledir@|$(exampledir)|" > README - -dovecot.conf: dovecot.conf.in Makefile - $(AM_V_GEN)cat $(srcdir)/dovecot.conf.in | sed "s|\@DOVECOT_CONFIG_VERSION\@|$(DOVECOT_CONFIG_VERSION)|" > dovecot.conf - -exampledir = $(docdir)/example-config -example_DATA = \ - dovecot.conf \ - dovecot-dict-auth.conf.ext \ - dovecot-dict-sql.conf.ext \ - dovecot-ldap.conf.ext \ - dovecot-oauth2.conf.ext - -EXTRA_DIST = \ - $(example_DATA) \ - dovecot.conf.in \ - README.in - -install-data-local: - $(mkdir_p) $(DESTDIR)/$(pkgsysconfdir) - -CLEANFILES = README diff --git a/doc/example-config/README.in b/doc/example-config/README.in deleted file mode 100644 index 9d93d9e831..0000000000 --- a/doc/example-config/README.in +++ /dev/null @@ -1,2 +0,0 @@ -Configuration files go to this directory. See example configuration files in -@exampledir@/ diff --git a/doc/example-config/conf.d/10-auth.conf b/doc/example-config/conf.d/10-auth.conf deleted file mode 100644 index 1dc9a3bf98..0000000000 --- a/doc/example-config/conf.d/10-auth.conf +++ /dev/null @@ -1,122 +0,0 @@ -## -## Authentication processes -## - -# Enable LOGIN command and all other plaintext authentications even if -# SSL/TLS is not used (LOGINDISABLED capability). Note that if the remote IP -# matches the local IP (ie. you're connecting from the same computer), the -# connection is considered secure and cleartext authentication is allowed. -# See also ssl=required setting. -#auth_allow_cleartext = no - -# Authentication cache size (e.g. 10M). 0 means it's disabled. Note that -# bsdauth and PAM require cache_key to be set for caching to be used. -#auth_cache_size = 0 -# Time to live for cached data. After TTL expires the cached record is no -# longer used, *except* if the main database lookup returns internal failure. -# We also try to handle password changes automatically: If user's previous -# authentication was successful, but this one wasn't, the cache isn't used. -# For now this works only with plaintext authentication. -#auth_cache_ttl = 1 hour -# TTL for negative hits (user not found, password mismatch). -# 0 disables caching them completely. -#auth_cache_negative_ttl = 1 hour - -# Space separated list of realms for SASL authentication mechanisms that need -# them. You can leave it empty if you don't want to support multiple realms. -# Many clients simply use the first one listed here, so keep the default realm -# first. -#auth_realms = - -# Default realm/domain to use if none was specified. This is used for both -# SASL realms and appending @domain to username in plaintext logins. -#auth_default_domain = - -# List of allowed characters in username. If the user-given username contains -# a character not listed in here, the login automatically fails. This is just -# an extra check to make sure user can't exploit any potential quote escaping -# vulnerabilities with SQL/LDAP databases. If you want to allow all characters, -# set this value to empty. -#auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@ - -# Username character translations before it's looked up from databases. The -# value contains series of from -> to characters. For example "#@/@" means -# that '#' and '/' characters are translated to '@'. -#auth_username_translation = - -# Username formatting before it's looked up from databases. You can use -# the standard variables here, eg. %Lu would lowercase the username, %n would -# drop away the domain if it was given, or "%n-AT-%d" would change the '@' into -# "-AT-". This translation is done after auth_username_translation changes. -#auth_username_format = %Lu - -# If you want to allow master users to log in by specifying the master -# username within the normal username string (ie. not using SASL mechanism's -# support for it), you can specify the separator character here. The format -# is then . UW-IMAP uses "*" as the -# separator, so that could be a good choice. -#auth_master_user_separator = - -# Username to use for users logging in with ANONYMOUS SASL mechanism -#auth_anonymous_username = anonymous - -# Host name to use in GSSAPI principal names. The default is to use the -# name returned by gethostname(). Use "$ALL" (with quotes) to allow all keytab -# entries. -#auth_gssapi_hostname = - -# Kerberos keytab to use for the GSSAPI mechanism. Will use the system -# default (usually /etc/krb5.keytab) if not specified. You may need to change -# the auth service to run as root to be able to read this file. -#auth_krb5_keytab = - -# Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and -# ntlm_auth helper. -# https://doc.dovecot.org/configuration_manual/authentication/winbind/ -#auth_use_winbind = no - -# Path for Samba's ntlm_auth helper binary. -#auth_winbind_helper_path = /usr/bin/ntlm_auth - -# Time to delay before replying to failed authentications. -#auth_failure_delay = 2 secs - -# Require a valid SSL client certificate or the authentication fails. -#auth_ssl_require_client_cert = no - -# Take the username from client's SSL certificate, using -# X509_NAME_get_text_by_NID() which returns the subject's DN's -# CommonName. -#auth_ssl_username_from_cert = no - -# Space separated list of wanted authentication mechanisms: -# plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi otp -# gss-spnego -# NOTE: See also auth_allow_cleartext setting. -auth_mechanisms = plain - -## -## Password and user databases -## - -# -# Password database is used to verify user's password (and nothing more). -# You can have multiple passdbs and userdbs. This is useful if you want to -# allow both system users (/etc/passwd) and virtual users to login without -# duplicating the system users into virtual database. -# -# https://doc.dovecot.org/configuration_manual/authentication/password_databases_passdb/ -# -# User database specifies where mails are located and what user/group IDs -# own them. For single-UID configuration use "static" userdb. -# -# https://doc.dovecot.org/configuration_manual/authentication/user_databases_userdb/ - -#!include auth-deny.conf.ext -#!include auth-master.conf.ext - -!include auth-system.conf.ext -#!include auth-sql.conf.ext -#!include auth-ldap.conf.ext -#!include auth-passwdfile.conf.ext -#!include auth-static.conf.ext diff --git a/doc/example-config/conf.d/10-logging.conf b/doc/example-config/conf.d/10-logging.conf deleted file mode 100644 index 2eb8187d63..0000000000 --- a/doc/example-config/conf.d/10-logging.conf +++ /dev/null @@ -1,106 +0,0 @@ -## -## Log destination. -## - -# Log file to use for error messages. "syslog" logs to syslog, -# /dev/stderr logs to stderr. -#log_path = syslog - -# Log file to use for informational messages. Defaults to log_path. -#info_log_path = -# Log file to use for debug messages. Defaults to info_log_path. -#debug_log_path = - -# Syslog facility to use if you're logging to syslog. Usually if you don't -# want to use "mail", you'll use local0..local7. Also other standard -# facilities are supported. -#syslog_facility = mail - -## -## Logging verbosity and debugging. -## - -# Log filter is a space-separated list conditions. If any of the conditions -# match, the log filter matches (i.e. they're ORed together). Parenthesis -# are supported if multiple conditions need to be matched together. -# -# See https://doc.dovecot.org/configuration_manual/event_filter/ for details. -# -# For example: event=http_request_* AND category=error AND category=storage -# -# Filter to specify what debug logging to enable. This will eventually replace -# mail_debug and auth_debug settings. -#log_debug = - -# Crash after logging a matching event. For example category=error will crash -# any time an error is logged, which can be useful for debugging. -#log_core_filter = - -# Log unsuccessful authentication attempts and the reasons why they failed. -#auth_verbose = no - -# In case of password mismatches, log the attempted password. Valid values are -# no, plain and sha1. sha1 can be useful for detecting brute force password -# attempts vs. user simply trying the same password over and over again. -# You can also truncate the value to n chars by appending ":n" (e.g. sha1:6). -#auth_verbose_passwords = no - -# Even more verbose logging for debugging purposes. Shows for example SQL -# queries. -#auth_debug = no - -# In case of password mismatches, log the passwords and used scheme so the -# problem can be debugged. Enabling this also enables auth_debug. -#auth_debug_passwords = no - -# Enable mail process debugging. This can help you figure out why Dovecot -# isn't finding your mails. -#mail_debug = no - -# Show protocol level SSL errors. -#verbose_ssl = no - -# mail_log plugin provides more event logging for mail processes. -plugin { - # Events to log. Also available: flag_change append - #mail_log_events = delete undelete expunge copy mailbox_delete mailbox_rename - # Available fields: uid, box, msgid, from, subject, size, vsize, flags - # size and vsize are available only for expunge and copy events. - #mail_log_fields = uid box msgid size -} - -## -## Log formatting. -## - -# Prefix for each line written to log file. % codes are in strftime(3) -# format. -#log_timestamp = "%b %d %H:%M:%S " - -# Space-separated list of elements we want to log. The elements which have -# a non-empty variable value are joined together to form a comma-separated -# string. -#login_log_format_elements = user=<%u> method=%m rip=%r lip=%l mpid=%e %c - -# Login log format. %s contains login_log_format_elements string, %$ contains -# the data we want to log. -#login_log_format = %$: %s - -# Log prefix for mail processes. See -# https://doc.dovecot.org/configuration_manual/config_file/config_variables/ -# for list of possible variables you can use. -#mail_log_prefix = "%s(%u)<%{process:pid}><%{session}>: " - -# Format to use for logging mail deliveries: -# %$ - Delivery status message (e.g. "saved to INBOX") -# %m / %{msgid} - Message-ID -# %s / %{subject} - Subject -# %f / %{from} - From address -# %p / %{size} - Physical size -# %w / %{vsize} - Virtual size -# %e / %{from_envelope} - MAIL FROM envelope -# %{to_envelope} - RCPT TO envelope -# %{delivery_time} - How many milliseconds it took to deliver the mail -# %{session_time} - How long LMTP session took, not including delivery_time -# %{storage_id} - Backend-specific ID for mail, e.g. Maildir filename -#deliver_log_format = msgid=%m: %$ diff --git a/doc/example-config/conf.d/10-mail.conf b/doc/example-config/conf.d/10-mail.conf deleted file mode 100644 index 01c78f92d0..0000000000 --- a/doc/example-config/conf.d/10-mail.conf +++ /dev/null @@ -1,421 +0,0 @@ -## -## Mailbox locations and namespaces -## - -# Location for users' mailboxes. The default is empty, which means that Dovecot -# tries to find the mailboxes automatically. This won't work if the user -# doesn't yet have any mail, so you should explicitly tell Dovecot the full -# location. -# -# If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u) -# isn't enough. You'll also need to tell Dovecot where the other mailboxes are -# kept. This is called the "root mail directory", and it must be the first -# path given in the mail_location setting. -# -# There are a few special variables you can use, eg.: -# -# %u - username -# %n - user part in user@domain, same as %u if there's no domain -# %d - domain part in user@domain, empty if there's no domain -# %h - home directory -# -# See https://doc.dovecot.org/configuration_manual/config_file/config_variables/ -# for full list. Some examples: -# -# mail_location = maildir:~/Maildir -# mail_location = mbox:~/mail:INBOX=/var/mail/%u -# mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n -# -# https://doc.dovecot.org/configuration_manual/mail_location/ -# -#mail_location = - -# If you need to set multiple mailbox locations or want to change default -# namespace settings, you can do it by defining namespace sections. -# -# You can have private, shared and public namespaces. Private namespaces -# are for user's personal mails. Shared namespaces are for accessing other -# users' mailboxes that have been shared. Public namespaces are for shared -# mailboxes that are managed by sysadmin. If you create any shared or public -# namespaces you'll typically want to enable ACL plugin also, otherwise all -# users can access all the shared mailboxes, assuming they have permissions -# on filesystem level to do so. -namespace inbox { - # Namespace type: private, shared or public - #type = private - - # Hierarchy separator to use. You should use the same separator for all - # namespaces or some clients get confused. '/' is usually a good one. - # The default however depends on the underlying mail storage format. - #separator = - - # Prefix required to access this namespace. This needs to be different for - # all namespaces. For example "Public/". - #prefix = - - # Physical location of the mailbox. This is in same format as - # mail_location, which is also the default for it. - #location = - - # There can be only one INBOX, and this setting defines which namespace - # has it. - inbox = yes - - # If namespace is hidden, it's not advertised to clients via NAMESPACE - # extension. You'll most likely also want to set list=no. This is mostly - # useful when converting from another server with different namespaces which - # you want to deprecate but still keep working. For example you can create - # hidden namespaces with prefixes "~/mail/", "~%u/mail/" and "mail/". - #hidden = no - - # Show the mailboxes under this namespace with LIST command. This makes the - # namespace visible for clients that don't support NAMESPACE extension. - # "children" value lists child mailboxes, but hides the namespace prefix. - #list = yes - - # Namespace handles its own subscriptions. If set to "no", the parent - # namespace handles them (empty prefix should always have this as "yes") - #subscriptions = yes - - # See 15-mailboxes.conf for definitions of special mailboxes. -} - -# Example shared namespace configuration -#namespace { - #type = shared - #separator = / - - # Mailboxes are visible under "shared/user@domain/" - # %%n, %%d and %%u are expanded to the destination user. - #prefix = shared/%%u/ - - # Mail location for other users' mailboxes. Note that %variables and ~/ - # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the - # destination user's data. - #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u - - # Use the default namespace for saving subscriptions. - #subscriptions = no - - # List the shared/ namespace only if there are visible shared mailboxes. - #list = children -#} -# Should shared INBOX be visible as "shared/user" or "shared/user/INBOX"? -#mail_shared_explicit_inbox = no - -# System user and group used to access mails. If you use multiple, userdb -# can override these by returning uid or gid fields. You can use either numbers -# or names. -# https://doc.dovecot.org/admin_manual/system_users_used_by_dovecot/ -#mail_uid = -#mail_gid = - -# Group to enable temporarily for privileged operations. Currently this is -# used only with INBOX when either its initial creation or dotlocking fails. -# Typically this is set to "mail" to give access to /var/mail. -#mail_privileged_group = - -# Grant access to these supplementary groups for mail processes. Typically -# these are used to set up access to shared mailboxes. Note that it may be -# dangerous to set these if users can create symlinks (e.g. if "mail" group is -# set here, ln -s /var/mail ~/mail/var could allow a user to delete others' -# mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it). -#mail_access_groups = - -# Allow full filesystem access to clients. There's no access checks other than -# what the operating system does for the active UID/GID. It works with both -# maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/ -# or ~user/. -#mail_full_filesystem_access = no - -# Dictionary for key=value mailbox attributes. This is used for example by -# URLAUTH and METADATA extensions. -#mail_attribute { - #dict_driver = -#} - -# A comment or note that is associated with the server. This value is -# accessible for authenticated users through the IMAP METADATA server -# entry "/shared/comment". -#mail_server_comment = "" - -# Indicates a method for contacting the server administrator. According to -# RFC 5464, this value MUST be a URI (e.g., a mailto: or tel: URL), but that -# is currently not enforced. Use for example mailto:admin@example.com. This -# value is accessible for authenticated users through the IMAP METADATA server -# entry "/shared/admin". -#mail_server_admin = - -## -## Mail processes -## - -# Don't use mmap() at all. This is required if you store indexes to shared -# filesystems (NFS or clustered filesystem). -#mmap_disable = no - -# Rely on O_EXCL to work when creating dotlock files. NFS supports O_EXCL -# since version 3, so this should be safe to use nowadays by default. -#dotlock_use_excl = yes - -# When to use fsync() or fdatasync() calls: -# optimized (default): Whenever necessary to avoid losing important data -# always: Useful with e.g. NFS when write()s are delayed -# never: Never use it (best performance, but crashes can lose data) -#mail_fsync = optimized - -# Locking method for index files. Alternatives are fcntl, flock and dotlock. -# Dotlocking uses some tricks which may create more disk I/O than other locking -# methods. NFS users: flock doesn't work, remember to change mmap_disable. -#lock_method = fcntl - -# Directory where mails can be temporarily stored. Usually it's used only for -# mails larger than >= 128 kB. It's used by various parts of Dovecot, for -# example LDA/LMTP while delivering large mails or mail-compress plugin for -# keeping uncompressed mails. -#mail_temp_dir = /tmp - -# Valid UID range for users, defaults to 500 and above. This is mostly -# to make sure that users can't log in as daemons or other system users. -# Note that denying root logins is hardcoded to dovecot binary and can't -# be done even if first_valid_uid is set to 0. -#first_valid_uid = 500 -#last_valid_uid = 0 - -# Valid GID range for users, defaults to non-root/wheel. Users having -# non-valid GID as primary group ID aren't allowed to log in. If user -# belongs to supplementary groups with non-valid GIDs, those groups are -# not set. -#first_valid_gid = 1 -#last_valid_gid = 0 - -# Maximum allowed length for mail keyword name. It's only forced when trying -# to create new keywords. -#mail_max_keyword_length = 50 - -# ':' separated list of directories under which chrooting is allowed for mail -# processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too). -# This setting doesn't affect login_chroot, mail_chroot or auth chroot -# settings. If this setting is empty, "/./" in home dirs are ignored. -# WARNING: Never add directories here which local users can modify, that -# may lead to root exploit. Usually this should be done only if you don't -# allow shell access for users. -# https://doc.dovecot.org/admin_manual/chrooting/ -#valid_chroot_dirs = - -# Default chroot directory for mail processes. This can be overridden for -# specific users in user database by giving /./ in user's home directory -# (eg. /home/./user chroots into /home). Note that usually there is no real -# need to do chrooting, Dovecot doesn't allow users to access files outside -# their mail directory anyway. If your home directories are prefixed with -# the chroot directory, append "/." to mail_chroot. -# https://doc.dovecot.org/admin_manual/chrooting/ -#mail_chroot = - -# UNIX socket path to master authentication server to find users. -# This is used by imap (for shared users) and lda. -#auth_socket_path = /var/run/dovecot/auth-userdb - -# Directory where to look up mail plugins. -#mail_plugin_dir = /usr/lib/dovecot - -# Space separated list of plugins to load for all services. Plugins specific to -# IMAP, LDA, etc. are added to this list in their own .conf files. -#mail_plugins = - -## -## Mailbox handling optimizations -## - -# Mailbox list indexes can be used to optimize IMAP STATUS commands. They are -# also required for IMAP NOTIFY extension to be enabled. -#mailbox_list_index = yes - -# Trust mailbox list index to be up-to-date. This reduces disk I/O at the cost -# of potentially returning out-of-date results after e.g. server crashes. -# The results will be automatically fixed once the folders are opened. -#mailbox_list_index_very_dirty_syncs = yes - -# Should INBOX be kept up-to-date in the mailbox list index? By default it's -# not, because most of the mailbox accesses will open INBOX anyway. -#mailbox_list_index_include_inbox = no - -# The minimum number of mails in a mailbox before updates are done to cache -# file. This allows optimizing Dovecot's behavior to do less disk writes at -# the cost of more disk reads. -#mail_cache_min_mail_count = 0 - -# When IDLE command is running, mailbox is checked once in a while to see if -# there are any new mails or other changes. This setting defines the minimum -# time to wait between those checks. Dovecot can also use inotify and -# kqueue to find out immediately when changes occur. -#mailbox_idle_check_interval = 30 secs - -# Save mails with CR+LF instead of plain LF. This makes sending those mails -# take less CPU, especially with sendfile() syscall with Linux and FreeBSD. -# But it also creates a bit more disk I/O which may just make it slower. -# Also note that if other software reads the mboxes/maildirs, they may handle -# the extra CRs wrong and cause problems. -#mail_save_crlf = no - -# Max number of mails to keep open and prefetch to memory. This only works with -# some mailbox formats and/or operating systems. -#mail_prefetch_count = 0 - -# How often to scan for stale temporary files and delete them (0 = never). -# These should exist only after Dovecot dies in the middle of saving mails. -#mail_temp_scan_interval = 1w - -# How many slow mail accesses sorting can perform before it returns failure. -# With IMAP the reply is: NO [LIMIT] Requested sort would have taken too long. -# The untagged SORT reply is still returned, but it's likely not correct. -#mail_sort_max_read_count = 0 - -protocol !indexer-worker { - # If folder vsize calculation requires opening more than this many mails from - # disk (i.e. mail sizes aren't in cache already), return failure and finish - # the calculation via indexer process. Disabled by default. This setting must - # be 0 for indexer-worker processes. - #mail_vsize_bg_after_count = 0 -} - -## -## Maildir-specific settings -## - -# By default LIST command returns all entries in maildir beginning with a dot. -# Enabling this option makes Dovecot return only entries which are directories. -# This is done by stat()ing each entry, so it causes more disk I/O. -# (For systems setting struct dirent->d_type, this check is free and it's -# done always regardless of this setting) -#maildir_stat_dirs = no - -# When copying a message, do it with hard links whenever possible. This makes -# the performance much better, and it's unlikely to have any side effects. -#maildir_copy_with_hardlinks = yes - -# Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only -# when its mtime changes unexpectedly or when we can't find the mail otherwise. -#maildir_very_dirty_syncs = no - -# If enabled, Dovecot doesn't use the S= in the Maildir filenames for -# getting the mail's physical size, except when recalculating Maildir++ quota. -# This can be useful in systems where a lot of the Maildir filenames have a -# broken size. The performance hit for enabling this is very small. -#maildir_broken_filename_sizes = no - -# Always move mails from new/ directory to cur/, even when the \Recent flags -# aren't being reset. -#maildir_empty_new = no - -## -## mbox-specific settings -## - -# Which locking methods to use for locking mbox. There are four available: -# dotlock: Create .lock file. This is the oldest and most NFS-safe -# solution. If you want to use /var/mail/ like directory, the users -# will need write access to that directory. -# dotlock_try: Same as dotlock, but if it fails because of permissions or -# because there isn't enough disk space, just skip it. -# fcntl : Use this if possible. Works with NFS too if lockd is used. -# flock : May not exist in all systems. Doesn't work with NFS. -# lockf : May not exist in all systems. Doesn't work with NFS. -# -# You can use multiple locking methods; if you do the order they're declared -# in is important to avoid deadlocks if other MTAs/MUAs are using multiple -# locking methods as well. Some operating systems don't allow using some of -# them simultaneously. -#mbox_read_locks = fcntl -#mbox_write_locks = dotlock fcntl - -# Maximum time to wait for lock (all of them) before aborting. -#mbox_lock_timeout = 5 mins - -# If dotlock exists but the mailbox isn't modified in any way, override the -# lock file after this much time. -#mbox_dotlock_change_timeout = 2 mins - -# When mbox changes unexpectedly we have to fully read it to find out what -# changed. If the mbox is large this can take a long time. Since the change -# is usually just a newly appended mail, it'd be faster to simply read the -# new mails. If this setting is enabled, Dovecot does this but still safely -# fallbacks to re-reading the whole mbox file whenever something in mbox isn't -# how it's expected to be. The only real downside to this setting is that if -# some other MUA changes message flags, Dovecot doesn't notice it immediately. -# Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK -# commands. -#mbox_dirty_syncs = yes - -# Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE, -# EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored. -#mbox_very_dirty_syncs = no - -# Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK -# commands and when closing the mailbox). This is especially useful for POP3 -# where clients often delete all mails. The downside is that our changes -# aren't immediately visible to other MUAs. -#mbox_lazy_writes = yes - -# If mbox size is smaller than this (e.g. 100k), don't write index files. -# If an index file already exists it's still read, just not updated. -#mbox_min_index_size = 0 - -# Mail header selection algorithm to use for MD5 POP3 UIDLs when -# pop3_uidl_format=%m. For backwards compatibility we use apop3d inspired -# algorithm, but it fails if the first Received: header isn't unique in all -# mails. An alternative algorithm is "all" that selects all headers. -#mbox_md5 = apop3d - -## -## mdbox-specific settings -## - -# Maximum dbox file size until it's rotated. -#mdbox_rotate_size = 10M - -# Maximum dbox file age until it's rotated. Typically in days. Day begins -# from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. -#mdbox_rotate_interval = 0 - -# When creating new mdbox files, immediately preallocate their size to -# mdbox_rotate_size. This setting currently works only in Linux with some -# filesystems (ext4, xfs). -#mdbox_preallocate_space = no - -## -## Mail attachments -## - -# sdbox and mdbox support saving mail attachments to external files, which -# also allows single instance storage for them. Other backends don't support -# this for now. - -# Directory root where to store mail attachments. Disabled, if empty. -#mail_attachment_dir = - -# Attachments smaller than this aren't saved externally. It's also possible to -# write a plugin to disable saving specific attachments externally. -#mail_attachment_min_size = 128k - -# Filesystem backend to use for saving attachments: -# posix : No SiS done by Dovecot (but this might help FS's own deduplication) -# sis posix : SiS with immediate byte-by-byte comparison during saving -# sis-queue posix : SiS with delayed comparison and deduplication -#mail_attachment_fs = sis posix - -# Hash format to use in attachment filenames. You can add any text and -# variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}. -# Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits -#mail_attachment_hash = %{sha1} - -# Settings to control adding $HasAttachment or $HasNoAttachment keywords. -# By default, all MIME parts with Content-Disposition=attachment, or inlines -# with filename parameter are consired attachments. -# add-flags - Add the keywords when saving new mails or when fetching can -# do it efficiently. -# content-type=type or !type - Include/exclude content type. Excluding will -# never consider the matched MIME part as attachment. Including will only -# negate an exclusion (e.g. content-type=!foo/* content-type=foo/bar). -# exclude-inlined - Exclude any Content-Disposition=inline MIME part. -#mail_attachment_detection_options = diff --git a/doc/example-config/conf.d/10-master.conf b/doc/example-config/conf.d/10-master.conf deleted file mode 100644 index 272108a7db..0000000000 --- a/doc/example-config/conf.d/10-master.conf +++ /dev/null @@ -1,139 +0,0 @@ -#default_process_limit = 100 -#default_client_limit = 1000 - -# Default VSZ (virtual memory size) limit for service processes. This is mainly -# intended to catch and kill processes that leak memory before they eat up -# everything. -#default_vsz_limit = 256M - -# Login user is internally used by login processes. This is the most untrusted -# user in Dovecot system. It shouldn't have access to anything at all. -#default_login_user = dovenull - -# Internal user is used by unprivileged processes. It should be separate from -# login user, so that login processes can't disturb other processes. -#default_internal_user = dovecot - -service imap-login { - inet_listener imap { - #port = 143 - } - inet_listener imaps { - #port = 993 - #ssl = yes - } - - # Number of connections to handle before starting a new process. Typically - # the only useful values are "unlimited" or 1. 1 is more secure, but - # "unlimited" is faster. - # https://doc.dovecot.org/admin_manual/login_processes/ - #restart_request_count = 1 - - # Number of processes to always keep waiting for more connections. - #process_min_avail = 0 - - # If you set restart_request_count=unlimited, you probably need to grow this. - #vsz_limit = $default_vsz_limit -} - -service pop3-login { - inet_listener pop3 { - #port = 110 - } - inet_listener pop3s { - #port = 995 - #ssl = yes - } -} - -service submission-login { - inet_listener submission { - #port = 587 - } - inet_listener submissions { - #port = 465 - } -} - -service lmtp { - unix_listener lmtp { - #mode = 0666 - } - - # Create inet listener only if you can't use the above UNIX socket - #inet_listener lmtp { - # Avoid making LMTP visible for the entire internet - #address = - #port = - #} -} - -service imap { - # Most of the memory goes to mmap()ing files. You may need to increase this - # limit if you have huge mailboxes. - #vsz_limit = $default_vsz_limit - - # Max. number of IMAP processes (connections) - #process_limit = 1024 -} - -service pop3 { - # Max. number of POP3 processes (connections) - #process_limit = 1024 -} - -service submission { - # Max. number of SMTP Submission processes (connections) - #process_limit = 1024 -} - -service auth { - # auth_socket_path points to this userdb socket by default. It's typically - # used by dovecot-lda, doveadm, possibly imap process, etc. Users that have - # full permissions to this socket are able to get a list of all usernames and - # get the results of everyone's userdb lookups. - # - # The default 0666 mode allows anyone to connect to the socket, but the - # userdb lookups will succeed only if the userdb returns an "uid" field that - # matches the caller process's UID. Also if caller's uid or gid matches the - # socket's uid or gid the lookup succeeds. Anything else causes a failure. - # - # To give the caller full permissions to lookup all users, set the mode to - # something else than 0666 and Dovecot lets the kernel enforce the - # permissions (e.g. 0777 allows everyone full permissions). - unix_listener auth-userdb { - #mode = 0666 - #user = - #group = - } - - # Postfix smtp-auth - #unix_listener /var/spool/postfix/private/auth { - # mode = 0666 - #} - - # Auth process is run as this user. - #user = $default_internal_user -} - -service auth-worker { - # Auth worker process is run as root by default, so that it can access - # /etc/shadow. If this isn't necessary, the user should be changed to - # $default_internal_user. - #user = root - - # Maximum number of auth worker processes. They're used to execute - # blocking passdb and userdb queries (eg. MySQL and PAM). They're - # automatically created and destroyed as needed. - #process_limit = 30 -} - -service dict { - # If dict proxy is used, mail processes should have access to its socket. - # For example: mode=0660, group=vmail and global mail_access_groups=vmail - unix_listener dict { - #mode = 0600 - #user = - #group = - } -} diff --git a/doc/example-config/conf.d/10-metrics.conf b/doc/example-config/conf.d/10-metrics.conf deleted file mode 100644 index f7a758f404..0000000000 --- a/doc/example-config/conf.d/10-metrics.conf +++ /dev/null @@ -1,74 +0,0 @@ -## -## Statistics and metrics -## - -# Dovecot supports gathering statistics from events. -# Currently there are no statistics logged by default, and therefore they must -# be explicitly added using the metric configuration blocks. -# -# Unlike old stats, the new statistics do not require any plugins loaded. -# -# See https://doc.dovecot.org/configuration_manual/stats/ for more details. - -## -## Example metrics -## - -#metric auth_success { -# filter = event=auth_request_finished AND success=yes -#} -# -#metric auth_failures { -# filter = event=auth_request_finished AND NOT success=yes -#} -# -#metric imap_command { -# filter = event=imap_command_finished -# group_by = cmd_name tagged_reply_state -#} -# -#metric smtp_command { -# filter = event=smtp_server_command_finished -# group_by = cmd_name status_code duration:exponential:1:5:10 -#} -# -#metric mail_delivery { -# filter = event=mail_delivery_finished -# group_by = duration:exponential:1:5:10 -#} - -## -## Prometheus -## - -# To allow access to statistics with Prometheus, enable http listener -# on stats process. Stats will be available on /metrics path. -# -# See https://doc.dovecot.org/configuration_manual/stats/openmetrics/ for more -# details. - -#service stats { -# inet_listener http { -# port = 9900 -# } -#} - -## -## Event exporting -## - -# You can also export individual events. -# -# See https://doc.dovecot.org/configuration_manual/event_export/ for more -# details. - -#event_exporter log { -# format = json -# format_args = time-rfc3339 -# transport = log -#} -# -#metric imap_commands { -# exporter = log -# filter = event=imap_command_finished -#} diff --git a/doc/example-config/conf.d/10-ssl.conf b/doc/example-config/conf.d/10-ssl.conf deleted file mode 100644 index 4dbff044aa..0000000000 --- a/doc/example-config/conf.d/10-ssl.conf +++ /dev/null @@ -1,82 +0,0 @@ -## -## SSL settings -## - -# SSL/TLS support: yes, no, required. https://doc.dovecot.org/admin_manual/ssl/ -#ssl = yes - -# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before -# dropping root privileges, so keep the key file unreadable by anyone but -# root. Included doc/mkcert.sh can be used to easily generate self-signed -# certificate, just make sure to update the domains in dovecot-openssl.cnf -ssl_cert = was automatically rejected:%n%r - -# Delimiter character between local-part and detail in email address. -#recipient_delimiter = + - -# Header where the original recipient address (SMTP's RCPT TO: address) is taken -# from if not available elsewhere. With dovecot-lda -a parameter overrides this. -# A commonly used header for this is X-Original-To. -#lda_original_recipient_header = - -# Should saving a mail to a nonexistent mailbox automatically create it? -#lda_mailbox_autocreate = no - -# Should automatically created mailboxes be also automatically subscribed? -#lda_mailbox_autosubscribe = no - -protocol lda { - # Space separated list of plugins to load (default is global mail_plugins). - #mail_plugins = $mail_plugins -} diff --git a/doc/example-config/conf.d/15-mailboxes.conf b/doc/example-config/conf.d/15-mailboxes.conf deleted file mode 100644 index 71076d4863..0000000000 --- a/doc/example-config/conf.d/15-mailboxes.conf +++ /dev/null @@ -1,86 +0,0 @@ -## -## Mailbox definitions -## - -# Each mailbox is specified in a separate mailbox section. The section name -# specifies the mailbox name. If it has spaces, you can put the name -# "in quotes". These sections can contain the following mailbox settings: -# -# auto: -# Indicates whether the mailbox with this name is automatically created -# implicitly when it is first accessed. The user can also be automatically -# subscribed to the mailbox after creation. The following values are -# defined for this setting: -# -# no - Never created automatically. -# create - Automatically created, but no automatic subscription. -# subscribe - Automatically created and subscribed. -# -# special_use: -# A space-separated list of SPECIAL-USE flags (RFC 6154) to use for the -# mailbox. There are no validity checks, so you could specify anything -# you want in here, but it's not a good idea to use flags other than the -# standard ones specified in the RFC: -# -# \All - This (virtual) mailbox presents all messages in the -# user's message store. -# \Archive - This mailbox is used to archive messages. -# \Drafts - This mailbox is used to hold draft messages. -# \Flagged - This (virtual) mailbox presents all messages in the -# user's message store marked with the IMAP \Flagged flag. -# \Important - This (virtual) mailbox presents all messages in the -# user's message store deemed important to user. -# \Junk - This mailbox is where messages deemed to be junk mail -# are held. -# \Sent - This mailbox is used to hold copies of messages that -# have been sent. -# \Trash - This mailbox is used to hold messages that have been -# deleted. -# -# comment: -# Defines a default comment or note associated with the mailbox. This -# value is accessible through the IMAP METADATA mailbox entries -# "/shared/comment" and "/private/comment". Users with sufficient -# privileges can override the default value for entries with a custom -# value. - -# NOTE: Assumes "namespace inbox" has been defined in 10-mail.conf. -namespace inbox { - # These mailboxes are widely used and could perhaps be created automatically: - mailbox Drafts { - special_use = \Drafts - } - mailbox Junk { - special_use = \Junk - } - mailbox Trash { - special_use = \Trash - } - - # For \Sent mailboxes there are two widely used names. We'll mark both of - # them as \Sent. User typically deletes one of them if duplicates are created. - mailbox Sent { - special_use = \Sent - } - mailbox "Sent Messages" { - special_use = \Sent - } - - # If you have a virtual "All messages" mailbox: - #mailbox virtual/All { - # special_use = \All - # comment = All my messages - #} - - # If you have a virtual "Flagged" mailbox: - #mailbox virtual/Flagged { - # special_use = \Flagged - # comment = All my flagged messages - #} - - # If you have a virtual "Important" mailbox: - #mailbox virtual/Important { - # special_use = \Important - # comment = All my important messages - #} -} diff --git a/doc/example-config/conf.d/20-imap.conf b/doc/example-config/conf.d/20-imap.conf deleted file mode 100644 index d25c4e49d0..0000000000 --- a/doc/example-config/conf.d/20-imap.conf +++ /dev/null @@ -1,100 +0,0 @@ -## -## IMAP specific settings -## - -# If nothing happens for this long while client is IDLEing, move the connection -# to imap-hibernate process and close the old imap process. This saves memory, -# because connections use very little memory in imap-hibernate process. The -# downside is that recreating the imap process back uses some resources. -#imap_hibernate_timeout = 0 - -# Maximum IMAP command line length. Some clients generate very long command -# lines with huge mailboxes, so you may need to raise this if you get -# "Too long argument" or "IMAP command line too large" errors often. -#imap_max_line_length = 64k - -# IMAP logout format string: -# %i - total number of bytes read from client -# %o - total number of bytes sent to client -# %{fetch_hdr_count} - Number of mails with mail header data sent to client -# %{fetch_hdr_bytes} - Number of bytes with mail header data sent to client -# %{fetch_body_count} - Number of mails with mail body data sent to client -# %{fetch_body_bytes} - Number of bytes with mail body data sent to client -# %{deleted} - Number of mails where client added \Deleted flag -# %{expunged} - Number of mails that client expunged, which does not -# include automatically expunged mails -# %{autoexpunged} - Number of mails that were automatically expunged after -# client disconnected -# %{trashed} - Number of mails that client copied/moved to the -# special_use=\Trash mailbox. -# %{appended} - Number of mails saved during the session -#imap_logout_format = in=%i out=%o deleted=%{deleted} expunged=%{expunged} \ -# trashed=%{trashed} hdr_count=%{fetch_hdr_count} \ -# hdr_bytes=%{fetch_hdr_bytes} body_count=%{fetch_body_count} \ -# body_bytes=%{fetch_body_bytes} - -# Override the IMAP CAPABILITY response. If the value begins with '+', -# add the given capabilities on top of the defaults (e.g. +XFOO XBAR). -#imap_capability = - -# How long to wait between "OK Still here" notifications when client is -# IDLEing. -#imap_idle_notify_interval = 2 mins - -# ID key and values to send to clients. The following list of keys have -# default values currently: name, version, os, os-version, support-url, -# support-email, revision. The default values can be accessed using the -# following syntax: = %{dovecot:}, i.e. %{dovecot:name}, -# %{dovecot:support-url}, etc. -#imap_id_send { -# name = %{dovecot:name} -# x-foobar = foovalue -#} - -# Workarounds for various client bugs: -# delay-newmail: -# Send EXISTS/RECENT new mail notifications only when replying to NOOP -# and CHECK commands. Some clients ignore them otherwise, for example OSX -# Mail () instead of full path -# syntax. -# -# The list is space-separated. -#lmtp_client_workarounds = - -protocol lmtp { - # Space separated list of plugins to load (default is global mail_plugins). - #mail_plugins = $mail_plugins -} diff --git a/doc/example-config/conf.d/20-pop3.conf b/doc/example-config/conf.d/20-pop3.conf deleted file mode 100644 index 154798798b..0000000000 --- a/doc/example-config/conf.d/20-pop3.conf +++ /dev/null @@ -1,100 +0,0 @@ -## -## POP3 specific settings -## - -# Don't try to set mails non-recent or seen with POP3 sessions. This is -# mostly intended to reduce disk I/O. With maildir it doesn't move files -# from new/ to cur/, with mbox it doesn't write Status-header. -#pop3_no_flag_updates = no - -# Support LAST command which exists in old POP3 specs, but has been removed -# from new ones. Some clients still wish to use this though. Enabling this -# makes RSET command clear all \Seen flags from messages. -#pop3_enable_last = no - -# If mail has X-UIDL header, use it as the mail's UIDL. -#pop3_reuse_xuidl = no - -# Allow only one POP3 session to run simultaneously for the same user. -#pop3_lock_session = no - -# POP3 requires message sizes to be listed as if they had CR+LF linefeeds. -# Many POP3 servers violate this by returning the sizes with LF linefeeds, -# because it's faster to get. When this setting is enabled, Dovecot still -# tries to do the right thing first, but if that requires opening the -# message, it fallbacks to the easier (but incorrect) size. -#pop3_fast_size_lookups = no - -# POP3 UIDL (unique mail identifier) format to use. You can use following -# variables, along with the variable modifiers described in -# https://doc.dovecot.org/configuration_manual/config_file/config_variables/ -# (e.g. %Uf for the filename in uppercase) -# -# %v - Mailbox's IMAP UIDVALIDITY -# %u - Mail's IMAP UID -# %m - MD5 sum of the mailbox headers in hex (mbox only) -# %f - filename (maildir only) -# %g - Mail's GUID -# -# If you want UIDL compatibility with other POP3 servers, use: -# UW's ipop3d : %08Xv%08Xu -# Courier : %f or %v-%u (both might be used simultaneously) -# Cyrus (<= 2.1.3) : %u -# Cyrus (>= 2.1.4) : %v.%u -# Dovecot v0.99.x : %v.%u -# tpop3d : %Mf -# -# Note that Outlook 2003 seems to have problems with %v.%u format which was -# Dovecot's default, so if you're building a new server it would be a good -# idea to change this. %08Xu%08Xv should be pretty fail-safe. -# -#pop3_uidl_format = %08Xu%08Xv - -# Permanently save UIDLs sent to POP3 clients, so pop3_uidl_format changes -# won't change those UIDLs. Currently this works only with Maildir. -#pop3_save_uidl = no - -# What to do about duplicate UIDLs if they exist? -# allow: Show duplicates to clients. -# rename: Append a temporary -2, -3, etc. counter after the UIDL. -#pop3_uidl_duplicates = allow - -# This option changes POP3 behavior so that it's not possible to actually -# delete mails via POP3, only hide them from future POP3 sessions. The mails -# will still be counted towards user's quota until actually deleted via IMAP. -# Use e.g. "$POP3Deleted" as the value (it will be visible as IMAP keyword). -# Make sure you can legally archive mails before enabling this setting. -#pop3_deleted_flag = - -# POP3 logout format string: -# %i - total number of bytes read from client -# %o - total number of bytes sent to client -# %t - number of TOP commands -# %p - number of bytes sent to client as a result of TOP command -# %r - number of RETR commands -# %b - number of bytes sent to client as a result of RETR command -# %d - number of deleted messages -# %{deleted_bytes} - number of bytes in deleted messages -# %m - number of messages (before deletion) -# %s - mailbox size in bytes (before deletion) -# %u - old/new UIDL hash. may help finding out if UIDLs changed unexpectedly -#pop3_logout_format = top=%t/%p, retr=%r/%b, del=%d/%m, size=%s - -# Workarounds for various client bugs: -# outlook-no-nuls: -# Outlook and Outlook Express hang if mails contain NUL characters. -# This setting replaces them with 0x80 character. -# oe-ns-eoh: -# Outlook Express and Netscape Mail breaks if end of headers-line is -# missing. This option simply sends it if it's missing. -# The list is space-separated. -#pop3_client_workarounds = - -protocol pop3 { - # Space separated list of plugins to load (default is global mail_plugins). - #mail_plugins = $mail_plugins - - # Maximum number of POP3 connections allowed for a user from each IP address. - # NOTE: The username is compared case-sensitively. - #mail_max_userip_connections = 10 -} diff --git a/doc/example-config/conf.d/20-submission.conf b/doc/example-config/conf.d/20-submission.conf deleted file mode 100644 index 1762130f5d..0000000000 --- a/doc/example-config/conf.d/20-submission.conf +++ /dev/null @@ -1,115 +0,0 @@ -## -## Settings specific to SMTP Submission -## - -# SMTP Submission logout format string: -# %i - total number of bytes read from client -# %o - total number of bytes sent to client -# %{command_count} - Number of commands received from client -# %{reply_count} - Number of replies sent to client -# %{session} - Session ID of the login session -# %{transaction_id} - ID of the current transaction, if any -#submission_logout_format = in=%i out=%o - -# Host name reported by the SMTP service, for example to the client in the -# initial greeting and to the relay server in the HELO/EHLO command. -# Default is the system's real hostname@domain. -#hostname = - -# Maximum size of messages accepted for relay. This announced in the SIZE -# capability. If not configured, this is either determined from the relay -# server or left unlimited if no limit is known (relay will reply with error -# if some unknown limit exists there, which is duly passed to our client). -#submission_max_mail_size = - -# Maximum number of recipients accepted per connection (default: unlimited) -#submission_max_recipients = - -# Add "Received:" header to mails delivered. -#submission_add_received_header = yes -# Workarounds for various client bugs: -# whitespace-before-path: -# Allow one or more spaces or tabs between `MAIL FROM:' and path and between -# `RCPT TO:' and path. -# mailbox-for-path: -# Allow using bare Mailbox syntax (i.e., without <...>) instead of full path -# syntax. -# -# The list is space-separated. -#submission_client_workarounds = - -# Relay server configuration: -# -# The Dovecot SMTP submission service directly proxies the mail transaction -# to the SMTP relay configured here. - -# Host name for the relay server (required) -#submission_relay_host = - -# Port for the relay server -#submission_relay_port = 25 - -# Is the relay server trusted? This determines whether we try to send -# (Postfix-specific) XCLIENT data to the relay server -#submission_relay_trusted = no - -# Authentication data for the relay server if authentication is required -#submission_relay_user = -#submission_relay_master_user = -#submission_relay_password = - -# SSL configuration for connection to relay server -# -# submission_relay_ssl: -# Indicates whether SSL is used for the connection to the relay server. The -# following values are defined for this setting: -# -# no - No SSL is used -# smtps - An SMTPS connection (immediate SSL) is used -# starttls - The STARTTLS command is used to establish SSL layer -#submission_relay_ssl = no - -# submission_relay_ssl_verify: -# Configures whether the SSL certificate of the relay server is to be -# verified. -#submission_relay_ssl_verify = yes - -# Write protocol logs for relay connection to this directory for debugging -#submission_relay_rawlog_dir = - -# BURL is configured implicitly by IMAP URLAUTH - -# Part of the SMTP capabilities that the submission service can offer to the -# client (as listed in the EHLO reply) depend on those capabilities also being -# provided by the relay server. These capabilities currently are: -# -# - 8BITMIME -# - BINARYMIME -# - DSN -# - VRFY (always returns 252 without support) -# - SMTPUTF8 (if experimental feature enabled) -# -# By default, the submission service first connects to the relay server to -# determine the support for such capabilities before sending the initial EHLO -# reply to the client. If the list of capabilities returned by the relay server -# is somehow unreliable or it is undesirable to start the connection to the -# relay server before the first mail transaction is started, the backend -# capabilities can be configured explicitly using the -# submission_backend_capabilities setting. This is a space-separated list of -# SMTP capability names. This setting is only relevant for capabilities that -# depend on support from the relay server: including (or omitting) capabilities -# that are not listed above has no effect. When this setting is explicitly set -# to the empty string, none of the capabilities is enabled. To achieve the -# default behavior, this setting must be left unconfigured. -#submission_backend_capabilities = - -protocol submission { - # Space-separated list of plugins to load (default is global mail_plugins). - #mail_plugins = $mail_plugins - - # Maximum number of SMTP submission connections allowed for a user from - # each IP address. - # NOTE: The username is compared case-sensitively. - #mail_max_userip_connections = 10 -} - diff --git a/doc/example-config/conf.d/90-acl.conf b/doc/example-config/conf.d/90-acl.conf deleted file mode 100644 index f0c0e7a5ef..0000000000 --- a/doc/example-config/conf.d/90-acl.conf +++ /dev/null @@ -1,19 +0,0 @@ -## -## Mailbox access control lists. -## - -# vfile backend reads ACLs from "dovecot-acl" file from mail directory. -# You can also optionally give a global ACL directory path where ACLs are -# applied to all users' mailboxes. The global ACL directory contains -# one file for each mailbox, eg. INBOX or sub.mailbox. cache_secs parameter -# specifies how many seconds to wait between stat()ing dovecot-acl file -# to see if it changed. -plugin { - #acl = vfile:/etc/dovecot/global-acls:cache_secs=300 -} - -# To let users LIST mailboxes shared by other users, Dovecot needs a -# shared mailbox dictionary. For example: -plugin { - #acl_shared_dict = file:/var/lib/dovecot/shared-mailboxes -} diff --git a/doc/example-config/conf.d/90-plugin.conf b/doc/example-config/conf.d/90-plugin.conf deleted file mode 100644 index 815318238c..0000000000 --- a/doc/example-config/conf.d/90-plugin.conf +++ /dev/null @@ -1,12 +0,0 @@ -## -## Plugin settings -## - -# All wanted plugins must be listed in mail_plugins setting before any of the -# settings take effect. See https://doc.dovecot.org/settings/plugin/ for list of -# plugins and their configuration. Note that %variable expansion is done for -# all values. - -plugin { - #setting_name = value -} diff --git a/doc/example-config/conf.d/90-quota.conf b/doc/example-config/conf.d/90-quota.conf deleted file mode 100644 index 432884fcc0..0000000000 --- a/doc/example-config/conf.d/90-quota.conf +++ /dev/null @@ -1,95 +0,0 @@ -## -## Quota configuration. -## - -# Note that you also have to enable quota plugin in mail_plugins setting. -# https://doc.dovecot.org/configuration_manual/quota/ - -## -## Quota limits -## - -# Quota limits are set using "quota_rule" parameters. To get per-user quota -# limits, you can set/override them by returning "quota_rule" extra field -# from userdb. It's also possible to give mailbox-specific limits, for example -# to give additional 100 MB when saving to Trash: - -plugin { - #quota_rule = *:storage=1G - #quota_rule2 = Trash:storage=+100M - - # LDA/LMTP allows saving the last mail to bring user from under quota to - # over quota, if the quota doesn't grow too high. Default is to allow as - # long as quota will stay under 10% above the limit. Also allowed e.g. 10M. - #quota_grace = 10%% - - # Quota plugin can also limit the maximum accepted mail size. - #quota_max_mail_size = 100M -} - -## -## Quota warnings -## - -# You can execute a given command when user exceeds a specified quota limit. -# Each quota root has separate limits. Only the command for the first -# exceeded limit is executed, so put the highest limit first. -# The commands are executed via script service by connecting to the named -# UNIX socket (quota-warning below). -# Note that % needs to be escaped as %%, otherwise "% " expands to empty. - -plugin { - #quota_warning = storage=95%% quota-warning 95 %u - #quota_warning2 = storage=80%% quota-warning 80 %u -} - -# Example quota-warning service. The unix listener's permissions should be -# set in a way that mail processes can connect to it. Below example assumes -# that mail processes run as vmail user. If you use mode=0666, all system users -# can generate quota warnings to anyone. -#service quota-warning { -# executable = script /usr/local/bin/quota-warning.sh -# user = dovecot -# unix_listener quota-warning { -# user = vmail -# } -#} - -## -## Quota backends -## - -# Multiple backends are supported: -# count: Dovecot index based driver which does not require external files. -# Extremely SLOW with Maildir. It'll eat your CPU and disk I/O. -# maildir: Maildir++ quota -# fs: Read-only support for filesystem quota - -plugin { - #quota = count:User quota - #quota = maildir:User quota - #quota = fs:User quota -} - -# Multiple quota roots are also possible, for example this gives each user -# their own 100MB quota and one shared 1GB quota within the domain: -plugin { - #quota = count:user - #quota2 = count:domain:%d - #quota_rule = *:storage=102400 - #quota2_rule = *:storage=1048576 -} - -## -## Storing quota information in dict (e.g. database) -## - -#mail_plugins = $mail_plugins quota_clone -plugin { - ## store in database - #quota_clone_dict = proxy::quota - ## store in redis - #quota_clone_dict = redis:host=127.0.0.1 - ## store in quota file - #quota_clone_dict = file:%h/quota -} diff --git a/doc/example-config/conf.d/Makefile.am b/doc/example-config/conf.d/Makefile.am deleted file mode 100644 index 35c77c560c..0000000000 --- a/doc/example-config/conf.d/Makefile.am +++ /dev/null @@ -1,30 +0,0 @@ -pkgsysconfdir = $(sysconfdir)/dovecot - -exampledir = $(docdir)/example-config/conf.d -example_DATA = \ - auth-deny.conf.ext \ - auth-dict.conf.ext \ - auth-ldap.conf.ext \ - auth-master.conf.ext \ - auth-passwdfile.conf.ext \ - auth-sql.conf.ext \ - auth-static.conf.ext \ - auth-system.conf.ext \ - 10-auth.conf \ - 10-logging.conf \ - 10-mail.conf \ - 10-master.conf \ - 10-metrics.conf \ - 10-ssl.conf \ - 15-lda.conf \ - 15-mailboxes.conf \ - 20-imap.conf \ - 20-lmtp.conf \ - 20-pop3.conf \ - 20-submission.conf \ - 90-acl.conf \ - 90-plugin.conf \ - 90-quota.conf - -EXTRA_DIST = \ - $(example_DATA) diff --git a/doc/example-config/conf.d/auth-deny.conf.ext b/doc/example-config/conf.d/auth-deny.conf.ext deleted file mode 100644 index ce3f1cf11c..0000000000 --- a/doc/example-config/conf.d/auth-deny.conf.ext +++ /dev/null @@ -1,15 +0,0 @@ -# Deny access for users. Included from 10-auth.conf. - -# Users can be (temporarily) disabled by adding a passdb with deny=yes. -# If the user is found from that database, authentication will fail. -# The deny passdb should always be specified before others, so it gets -# checked first. - -# Example deny passdb using passwd-file. You can use any passdb though. -passdb { - driver = passwd-file - deny = yes - - # File contains a list of usernames, one per line - args = /etc/dovecot/deny-users -} diff --git a/doc/example-config/conf.d/auth-dict.conf.ext b/doc/example-config/conf.d/auth-dict.conf.ext deleted file mode 100644 index b21944b980..0000000000 --- a/doc/example-config/conf.d/auth-dict.conf.ext +++ /dev/null @@ -1,16 +0,0 @@ -# Authentication via dict backend. Included from 10-auth.conf. -# -# https://doc.dovecot.org/configuration_manual/authentication/dict/ - -passdb { - driver = dict - - # Path for dict configuration file, see - # example-config/dovecot-dict-auth.conf.ext - args = /etc/dovecot/dovecot-dict-auth.conf.ext -} - -userdb { - driver = dict - args = /etc/dovecot/dovecot-dict-auth.conf.ext -} diff --git a/doc/example-config/conf.d/auth-ldap.conf.ext b/doc/example-config/conf.d/auth-ldap.conf.ext deleted file mode 100644 index a74549e0db..0000000000 --- a/doc/example-config/conf.d/auth-ldap.conf.ext +++ /dev/null @@ -1,33 +0,0 @@ -# Authentication for LDAP users. Included from 10-auth.conf. -# -# https://doc.dovecot.org/configuration_manual/authentication/ldap/ - -passdb { - driver = ldap - - # Path for LDAP configuration file, see example-config/dovecot-ldap.conf.ext - args = /etc/dovecot/dovecot-ldap.conf.ext -} - -# "prefetch" user database means that the passdb already provided the -# needed information and there's no need to do a separate userdb lookup. -# https://doc.dovecot.org/configuration_manual/authentication/prefetch_userdb/ -#userdb { -# driver = prefetch -#} - -userdb { - driver = ldap - args = /etc/dovecot/dovecot-ldap.conf.ext - - # Default fields can be used to specify defaults that LDAP may override - #default_fields = home=/home/virtual/%u -} - -# If you don't have any user-specific settings, you can avoid the userdb LDAP -# lookup by using userdb static instead of userdb ldap, for example: -# https://doc.dovecot.org/configuration_manual/authentication/static_user_database/ -#userdb { - #driver = static - #args = uid=vmail gid=vmail home=/var/vmail/%u -#} diff --git a/doc/example-config/conf.d/auth-master.conf.ext b/doc/example-config/conf.d/auth-master.conf.ext deleted file mode 100644 index 57e4d96ff7..0000000000 --- a/doc/example-config/conf.d/auth-master.conf.ext +++ /dev/null @@ -1,16 +0,0 @@ -# Authentication for master users. Included from 10-auth.conf. - -# By adding master=yes setting inside a passdb you make the passdb a list -# of "master users", who can log in as anyone else. -# https://doc.dovecot.org/configuration_manual/authentication/master_users/ - -# Example master user passdb using passwd-file. You can use any passdb though. -passdb { - driver = passwd-file - master = yes - args = /etc/dovecot/master-users - - # Unless you're using PAM, you probably still want the destination user to - # be looked up from passdb that it really exists. pass=yes does that. - pass = yes -} diff --git a/doc/example-config/conf.d/auth-passwdfile.conf.ext b/doc/example-config/conf.d/auth-passwdfile.conf.ext deleted file mode 100644 index 1bc2c2577b..0000000000 --- a/doc/example-config/conf.d/auth-passwdfile.conf.ext +++ /dev/null @@ -1,20 +0,0 @@ -# Authentication for passwd-file users. Included from 10-auth.conf. -# -# passwd-like file with specified location. -# https://doc.dovecot.org/configuration_manual/authentication/passwd_file/ - -passdb { - driver = passwd-file - args = scheme=CRYPT username_format=%u /etc/dovecot/users -} - -userdb { - driver = passwd-file - args = username_format=%u /etc/dovecot/users - - # Default fields that can be overridden by passwd-file - #default_fields = quota_rule=*:storage=1G - - # Override fields from passwd-file - #override_fields = home=/home/virtual/%u -} diff --git a/doc/example-config/conf.d/auth-sql.conf.ext b/doc/example-config/conf.d/auth-sql.conf.ext deleted file mode 100644 index c2e1e76e26..0000000000 --- a/doc/example-config/conf.d/auth-sql.conf.ext +++ /dev/null @@ -1,28 +0,0 @@ -# Authentication for SQL users. Included from 10-auth.conf. -# -# https://doc.dovecot.org/configuration_manual/authentication/sql/ - -passdb sql { - sql_driver = mysql - #sql_query = SELECT userid AS user, password FROM users where userid = '%u' -} - -# "prefetch" user database means that the passdb already provided the -# needed information and there's no need to do a separate userdb lookup. -# https://doc.dovecot.org/configuration_manual/authentication/prefetch_userdb/ -#userdb { -# driver = prefetch -#} - -userdb sql { - sql_driver = mysql - #sql_query = SELECT userid AS user FROM users where userid = '%u' -} - -# If you don't have any user-specific settings, you can avoid the user_query -# by using userdb static instead of userdb sql, for example: -# https://doc.dovecot.org/configuration_manual/authentication/static_user_database/ -#userdb { - #driver = static - #args = uid=vmail gid=vmail home=/var/vmail/%u -#} diff --git a/doc/example-config/conf.d/auth-static.conf.ext b/doc/example-config/conf.d/auth-static.conf.ext deleted file mode 100644 index 90890c596b..0000000000 --- a/doc/example-config/conf.d/auth-static.conf.ext +++ /dev/null @@ -1,24 +0,0 @@ -# Static passdb. Included from 10-auth.conf. - -# This can be used for situations where Dovecot doesn't need to verify the -# username or the password, or if there is a single password for all users: -# -# - proxy frontend, where the backend verifies the password -# - proxy backend, where the frontend already verified the password -# - authentication with SSL certificates -# - simple testing - -#passdb { -# driver = static -# args = proxy=y host=%1Mu.example.com nopassword=y -#} - -#passdb { -# driver = static -# args = password=test -#} - -#userdb { -# driver = static -# args = uid=vmail gid=vmail home=/home/%u -#} diff --git a/doc/example-config/conf.d/auth-system.conf.ext b/doc/example-config/conf.d/auth-system.conf.ext deleted file mode 100644 index 281ffcb836..0000000000 --- a/doc/example-config/conf.d/auth-system.conf.ext +++ /dev/null @@ -1,68 +0,0 @@ -# Authentication for system users. Included from 10-auth.conf. -# -# https://doc.dovecot.org/configuration_manual/authentication/password_databases_passdb/ -# https://doc.dovecot.org/configuration_manual/authentication/user_databases_userdb/ - -# PAM authentication. Preferred nowadays by most systems. -# PAM is typically used with either userdb passwd or userdb static. -# REMEMBER: You'll need /etc/pam.d/dovecot file created for PAM -# authentication to actually work. -# https://doc.dovecot.org/configuration_manual/authentication/pam/ -passdb { - driver = pam - # [session=yes] [setcred=yes] [failure_show_msg=yes] [max_requests=] - # [cache_key=] [] - #args = dovecot -} - -# System users (NSS, /etc/passwd, or similar). -# In many systems nowadays this uses Name Service Switch, which is -# configured in /etc/nsswitch.conf. -# https://doc.dovecot.org/configuration_manual/authentication/passwd/ -#passdb { - #driver = passwd - # [blocking=no] - #args = -#} - -# PAM-like authentication for OpenBSD. -# https://doc.dovecot.org/configuration_manual/authentication/bsdauth/ -#passdb { - #driver = bsdauth - # [blocking=no] [cache_key=] - #args = -#} - -## -## User databases -## - -# System users (NSS, /etc/passwd, or similar). In many systems nowadays this -# uses Name Service Switch, which is configured in /etc/nsswitch.conf. -userdb { - # https://doc.dovecot.org/configuration_manual/authentication/passwd/ - driver = passwd - # [blocking=no] - #args = - - # Override fields from passwd - #override_fields = home=/home/virtual/%u -} - -# Static settings generated from template -# https://doc.dovecot.org/configuration_manual/authentication/static_user_database/ -#userdb { - #driver = static - # Can return anything a userdb could normally return. For example: - # - # args = uid=500 gid=500 home=/var/mail/%u - # - # LDA and LMTP needs to look up users only from the userdb. This of course - # doesn't work with static userdb because there is no list of users. - # Normally static userdb handles this by doing a passdb lookup. This works - # with most passdbs, with PAM being the most notable exception. If you do - # the user verification another way, you can add allow_all_users=yes to - # the args in which case the passdb lookup is skipped. - # - #args = -#} diff --git a/doc/example-config/dovecot-dict-auth.conf.ext b/doc/example-config/dovecot-dict-auth.conf.ext deleted file mode 100644 index 79f43de6ee..0000000000 --- a/doc/example-config/dovecot-dict-auth.conf.ext +++ /dev/null @@ -1,54 +0,0 @@ -# This file is commonly accessed via passdb {} or userdb {} section in -# conf.d/auth-dict.conf.ext - -# Dictionary URI -#uri = - -# Default password scheme -default_pass_scheme = MD5 - -# Username iteration prefix. Keys under this are assumed to contain usernames. -iterate_prefix = userdb/ - -# Should iteration be disabled for this userdb? If this userdb acts only as a -# cache there's no reason to try to iterate the (partial & duplicate) users. -#iterate_disable = no - -# The example here shows how to do multiple dict lookups and merge the replies. -# The "passdb" and "userdb" keys are JSON objects containing key/value pairs, -# for example: { "uid": 1000, "gid": 1000, "home": "/home/user" } - -key passdb { - key = passdb/%u - format = json -} -key userdb { - key = userdb/%u - format = json -} -key quota { - key = userdb/%u/quota - #format = value - # The default_value is used if the key isn't found. If default_value setting - # isn't specified at all (even as empty), the passdb/userdb lookup fails with - # "user doesn't exist". - default_value = 100M -} - -# Space separated list of keys whose values contain key/value paired objects. -# All the key/value pairs inside the object are added as passdb fields. -passdb_objects = passdb - -#passdb_fields { -#} - -# Userdb key/value object list. -userdb_objects = userdb - -userdb_fields { - # dict: refers to key names - quota_rule = *:storage=%{dict:quota} - - # dict:. refers to the objkey inside (JSON) object - mail = maildir:%{dict:userdb.home}/Maildir -} diff --git a/doc/example-config/dovecot-dict-sql.conf.ext b/doc/example-config/dovecot-dict-sql.conf.ext deleted file mode 100644 index 35aa107b91..0000000000 --- a/doc/example-config/dovecot-dict-sql.conf.ext +++ /dev/null @@ -1,23 +0,0 @@ -# This file is commonly accessed via dict {} section in dovecot.conf - -#connect = host=localhost dbname=mails user=testuser password=pass - -# CREATE TABLE quota ( -# username varchar(100) not null, -# bytes bigint not null default 0, -# messages integer not null default 0, -# primary key (username) -# ); - -map { - pattern = priv/quota/storage - table = quota - username_field = username - value_field = bytes -} -map { - pattern = priv/quota/messages - table = quota - username_field = username - value_field = messages -} diff --git a/doc/example-config/dovecot-ldap.conf.ext b/doc/example-config/dovecot-ldap.conf.ext deleted file mode 100644 index 109dd5791c..0000000000 --- a/doc/example-config/dovecot-ldap.conf.ext +++ /dev/null @@ -1,153 +0,0 @@ -# This file is commonly accessed via passdb {} or userdb {} section in -# conf.d/auth-ldap.conf.ext - -# This file is opened as root, so it should be owned by root and mode 0600. -# -# https://doc.dovecot.org/configuration_manual/authentication/ldap/ -# -# NOTE: If you're not using authentication binds, you'll need to give -# dovecot-auth read access to userPassword field in the LDAP server. -# With OpenLDAP this is done by modifying /etc/ldap/slapd.conf. There should -# already be something like this: - -# access to attribute=userPassword -# by dn="" read # add this -# by anonymous auth -# by self write -# by * none - -# Space separated list of LDAP hosts to use. host:port is allowed too. -#hosts = - -# LDAP URIs to use. You can use this instead of hosts list. Note that this -# setting isn't supported by all LDAP libraries. -#uris = - -# Distinguished Name - the username used to login to the LDAP server. -# Leave it commented out to bind anonymously (useful with auth_bind=yes). -#dn = - -# Password for LDAP server, if dn is specified. -#dnpass = - -# Use SASL binding instead of the simple binding. Note that this changes -# ldap_version automatically to be 3 if it's lower. -#sasl_bind = no -# SASL mechanism name to use. -#sasl_mech = -# SASL realm to use. -#sasl_realm = -# SASL authorization ID, ie. the dnpass is for this "master user", but the -# dn is still the logged in user. Normally you want to keep this empty. -#sasl_authz_id = - -# Use TLS to connect to the LDAP server. -#tls = no -# TLS options, currently supported only with OpenLDAP: -#tls_ca_cert_file = -#tls_ca_cert_dir = -#tls_cipher_suite = -# TLS cert/key is used only if LDAP server requires a client certificate. -#tls_cert_file = -#tls_key_file = -# Valid values: never, hard, demand, allow, try -#tls_require_cert = - -# Use the given ldaprc path. -#ldaprc_path = - -# LDAP library debug level as specified by LDAP_DEBUG_* in ldap_log.h. -# -1 = everything. You may need to recompile OpenLDAP with debugging enabled -# to get enough output. -#debug_level = 0 - -# Use authentication binding for verifying password's validity. This works by -# logging into LDAP server using the username and password given by client. -# The pass_filter is used to find the DN for the user. Note that the pass_attrs -# is still used, only the password field is ignored in it. Before doing any -# search, the binding is switched back to the default DN. -#auth_bind = no - -# If authentication binding is used, you can save one LDAP request per login -# if users' DN can be specified with a common template. The template can use -# the standard %variables (see user_filter). Note that you can't -# use any pass_attrs if you use this setting. -# -# If you use this setting, it's a good idea to use a different -# dovecot-ldap.conf.ext for userdb (it can even be a symlink, just as long as -# the filename is different in userdb's args). That way one connection is used -# only for LDAP binds and another connection is used for user lookups. -# Otherwise the binding is changed to the default DN before each user lookup. -# -# For example: -# auth_bind_userdn = cn=%u,ou=people,o=org -# -#auth_bind_userdn = - -# LDAP protocol version to use. Likely 2 or 3. -#ldap_version = 3 - -# LDAP base. %variables can be used here. -# For example: dc=mail, dc=example, dc=org -base = - -# Dereference: never, searching, finding, always -#deref = never - -# Search scope: base, onelevel, subtree -#scope = subtree - -# User attributes are given in LDAP-name=dovecot-internal-name list. The -# internal names are: -# uid - System UID -# gid - System GID -# home - Home directory -# mail - Mail location -# -# There are also other special fields which can be returned, see -# https://doc.dovecot.org/configuration_manual/authentication/user_database_extra_fields/ -#user_attrs = homeDirectory=home,uidNumber=uid,gidNumber=gid - -# Filter for user lookup. Some variables can be used (see -# https://doc.dovecot.org/configuration_manual/config_file/config_variables/ -# for full list): -# %u - username -# %n - user part in user@domain, same as %u if there's no domain -# %d - domain part in user@domain, empty if user there's no domain -#user_filter = (&(objectClass=posixAccount)(uid=%u)) - -# Password checking attributes: -# user: Virtual user name (user@domain), if you wish to change the -# user-given username to something else -# password: Password, may optionally start with {type}, eg. {crypt} -# There are also other special fields which can be returned, see -# https://doc.dovecot.org/configuration_manual/authentication/password_database_extra_fields/ -#pass_attrs = uid=user,userPassword=password - -# If you wish to avoid two LDAP lookups (passdb + userdb), you can use -# userdb prefetch instead of userdb ldap in dovecot.conf. In that case you'll -# also have to include user_attrs in pass_attrs field prefixed with "userdb_" -# string. For example: -#pass_attrs = uid=user,userPassword=password,\ -# homeDirectory=userdb_home,uidNumber=userdb_uid,gidNumber=userdb_gid - -# Filter for password lookups -#pass_filter = (&(objectClass=posixAccount)(uid=%u)) - -# Attributes and filter to get a list of all users -#iterate_attrs = uid=user -#iterate_filter = (objectClass=posixAccount) - -# Default password scheme. "{scheme}" before password overrides this. -# List of supported schemes is in: -# https://doc.dovecot.org/configuration_manual/authentication/ -#default_pass_scheme = CRYPT - -# By default all LDAP lookups are performed by the auth master process. -# If blocking=yes, auth worker processes are used to perform the lookups. -# Each auth worker process creates its own LDAP connection so this can -# increase parallelism. With blocking=no the auth master process can -# keep 8 requests pipelined for the LDAP connection, while with blocking=yes -# each connection has a maximum of 1 request running. For small systems the -# blocking=no is sufficient and uses less resources. -#blocking = no diff --git a/doc/example-config/dovecot-oauth2.conf.ext b/doc/example-config/dovecot-oauth2.conf.ext deleted file mode 100644 index 843647f78e..0000000000 --- a/doc/example-config/dovecot-oauth2.conf.ext +++ /dev/null @@ -1,72 +0,0 @@ -### OAuth2 password database configuration - -## url for verifying token validity. Token is appended to the URL -# tokeninfo_url = http://endpoint/oauth/tokeninfo?access_token= - -## introspection endpoint, used to gather extra fields and other information. -# introspection_url = http://endpoint/oauth/me - -## How introspection is made, valid values are -## auth = GET request with Bearer authentication -## get = GET request with token appended to URL -## post = POST request with token=bearer_token as content -## local = perform local validation only -# introspection_mode = auth - -## Force introspection even if tokeninfo contains wanted fields -## Set this to yes if you are using active_attribute -# force_introspection = no - -## Validation key dictionary (e.g. fs:posix:prefix=/etc/dovecot/keys/) -## Lookup key is /shared/// -# local_validation_key_dict = - -## A single wanted scope of validity (optional) -# scope = something - -## username attribute in response (default: email) -# username_attribute = email - -## username normalization format (default: %Lu) -# username_format = %Lu - -## Attribute name for checking whether account is disabled (optional) -# active_attribute = - -## Expected value in active_attribute (empty = require present, but anything goes) -# active_value = - -## Expected issuer(s) for the token (space separated list) -# issuers = - -## URL to RFC 7628 OpenID Provider Configuration Information schema -# openid_configuration_url = - -## Extra fields to set in passdb response (in passdb static style) -# pass_attrs = - -## Timeout in milliseconds -# timeout_msecs = 0 - -## Enable debug logging -# debug = no - -## Use worker to verify token -# blocking = yes - -## Max parallel connections (how many simultaneous connections to open) -# max_parallel_connections = 10 - -## Max pipelined requests (how many requests to send per connection, requires server-side support) -# max_pipelined_requests = 1 - -## HTTP request raw log directory -# rawlog_dir = /tmp/oauth2 - -## TLS settings -# tls_ca_cert_file = /path/to/ca-certificates.txt -# tls_ca_cert_dir = /path/to/certs/ -# tls_cert_file = /path/to/client/cert -# tls_key_file = /path/to/client/key -# tls_cipher_suite = HIGH:!SSLv2 -# tls_allow_invalid_cert = FALSE diff --git a/doc/example-config/dovecot.conf.in b/doc/example-config/dovecot.conf.in deleted file mode 100644 index 3d2d2bf8fc..0000000000 --- a/doc/example-config/dovecot.conf.in +++ /dev/null @@ -1,117 +0,0 @@ -## Dovecot configuration file - -# Dovecot configuration version. This must be the first setting in the -# configuration file. It specifies the configuration syntax, the used setting -# names and the expected default values. -dovecot_config_version = @DOVECOT_CONFIG_VERSION@ - -# Dovecot storage file format version. It specifies the oldest Dovecot version -# that must be able to read files written by this Dovecot instance. The -# intention is that when upgrading Dovecot cluster, this setting is first kept -# as the old Dovecot version. Once the cluster is fully upgraded to a new -# version and there is no intention to rollback to the old version anymore, -# this version number can be increased. -dovecot_storage_version = @DOVECOT_CONFIG_VERSION@ - -# If you're in a hurry, see -# https://doc.dovecot.org/configuration_manual/quick_configuration/ - -# "doveconf -n" command gives a clean output of the changed settings. Use it -# instead of copy&pasting files when posting to the Dovecot mailing list. - -# '#' character and everything after it is treated as comments. Extra spaces -# and tabs are ignored. If you want to use either of these explicitly, put the -# value inside quotes, eg.: key = "# char and trailing whitespace " - -# Most (but not all) settings can be overridden by different protocols and/or -# source/destination IPs by placing the settings inside sections, for example: -# protocol imap { }, local 127.0.0.1 { }, remote 10.0.0.0/8 { } - -# Default values are shown for each setting, it's not required to uncomment -# those. These are exceptions to this though: No sections (e.g. namespace {}) -# or plugin settings are added by default, they're listed only as examples. -# Paths are also just examples with the real defaults being based on configure -# options. The paths listed here are for configure --prefix=/usr -# --sysconfdir=/etc --localstatedir=/var - -# Protocols we want to be serving. -#protocols = imap pop3 lmtp submission - -# A comma separated list of IPs or hosts where to listen in for connections. -# "*" listens in all IPv4 interfaces, "::" listens in all IPv6 interfaces. -# If you want to specify non-default ports or anything more complex, -# edit conf.d/master.conf. -#listen = *, :: - -# Base directory where to store runtime data. -#base_dir = /var/run/dovecot/ - -# Name of this instance. In multi-instance setup doveadm and other commands -# can use -i to select which instance is used (an alternative -# to -c ). The instance name is also added to Dovecot processes -# in ps output. -#instance_name = dovecot - -# Greeting message for clients. -#login_greeting = Dovecot ready. - -# Space separated list of trusted network ranges. Connections from these -# IPs are allowed to override their IP addresses and ports (for logging and -# for authentication checks). auth_allow_cleartext is also ignored for -# these networks. Typically you'd specify your IMAP proxy servers here. -#login_trusted_networks = - -# With proxy_maybe=yes if proxy destination matches any of these IPs, don't do -# proxying. This isn't necessary normally, but may be useful if the destination -# IP is e.g. a load balancer's IP. -#auth_proxy_self = - -# Show more verbose process titles (in ps). Currently shows user name and -# IP address. Useful for seeing who are actually using the IMAP processes -# (eg. shared mailboxes or if same uid is used for multiple accounts). -#verbose_proctitle = no - -# Should all processes be killed when Dovecot master process shuts down. -# Setting this to "no" means that Dovecot can be upgraded without -# forcing existing client connections to close (although that could also be -# a problem if the upgrade is e.g. because of a security fix). -#shutdown_clients = yes - -# If non-zero, run mail commands via this many connections to doveadm server, -# instead of running them directly in the same process. -#doveadm_worker_count = 0 -# UNIX socket or host:port used for connecting to doveadm server -#doveadm_socket_path = doveadm-server - -# List of environment variables that are preserved on Dovecot startup and -# passed down to all of its child processes. There are two options to set -# variables: You can either import variables from the environment using -# %{env:} or alternatively using key=value pairs to always set specific -# settings. -#import_environment { -# GDB = 1 -# TZ = %{env:TZ} -#} - -## -## Dictionary server settings -## - -# Dictionary can be used to store key=value lists. This is used by several -# plugins. The dictionary can be accessed either directly or though a -# dictionary server. The following dict block maps dictionary names to URIs -# when the server is used. These can then be referenced using URIs in format -# "proxy::". - -dict { - #quota = mysql:/etc/dovecot/dovecot-dict-sql.conf.ext -} - -# Most of the actual configuration gets included below. The filenames are -# first sorted by their ASCII value and parsed in that order. The 00-prefixes -# in filenames are intended to make it easier to understand the ordering. -!include conf.d/*.conf - -# A config file can also tried to be included without giving an error if -# it's not found: -!include_try local.conf