Incorporate changes for version 2.0

dist/etc/ribs/conf-available/ribs.conf.sample

@@ -20,17 +20,17 @@
 #   backed up. If not, the directory itself will be backed up.
 #   NOTE: Special characters must be escaped with backslashes!
 #
-source_dir=/var/www/
+#source_dir=/var/www/
 #
 # Backup root directory - The directory on the backup storage where the
 #   backups are stored. For offline storage, this is the mount point of 
 #   the backup drive filesystem. For remote storage, this is the path on
-#   the remote server. Must be writable to user running ribs. This must
+#   the remote server. Must be writable to user running RIBS. This must
 #   be an absolute, not a relative path. Directories named as the date
 #   of the backups will be created here containing the backed up files.
 #   NOTE: Special characters must be escaped with backslashes!
 #
-backup_root=/mnt/incremental_backup_dir
+#backup_root=/mnt/incremental_backup_dir
 #
 # Backup subdirectory - A subdirectory of backup_root in which to store 
 #   the backup date directories. If this is not set, the date 
@@ -52,7 +52,7 @@ backup_root=/mnt/incremental_backup_dir
 #   complete, directories with dates older than this limit will be
 #   deleted.
 #
-day_limit=90
+#day_limit=90
 #
 # Storage type - Where the backups are to be stored. Only one of the
 #   three options should be specified. Set the option you want, then 
@@ -63,11 +63,15 @@ day_limit=90
 #   offline - Back up to offline storage that must be mounted. Can be
 #       anything that you can mount and unmount, including a filesystem
 #       on a local block device or a remote NFS or CIFS/SMB share.
+#       NOTE: To use offline storage, you must have superuser privileges
+#       in order to mount and unmount the device. RIBS will abort if you
+#       set storage_type to offline and you are not running as root or
+#       with sudo.
 #   remote - Back up to a remote system directly via rsync. If you use
 #       this, you must define remote_user_host below and setup pubkey 
 #       authentication vi ssh for the remote user and host.
 #
-storage_type=remote
+#storage_type=remote
 #
 
 
@@ -81,22 +85,26 @@ storage_type=remote
 [offline]
 # Options for offline storage type
 #
-# Options in this section are required if storage_type above is set
-# to offline. Otherwise, they are ignored. 
 #
 # Mount parameters - Storage filesystem mount parameters. Should be what
 #   you'd type on the command line between the word "mount" and the 
 #   mountpoint. See the manual page for the mount command (man 8 mount)
-#   for the available options.
+#   for the available options. If this is blank ("") or not defined,
+#   RIBS will attempt to mount backup_root, defined above in the 
+#   [General] section, with no parameters, hoping that it is listed in
+#   /etc/fstab (man 5 fstab). You must run RIBS with superuser
+#   privileges for the offline storage type to work, since it requires
+#   mounting and unmounting filesystems.
 #
-mount_parameters=-t ext4 -U 433a2e61-25aa-4da5-a7c7-4d730a5793e7
+#mount_parameters=-t ext4 -U 433a2e61-25aa-4da5-a7c7-4d730a5793e7
 #mount_parameters="-t nfs nfsserver:/srv/ribs-backups"
 #mount_parameters="/dev/sdc1"
 #
 # Remount read-only - Set this to True if storage should be remounted in
-#   read-only mode when not being used for backups, False if not.
+#   read-only mode when not being used for backups, False if not. If 
+#   blank ("") or not defined, the default is False.
 #
-remount_ro=True
+#remount_ro=True
 #
 
 [remote]
@@ -112,5 +120,5 @@ remount_ro=True
 #   usually done with the ssh-copy-id command, which also takes care of
 #   adding the host's key fingerprint to the local known_hosts file.
 #
-remote_user_host=user@backupserver
+#remote_user_host=user@backupserver
 #