This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 1 and 16 (spanning 15 versions)
Revision 1 as of 2010-07-02 15:52:25
Size: 5051
Editor: PageImporter
Revision 16 as of 2017-05-15 07:18:28
Size: 5597
Editor: PageImporter
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
<p><b>doveconf</b> [<b>-anNx</b>] [<b>-c</b> <i>config-file</i>] [<b>-f</b> <i>filter</i>] <p><b>doveconf</b> [<b>-adnNSx</b>] [<b>-c</b> <i>config-file</i>] [<b>-f</b> <i>filter</i>]
Line 27: Line 27:
<dt style="font-weight: bold">-d</dt>
<dd>Show the setting&#39;s default value instead of the one currently configured.</dd>
Line 63: Line 65:
<dt style="font-weight: bold">-S</dt>
<dd>Dump settings in simplified machine parsable/readable format.</dd>
Line 70: Line 74:
value.</dd> value. You can show a setting inside a section using &#39;/&#39; as the section separator, e.g.
Line 75: Line 80:
<b>doveconf -f local= -f remote= -f service=pop3 -n</b>
<pre style="font-weight: bold">
doveconf -f local= -f remote= -f service=pop3 -n
Line 78: Line 83:
<p><b>doveconf</b> can be also used to convert v1.x configuration files into v2.0 format.</p>
<b>doveconf -n -c /oldpath/dovecot.conf &gt; /etc/dovecot/</b>
<p><b>doveconf</b> can be also used to convert v1.x configuration files into v2.x format.</p>
<pre style="font-weight: bold">
doveconf -n -c /oldpath/dovecot.conf &gt; /etc/dovecot/
Line 86: Line 91:
<b>doveconf mail_plugins</b>
mail_plugins = quota
<b>doveconf -h -f protocol=imap mail_plugins</b>
quota imap_quota
<b>doveconf mail_plugins
</b>mail_plugins = quota
<b>doveconf -h -f protocol=imap mail_plugins
</b>quota imap_quota
Line 93: Line 98:
<b>doveconf dict</b>
dict {
<b>doveconf dict
</b>dict {
Line 98: Line 103:
<p>Or how to dump only the quota dict:</p>
<b>doveconf dict/quota
</b>dict/quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
Line 100: Line 110:
<b><a href="/Tools/DovecotLDA">dovecot-lda</a></b>(1), <b><a href="/Tools/Dsync">dsync</a></b>(1)
<b><a href="/Tools/DovecotLDA">dovecot-lda</a></b>(1), <b><a href=
"/Tools/Doveadm/Sync">dsync</a></b>(1) }}}



doveconf - Dovecot's configuration dumping utility


doveconf [-adnNSx] [-c config-file] [-f filter] [-m module]
doveconf [-n] [-c config-file] section_name ...
doveconf [-h] [-c config-file] [-f filter] setting_name ...


doveconf reads and parses Dovecot's configuration files and converts them into a simpler format used by the rest of Dovecot. All standalone programs, such as dovecot(1) and dovecot-lda(1), will first get their settings by executing doveconf.

For system administrators, doveconf is mainly useful for dumping the configuration in easy human readable output.


Show all settings with their currently configured values.
-c config-file
read configuration from the given config-file. By default /etc/dovecot/dovecot.conf will be used.
Show the setting's default value instead of the one currently configured.
-f filter
Show the matching configuration for the specified filter condition. The filter option string has to be given as name=value pair. For multiple filter conditions the -f option can be supplied multiple times.
Possible names for the filter are:
The local hostname, e.g. This will only match hostnames which were configured like:
local_name { # special settings }
The server's hostname or IP address. This will also match hostnames which were configured like:
local { # special settings }
protocol, service
The protocol, e.g. imap or pop3
The client's hostname or IP address.
Hide the setting's name, show only the setting's value.
-m module
Show only settings for the given module.
e.g. imap, imap-login, lmtp, pop3 or pop3-login
Show only settings with non-default values.
Show settings with non-default values and explicitly set default values.
Dump settings in simplified machine parsable/readable format.
Expand configuration variables (e.g. $mail_plugins ⇒ quota) and show file contents (from e.g. ssl_cert = </etc/ssl/certs/dovecot.pem).
Show only the current configuration of one or more specified sections.
Show only the setting of one or more setting_name(s) with the currently configured value. You can show a setting inside a section using '/' as the section separator, e.g. service/imap/executable.


When Dovecot was configured to use different settings for some networks/subnets it is possible to show which settings will be applied for a specific connection.

doveconf -f local= -f remote= -f service=pop3 -n

doveconf can be also used to convert v1.x configuration files into v2.x format.

doveconf -n -c /oldpath/dovecot.conf > /etc/dovecot/

This example shows how to ask doveconf for a global setting and a protocol specific setting. The second command uses also the -h option, in order to hide the setting's name.

doveconf mail_plugins
mail_plugins = quota
doveconf  -h -f protocol=imap mail_plugins
quota imap_quota

This example demonstrates how to dump a whole configuration section.

doveconf dict
dict {
  quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext

Or how to dump only the quota dict:

doveconf dict/quota
dict/quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext

See Also

doveadm(1), dovecot(1), dovecot-lda(1), dsync(1)


None: Tools/Doveconf (last edited 2021-09-22 07:08:20 by PageImporter)