#
# Dirvish master configuration example for hardBackup
# See Dirvish configuration documentation for all options
#

# Excerpt from 'Configuring and Using Dirvish for Snapshot Backups'
# by Jason Boxman 
# (http://edseek.com/~jasonb/articles/dirvish_backup/index.html):
#
# A bank is essentially a place where you store your backups. Each bank
# may have one or more vaults. A vault is the container for a single
# filesystem. You must create a vault for each filesystem you wish 
# to backup. A vault is simply a directory within the root directory
# of the filesystem on a bank. You can choose any directory name you want,
# but something descriptive is usually best. Dirvish determines what is
# a vault and what is not based on the presence of a dirvish/ subdirectory
# containing a file named default.conf. 
#
# Example configuration: You have two banks: 
#
# 'c:\backup\servers' and 'c:\backup\clients'.
#
# Bank 'Servers' contain two vaults: file-server-a and file-server-b
# Bank 'Clients' contains one vault: client-a
#
# Directory structure below is needed for the configuration above:
#
# c:\backup\servers\
# c:\backup\servers\file-server-a\dirvish\
# c:\backup\servers\file-server-a\dirvish\default.conf
#
# c:\backup\servers\
# c:\backup\servers\file-server-b\dirvish\
# c:\backup\servers\file-server-b\dirvish\default.conf
#
# c:\backup\clients\
# c:\backup\clients\client-a\dirvish\
# c:\backup\clients\client-a\dirvish\default.conf

bank:
	c:\snapshot

# Each snapshot, or image, within the vault must have a directory name. 
# The default is specified with the image-default. Valid tokens are strftime
# compliant (available from start menu). A pleasant default is the familiar
# four digit year, followed by a two digit month and day, as specified below. 

image-default: %Y%m%d

# All backups performed with Dirvish are logged. Each vault's snapshot
# has a log associated with it. You can choose to have this log, which
# includes all the output from running rsync with its verbose option,
# compressed with either gzip or bzip2. The former is a good choice. 
# The default is to use no compression for the log file at all. You can
# specify either of the former two compression programs by using their
# respective names. For no compression, simply omit the directive log 
# entirely or specify text.

log: gzip

# A searchable index can be created by Dirvish after each snapshot has 
# been taken, which is used later when you run dirvish-locate to search
# for a file you may wish to restore. If you do not specify this 
# directive, no index will be created. You can use the same values as
# you can for log, above. Additionally, you can specify none if you wish
# for no index to be created, but do not want to omit including the
# directive for clarity. 

index: gzip

# exclude directive lets you prune files from the filesystem you may not 
# want backed up. Files related to virtual memory management, like 
# pagefile.sys need not be backed up. You may also wish to exclude temporary
# files. File exclusion can be specified using all the regular expression
# rules used by rsync, covered in great detail in that program's manual.
# (Available from start menu)
#
# As of version hardBackup 1.0.0, they should be defined in cygwin path
# format : 'c:\test' becomes '/cygdrive/c/test'

exclude:

	/pagefile.sys
	*Temporary Internet Files/
	*Cookies/*
	*Recent/*
	*[cC]ache/*
	*Local Settings/Temp/*
	
# an expire-default is a wise idea. Otherwise, none of your snapshots
# will ever expire. Generally it is desirable for snapshots to be deleted
# eventually after being transferred to longer term storage media. 
# expire-default is applied if no other expiration mechanism, such as
# expire-rule, matches a snapshot. You can specify a suffix of days, 
# weeks, months, years, or anything else supported by the Time::ParseDate
# Perl module. The directive below results in a default retention period
# of 30 days. 

expire-default: +30 days

# Last, you will need a Runall directive, which is a list of all vaults
# you want Dirvish to perform backups on when dirvish-runall is run. 
# If you specify a time, the snapshot will have its modification time
# stamp changed to the specified time. If you specify a time that is
# in the future when dirvish-runall is run, your time will be forced
# 24 hours into the past. The specified time is entirely cosmetic.
# It gives the illusion of a snapshot being taken at some specific time
# for consistency. If you perform daily backups at 3 A.M., for example,
# it might be confusing to users if the snapshots are accessible to them.
# Instead, you can make it appear as if the backups actually run at 11 P.M.
# In either case, you can entirely omit a specified time. 

Runall:
	nt
	docs