examples/example.maildir

   1 ##
   2 ## This is an example maildir configuration file.
   3 ##
   4 ## The maildir handler slowly creates a backup of each user's
   5 ## maildir to a remote server. It is designed to be run with
   6 ## low overhead in terms of CPU and bandwidth, so it runs pretty
   7 ## slow. Hardlinking is used to save storage space. The actual
   8 ## maildir is stored within each snapshot directory.
   9 ##
  10 ## The basic algorithm is to rsync each maildir individually,
  11 ## and to use hard links for retaining historical data.
  12 ##
  13 ## We handle each maildir individually because it becomes very
  14 ## unweldy to hardlink and rsync many hundreds of thousands
  15 ## of files at once. It is much faster to take on smaller
  16 ## chunks at a time.
  17 ##
  18 ## Any maildir which is deleted from the source will be moved to
  19 ## "deleted" directory in the destination. It is up to you to
  20 ## periodically remove this directory or old maildirs in it.
  21 ## The defaults are useful in most cases, just make sure
  22 ## to configure the source and destination information
  23
  24 when = everyday at 21:00
  25
  26 ## each users maildir will contain these files:
  27 ## daily.1, daily.2, daily.3, daily.4, daily.5, weekly.1, weekly.2,
  28 ## weekly.3, monthly.1
  29 ## if keepdaily is 5, keepweekly is 3, and keepmonthly is 1
  30 keepdaily = 5
  31 keepweekly = 3
  32 keepmonthly = 1
  33
  34 # directory which contains all the maildirs
  35 # this directory is expected to have subdirectories lettered a-z and
  36 # in each letter subdirectory are the users Maildirs which start with
  37 # those letters
  38 srcdir = /maildir/riseup.net
  39
  40 # put the backups under this directory
  41 destdir = /crypta/maildir/riseup.net
  42 desthost = kakapo-pn
  43
  44 # For the backup rotation to work, destuser must be able to run
  45 # arbitrary bash commands on the desthost.
  46 destuser = backer
  47
  48 # remove any maildirs from backup which might have been deleted
  49 remove = yes
  50
  51 # use a ssh-mux to reuse connections, see the following article
  52 # http://www.debian-administration.org/articles/290 for an example
  53 multiconnection = notset