ISiBackup Documentation

Dr. Marcus Holthaus

     
    

Simon Huerlimann

     
    

Revision History
Revision 1.4.9-82004-10-04Revised by: mh
Documentation completion, concerning debian package isibackup-1.4.9-8; Corrections in spelling; changes due to program changes
Revision 1.4.52004-02-14Revised by: mh
Documentation completion, concerning debian package isibackup-1.4.5
Revision 1.4.32004-02-13Revised by: mh
Documentation completion, concerning debian package isibackup-1.4.3
Revision 1.4.12004-02-07Revised by: mh
Major documentation rework, concerning debian package isibackup-1.4.1
Revision 1.42003-08-21Revised by: mh
First public relase.
Revision 0.12002-09-24Revised by: sh
Copy from isitools manual

ISiBackup is a backup program.

It is capable of backing up any collection of directories inside a filesystem to any other single location in a file system. It can handle system and data differently. it allows for full, incrementatal and differential backups.

ISi is an abbreviation for the german term Informations-Sicherheit, which is information security in english. Furthermore, the german pronounciation of isi is like the english one of easy.


Table of Contents
1. Overview
1.1. History
1.2. Features
1.3. Copyright Information
1.4. Disclaimer
2. Installation
3. Configuration Files
4. Using ISiBackup
4.1. Synapsis
4.2. Simple Backup
4.3. Backup results
4.4. Display
5. How it works
5.1. Initialisation
5.2. Directory selection
5.3. Directory Processing
5.3.1. File selection
5.3.2. Collection
5.3.3. Compression
5.3.4. Encryption
6. Configuration Parameters and Command Line Options
7. Remarks

Warning

Warning and Disclaimer: As with all software that leaves a closed environment to earn its merits in the wild wild world, there have to be errors and malfunctions in this software that prevent a successful use and that may even damage your system. While we are interested in getting to know these malfunctions so that we can fix them, we can not in any form take responsibility for what it does to your system, nor can we promise to do remove these bugs, and hence if you use this software, it's on your own risk.

1. Overview

ISiBackup's primary intention is to save the data on a system. Its secondary goal is to allow for a quick recovery from a fatal system failure, e.g. as the result of hard drive crash or even sabotage like the one that can be caused by hacking attacks. The third goal is to provide a backup infrastructure that allows you to use it in many different ways to manage your backups. We are by no way near that third goal yet.

1.1. History

ISiBackup was originally developed by the author to make backups of the data on his computer. As with many programs, the requirements grew over time, and so did the features of the program. Furthermore, in the beginning, it was OK to just copy the script to every new one of his computers, while later, when keeping track of the distributed versions became hard, the debian package management system was utilized to provide for a consistent release management. The first script was created in 1996 for his then sole linux machine. Debianization first took place in 1999 and was done by Simon Hürlimann, a then employee of Marcus's company IMSEC GmbH.

The ISiBackup scripts were adapted / updated / splitted-up / merged a lot over time. Version 1.4 was the first one-package release that ever left the original environment. The authors invested a lot of work into the professionalisation of these tools. They added documentation (man, info, DocBook, ...), unified command-line interfaces, packaging for debian (.deb) and other stuff. Development continues, the wish list is long.

1.2. Features

ISiBackup has the following features:

  • creation of backups of data (files, directories) to a directory

  • compression of files

  • encryption of files

  • remote storage (push) and remote fetching (pull) of backup data

  • handling of sets of files

  • support for full, incremental and differential backups

  • in-place refresh of previously created backups

ISiBackup is more or less one script with lots of parameters and commmands. Additional scripts are avaliable (and part of the package) for

  • restoring data from a backup (isirestore)

  • calculation the occupied backup space (isibus)

  • reminding the change of backup disk (isiremind)

  • mailing the success or failures of executed programs(isibackupsize)

  • managing the removal of old backups after new ones are available (deleteoldbackups, deleteolddiffbackups)

Futhermore, it bears the common features of linux programs, such as

  • integration in debian environment with crontab and logrotate entries

  • logging

  • integrated use of tar, zip, bzip2, gzip, gnupg and pgp as available on the system

Planned features include

  • auto deletion of obsolete backups

  • integration of mkisofs to automatically create iso image files

It's funny that by using ISiBackup,

  • the replication of a system becomes easy (just backup on one system and restore on another)

  • the archivation of data is supported

The most notable property of ISiBackup ist that it does not pack all of the source into one giant archive, and not even into a set of volumes, but in that its result is a directory tree (almost) identical to the backed up source directory tree. The main difference is that in the backup tree, the files are (usually) collected into one file per directory, that they are (usually) compressed and (optionally) encrypted. By keeping the directory structure intact,

  • file handling is easier (no huge file operations necessary),

  • the backup can be stored to the same file system types as the original (no large file support needed if not already needed for the source),

  • the backup can easily be split up (just move some of the backup directories to one medium, and some others to the next one), and

  • restoration of files is easily done by just directly applying the standard unzip, gpg or tar tools that were used in creating the backup (alternatively, there is an isirestore script).

1.3. Copyright Information

This document is copyrighted (c) 1999-2004 by IMSEC GmbH.

1.4. Disclaimer

No liability for the contents of this documents can be accepted. Use the concepts, examples and other content at your own risk. As this is a new edition of this document, there may be errors and inaccuracies, that of course might be damaging your system. Proceed with caution, and although this is highly unlikely, the author(s) do not take any responsibility for any consequences of the use of this program.

All copyrights are held by their by their respective owners, unless specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark.

Naming of particular products or brands should not be seen as endorsements.

Acknowledgements and contribution: Writing and testing ISiBackup has taken up a good part of my time in 2000 and 2001, and documenting it was a task I always postponed until now. However, it was worth it, and I am happy to have been able to finish a first version. May my effort enhance your prosperity. That having said, I am fully aware that I am just one of the great many individuals and organisations contributing to open source development, to linux and other great systems. Hereby I thank you all for your effort in creating dependable and freely available information systems. ISiBackup is, up to now, my major manifest contribution to this community. Apart from that I continue to sponsor open-source related systems mentally, by providing connectivity and partly even by spending money on developers (employees, co-workers, partners). Let's go on building the information society.