README

   1
   2                               BackupPC
   3
   4                             Version __VERSION__
   5
   6                             __RELEASEDATE__
   7
   8          Copyright (C) 2001-2003 Craig Barratt.  All rights reserved.
   9
  10       This program is free software; you can redistribute it and/or
  11       modify it under the terms of the GNU General Public License.
  12                         See the LICENSE file.
  13
  14 QUICK START:
  15 -----------
  16
  17 The latest version of BackupPC can be fetched from:
  18
  19     http://backuppc.sourceforge.net
  20
  21 If you will use SMB for WinXX clients, you will need smbclient and
  22 nmblookup from the Samba distribution.  Version >= 2.2.0 of Samba is
  23 recommended (smbclient's tar feature in 2.0.7 has bugs for certain
  24 path lengths).  See www.samba.org for source and binaries.
  25
  26 To install BackupPC run these commands as root:
  27
  28     tar zxf BackupPC-__VERSION__.tar.gz
  29     cd BackupPC-__VERSION__
  30     perl configure.pl
  31
  32 This will automatically determine some system information and prompt you
  33 for install paths.
  34
  35 INTRODUCTION:
  36 ------------
  37
  38 BackupPC is a high-performance, enterprise-grade system for
  39 backing up Linux and WinXX PCs and laptops to a server's disk.
  40 BackupPC is highly configurable and easy to install and maintain.
  41
  42 Given the ever decreasing cost of disks and raid systems, it is now
  43 practical and cost effective to backup a large number of machines onto
  44 a server's local disk or network storage. This is what BackupPC does.
  45 For some sites, this might be the complete backup solution. For other
  46 sites, additional permanent archives could be created by periodically
  47 backing up the server to tape.  A variety of Open Source systems are
  48 available for doing backup to tape.
  49
  50 BackupPC is written in Perl and extracts backup data via SMB (using Samba),
  51 rsync, or tar over ssh/rsh/nfs.  It is robust, reliable, well documented
  52 and freely available as Open Source on SourceForge.
  53
  54 FEATURES:
  55 --------
  56
  57   - A clever pooling scheme minimizes disk storage and disk IO. Identical
  58     files across multiple backups of the same or different PCs are stored
  59     only once resulting in substantial savings in disk storage.
  60
  61   - One example of disk use: 95 latops with each full backup averaging
  62     3.6GB each, and each incremental averaging about 0.3GB.  Storing
  63     three weekly full backups and six incremental backups per laptop
  64     is around 1200GB of raw data, but because of pooling and compression
  65     only 150GB is needed.
  66
  67   - No client-side software is needed.  The standard smb protocol is used
  68     to extract backup data on WinXX clients.  On *nix clients, either rsync
  69     or tar over ssh/rsh/nfs is used to backup the data.  Various alternatives
  70     are possible: rsync can also be used with WinXX by running rsyncd/cygwin.
  71     Similarly, smb could be used to backup *nix file systems if they are
  72     exported as smb shares.
  73
  74   - A powerful http/cgi user interface allows administrators to view log
  75     files, configuration, current status and allows users to initiate and
  76     cancel backups and browse and restore files from backups.
  77
  78   - Flexible restore options.  Single files can be downloaded from
  79     any backup directly from the CGI interface.  Zip or Tar archives
  80     for selected files or directories from any backup can also be
  81     downloaded from the CGI interface.  Finally, direct restore to
  82     the client machine (using SMB, rsync or tar) for selected files
  83     or directories is also supported from the CGI interface.
  84
  85   - Supports mobile environments where laptops are only intermittently
  86     connected to the network and have dynamic IP addresses (DHCP).
  87
  88   - Flexible configuration parameters allow multiple backups to be performed
  89     in parallel, specification of which shares to backup, which directories
  90     to backup or not backup, various schedules for full and incremental
  91     backups, schedules for email reminders to users and so on.  Configuration
  92     parameters can be set system-wide or also on a per-PC basis.
  93
  94   - Users are sent periodic email reminders if their PC has not
  95     recently been backed up.  Email content, timing and policies
  96     are configurable.
  97
  98   - Tested on Linux and Solaris hosts, and Linux, Win95, Win98, Win2000
  99     and WinXP clients.
 100
 101   - Detailed documentation.
 102
 103   - Open Source hosted by SourceForge and freely available under GPL.
 104
 105 RESOURCES:
 106 ---------
 107
 108 Complete documentation is available in this release in doc/BackupPC.pod
 109 or doc/BackupPC.html. You can read doc/BackupPC.pod with perldoc and
 110 doc/BackupPC.html with any browser.  You can also see the documentation
 111 and general information at:
 112
 113     http://backuppc.sourceforge.net
 114
 115 The SourceForge project resides at:
 116
 117     http://sourceforge.net/projects/backuppc
 118
 119 You are encouraged to subscribe to any of the mail lists available
 120 on sourceforge.net:
 121
 122     http://lists.sourceforge.net/lists/listinfo/backuppc-announce
 123     http://lists.sourceforge.net/lists/listinfo/backuppc-users
 124     http://lists.sourceforge.net/lists/listinfo/backuppc-devel
 125
 126 The backuppc-announce list is moderated and is used only for
 127 important announcements (eg: new versions).  It is low traffic.
 128 You only need to subscribe to one of users and announce: backuppc-users
 129 also receives any messages on backuppc-announce.
 130
 131 The backuppc-devel list is only for developers who are working on BackupPC.
 132 Do not post questions or support requests there.  But detailed technical
 133 discussions should happen on this list.
 134
 135 To post a message to the backuppc-users list, send an email to
 136
 137     backuppc-users@lists.sourceforge.net
 138
 139 Do not send subscription requests to this address!