DOVEADM-REPLICATOR(1)

💖 DOVEADM-REPLICATOR 💖

okay bestie, so this is the doveadm-replicator page from the Dovecot manual — like, the official one, manual section 1 🎀

---

✨ NAME ✨

doveadm-replicator — manage users' mail replication 💌

---

🌸 SYNOPSIS 🌸

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

---

🦋 DESCRIPTION 🦋

so the doveadm replicator COMMANDS are literally your whole toolkit for managing the automated replication of users' mail. that's it, that's the vibe. automated. mail. replication. ✨

---

💅 OPTIONS 💅

the global doveadm(1) options, bestie

• -D — turns on verbosity AND debug messages. it's giving "i want to see everything" 🔍
• -f formatter — picks the formatter for the output. the 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 a form feed character (^L).
  • tab — prints a table header, then tab separated value lines.
  • table — prints a table header, then adjusted value lines.
• -o setting=value — overrides a configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the value you give it. and if you wanna override multiple settings? no problem, just specify the -o option multiple times 💫
• -v — turns on verbosity, including the progress counter. we love a progress bar 🫶

oh and btw, this command uses the output formatter flow by default — without the key= prefix.

the command-specific option, gorgeous

• -a replicator_socket_path — this one is for specifying an absolute path to an alternative UNIX domain socket.

by default doveadm(1) will use the socket /run/dovecot/replicator-doveadm. but the socket may be located in another directory if the default base_dir setting was overridden in /etc/dovecot/dovecot.conf 👑

---

🎀 ARGUMENTS 🎀

• user_mask — specifies which users the command should be executed for. in most cases you'd wanna use patterns containing wildcards, like \*@example.net for all the users of the example.net domain, or just simply \* for, like, every single user 🌈

when the SQL userdb module is used, make sure the iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. and when you're using the LDAP userdb module, make sure the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. otherwise doveadm(1) will be unable to iterate over all users 😭 (no cap, that's a real problem)

---

👑 COMMANDS 👑

replicator add

doveadm replicator add [-a replicator_socket_path] user_mask

adds the specified user(s) to the replicator. if the user_mask contains "?" or "*" wildcards, the list of usernames is looked up from the userdb. periodt 💅

replicator dsync-status

doveadm replicator dsync-status [-a replicator_socket_path]

shows the status for the currently running dsync processes. it's giving live updates 📡

replicator remove

doveadm replicator remove [-a replicator_socket_path] username

removes the specified username from the replicator. bye bestie 👋

replicator replicate

doveadm replicator replicate [-a replicator_socket_path] [-f] [-p priority] user_mask

starts replication for the specified users right now, like immediately, no waiting ✨ if the -f parameter is given, a full replication is done for the user. you can also specify the priority, which can be either high or low. and if the user_mask contains "?" or "*" wildcards, the list of usernames is looked up from the users that currently exist in the replicator — not from the userdb. important distinction, iykyk 🔥

replicator status

doveadm replicator status [-a replicator_socket_path] user_mask

shows the replication status for users. the vibe check of replication 📊

---

🐛 REPORTING BUGS 🐛

found a bug? report it, including doveconf -n output, to the Dovecot Mailing List <dovecot@dovecot.org>. info about reporting bugs lives at: http://dovecot.org/bugreport.html — don't be shy, they wanna hear it 🙈

---

💜 SEE ALSO 💜

• doveadm(1)
• doveadm-sync(1)

additional resources:

• Replication with dsync — http://wiki2.dovecot.org/Replication

---

and that's the whole page bestie, you ate that 🍓

so fr fr, this was Dovecot v2.3, dated 2014-10-05, and it's the DOVEADM-REPLICATOR(1) page 💖 go forth and replicate, main character 🧚✨