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 ## should backupninja ignore the version differences between source and remote
  24 ## rdiff-backup? (default: no)
  25 ## This could be useful if the version differences between rdiff-backup instances
  26 ## on remote and local side are different, and you are certain there are no
  27 ## problems in using mis-matched versions and want to get beyond this check.
  28 ## An example usage could be the remote side has its authorized_keys configured
  29 ## with command="rdiff-backup --server" to allow for restricted yet automated
  30 ## password-less backups
  31 # ignore_version = no
  32
  33 ######################################################
  34 ## source section
  35 ## (where the files to be backed up are coming from)
  36
  37 [source]
  38
  39 # an optional subdirectory below 'directory' (see [dest])
  40 label = thishostname
  41
  42 # type can be "local" or "remote"
  43 type = local
  44
  45 # only use if '[source] type = remote'
  46 #host = srchost
  47 #user = srcuser
  48
  49 # how many days of data to keep
  50 # (you can also use the time format of rdiff-backup, e.g. 6D5h)
  51 # (to keep everything, set this to yes)
  52 #keep = yes
  53 keep = 60
  54
  55 # A few notes about includes and excludes:
  56 # 1. include, exclude and vsinclude statements support globbing with '*'
  57 # 2. Symlinks are not dereferenced. Moreover, an include line whose path
  58 #    contains, at any level, a symlink to a directory, will only have the
  59 #    symlink backed-up, not the target directory's content. Yes, you have to
  60 #    dereference yourself the symlinks, or to use 'mount --bind' instead.
  61 #    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
  62 #    line will only backup a "/home" symlink ; neither /home/user nor
  63 #    /home/user/Mail will be backed-up :
  64 #      include = /home/user/Mail
  65 #    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
  66 #    write :
  67 #      include = /mnt/crypt/home/user/Mail
  68 # 3. All the excludes come after all the includes. The order is not otherwise
  69 #    taken into account.
  70
  71 # files to include in the backup
  72 include = /var/spool/cron/crontabs
  73 include = /var/backups
  74 include = /etc
  75 include = /root
  76 include = /home
  77 include = /usr/local/bin
  78 include = /usr/local/sbin
  79 include = /var/lib/dpkg/status
  80 include = /var/lib/dpkg/status-old
  81
  82 # If vservers = yes in /etc/backupninja.conf then the following variables can
  83 # be used:
  84 # vsnames = all | <vserver1> <vserver2> ... (default = all)
  85 # vsinclude = <path>
  86 # vsinclude = <path>
  87 # ...
  88 # Any path specified in vsinclude is added to the include list for each vserver
  89 # listed in vsnames (or all if vsnames = all, which is the default).
  90 #
  91 # For example, vsinclude = /home will backup the /home directory in every
  92 # vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
  93 # vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
  94 # and /vservers/baz/home.
  95 # Vservers paths are derived from $VROOTDIR.
  96
  97 # files to exclude from the backup
  98 #exclude = /home/*/.gnupg
  99
 100 ######################################################
 101 ## destination section
 102 ## (where the files are copied to)
 103
 104 [dest]
 105
 106 # type can be "local" or "remote"
 107 type = remote
 108
 109 # put the backups under this directory
 110 directory = /backups
 111
 112 # the machine which will receive the backups.
 113 # only use if "[dest] type = remote"
 114 host = backuphost
 115
 116 # make the files owned by this user. you must be able to
 117 # `su -c "ssh backupuser@backhost"` without specifying a password.
 118 # only use if "[dest] type = remote"
 119 user = backupuser
 120