v1.5.0
authorcbarratt <cbarratt>
Sat, 10 Aug 2002 22:47:37 +0000 (22:47 +0000)
committercbarratt <cbarratt>
Sat, 10 Aug 2002 22:47:37 +0000 (22:47 +0000)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..8dc7c8a
--- /dev/null
+++ b/README
@@ -0,0 +1,132 @@
+
+                              BackupPC
+
+                            Version __VERSION__
+
+                            __RELEASEDATE__
+
+         Copyright (C) 2001-2002 Craig Barratt.  All rights reserved.
+
+      This program is free software; you can redistribute it and/or
+      modify it under the terms of the GNU General Public License.
+                        See the LICENSE file.
+
+QUICK START:
+-----------
+
+The latest version of BackupPC can be fetched from:
+
+    http://backuppc.sourceforge.net
+
+If you will use SMB for WinXX clients, you will need smbclient and
+nmblookup from the Samba distribution.  Version >= 2.2.0 of Samba is
+recommended (smbclient's tar feature in 2.0.7 has bugs for certain
+path lengths).  See www.samba.org for source and binaries.
+
+To install BackupPC run these commands as root:
+
+    tar zxf BackupPC-__VERSION__.tar.gz
+    cd BackupPC-__VERSION__
+    perl configure.pl
+
+This will automatically determine some system information and prompt you
+for install paths.
+
+INTRODUCTION:
+------------
+
+BackupPC is a high-performance, enterprise-grade system for
+backing up Linux and WinXX PCs and laptops to a server's disk.
+BackupPC is highly configurable and easy to install and maintain.
+
+Given the ever decreasing cost of disks and raid systems, it is now
+practical and cost effective to backup a large number of machines onto
+a server's local disk or network storage. This is what BackupPC does.
+For some sites, this might be the complete backup solution. For other
+sites, additional permanent archives could be created by periodically
+backing up the server to tape.  A variety of Open Source systems are
+available for doing backup to tape.
+
+BackupPC is written in Perl and extracts backup data either via
+SMB (using Samba) or tar over ssh/rsh/nfs.  It is robust, reliable,
+well documented and freely available as Open Source on SourceForge.
+
+FEATURES:
+--------
+
+  - A clever pooling scheme minimizes disk storage and disk IO. Identical
+    files across multiple backups of the same or different PCs are stored
+    only once resulting in substantial savings in disk storage.
+
+  - One example of disk use: 95 latops with each full backup averaging
+    3.6GB each, and each incremental averaging about 0.3GB.  Storing
+    three weekly full backups and six incremental backups per laptop
+    is around 1200GB of raw data, but because of pooling and compression
+    only 150GB is needed.
+
+  - No client-side software is needed.  The standard smb protocol is used
+    to extract backup data on WinXX clients.  On linux clients, tar
+    over ssh/rsh/nfs is used to backup the data (or alternatively
+    Samba can be installed on the linux client to provide smb shares).
+
+  - A powerful http/cgi user interface allows administrators to view log
+    files, configuration, current status and allows users to initiate and
+    cancel backups and browse and restore files from backups.
+
+  - Flexible restore options.  Single files can be downloaded from
+    any backup directly from the CGI interface.  Zip or Tar archives
+    for selected files or directories from any backup can also be
+    downloaded from the CGI interface.  Finally, direct restore to
+    the client machine (using SMB or tar) for selected files or
+    directories is also supported from the CGI interface.
+
+  - Supports mobile environments where laptops are only intermittently
+    connected to the network and have dynamic IP addresses (DHCP).
+
+  - Flexible configuration parameters allow multiple backups to be performed
+    in parallel, specification of which shares to backup, which directories
+    to backup or not backup, various schedules for full and incremental
+    backups, schedules for email reminders to users and so on.  Configuration
+    parameters can be set system-wide or also on a per-PC basis.
+
+  - Users are sent periodic email reminders if their PC has not
+    recently been backed up.  Email content, timing and policies
+    are configurable.
+
+  - Tested on Linux and Solaris hosts, and Linux, Win95, Win98, Win2000
+    and WinXP clients.
+
+  - Detailed documentation.
+
+  - Open Source hosted by SourceForge and freely available under GPL.
+
+RESOURCES:
+---------
+
+Complete documentation is available in this release in doc/BackupPC.pod
+or doc/BackupPC.html. You can read doc/BackupPC.pod with perldoc and
+doc/BackupPC.html with any browser.  You can also see the documentation
+and general information at:
+
+    http://backuppc.sourceforge.net
+
+The SourceForge project resides at:
+
+    http://sourceforge.net/projects/backuppc
+
+You are encouraged to subscribe to either the backuppc-announce
+or backuppc-users mail list on sourceforge.net at either:
+
+    http://lists.sourceforge.net/lists/listinfo/backuppc-announce
+    http://lists.sourceforge.net/lists/listinfo/backuppc-users
+
+The backuppc-announce list is moderated and is used only for
+important announcements (eg: new versions).  It is low traffic.
+You only need to subscribe to one list: backuppc-users also
+receives any messages on backuppc-announce.
+
+To post a message to the backuppc-users list, send an email to
+
+    backuppc-users@lists.sourceforge.net
+
+Do not send subscription requests to this address!