dumpnet.fstab.conf - the host-specific dumpnet.host.fstab configuration file
A dumpnet.fstab.conf file is used to configure the module dumpnet.host.fstab for a specific target host. It should be placed in a host configuration directory (a subdirectory of $DUMPNET_HOME/conf/) - see the CONFIGURATION section in dumpnet(8) for details. The general format of this configuration file is specified in the section CONFIGURATION FILE FORMAT in dumpnet(8).
Each directory/filesystem to backup is specified on a separate line; fields on each line are separated by spaces or tabs. Lines starting with `#' are comments - for the exeption of the statements ``option'' and ``extends'', see below. The order of records in dumpnet.fstab.conf is important because dumpnet.host.fstab will perform the backup in the order specified. The configuration file knows the following fields (in this order):
- Mount Point
-
The mount point of the filesystem or the name of the directory to backup.
- Utility
-
The utility to use for the backup: ``dump'', ``tar'' or ``rsync''. dumpnet.host.fstab will call dumpnet.host.fstab.$utility to do the job.
- Compression
-
Compression of the dump/archive: ``remote'', ``local'' or ``none''.
- remote
-
Does the compression on the target host before transferring the data. This requires more CPU-resources on the target host but is fastest on slow connections. It is recommended for use over the Internet.
- local
-
Does the compression on the backup machine after transferring the data. This is easyier to handle for the target host but requires a fast connection and a lot of CPU-power on the backup machine. For dumpnet.host.fstab.rsync ``local'' compression is equivalent to ``none''.
- none
-
Does no compression at all. Choose this option if the data is already compressed or if you always need it to be available in uncrompressed form for some reason.
- TOC (Table Of Contents)
-
Whether to create a table of contents: ``yes'', ``no'', ``true'' or ``false''. It will be stored in a file named like the archive/dump with ``.toc'' appended. The TOC for tar is created using `tar tf'; the one for dump is created using `$local_restore -tf' (see dumpnet.conf(8) for $local_restore). The TOC for rsync is created using a find command.
- Level
-
The level or level mode to use for this filesystem/directory. Please see the LEVELS and LEVEL MODES sections of dumpnet(8) for details.
- Dirname
-
The name of the sub-directory where the archives/dumps are to be stored: $backupDir/$host/$dirname. When backing up top-level directories (like /usr or /var) it is recommended to use the name of the backuped directory (``usr'' or ``var''). If this field is empty (this would require the last field to be empty as well) the dirname is generated by replacing all slashes (`/') in the first field Mount Point. For example /home/jdoe/somedir would become ``homejdoesomedir''.
-
If dirname is prefixed by a plus sign (``+'') dumpnet.host.fstab.rsync will preserve owner and devices (rsync options -o and -D implied by option -a). This requires root privileges on the dumpnet host. Therefore the rsync command will be run using sudo. Please see the rsyncPreserveOwnerAndDevices option below for details.
- Cleanup Policy
-
The cleanup policy to apply for the backups of this filesystem/directory. Please see the CLEANUP section in dumpnet(8) for details.
You can use the ``option'' and ``extends'' statements in this file - as documented in the CONFIGURATION FILE FORMAT section in dumpnet(8). This allows you to overwrite options set in the host configuration file - see dumpnet.HOST.conf(8). You might want to set the following options:
- dosudo
-
If set to ``true'' all dump/tar commands will be run using sudo on the target host. This means that dumpnet.host.fstab.dump and dumpnet.host.fstab.tar will both be called with the -S option. The default value for dosudo is ``false''. The location of the sudo command can be configured using the option sudo in dumpnet.HOST.conf(8). Keep in mind that the login name used to log into the target host can only be defined in dumpnet.HOST.conf.
-
Example:
-
# option dosudo=true
- read_options
-
Options to be passed to the bash builtin read to read in the configuration file. In some cases you will want to use the -r option which causes the backslash not to act as an escape character. The backslash is considered to be part of the line. In particular, a backslash-newline pair may not be used as a line continuation. If read_options is not set (or set to an empty string) a backslash-newline pair can be used as a line continuation but all literal backslashes will have to be escaped.
-
Example:
-
# option read_options="-r"
- rsyncPreserveOwnerAndDevices
-
This option applies only to dumpnet.host.fstab.rsync(8). If set to ``true''
dumpnet.host.fstab.rsync will run rsync as root on the dumpnet host to preserve owner and devices (rsync options -o and -D implied by option -a). sudo will be used to gain root previleges (please see the $local_sudo option in dumpnet.conf(8)).
-
rsync is always called with the -a option which implies the options -D (preserve devices) and -o (preserve ownership). But devices and ownership will actually only be preserved if rsync is run with root previleges on the dumpnet host. The result would be a directory tree exectly as on the target host. This means that the dumpnet user would eventually not be able to read files contained in the backup directory. To be able to use the restore mode it is recommended to create a TOC-file (see the TOC field above). Because the contents of the backup directory will be read with root previleges if necessary and stored in the TOC-file owned by the dumpnet user. Because of these complications the default is not to run rsync with root previleges on the dumpnet host which results in all files being owned by the dumpnet user. If rsync is run as root sudo will be used - please see the $sudo option in dumpnet.HOST.conf(8). For some more information please see the -n option of dumpnet.host.fstab.rsync(8).
dumpnet.host(8)
dumpnet.host.fstab(8)
dumpnet.host.fstab.dump(8)
dumpnet.host.fstab.tar(8)
Lukas Feiler <lukas.feiler@lukasfeiler.com>
dumpnet is published under the LGPL (GNU LESSER GENERAL PUBLIC LICENSE). Please see the LICENSE file contained in the installation tarball for details. The official web site is http://dumpnet.sourceforge.net.