openduckbill/openduckbill.conf

   1 # Openduckbill configuration file.
   2 # This is an YAML file and has four different sections
   3 #
   4 # ----- Global variable declaration section ----
   5 global :
   6 # Backup method
   7 # How we will access the backup server. This can be LOCAL|NFS|RSYNC
   8 # Also define a section below with server, remote and local mount paths
   9  backupmethod : LOCAL
  10 # Time in seconds
  11  syncinterval : 300
  12 # Wait for these many filesystem changes to occur. Integer
  13  commitchanges : 64
  14 # Keep a backup of files which were synced to backup destination. The backup
  15 # files will have a file extention ".odb~". Openduckbill maintains an exact copy
  16 # of the entries in the backup directory. If "maintainprevious" is specified as "yes"
  17 # openduckbill will keep another copy of the modified file. In effect, openduckbill
  18 # will maintain the current and previous version of the modified file at the backup
  19 # destination. This will increase the # disk usage at the destination. [Boolean] [yes|no]
  20  maintainprevious : no
  21 # Retain files/directories which are not in the scheduled list? [Boolean] [yes|no]
  22 # Default is yes
  23  retainbackup : yes
  24 # When entries are removed from backup schedule, these remain
  25 # in the backup drive and are no longer backed up. If there are
  26 # files/directories which are older than "retentiontime" and,
  27 # not in the schedule (entry list) to be backed up, then these
  28 # are removed. (seconds) [Default = 7 Days = 604800 Seconds]
  29 # Valid if "retainbackup" is yes
  30  retentiontime : 604800
  31
  32 # ----- Backup method declaration section ----
  33 LOCAL :
  34 # Some directory on localmachine. This could be an NFS hard mount.
  35  localmount : "/backup/odb_backup"
  36
  37 NFS :
  38 # Make sure you have the following line in your /etc/fstab
  39 #
  40 # $server:$remotemount $localmount  nfs  $nfsmountoptions,user,auto  0 0
  41 #
  42 # The reason being, openduckbill tries to run the command `mount $localmount`,
  43 # which doesn't require password if the line is already mentioned in /etc/fstab
  44 # Replace $server, $remotemount, $localmount with values mentioned below.
  45 #
  46 # While modifying the server address, make sure to update entry in /etc/fstab
  47 # NFS server (FQDN)
  48  server : "server1.mydomain.com"
  49 # Remote NFS exported partition
  50  remotemount : "/backup/odb_server1"
  51 # Local mount point for the NFS partition
  52  localmount : "/mnt/odb_mount"
  53 # Other NFS mount options (comma separated, within quotes. eg. "rw,nosuid")
  54  nfsmountoptions : "rw,nosuid,soft"
  55
  56 # RSYNC over SSH
  57 RSYNC :
  58 # SSH server (FQDN)
  59  server : "server2.mydomain.com"
  60 # ssh server port (mention port number if your server is running on a
  61 # non-standard port. Default is 22)
  62  sshport : 22
  63 # Remote directory path on server
  64  remotemount : "/backup/odb_server2"
  65
  66 # ----- Exclude declaration section ----
  67 # Files/directories to be excluded from backup paths defined in "entry" section.
  68 exclude :
  69  - "*.mp3"
  70  - "*.mp4"
  71  - "*.jpg"
  72  - "*.jpeg"
  73  - "*.png"
  74  - "*.gif"
  75  - "*.log*"
  76
  77 # ----- Backup entry declaration section ----
  78 # Backup entries
  79 # recursive : yes | no
  80 # Per entry include, exlcude : same format as toplevel exclude declaration
  81 #   Use absolute paths for better pattern matching. :-)
  82 entry :
  83  - name : home_backup
  84    path : "~/"
  85    recursive : no
  86    include :
  87     - "*.log*"
  88  - name : docs_backup
  89    path : "~/Documents"
  90    recursive : yes
  91    exclude :
  92     - "*~"
  93     - "~/Documents/Personal/*"
  94  - name : projects_backup
  95    path : "~/Projects/"
  96    recursive : yes
  97    include :
  98     - "*.gif"