| 1 |
.. cyrusman:: mupdate(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-mupdate: |
| 6 |
|
| 7 |
=========== |
| 8 |
**mupdate** |
| 9 |
=========== |
| 10 |
|
| 11 |
MUPDATE server process |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**mupdate** [ **-C** *config-file* ] [ **-m** ] [ **-a** ] |
| 19 |
|
| 20 |
Description |
| 21 |
=========== |
| 22 |
|
| 23 |
**mupdate** is the mailboxdb aggregation server. It accepts commands |
| 24 |
on its standard input and responds on its standard output. It MUST be |
| 25 |
invoked by :cyrusman:`master(8)` with those descriptors attached to a |
| 26 |
remote client connection. |
| 27 |
|
| 28 |
**mupdate** |default-conf-text| |
| 29 |
|
| 30 |
If the directory ``log``\/*user* exists under the directory specified in |
| 31 |
the ``configdirectory`` configuration option, then **mupdate** will create |
| 32 |
protocol telemetry logs for sessions authenticating as *user*. |
| 33 |
|
| 34 |
The telemetry logs will be stored in the ``log``/\ *user* directory with |
| 35 |
a filename of the **mupdate** process-id. |
| 36 |
|
| 37 |
Options |
| 38 |
======= |
| 39 |
|
| 40 |
.. program:: mupdate |
| 41 |
|
| 42 |
.. option:: -C config-file |
| 43 |
|
| 44 |
|cli-dash-c-text| |
| 45 |
|
| 46 |
.. option:: -m |
| 47 |
|
| 48 |
Run as the MUPDATE master. Default is to act as slave. |
| 49 |
|
| 50 |
.. option:: -a |
| 51 |
|
| 52 |
[autoselect] Check ``mupdate_server`` setting in |
| 53 |
:cyrusman:`imapd.conf(5)` to see if this is the designated master |
| 54 |
server, and act as master if this is the case. Otherwise act as |
| 55 |
slave. |
| 56 |
|
| 57 |
Examples |
| 58 |
======== |
| 59 |
|
| 60 |
**mupdate** is commonly included in the SERVICES section of |
| 61 |
:cyrusman:`cyrus.conf(5)` like so: |
| 62 |
|
| 63 |
.. parsed-literal:: |
| 64 |
SERVICES { |
| 65 |
imap cmd="imapd -U 30" listen="imap" prefork=0 |
| 66 |
imaps cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100 |
| 67 |
lmtpunix cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20 |
| 68 |
sieve cmd="timsieved" listen="sieve" prefork=0 |
| 69 |
notify cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1 |
| 70 |
httpd cmd="httpd" listen=8080 prefork=1 maxchild=20 |
| 71 |
# (mupdate master, only one in the entire cluster) |
| 72 |
**mupdate cmd="mupdate -m" listen="mupdate" prefork=1** |
| 73 |
# |
| 74 |
# (mupdate slave, run on each frontend host in the cluster) |
| 75 |
# mupdate cmd="mupdate" listen="mupdate" prefork=1 |
| 76 |
} |
| 77 |
|
| 78 |
Files |
| 79 |
===== |
| 80 |
|
| 81 |
/etc/imapd.conf |
| 82 |
|
| 83 |
See Also |
| 84 |
======== |
| 85 |
|
| 86 |
:cyrusman:`imapd.conf(5)`, |
| 87 |
:cyrusman:`master(8)` |