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 ##
  22 ## Note: This handler assumes that the remote shell is set to bash
  23 ##
  24 ## The defaults are useful in most cases, just make sure
  25 ## to configure the source and destination information
  26
  27 when = everyday at 21:00
  28
  29 ## each users maildir will contain these files:
  30 ## daily.1, daily.2, daily.3, daily.4, daily.5, weekly.1, weekly.2,
  31 ## weekly.3, monthly.1
  32 ## if keepdaily is 5, keepweekly is 3, and keepmonthly is 1
  33 keepdaily = 5
  34 keepweekly = 3
  35 keepmonthly = 1
  36
  37 # directory which contains all the maildirs
  38 # this directory is expected to have subdirectories lettered a-z and
  39 # in each letter subdirectory are the users Maildirs which start with
  40 # those letters
  41 srcdir = /maildir/riseup.net
  42
  43 # put the backups under this directory
  44 destdir = /crypta/maildir/riseup.net
  45 desthost = kakapo-pn
  46
  47 # For the backup rotation to work, destuser must be able to run
  48 # arbitrary bash commands on the desthost.
  49 destuser = backer
  50
  51 # remove any maildirs from backup which might have been deleted
  52 remove = yes
  53
  54 # use a ssh-mux to reuse connections, see the following article
  55 # http://www.debian-administration.org/articles/290 for an example
  56 multiconnection = notset