This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 1 and 26 (spanning 25 versions)
Revision 1 as of 2010-07-02 15:52:25
Size: 5051
Editor: PageImporter
Comment:
Revision 26 as of 2021-09-21 05:30:10
Size: 5552
Editor: PageImporter
Comment:
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>-adnPNSx</b>] [<b>-c</b> <i>config-file</i>] [<b>-f</b> <i>filter</i>]
Line 22: Line 22:
<dt style="font-weight: bold">-a</dt> <dt><b>-a</b></dt>
Line 27: Line 27:
<dt><b>-d</b></dt>
<dd>Show the setting&#39;s default value instead of the one currently configured.</dd>
Line 35: Line 37:
<dt style="font-weight: bold">lname</dt> <dt><b>lname</b></dt>
Line 39: Line 41:
<dt style="font-weight: bold">local</dt> <dt><b>local</b></dt>
Line 43: Line 45:
<dt style="font-weight: bold">protocol, service</dt> <dt><b>protocol, service</b></dt>
Line 45: Line 47:
<dt style="font-weight: bold">remote</dt> <dt><b>remote</b></dt>
Line 51: Line 53:
<dt style="font-weight: bold">-h</dt> <dt><b>-h</b></dt>
Line 59: Line 61:
<dt style="font-weight: bold">-n</dt> <dt><b>-n</b></dt>
Line 61: Line 63:
<dt style="font-weight: bold">-N</dt> <dt><b>-N</b></dt>
Line 63: Line 65:
<dt style="font-weight: bold">-x</dt> <dt><b>-S</b></dt>
<dd>Dump settings in simplified machine parsable/readable format.</dd>
<dt><b>-s</b></dt>
<dd>Show also hidden settings. The hidden settings should not be changed normally.</dd>
<dd></dd>
<dt><b>-P</b></dt>
<dd>Show passwords and other sensitive values.</dd>
<dt><b>-x</b></dt>
Line 66: Line 75:
<dt style="font-style: italic">section_name</dt> <dt><i>section_name</i></dt>
Line 68: Line 77:
<dt style="font-style: italic">setting_name</dt> <dt><i>setting_name</i></dt>
Line 70: Line 79:
value.</dd> value. You can show a setting inside a section using &#39;/&#39; as the section separator, e.g.
service/imap/executable.</dd>
Line 76: Line 86:
<b>doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n</b>
</pre>
<p><b>doveconf</b> can be also used to convert v1.x configuration files into v2.0 format.</p>
<b>doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n
</b></pre>
<p><b>doveconf</b> can be also used to convert v1.x configuration files into v2.x format.</p>
Line 80: Line 90:
<b>doveconf -n -c /oldpath/dovecot.conf &gt; /etc/dovecot/dovecot.conf.new</b>
</pre>
<b>doveconf -n -c /oldpath/dovecot.conf &gt; /etc/dovecot/dovecot.conf.new
</b></pre>
Line 86: Line 96:
<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 103:
<b>doveconf dict</b>
dict {
<b>doveconf dict
</b>dict {
Line 98: Line 108:
<p>Or how to dump only the quota dict:</p>
<pre>
<b>doveconf dict/quota
</b>dict/quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
</pre>
Line 100: Line 115:
<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) &lt;_io.StringIO object at 0x7f1ad3755e58&gt;

Doveconf

Name

doveconf - Dovecot's configuration dumping utility

Synopsis

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

Description

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.

Options

-a
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.
-d
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:
lname
The local hostname, e.g. mail.example.com. This will only match hostnames which were configured like:
local_name mail.example.com { # special settings }
local
The server's hostname or IP address. This will also match hostnames which were configured like:
local imap.example.net { # special settings }
protocol, service
The protocol, e.g. imap or pop3
remote
The client's hostname or IP address.
-h
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
-n
Show only settings with non-default values.
-N
Show settings with non-default values and explicitly set default values.
-S
Dump settings in simplified machine parsable/readable format.
-s
Show also hidden settings. The hidden settings should not be changed normally.
-P
Show passwords and other sensitive values.
-x
Expand configuration variables (e.g. $mail_plugins ⇒ quota) and show file contents (from e.g. ssl_cert = </etc/ssl/certs/dovecot.pem).
section_name
Show only the current configuration of one or more specified sections.
setting_name
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.

Example

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=10.0.0.110 -f remote=10.11.1.2 -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/dovecot.conf.new

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) <_io.StringIO object at 0x7f1ad3755e58>


CategoryMan

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