DUMPNET ======= $Id: README,v 1.15 2005/10/01 18:11:17 lukasfeiler Exp $ Table of Contents ----------------- 1 Directory Structure 2 What is dumpnet? 3 Requirements 4 License 5 Intended Use 6 Tested Setups 7 Sample Configurations 1 Directory Structure --------------------- +---bin......................... all executables +---conf........................ all configuration files | +---_defaults............... default configuration files | +---_example_freebsd........ sample FreeBSD target host configuration | +---_example_freebsd_dosudo. sample FreeBSD target host configuration | | with dosudo set to true | +---_example_linux.......... sample Linux target host configuration | +---_example_linux_dosudo... sample Linux target host configuration | | with dosudo set to true | +---_example_openbsd........ sample OpenBSD target host configuration | +---_example_openbsd_dosudo. sample OpenBSD target host configuration | | with dosudo set to true | +---_example_solaris........ sample Solaris target host configuration | +---_example_solaris_dosudo. sample Salaris target host configuration | | with dosudo set to true | +---_example_windows........ sample Windows target host configuration +---doc | +---html.................... the man pages in html format as published | |........................... on http://dumpnet.sourceforge.net | +---catman.................. the ready to install/installed man pages | +---pod..................... the unformatted man pages in pod format +---log......................... log file directory +---tmp......................... directory for temporary files 2 What is dumpnet? ------------------ Dumpnet is a tool for performing remote backups to a hard drive. Major Features: 1. Dumpnet is implemented in bash scripts only. 2. It's a hard disk based backup solution - no tapes are necessary. 3. The backup machine on which dumpnet is installed func- tions as a SSH client while the target hosts (the hosts to be backuped) function as SSH servers. Public key authentication is used. 4. Due to the use of SSH all traffic between the backup machine and the target hosts is encrypted and can be run over the Internet. 5. Dumpnet only needs to be installed on the backup machine. 6. Dumpnet is flexible and highly configurable. 7. Incremental filesystem backups can be done easily using dump, tar or rsync. 8. Integration of auditing and intrusion detection tools such as AIDE (Advanced Intrusion Detection Environ- ment) and nmap. 9. Full support for sudo - no remote root login is required. 10. The report generated about a backup session can be sent via email. Encryption using GnuPG is supported. 11. It provides extensive logging. 12. Dumpnet was tested on SuSE, Fedora & Debian Linux, FreeBSD, OpenBSD, Solaris and Cygwin (Windows). See section 6, Tested Setups. 3 Requirements -------------- Dumpnet host: - Any Linux/Unix system or Cygwin - Bash installed at /bin/bash - The GNU versions of date, find and md5sum - A version of grep that understands the -f option - AIDE if you want to use dumpnet.host.aide - dump & restore if you want to use dumpnet.host.fstab.dump - rsync if you want to use dumpnet.host.fstab.rsync - (Open)SSH client set up with public key authentication - The command `mail' or under Cygwin `email' - sudo if you want to use rsync and preserve ownerships and devices - GnuPG (or something similar) to encrypt outgoing mails Target host: - Any Linux/Unix system or Cygwin - Bash installed - The GNU version of date - AIDE if you want to use dumpnet.host.aide - The GNU version of tar if you want to use dumpnet.host.fstab.tar - dump & restore if you want to use dumpnet.host.fstab.dump - rsync if you want to use dumpnet.host.fstab.rsync - sudo if remote root logins are not allowed - (Open)SSH server set up with public key authentication Automated Connection - The dumpnet host must be able to connect to the target hosts via (Open)SSH without ssh prompting for any passwords 4 License --------- Dumpnet is released under the terms of the Lesser General Public License (LGPL). Please see the LICENSE file for details. The official web site is http://dumpnet.sourceforge.net/. 5 Intended Use -------------- Dumpnet was designed to backup 1 up to 10 servers. 6 Tested Setups --------------- dumpnet was tested with the following dumpnet host OSs: - SuSE Linux Pro 9.2 - OpenBSD 3.7-RELEASE - FreeBSD 5.4-RELEASE dumpnet was tested with the following target host OSs: - SuSE Linux Pro 9.2 - SuSE Linux Pro 9.3 - RedHat Fedora Core 4 - Debian GNU/Linux 3.1 "Sarge" - FreeBSD 5.3-STABLE - FreeBSD 5.4-RELEASE - OpenBSD 3.6-STABLE - OpenBSD 3.7-RELEASE - Solaris 10 - Windows with Cygwin DLL v1.5.18-1 7 Sample Configurations ----------------------- Dumpnet comes with a the a couple of target host sample configurations. They are all named conf/_example_*. Some of them have _dosudo appended to indicate that they use sudo on the target host. These sample configurations try to make use of every feature dumpnet provides. Note that they are very similar to each other. To get the example configurations running yourself the following steps need to be taken: - dumpnet.userdefined.conf does a MySQL database dump using mysqldump; make sure you have MySQL running and mysqldump installed where specified in dumpnet.userdefined.conf. - dumpnet.userdefined.conf encrypts one of the backups using GnuPG before transferring it to the dumpnet host. A public key needs to be installed to make this work. Change dumpnet.userdefined.conf to match its name. - dumpnet.fstab.conf uses rsync in a way that requires it to run with root privileges on the dumpnet host. The user dumpnet should therefore be able to sudo without a password on the dumpnet host. - dumpnet.info.conf and dumpnet.diff.conf use nmap on the dumpnet host to scan the target host - install nmap. - dumpnet.reportmail.conf encrypts the report using GnuPG before sending it via mail. Install your keys and change dumpnet.reportmail.conf accordingly. - all _example_*_dosudo examples require that the account used to log into the target host (sudoer) is able to run sudo without a password. Dumpnet comes with the following target host sample configurations: _example_freebsd........ sample FreeBSD target host configuration _example_freebsd_dosudo. sample FreeBSD target host configuration with dosudo set to true _example_linux.......... sample Linux target host configuration _example_linux_dosudo... sample Linux target host configuration with dosudo set to true _example_openbsd........ sample OpenBSD target host configuration _example_openbsd_dosudo. sample OpenBSD target host configuration with dosudo set to true _example_solaris........ sample Solaris target host configuration _example_solaris_dosudo. sample Salaris target host configuration with dosudo set to true _example_windows........ sample Windows target host configuration