doveadm-replicator(1)

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

NAME

6       doveadm-replicator - Manage users' mail replication
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] replicator command [OPTIONS] [ARGUMENTS]
10

DESCRIPTION

12       The  doveadm  replicator  COMMANDS  can be used to manage the automated
13       replication of users' mail.
14

OPTIONS

16       Global doveadm(1) options:
17
18       -D     Enables verbosity and debug messages.
19
20       -f formatter
21              Specifies the formatter for formatting  the  output.   Supported
22              formatters are:
23
24              flow   prints each line with key=value pairs.
25
26              pager  prints each key: value pair on its own line and separates
27                     records with form feed character (^L).
28
29              tab    prints a table header followed  by  tab  separated  value
30                     lines.
31
32              table  prints a table header followed by adjusted value lines.
33
34       -o setting=value
35              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
36              cot.conf and from the userdb with the given value.  In order  to
37              override  multiple settings, the -o option may be specified mul‐
38              tiple times.
39
40       -v     Enables verbosity, including progress counter.
41
42       This command uses by default the output  formatter  flow  (without  the
43       key= prefix).
44
45       Command specific options:
46
47       -a replicator_socket_path
48              This  option  is used to specify an absolute path to an alterna‐
49              tive UNIX domain socket.
50
51              By default doveadm(1) will use the socket  /run/dovecot/replica‐
52              tor-doveadm.   The  socket  may be located in another directory,
53              when the default base_dir setting was overridden  in  /etc/dove‐
54              cot/dovecot.conf.
55

ARGUMENTS

57       user_mask
58              Specifies  for  which  users the command should be executed.  In
59              most cases you would like to use patterns which  contains  wild‐
60              cards,  e.g.  \*@example.net  for  all  users of the example.net
61              domain, or simply \* for all users.
62
63              When the SQL userdb module is used  make  sure  that  the  iter‐
64              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
65              your database layout.  When using the LDAP userdb  module,  make
66              sure  that  the  iterate_attrs  and  iterate_filter  settings in
67              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
68              erwise doveadm(1) will be unable to iterate over all users.
69

COMMANDS

71   replicator add
72       doveadm replicator add [-a replicator_socket_path] user_mask
73
74       Add the specified user(s) to the replicator.  If the user_mask contains
75       "?" or "*" wildcards, the list of  usernames  is  looked  up  from  the
76       userdb.
77
78   replicator dsync-status
79       doveadm replicator dsync-status [-a replicator_socket_path]
80
81       Show the status for the currently running dsync processes.
82
83   replicator remove
84       doveadm replicator remove [-a replicator_socket_path] username
85
86       Remove the specified user from replicator.
87
88   replicator replicate
89       doveadm  replicator replicate [-a replicator_socket_path] [-f] [-p pri‐
90       ority] user_mask
91
92       Start replication for the specified users now.  If the -f parameter  is
93       given, full replication is done for the user.  You can also specify the
94       priority, which can be either high  or  low.  If the user mask contains
95       "?" or "*" wildcards, the list of usernames is looked up from the users
96       that currently exist in replicator (not from the userdb).
97
98   replicator status
99       doveadm replicator status [-a replicator_socket_path] user_mask
100
101       Show the replication status for users.
102

REPORTING BUGS

104       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
105       <dovecot@dovecot.org>.   Information  about reporting bugs is available
106       at: http://dovecot.org/bugreport.html
107