doveadm-instance (1) Linux Manual Page
doveadm-instance – Manage the list of running Dovecot instances
Synopsis
doveadm [-Dv] [-f formatter] instance listdoveadm [-Dv] instance remove name | base_dir
Description
The doveadm instance commands are used to manage the list of Dovecot instances running on the server. In most installations there is only one Dovecot instance, but in some cases is may be useful to have more (e.g. running director proxy and backend in the same server). Instances are added to the list automatically when Dovecot is started. Each instance is uniquely identified by its base_dir setting. Instances can be named by setting instance_name in each instance’s dovecot.conf. When an instance is named, it can be accessed easily by giving -i
Options
Global doveadm(1) options:- -D
- Enables verbosity and debug messages.
- -f
formatter
- Specifies the formatter for formatting the output. Supported formatters are:
- flow
- prints each line with key=value pairs.
- pager
- prints each key:
value pair on its own line and separates records with form feed character (^L).
- tab
- prints a table header followed by tab separated value lines.
- table
- prints a table header followed by adjusted value lines.
- tab
- flow
- -v
- Enables verbosity, including progress counter.
Arguments
- name
- The value of an instance’s instance_name setting.
- base_dir
- The base directory of a Dovecot instance.
Commands
instance list
doveadm instance list This command lists the seen Dovecot instances.
instance remove
doveadm instance remove name | base_dir This command removes the specified instance.