examples/example.rdiff

   1 ##
   2 ## This is an example rdiff-backup configuration file.
   3 ##
   4 ## Here you can find all the possible duplicity options, details of
   5 ## what the options provide and possible settings. The defaults are set
   6 ## as the commented out option, uncomment and change when
   7 ## necessary. Options which are uncommented in this example do not have
   8 ## defaults, and the settings provided are recommended.
   9 ##
  10 ## The defaults are useful in most cases, just make sure to configure the
  11 ## destination host and user.
  12 ##
  13
  14 ## passed directly to rdiff-backup
  15 ## an example setting would be:
  16 ## options = --force
  17 ##
  18 ## Default:
  19 # options =
  20
  21 ## default is 0, but set to 19 if you want to lower the priority.
  22 ## an example setting would be:
  23 ## nicelevel = 19
  24 ##
  25 ## Default
  26 # nicelevel = 0
  27
  28 ## default is yes. set to no to skip the test if the remote host is alive
  29 ##
  30 ## Default:
  31 # testconnect = no
  32
  33 ## default is not to limit bandwidth.
  34 ## set to a number in bytes/second to limit bandwidth usage. Use a negative
  35 ## number to set a limit that will never be exceeded, or a positive number
  36 ## to set a target average bandwidth use. cstream is required. See cstream's
  37 ## -t option for more information. 62500 bytes = 500 Kb (.5 Mb)
  38 ## an example setting would be:
  39 ## bwlimit = 62500
  40 ##
  41 ## Default:
  42 # bwlimit = 0
  43
  44 ## should backupninja ignore the version differences between source and remote
  45 ## rdiff-backup? (default: no)
  46 ## This could be useful if the version differences between rdiff-backup instances
  47 ## on remote and local side are different, and you are certain there are no
  48 ## problems in using mis-matched versions and want to get beyond this check.
  49 ## An example usage could be the remote side has its authorized_keys configured
  50 ## with command="rdiff-backup --server" to allow for restricted yet automated
  51 ## password-less backups
  52 ##
  53 ## Default:
  54 # ignore_version = no
  55
  56 ######################################################
  57 ## source section
  58 ## (where the files to be backed up are coming from)
  59
  60 [source]
  61
  62 ## an optional subdirectory below 'directory' (see [dest])
  63 label = thishostname
  64
  65 ## type can be "local" or "remote"
  66 type = local
  67
  68 ## only use if '[source] type = remote'
  69 # host = srchost
  70 # user = srcuser
  71
  72 ## how many days of data to keep
  73 ## (you can also use the time format of rdiff-backup, e.g. 6D5h)
  74 ## (to keep everything, set this to yes)
  75 ## an example setting would be:
  76 ##keep = yes
  77 ##
  78 ## Default:
  79 # keep = 60
  80
  81 ## A few notes about includes and excludes:
  82 ## 1. include, exclude and vsinclude statements support globbing with '*'
  83 ## 2. Symlinks are not dereferenced. Moreover, an include line whose path
  84 ##    contains, at any level, a symlink to a directory, will only have the
  85 ##    symlink backed-up, not the target directory's content. Yes, you have to
  86 ##    dereference yourself the symlinks, or to use 'mount --bind' instead.
  87 ##    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
  88 ##    line will only backup a "/home" symlink ; neither /home/user nor
  89 ##    /home/user/Mail will be backed-up :
  90 ##      include = /home/user/Mail
  91 ##    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
  92 ##    write :
  93 ##      include = /mnt/crypt/home/user/Mail
  94 ## 3. All the excludes come after all the includes. The order is not otherwise
  95 ##    taken into account.
  96
  97 ## files to include in the backup
  98 include = /var/spool/cron/crontabs
  99 include = /var/backups
 100 include = /etc
 101 include = /root
 102 include = /home
 103 include = /usr/local/bin
 104 include = /usr/local/sbin
 105 include = /var/lib/dpkg/status
 106 include = /var/lib/dpkg/status-old
 107
 108 ## If vservers = yes in /etc/backupninja.conf then the following variables can
 109 ## be used:
 110 ## vsnames = all | <vserver1> <vserver2> ... (default = all)
 111 ## vsinclude = <path>
 112 ## vsinclude = <path>
 113 ## ...
 114 ## Any path specified in vsinclude is added to the include list for each vserver
 115 ## listed in vsnames (or all if vsnames = all, which is the default).
 116 ##
 117 ## For example, vsinclude = /home will backup the /home directory in every
 118 ## vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
 119 ## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
 120 ## and /vservers/baz/home.
 121 ## Vservers paths are derived from $VROOTDIR.
 122
 123 ## files to exclude from the backup
 124 exclude = /home/*/.gnupg
 125
 126 ######################################################
 127 ## destination section
 128 ## (where the files are copied to)
 129
 130 [dest]
 131
 132 ## type can be "local" or "remote", this must be set!
 133 ## an example configuration would be:
 134 ## type = remote
 135 ##
 136 ## Default:
 137 # type =
 138
 139 ## put the backups under this directory, this must be set!
 140 ## an example setting would be:
 141 ## directory = /backups
 142 ##
 143 ## Default:
 144 # directory =
 145
 146 ## the machine which will receive the backups.
 147 ## only use if "[dest] type = remote"
 148 ## an example setting would be:
 149 ## host = backuphost
 150 ##
 151 ## Default
 152 # host =
 153
 154 ## make the files owned by this user. you must be able to
 155 ## `su -c "ssh backupuser@backhost"` without specifying a password.
 156 ## only use if "[dest] type = remote"
 157 ## an example setting would be:
 158 ## user = backupuser
 159 ##
 160 ## Default:
 161 # user =
 162
 163