1BACKUPD(8)                        Cyrus IMAP                        BACKUPD(8)
2
3
4

NAME

6       backupd - Cyrus IMAP documentation
7
8       Cyrus Backups server process
9

SYNOPSIS

11          backupd [ -C config-file ] [ -U uses ] [ -T timeout ] [ -D ]
12              [ -s ] [ -N ] [ -p ssf ]
13

DESCRIPTION

15       backupd is the Cyrus Backups server.  It accepts Cyrus replication pro‐
16       tocol commands on its standard input and responds on its standard  out‐
17       put.   It  MUST be invoked by master(8) with those descriptors attached
18       to a replication client connection, typically sync_client(8).
19
20       backupd reads its configuration options out of the  imapd.conf(5)  file
21       unless specified otherwise by -C.
22
23       backupd  is  generally  configured to run on a dedicated backup server,
24       containing backup storage, but no IMAP service or mailbox storage.
25
26       You must configure at least one backuppartition.  User backups will  be
27       distributed among the configured partitions.  Note that there is no re‐
28       lationship between mailbox partitions and backuppartitions.
29
30       If the directory log/user exists under the directory specified  in  the
31       configdirectory configuration option, then backupd will create protocol
32       telemetry logs for sessions authenticating as user.  The telemetry logs
33       will be stored in the log/user directory with a filename of the backupd
34       process-id.
35

OPTIONS

37       -C config-file
38              Use the specified configuration file config-file rather than the
39              default imapd.conf(5).
40
41       -U uses
42              The  maximum number of times that the process should be used for
43              new connections before shutting down.  The default is 250.
44
45       -T timeout
46              The number of seconds that the process will wait for a new  con‐
47              nection  before  shutting  down.   Note that a value of 0 (zero)
48              will disable the timeout.  The default is 60.
49
50       -D     Run external debugger specified in debug_command.
51
52       -p ssf Tell backupd that an external layer exists.   An  SSF  (security
53              strength  factor)  of  1 means an integrity protection layer ex‐
54              ists.  Any higher SSF implies some form of privacy protection.
55

EXAMPLES

57       backupd is commonly included in the SERVICES section  of  cyrus.conf(5)
58       like so:
59
60          SERVICES {
61              backupd        cmd="backupd" listen="csync" prefork=0
62          }
63

HISTORY

FILES
SEE ALSO
67       imapd.conf(5), master(8), sync_client(8)
68

AUTHOR
70       The Cyrus Team
71

73       1993–2023, The Cyrus Team
74
75
76
77
783.8.1                            Sep 11, 2023                       BACKUPD(8)



        

    


            
        

        

            Impressum