doveadm-instance(1)

1DOVEADM-INSTANCE(1)                 Dovecot                DOVEADM-INSTANCE(1)
2
3
4

NAME

6       doveadm-instance - Manage the list of running Dovecot instances
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] instance list
10       doveadm [-Dv] instance remove name | base_dir
11

DESCRIPTION

13       The  doveadm  instance  commands are used to manage the list of Dovecot
14       instances running on the server.  In most installations there  is  only
15       one  Dovecot  instance, but in some cases is may be useful to have more
16       (e.g. running director proxy and backend in the same server).
17
18       Instances are added to the list automatically when Dovecot is  started.
19       Each   instance   is  uniquely  identified  by  its  base_dir  setting.
20       Instances can be named by  setting  instance_name  in  each  instance's
21       dovecot.conf.   When an instance is named, it can be accessed easily by
22       giving -i instance_name command line  parameter  for  Dovecot  binaries
23       (e.g. doveadm).
24

OPTIONS

26       Global doveadm(1) options:
27
28       -D     Enables verbosity and debug messages.
29
30       -f formatter
31              Specifies  the  formatter  for formatting the output.  Supported
32              formatters are:
33
34              flow   prints each line with key=value pairs.
35
36              pager  prints each key: value pair on its own line and separates
37                     records with form feed character (^L).
38
39              tab    prints  a  table  header  followed by tab separated value
40                     lines.
41
42              table  prints a table header followed by adjusted value lines.
43
44       -o setting=value
45              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
46              cot.conf  and from the userdb with the given value.  In order to
47              override multiple settings, the -o option may be specified  mul‐
48              tiple times.
49
50       -v     Enables verbosity, including progress counter.
51

ARGUMENTS

53       name   The value of an instance's instance_name setting.
54
55       base_dir
56              The base directory of a Dovecot instance.
57

COMMANDS

59   instance list
60       doveadm instance list
61
62       This command lists the seen Dovecot instances.
63
64   instance remove
65       doveadm instance remove name | base_dir
66
67       This command removes the specified instance.
68

REPORTING BUGS

70       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
71       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
72       at: http://dovecot.org/bugreport.html
73