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