sources/rsnapshot/rsnapshot.conf

   1 #################################################
   2 # rsnapshot.conf - rsnapshot configuration file #
   3 #################################################
   4 #                                               #
   5 # PLEASE BE AWARE OF THE FOLLOWING RULES:       #
   6 #                                               #
   7 # This file requires tabs between elements      #
   8 #                                               #
   9 # Directories require a trailing slash:         #
  10 #   right: /home/                               #
  11 #   wrong: /home                                #
  12 #                                               #
  13 #################################################
  14
  15 #######################
  16 # CONFIG FILE VERSION #
  17 #######################
  18
  19 config_version  1.2
  20
  21 ###########################
  22 # SNAPSHOT ROOT DIRECTORY #
  23 ###########################
  24
  25 # All snapshots will be stored under this root directory.
  26 snapshot_root   /opt/var/rsnapshot/
  27
  28 # If no_create_root is enabled, rsnapshot will not automatically create the
  29 # snapshot_root directory. This is particularly useful if you are backing
  30 # up to removable media, such as a FireWire drive.
  31 #
  32 #no_create_root 1
  33
  34 #################################
  35 # EXTERNAL PROGRAM DEPENDENCIES #
  36 #################################
  37
  38 # LINUX USERS:   Be sure to uncomment "cmd_cp". This gives you extra features.
  39 # EVERYONE ELSE: Leave "cmd_cp" commented out for compatibility.
  40 #
  41 # See the README file or the man page for more details.
  42 #
  43 cmd_cp          /opt/bin/cp
  44
  45 # uncomment this to use the rm program instead of the built-in perl routine.
  46 cmd_rm          /opt/bin/rm
  47
  48 # rsync must be enabled for anything to work.
  49 cmd_rsync       /opt/bin/rsync
  50
  51 # Uncomment this to enable remote ssh backups over rsync.
  52 cmd_ssh /opt/bin/ssh
  53
  54 # Comment this out to disable syslog support.
  55 #cmd_logger     /path/to/logger
  56
  57 # Uncomment this to specify a path to "du" for disk usage checks.
  58 cmd_du          /opt/bin/du
  59
  60 #########################################
  61 #           BACKUP INTERVALS            #
  62 # Must be unique and in ascending order #
  63 # i.e. hourly, daily, weekly, etc.      #
  64 #########################################
  65
  66 interval        hourly  6
  67 interval        daily   7
  68 interval        weekly  4
  69 #interval       monthly 3
  70
  71 ############################################
  72 #              GLOBAL OPTIONS              #
  73 # All are optional, with sensible defaults #
  74 ############################################
  75
  76 # If your version of rsync supports --link-dest, consider enable this.
  77 # This is the best way to support special files (FIFOs, etc) cross-platform.
  78 # The default is 0 (off).
  79 #
  80 link_dest       1
  81
  82 # Verbose level, 1 through 5.
  83 # 1     Quiet           Print fatal errors only
  84 # 2     Default         Print errors and warnings only
  85 # 3     Verbose         Show equivalent shell commands being executed
  86 # 4     Extra Verbose   Show extra verbose information
  87 # 5     Debug mode      More than you care to know
  88 #
  89 verbose         2
  90
  91 # Same as "verbose" above, but controls the amount of data sent to the
  92 # logfile, if one is being used. The default is 3.
  93 loglevel        3
  94
  95 # If you enable this, data will be written to the file you specify. The
  96 # amount of data written is controlled by the "loglevel" parameter.
  97 logfile         /opt/var/log/rsnapshot
  98
  99 # The include and exclude parameters, if enabled, simply get passed directly
 100 # to rsync. If you have multiple include/exclude patterns, put each one on a
 101 # seperate line. Please look up the --include and --exclude options in the
 102 # rsync man page for more details.
 103 #
 104 #include        ???
 105 #include        ???
 106 #exclude        ???
 107 #exclude        ???
 108
 109 # The include_file and exclude_file parameters, if enabled, simply get
 110 # passed directly to rsync. Please look up the --include-from and
 111 # --exclude-from options in the rsync man page for more details.
 112 #
 113 #include_file   /path/to/include/file
 114 #exclude_file   /path/to/exclude/file
 115
 116 # Default rsync args. All rsync commands have at least these options set.
 117 #
 118 #rsync_short_args       -a
 119 #rsync_long_args        --delete --numeric-ids --relative --delete-excluded
 120
 121 # ssh has no args passed by default, but you can specify some here.
 122 #
 123 #ssh_args       -p 22
 124
 125 # Default arguments for the "du" program (for disk space reporting).
 126 # The GNU version of "du" is preferred. See the man page for more details.
 127 #
 128 #du_args        -csh
 129
 130 # If this is enabled, rsync won't span filesystem partitions within a
 131 # backup point. This essentially passes the -x option to rsync.
 132 # The default is 0 (off).
 133 #
 134 #one_fs         0
 135
 136 # If enabled, rsnapshot will write a lockfile to prevent two instances
 137 # from running simultaneously (and messing up the snapshot_root).
 138 # If you enable this, make sure the lockfile directory is not world
 139 # writable. Otherwise anyone can prevent the program from running.
 140 #
 141 lockfile        /opt/var/run/rsnapshot.pid
 142
 143 ###############################
 144 ### BACKUP POINTS / SCRIPTS ###
 145 ###############################
 146
 147 # LOCALHOST
 148 #backup /home/                  localhost/
 149 backup  /etc/                   localhost/
 150 backup  /opt/etc/               localhost/
 151 #backup /usr/local/             localhost/
 152 #backup /etc/passwd             localhost/
 153 #backup /home/foo/My Documents/         localhost/
 154 #backup /foo/bar/       localhost/      one_fs=1, rsync_short_args=-urltvpog
 155 #backup_script          /usr/local/bin/backup_pgsql.sh  localhost/postgres/
 156
 157 # EXAMPLE.COM
 158 #backup root@example.com:/home/ example.com/
 159 #backup root@example.com:/etc/  example.com/
 160
 161 # CVS.SOURCEFORGE.NET
 162 #backup_script  /usr/local/bin/backup_rsnapshot_cvsroot.sh      cvs.sourceforge.net/
 163
 164 # RSYNC.SAMBA.ORG
 165 #backup rsync://rsync.samba.org/rsyncftp/       rsync.samba.org/rsyncftp/
 166