examples/example.rdiff

   1 ##
   2 ## This is an example rdiff-backup configuration file.
   3 ## The defaults are useful in most cases, just make sure
   4 ## to configure the destination host and user.
   5 ##
   6
   7 ## passed directly to rdiff-backup
   8 # options = --force
   9
  10 ## default is 0, but set to 19 if you want to lower the priority.
  11 # nicelevel = 19
  12
  13 ## default is yes. set to no to skip the test if the remote host is alive
  14 # testconnect = no
  15
  16 ## default is not to limit bandwidth.
  17 ## set to a number in bytes/second to limit bandwidth usage. Use a negative
  18 ## number to set a limit that will never be exceeded, or a positive number
  19 ## to set a target average bandwidth use. cstream is required. See cstream's
  20 ## -t option for more information. 62500 bytes = 500 Kb (.5 Mb)
  21 # bwlimit = 62500
  22
  23 ######################################################
  24 ## source section
  25 ## (where the files to be backed up are coming from)
  26
  27 [source]
  28
  29 # an optional subdirectory below 'directory' (see [dest])
  30 label = thishostname
  31
  32 # type can be "local" or "remote"
  33 type = local
  34
  35 # only use if '[source] type = remote'
  36 #host = srchost
  37 #user = srcuser
  38
  39 # how many days of data to keep
  40 # (you can also use the time format of rdiff-backup, e.g. 6D5h)
  41 keep = 60
  42
  43 # A few notes about includes and excludes:
  44 # 1. include, exclude and vsinclude statements support globbing with '*'
  45 # 2. Symlinks are not dereferenced. Moreover, an include line whose path
  46 #    contains, at any level, a symlink to a directory, will only have the
  47 #    symlink backed-up, not the target directory's content. Yes, you have to
  48 #    dereference yourself the symlinks, or to use 'mount --bind' instead.
  49 #    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
  50 #    line will only backup a "/home" symlink ; neither /home/user nor
  51 #    /home/user/Mail will be backed-up :
  52 #      include = /home/user/Mail
  53 #    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
  54 #    write :
  55 #      include = /mnt/crypt/home/user/Mail
  56 # 3. All the excludes come after all the includes. The order is not otherwise
  57 #    taken into account.
  58
  59 # files to include in the backup
  60 include = /var/spool/cron/crontabs
  61 include = /var/backups
  62 include = /etc
  63 include = /root
  64 include = /home
  65 include = /usr/local/bin
  66 include = /usr/local/sbin
  67 include = /var/lib/dpkg/status
  68 include = /var/lib/dpkg/status-old
  69
  70 # If vservers = yes in /etc/backupninja.conf then the following variables can
  71 # be used:
  72 # vsnames = all | <vserver1> <vserver2> ... (default = all)
  73 # vsinclude = <path>
  74 # vsinclude = <path>
  75 # ...
  76 # Any path specified in vsinclude is added to the include list for each vserver
  77 # listed in vsnames (or all if vsnames = all, which is the default).
  78 #
  79 # For example, vsinclude = /home will backup the /home directory in every
  80 # vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
  81 # vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
  82 # and /vservers/baz/home.
  83 # Vservers paths are derived from $VROOTDIR.
  84
  85 # files to exclude from the backup
  86 #exclude = /home/*/.gnupg
  87
  88 ######################################################
  89 ## destination section
  90 ## (where the files are copied to)
  91
  92 [dest]
  93
  94 # type can be "local" or "remote"
  95 type = remote
  96
  97 # put the backups under this directory
  98 directory = /backups
  99
 100 # the machine which will receive the backups.
 101 # only use if "[dest] type = remote"
 102 host = backuphost
 103
 104 # make the files owned by this user. you must be able to
 105 # `su -c "ssh backupuser@backhost"` without specifying a password.
 106 # only use if "[dest] type = remote"
 107 user = backupuser
 108