rdiff and dup handlers/helpers/examples symlink and globbing support enhancement
[matthijs/upstream/backupninja.git] / 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 ######################################################
17 ## source section
18 ## (where the files to be backed up are coming from)
19
20 [source]
21
22 # an optional subdirectory below 'directory' (see [dest])
23 label = thishostname
24
25 # type can be "local" or "remote"
26 type = local
27
28 # only use if '[source] type = remote'
29 #host = srchost
30 #user = srcuser
31
32 # how many days of data to keep
33 # (you can also use the time format of rdiff-backup, e.g. 6D5h)
34 keep = 60
35
36 # A few notes about includes and excludes:
37 #   - include, exclude and vsinclude statements support EITHER globbing with '*'
38 #     OR symlinks in the path; usage of both in the same statement is *not*
39 #     supported and will lead to weird behaviour.
40 #   - All the excludes come after all the includes. The order is not otherwise
41 #     taken into account.
42
43 # files to include in the backup
44 include = /var/spool/cron/crontabs
45 include = /var/backups
46 include = /etc
47 include = /root
48 include = /home
49 include = /usr/local/bin
50 include = /usr/local/sbin
51 include = /var/lib/dpkg/status
52 include = /var/lib/dpkg/status-old
53
54 # If vservers = yes in /etc/backupninja.conf then the following variables can
55 # be used:
56 # vsnames = all | <vserver1> <vserver2> ... (default = all)
57 # vsinclude = <path>
58 # vsinclude = <path>
59 # ...
60 # Any path specified in vsinclude is added to the include list for each vserver
61 # listed in vsnames (or all if vsnames = all, which is the default).
62 #
63 # For example, vsinclude = /home will backup the /home directory in every
64 # vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
65 # vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
66 # and /vservers/baz/home.
67 # Vservers paths are derived from $VROOTDIR.
68
69 # files to exclude from the backup
70 #exclude = /home/*/.gnupg
71
72 ######################################################
73 ## destination section
74 ## (where the files are copied to)
75
76 [dest]
77
78 # type can be "local" or "remote"
79 type = remote
80
81 # put the backups under this directory
82 directory = /backups
83
84 # the machine which will receive the backups.
85 # only use if "[dest] type = remote"
86 host = backuphost
87
88 # make the files owned by this user. you must be able to
89 # `su -c "ssh backupuser@backhost"` without specifying a password.
90 # only use if "[dest] type = remote"
91 user = backupuser
92