* On the phase 2 retry pass with rsync, verify the cached checksums
[BackupPC.git] / doc-src / BackupPC.pod
1 =head1 BackupPC Introduction
2
3 This documentation describes BackupPC version __VERSION__,
4 released on __RELEASEDATE__.
5
6 =head2 Overview
7
8 BackupPC is a high-performance, enterprise-grade system for backing up
9 Linux and WinXX PCs, desktops and laptops to a server's disk.  BackupPC
10 is highly configurable and easy to install and maintain.
11
12 Given the ever decreasing cost of disks and raid systems, it is now
13 practical and cost effective to backup a large number of machines onto a
14 server's local disk or network storage.  For some sites this might be
15 the complete backup solution.  For other sites additional permanent
16 archives could be created by periodically backing up the server to tape.
17
18 Features include:
19
20 =over 4
21
22 =item *
23
24 A clever pooling scheme minimizes disk storage and disk I/O.
25 Identical files across multiple backups of the same or different PC
26 are stored only once (using hard links), resulting in substantial
27 savings in disk storage and disk writes.
28
29 =item *
30
31 Optional compression provides additional reductions in storage
32 (around 40%).  The CPU impact of compression is low since only
33 new files (those not already in the pool) need to be compressed.
34
35 =item *
36
37 A powerful http/cgi user interface allows administrators to view log
38 files, configuration, current status and allows users to initiate and
39 cancel backups and browse and restore files from backups.
40
41 =item *
42
43 The http/cgi user interface has internationalization (i18n) support,
44 currently providing English, French, German, Spanish and Italian.
45
46 =item *
47
48 No client-side software is needed. On WinXX the standard smb
49 protocol is used to extract backup data. On linux or unix clients,
50 rsync or tar (over ssh/rsh/nfs) is used to extract backup data.
51 Alternatively, rsync can also be used on WinXX (using cygwin),
52 and Samba could be installed on the linux or unix client to
53 provide smb shares).
54
55 =item *
56
57 Flexible restore options.  Single files can be downloaded from
58 any backup directly from the CGI interface.  Zip or Tar archives
59 for selected files or directories from any backup can also be
60 downloaded from the CGI interface.  Finally, direct restore to
61 the client machine (using smb or tar) for selected files or
62 directories is also supported from the CGI interface.
63
64 =item *
65
66 BackupPC supports mobile environments where laptops are only
67 intermittently connected to the network and have dynamic IP addresses
68 (DHCP).  Configuration settings allow machines connected via slower WAN
69 connections (eg: dial up, DSL, cable) to not be backed up, even if they
70 use the same fixed or dynamic IP address as when they are connected
71 directly to the LAN.
72
73 =item *
74
75 Flexible configuration parameters allow multiple backups to be performed
76 in parallel, specification of which shares to backup, which directories
77 to backup or not backup, various schedules for full and incremental
78 backups, schedules for email reminders to users and so on.  Configuration
79 parameters can be set system-wide or also on a per-PC basis.
80
81 =item *
82
83 Users are sent periodic email reminders if their PC has not
84 recently been backed up.  Email content, timing and policies
85 are configurable.
86
87 =item *
88
89 BackupPC is Open Source software hosted by SourceForge.
90
91 =back
92
93 =head2 Backup basics
94
95 =over 4
96
97 =item Full Backup
98
99 A full backup is a complete backup of a share. BackupPC can be
100 configured to do a full backup at a regular interval (typically
101 weekly).  BackupPC can be configured to keep a certain number
102 of full backups.  Exponential expiry is also supported, allowing
103 full backups with various vintages to be kept (for example, a
104 settable number of most recent weekly fulls, plus a settable
105 number of older fulls that are 2, 4, 8, or 16 weeks apart).
106
107 =item Incremental Backup
108
109 An incremental backup is a backup of files that have changed (based on their
110 modification time) since the last successful full backup.  For SMB and
111 tar, BackupPC backups all files that have changed since one hour prior to the
112 start of the last successful full backup.  Rsync is more clever: any files
113 who attributes have changed (ie: uid, gid, mtime, modes, size) since the
114 last full are backed up.  Deleted and new files are also detected by
115 Rsync incrementals (SMB and tar are not able to detect deleted files or
116 new files whose modification time is prior to the last full dump.
117
118 BackupPC can also be configured to keep a certain number of incremental
119 backups, and to keep a smaller number of very old incremental backups.
120 (BackupPC does not support multi-level incremental backups, although it
121 would be easy to do so.)
122
123 BackupPC's CGI interface "fills-in" incremental backups based on the 
124 last full backup, giving every backup a "full" appearance.  This makes
125 browsing and restoring backups easier.
126
127 =item Partial Backup
128
129 When a full backup fails or is canceled, and some files have already
130 been backed up, BackupPC keeps a partial backup containing just the
131 files that were backed up successfully.  The partial backup is removed
132 when the next successful backup completes, or if another full backup
133 fails resulting in a newer partial backup.  A failed full backup
134 that has not backed up any files, or any failed incremental backup,
135 is removed; no partial backup is saved in these cases.
136
137 The partial backup may be browsed or used to restore files just like
138 a successful full or incremental backup.
139
140 With the rsync transfer method the partial backup is used to resume
141 the next full backup, avoiding the need to retransfer the file data
142 already in the partial backup.
143
144 =item Identical Files
145
146 BackupPC pools identical files using hardlinks.  By "identical
147 files" we mean files with identical contents, not necessary the
148 same permissions, ownership or modification time.  Two files might
149 have different permissions, ownership, or modification time but
150 will still be pooled whenever the contents are identical.  This
151 is possible since BackupPC stores the file meta-data (permissions,
152 ownership, and modification time) separately from the file contents.
153
154 =item Backup Policy
155
156 Based on your site's requirements you need to decide what your backup
157 policy is.  BackupPC is not designed to provide exact re-imaging of
158 failed disks.  See L<Limitations|limitations> for more information.
159 However, the addition of tar transport for linux/unix clients, plus
160 full support for special file types and unix attributes in v1.4.0
161 likely means an exact image of a linux/unix file system can be made.
162
163 BackupPC saves backups onto disk. Because of pooling you can relatively
164 economically keep several weeks of old backups.
165
166 At some sites the disk-based backup will be adequate, without a
167 secondary tape backup. This system is robust to any single failure: if a
168 client disk fails or loses files, the BackupPC server can be used to
169 restore files. If the server disk fails, BackupPC can be restarted on a
170 fresh file system, and create new backups from the clients. The chance
171 of the server disk failing can be made very small by spending more money
172 on increasingly better RAID systems.
173
174 At other sites a secondary tape backup or cd/dvd will be required. This
175 backup can be done perhaps weekly using the archive function of BackupPC.
176
177 =back
178
179 =head2 Resources
180
181 =over 4
182
183 =item BackupPC home page
184
185 The BackupPC Open Source project is hosted on SourceForge.  The
186 home page can be found at:
187
188     http://backuppc.sourceforge.net
189
190 This page has links to the current documentation, the SourceForge
191 project page and general information.
192
193 =item SourceForge project
194
195 The SourceForge project page is at:
196
197     http://sourceforge.net/projects/backuppc
198
199 This page has links to the current releases of BackupPC.
200
201 =item Mail lists
202
203 Three BackupPC mailing lists exist for announcements (backuppc-announce),
204 developers (backuppc-devel), and a general user list for support, asking
205 questions or any other topic relevant to BackupPC (backuppc-users).
206
207 The lists are archived on SourceForge and Gmane.  The SourceForge lists
208 are not always up to date and the searching is limited, so Gmane is
209 a good alternative.  See:
210
211     http://news.gmane.org/index.php?prefix=gmane.comp.sysutils.backup.backuppc
212     http://sourceforge.net/mailarchive/forum.php?forum_id=503
213
214 You can subscribe to these lists by visiting:
215
216     http://lists.sourceforge.net/lists/listinfo/backuppc-announce
217     http://lists.sourceforge.net/lists/listinfo/backuppc-users
218     http://lists.sourceforge.net/lists/listinfo/backuppc-devel
219
220 The backuppc-announce list is moderated and is used only for
221 important announcements (eg: new versions).  It is low traffic.
222 You only need to subscribe to one of backuppc-announce and
223 backuppc-users: backuppc-users also receives any messages on
224 backuppc-announce.
225
226 The backuppc-devel list is only for developers who are working on BackupPC.
227 Do not post questions or support requests there.  But detailed technical
228 discussions should happen on this list.
229
230 To post a message to the backuppc-users list, send an email to
231
232     backuppc-users@lists.sourceforge.net
233
234 Do not send subscription requests to this address!
235
236 =item Other Programs of Interest
237
238 If you want to mirror linux or unix files or directories to a remote server
239 you should consider rsync, L<http://rsync.samba.org>.  BackupPC now uses
240 rsync as a transport mechanism; if you are already an rsync user you
241 can think of BackupPC as adding efficient storage (compression and
242 pooling) and a convenient user interface to rsync.
243
244 Unison is a utility that can do two-way, interactive, synchronization.
245 See L<http://www.cis.upenn.edu/~bcpierce/unison>.
246
247 Three popular open source packages that do tape backup are
248 Amanda (L<http://www.amanda.org>),
249 afbackup (L<http://sourceforge.net/projects/afbackup>), and
250 Bacula (L<http://www.bacula.org>).
251 Amanda can also backup WinXX machines to tape using samba.
252 These packages can be used as back ends to BackupPC to backup the
253 BackupPC server data to tape.
254
255 Various programs and scripts use rsync to provide hardlinked backups.
256 See, for example, Mike Rubel's site (L<http://www.mikerubel.org>),
257 J. W. Schultz's dirvish (L<http://www.pegasys.ws/dirvish>),
258 Ben Escoto's rdiff-backup (L<http://rdiff-backup.stanford.edu>),
259 and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>).
260
261 BackupPC provides many additional features, such as compressed storage,
262 hardlinking any matching files (rather than just files with the same name),
263 and storing special files without root privileges.  But these other scripts
264 provide simple and effective solutions and are worthy of consideration.
265
266 =back
267
268 =head2 Road map
269
270 Here are some ideas for new features that might appear in future
271 releases of BackupPC:
272
273 =over 4
274
275 =item *
276
277 Adding hardlink support to rsync.  Currently the tar XferMethod
278 correctly saves/restores hardlinks, but rsync does not.  Rsync
279 2.6.2 has greatly improved the efficiency of saving hardlink
280 information, so File::RsyncP and BackupPC::Xfer::RsyncFileIO need
281 the corresponding changes.  Hardlink support is necessary for
282 doing a bare-metal restore of a *nix system.
283
284 =item *
285
286 Adding more complete utf8 support.  BackupPC should use utf8 as the
287 native charset for storing file names, and the CGI script should emit
288 utf8 so that the file names can be rendered correctly.  Additional
289 configuration parameters should allow you to specify the client Xfer
290 charset (ie: the filcharset delivered by the XferMethod).  BackupPC
291 should encode/decode between this charset and utf8 when doing a
292 backup/restore. That way BackupPC can store all files in utf8 no
293 matter what charset is used by the XferMethod to deliver the file
294 names.  Secondly, the CGI charset should be configurable (default
295 utf8) and the CGI script BackupPC_Admin should encode the utf8 file
296 names in the desired output charset.  Finally, the charset used to
297 deliver file names when restoring individual file names should also
298 be configurable, and again BackupPC_Admin should encode the file
299 names in this charset (again, utf8 default).  That should allow the
300 "Save As" IE dialog to default to the correct file name.
301
302 =item *
303
304 Adding a trip wire feature for notification when files below certain
305 directories change.  For example, if you are backing up a DMZ machine,
306 you could request that you get sent email if any files below /bin,
307 /sbin or /usr change.
308
309 =item *
310
311 Allow editing of config parameters via the CGI interface. Users should
312 have permission to edit a subset of the parameters for their clients.
313 Additionally, allow an optional self-service capability so that users
314 can sign up and setup their own clients with no need for IT support.
315
316 =item *
317
318 Add backend SQL support for various BackupPC metadata, including
319 configuration parameters, client lists, and backup and restore
320 information.  At installation time the backend data engine will
321 be specified (eg: MySQL, ascii text etc).
322
323 =item *
324
325 Because of file name mangling (adding "f" to start of each file
326 name) and with pending utf8 changes, BackupPC is not able to
327 store files whose file name length is 255 bytes or greater. The
328 format of the attrib file should be extended so that very long
329 file names (ie: >= 255) are abbreviated on the file system, but
330 the full name is stored in the attrib file.  This could also be
331 used to eliminate the leading "f", since that is there to avoid
332 collisions with the attrib file.
333
334 =item *
335
336 Replacing smbclient with the perl module FileSys::SmbClient.  This
337 gives much more direct control of the smb transfer, allowing
338 incrementals to depend on any attribute change (eg: exist, mtime,
339 file size, uid, gid), and better support for include and exclude.
340 Currently smbclient incrementals only depend upon mtime, so
341 deleted files or renamed files are not detected.  FileSys::SmbClient
342 would also allow resuming of incomplete full backups in the
343 same manner as rsync will.
344
345 =item *
346
347 Support --listed-incremental or --incremental for tar,
348 so that incrementals will depend upon any attribute change (eg: exist,
349 mtime, file size, uid, gid), rather than just mtime.  This will allow
350 tar to be to as capable as FileSys::SmbClient and rsync.  This is
351 low priority since rsync is really the preferred method.
352
353 =item *
354
355 In addition to allowing a specific backup (incremental or full) to
356 be started from the CGI interface, also allow a "regular" backup
357 to be started.  This would behave just like a regular background
358 backup and determine whether a full, incremental or nothing
359 should be done.
360
361 =item *
362
363 For rysnc (and smb when FileSys::SmbClient is supported, and tar when
364 --listed-incremental is supported) support multi-level incrementals.
365 In fact, since incrementals will now be more "accurate", you could
366 choose to never do full backups (except the first time), or at a
367 minimum do them infrequently: each incremental would depend upon
368 the last, giving a continuous chain of differential backups.
369
370 =item *
371
372 Allow diffs between two different backed up files to be displayed.
373 The history feature in 2.1.0 does show files that are the same
374 between backups.  Most often we would like to just take the diff of
375 the same host, path and file between different backups, but it would
376 be nice to generalize it to any pair of files (ie: different hosts,
377 backups, paths etc).  But I'm not sure how the user interface would
378 look.
379
380 =item *
381
382 More speculative: Storing binary file deltas (in fact, reverse deltas)
383 for files that have the same name as a previous backup, but that aren't
384 already in the pool. This will save storage for things like mailbox
385 files or documents that change slightly between backups.  Running some
386 benchmarks on a large pool suggests that the potential savings are
387 around 15-20%, which isn't spectacular, and likely not worth the
388 implementation effort. The program xdelta (v1) on SourceForge (see
389 L<http://sourceforge.net/projects/xdelta>) uses an rsync algorithm for
390 doing efficient binary file deltas.  Rather than using an external
391 program, File::RsyncP would eventually get the necessary delta
392 generation code from rsync.
393
394 =back
395
396 Comments and suggestions are welcome.
397
398 =head2 You can help
399
400 BackupPC is free. I work on BackupPC because I enjoy doing it and I like
401 to contribute to the open source community.
402
403 BackupPC already has more than enough features for my own needs.  The
404 main compensation for continuing to work on BackupPC is knowing that
405 more and more people find it useful.  So feedback is certainly
406 appreciated.  Even negative feedback is helpful, for example "We
407 evaluated BackupPC but didn't use it because it doesn't ...".
408
409 Beyond being a satisfied user and telling other people about it, everyone
410 is encouraged to add links to L<http://backuppc.sourceforge.net> (I'll
411 see then via Google) or otherwise publicize BackupPC.  Unlike the
412 commercial products in this space, I have a zero budget (in both
413 time and money) for marketing, PR and advertising, so it's up to
414 all of you!
415
416 Also, everyone is encouraged to contribute patches, bug reports, feature
417 and design suggestions, new code, and documentation corrections or
418 improvements.
419
420 =head1 Installing BackupPC
421
422 =head2 Requirements
423
424 BackupPC requires:
425
426 =over 4
427
428 =item *
429
430 A linux, solaris, or unix based server with a substantial amount of free
431 disk space (see the next section for what that means). The CPU and disk
432 performance on this server will determine how many simultaneous backups
433 you can run. You should be able to run 4-8 simultaneous backups on a
434 moderately configured server.
435
436 When BackupPC starts with an empty pool, all the backup data will be
437 written to the pool on disk. After more backups are done, a higher
438 percentage of incoming files will already be in the pool. BackupPC is
439 able to avoid writing to disk new files that are already in the pool.
440 So over time disk writes will reduce significantly (by perhaps a factor
441 of 20 or more), since eventually 95% or more of incoming backup files
442 are typically in the pool. Disk reads from the pool are still needed to
443 do file compares to verify files are an exact match. So, with a mature
444 pool, if a relatively fast client generates data at say 1MB/sec, and you
445 run 4 simultaneous backups, there will be an average server disk load of
446 about 4MB/sec reads and 0.2MB/sec writes (assuming 95% of the incoming
447 files are in the pool). These rates will be perhaps 40% lower if
448 compression is on.
449
450 =item *
451
452 Perl version 5.6.0 or later. BackupPC has been tested with
453 version 5.6.0, 5.6.1, 5.8.0, 5.8.1 and 5.8.2. If you don't
454 have perl, please see L<http://www.cpan.org>.
455
456 =item *
457
458 Perl modules Compress::Zlib, Archive::Zip and File::RsyncP.  Try "perldoc
459 Compress::Zlib" and "perldoc Archive::Zip" to see if you have these
460 modules.  If not, fetch them from L<http://www.cpan.org> and see the
461 instructions below for how to build and install them.
462
463 The File::RsyncP module is available from L<http://perlrsync.sourceforge.net>
464 or CPAN.  You'll need to install the File::RsyncP module if you want to use
465 Rsync as a transport method.
466
467 =item *
468
469 If you are using smb to backup WinXX machines you need smbclient and
470 nmblookup from the samba package.  You will also need nmblookup if
471 you are backing up linux/unix DHCP machines.  See L<http://www.samba.org>.
472 Version 2.2.0 or later of Samba is required (smbclient's tar feature in
473 2.0.8 and prior has bugs for file path lengths around 100 characters
474 and generates bad output when file lengths change during the backup).
475 Samba versions 3.x are stable and recommended instead of 2.x.
476
477 See L<http://www.samba.org> for source and binaries.  It's pretty easy to
478 fetch and compile samba, and just grab smbclient and nmblookup, without
479 doing the installation. Alternatively, L<http://www.samba.org> has binary
480 distributions for most platforms.
481
482 =item *
483
484 If you are using tar to backup linux/unix machines you should have version
485 1.13.7 at a minimum, with version 1.13.20 or higher recommended.  Use
486 "tar --version" to check your version.  Various GNU mirrors have the newest
487 versions of tar, see for example L<http://www.funet.fi/pub/gnu/alpha/gnu/tar>.
488 As of June 2003 the latest version is 1.13.25.
489
490 =item *
491
492 If you are using rsync to backup linux/unix machines you should have
493 version 2.5.5 or higher on each client machine.  See
494 L<http://rsync.samba.org>. Use "rsync --version" to check your
495 version.
496
497 For BackupPC to use Rsync you will also need to install the perl
498 File::RsyncP module, which is available from
499 L<http://perlrsync.sourceforge.net>.
500 Version 0.51 or later is required.
501
502 =item *
503
504 The Apache web server, see L<http://www.apache.org>, preferably built
505 with mod_perl support.
506
507 =back
508
509 =head2 How much disk space do I need?
510
511 Here's one real example for an environment that is backing up 65 laptops
512 with compression off. Each full backup averages 3.2GB. Each incremental
513 backup averages about 0.2GB. Storing one full backup and two incremental
514 backups per laptop is around 240GB of raw data. But because of the
515 pooling of identical files, only 87GB is used.  This is without
516 compression.
517
518 Another example, with compression on: backing up 95 laptops, where
519 each backup averages 3.6GB and each incremental averages about 0.3GB.
520 Keeping three weekly full backups, and six incrementals is around
521 1200GB of raw data.  Because of pooling and compression, only 150GB
522 is needed.
523
524 Here's a rule of thumb. Add up the C drive usage of all the machines you
525 want to backup (210GB in the first example above). This is a rough
526 minimum space estimate that should allow a couple of full backups and at
527 least half a dozen incremental backups per machine. If compression is on
528 you can reduce the storage requirements by maybe 30-40%.  Add some margin
529 in case you add more machines or decide to keep more old backups.
530
531 Your actual mileage will depend upon the types of clients, operating
532 systems and applications you have. The more uniform the clients and
533 applications the bigger the benefit from pooling common files.
534
535 For example, the Eudora email tool stores each mail folder in a separate
536 file, and attachments are extracted as separate files. So in the sadly
537 common case of a large attachment emailed to many recipients, Eudora
538 will extract the attachment into a new file. When these machines are
539 backed up, only one copy of the file will be stored on the server, even
540 though the file appears in many different full or incremental backups. In
541 this sense Eudora is a "friendly" application from the point of view of
542 backup storage requirements.
543
544 An example at the other end of the spectrum is Outlook. Everything
545 (email bodies, attachments, calendar, contact lists) is stored in a
546 single file, which often becomes huge. Any change to this file requires
547 a separate copy of the file to be saved during backup. Outlook is even
548 more troublesome, since it keeps this file locked all the time, so it
549 cannot be read by smbclient whenever Outlook is running.  See the
550 L<Limitations|limitations> section for more discussion of this problem.
551
552 In addition to total disk space, you shold make sure you have
553 plenty of inodes on your BackupPC data partition. Some users have
554 reported running out of inodes on their BackupPC data partition.
555 So even if you have plenty of disk space, BackupPC will report
556 failures when the inodes are exhausted.  This is a particular
557 problem with ext2/ext3 file systems that have a fixed number of
558 inodes when the file system is built.  Use "df -i" to see your
559 inode usage.
560
561 =head2 Step 1: Getting BackupPC
562
563 Download the latest version from L<http://backuppc.sourceforge.net>.
564
565 =head2 Step 2: Installing the distribution
566
567 First off, there are three perl modules you should install.
568 These are all optional, but highly recommended:
569
570 =over 4
571
572 =item Compress::Zlib
573
574 To enable compression, you will need to install Compress::Zlib
575 from L<http://www.cpan.org>.
576 You can run "perldoc Compress::Zlib" to see if this module is installed.
577
578 =item Archive::Zip
579
580 To support restore via Zip archives you will need to install
581 Archive::Zip, also from L<http://www.cpan.org>.
582 You can run "perldoc Archive::Zip" to see if this module is installed.
583
584 =item File::RsyncP
585
586 To use rsync and rsyncd with BackupPC you will need to install File::RsyncP.
587 You can run "perldoc File::RsyncP" to see if this module is installed.
588 File::RsyncP is available from L<http://perlrsync.sourceforge.net>.
589 Version 0.44 or later is required.
590
591 =back
592
593 To build and install these packages, fetch the tar.gz file and
594 then run these commands:
595
596     tar zxvf Archive-Zip-1.01.tar.gz
597     cd Archive-Zip-1.01
598     perl Makefile.PL
599     make
600     make test
601     make install
602
603 The same sequence of commands can be used for each module.
604
605 Now let's move onto BackupPC itself.  After fetching
606 BackupPC-__VERSION__.tar.gz, run these commands as root:
607
608     tar zxf BackupPC-__VERSION__.tar.gz
609     cd BackupPC-__VERSION__
610     perl configure.pl
611
612 The configure.pl also accepts command-line options if you wish
613 to run it in a non-interactive manner.  It has self-contained
614 documentation for all the command-line options, which you can
615 read with perldoc:
616
617     perldoc configure.pl
618
619 When you run configure.pl you will be prompted for the full paths
620 of various executables, and you will be prompted for the following
621 information:
622
623 =over 4
624
625 =item BackupPC User
626
627 It is best if BackupPC runs as a special user, eg backuppc, that has
628 limited privileges. It is preferred that backuppc belongs to a system
629 administrator group so that sys admin members can browse backuppc files,
630 edit the configuration files and so on. Although configurable, the
631 default settings leave group read permission on pool files, so make
632 sure the BackupPC user's group is chosen restrictively.
633
634 On this installation, this is __BACKUPPCUSER__.
635
636 =item Data Directory
637
638 You need to decide where to put the data directory, below which
639 all the BackupPC data is stored.  This needs to be a big file system.
640
641 On this installation, this is __TOPDIR__.
642
643 =item Install Directory
644
645 You should decide where the BackupPC scripts, libraries and documentation
646 should be installed, eg: /opt/local/BackupPC.
647
648 On this installation, this is __INSTALLDIR__.
649
650 =item CGI bin Directory
651
652 You should decide where the BackupPC CGI script resides.  This will
653 usually below Apache's cgi-bin directory.
654
655 On this installation, this is __CGIDIR__.
656
657 =item Apache image directory
658
659 A directory where BackupPC's images are stored so that Apache can
660 serve them.  This should be somewhere under Apache's DocumentRoot
661 directory.
662
663 =back
664
665 =head2 Step 3: Setting up config.pl
666
667 After running configure.pl, browse through the config file,
668 __INSTALLDIR__/conf/config.pl, and make sure all the default settings
669 are correct. In particular, you will need to decide whether to use
670 smb or tar transport (or whether to set it on a per-PC basis),
671 set the smb share password (if using smb), set the backup policies
672 and modify the email message headers and bodies.
673
674 BackupPC needs to know the smb share user name and password for each PC
675 that uses smb (ie: all the WinXX clients).  The user name is specified
676 in $Conf{SmbShareUserName}. There are four ways to tell BackupPC the smb
677 share password:
678
679 =over 4
680
681 =item *
682
683 As an environment variable BPC_SMB_PASSWD set before BackupPC starts.
684 If you start BackupPC manually the BPC_SMB_PASSWD variable must be set
685 manually first.  For backward compatibility for v1.5.0 and prior, the
686 environment variable PASSWD can be used if BPC_SMB_PASSWD is not set.
687 Warning: on some systems it is possible to see environment variables of
688 running processes.
689
690 =item *
691
692 Alternatively the BPC_SMB_PASSWD setting can be included in
693 /etc/init.d/backuppc, in which case you must make sure this file
694 is not world (other) readable.
695
696 =item *
697
698 As a configuration variable $Conf{SmbSharePasswd} in
699 __TOPDIR__/conf/config.pl.  If you put the password
700 here you must make sure this file is not world (other) readable.
701
702 =item *
703
704 As a configuration variable $Conf{SmbSharePasswd} in the per-PC
705 configuration file, __TOPDIR__/pc/$host/config.pl. You will have to
706 use this option if the smb share password is different for each host.
707 If you put the password here you must make sure this file is not
708 world (other) readable.
709
710 =back
711
712 Placement and protection of the smb share password is a possible
713 security risk, so please double-check the file and directory
714 permissions.  In a future version there might be support for
715 encryption of this password, but a private key will still have to
716 be stored in a protected place.  Suggestions are welcome.
717
718 =head2 Step 4: Setting up the hosts file
719
720 The file __TOPDIR__/conf/hosts contains the list of clients to backup.
721 BackupPC reads this file in three cases:
722
723 =over 4
724
725 =item *
726
727 Upon startup.
728
729 =item *
730
731 When BackupPC is sent a HUP (-1) signal.  Assuming you installed the
732 init.d script, you can also do this with "/etc/init.d/backuppc reload".
733
734 =item *
735
736 When the modification time of the hosts file changes.  BackupPC
737 checks the modification time once during each regular wakeup.
738
739 =back
740
741 Whenever you change the hosts file (to add or remove a host) you can
742 either do a kill -HUP BackupPC_pid or simply wait until the next regular
743 wakeup period.
744
745 Each line in the hosts file contains three fields, separated
746 by white space:
747
748 =over 4
749
750 =item Host name
751
752 This is typically the host name or NetBios name of the client machine
753 and should be in lower case.  The host name can contain spaces (escape
754 with a backslash), but it is not recommended.
755
756 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>.
757
758 In certain cases you might want several distinct clients to refer
759 to the same physical machine.  For example, you might have a database
760 you want to backup, and you want to bracket the backup of the database
761 with shutdown/restart using $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}.
762 But you also want to backup the rest of the machine while the database
763 is still running.  In the case you can specify two different clients in
764 the host file, using any mnemonic name (eg: myhost_mysql and myhost), and
765 use $Conf{ClientNameAlias} in myhost_mysql's config.pl to specify the
766 real host name of the machine.
767
768 =item DHCP flag
769
770 Starting with v2.0.0 the way hosts are discovered has changed and now
771 in most cases you should specify 0 for the DHCP flag, even if the host
772 has a dynamically assigned IP address.
773 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>
774 to understand whether you need to set the DHCP flag.
775
776 You only need to set DHCP to 1 if your client machine doesn't
777 respond to the NetBios multicast request:
778
779     nmblookup myHost
780
781 but does respond to a request directed to its IP address:
782
783     nmblookup -A W.X.Y.Z
784
785 If you do set DHCP to 1 on any client you will need to specify the range of
786 DHCP addresses to search is specified in $Conf{DHCPAddressRanges}.
787
788 Note also that the $Conf{ClientNameAlias} feature does not work for
789 clients with DHCP set to 1.
790
791 =item User name
792
793 This should be the unix login/email name of the user who "owns" or uses
794 this machine. This is the user who will be sent email about this
795 machine, and this user will have permission to stop/start/browse/restore
796 backups for this host.  Leave this blank if no specific person should
797 receive email or be allowed to stop/start/browse/restore backups
798 for this host.  Administrators will still have full permissions.
799
800 =item More users
801
802 Additional user names, separate by commas and with no white space,
803 can be specified.  These users will also have full permission in
804 the CGI interface to stop/start/browse/restore backups for this host.
805 These users will not be sent email about this host.
806
807 =back
808
809 The first non-comment line of the hosts file is special: it contains
810 the names of the columns and should not be edited.
811
812 Here's a simple example of a hosts file:
813
814     host        dhcp    user      moreUsers
815     farside     0       craig     jim,dave
816     larson      1       gary      andy
817
818 =head2 Step 5: Client Setup
819
820 Two methods for getting backup data from a client are supported: smb and
821 tar. Smb is the preferred method for WinXX clients and tar is preferred
822 method for linux/unix clients.
823
824 The transfer method is set using the $Conf{XferMethod} configuration
825 setting. If you have a mixed environment (ie: you will use smb for some
826 clients and tar for others), you will need to pick the most common
827 choice for $Conf{XferMethod} for the main config.pl file, and then
828 override it in the per-PC config file for those hosts that will use
829 the other method.  (Or you could run two completely separate instances
830 of BackupPC, with different data directories, one for WinXX and the
831 other for linux/unix, but then common files between the different
832 machine types will duplicated.)
833
834 Here are some brief client setup notes:
835
836 =over 4
837
838 =item WinXX
839
840 The preferred setup for WinXX clients is to set $Conf{XferMethod} to "smb".
841 (Actually, for v2.0.0, rsyncd is the better method for WinXX if you are
842 prepared to run rsync/cygwin on your WinXX client.  More information
843 about this will be provided via the FAQ.)
844
845 If you want to use rsyncd for WinXX clients you can find a pre-packaged
846 zip file on L<http://backuppc.sourceforge.net>. The package is called
847 cygwin-rsync. It contains rsync.exe, template setup files and the
848 minimal set of cygwin libraries for everything to run.  The README file
849 contains instructions for running rsync as a service, so it starts
850 automatically everytime you boot your machine.
851
852 Otherwise, to use SMB, you need to create shares for the data you want
853 to backup. Open "My Computer", right click on the drive (eg: C), and
854 select "Sharing..." (or select "Properties" and select the "Sharing"
855 tab). In this dialog box you can enable sharing, select the share name
856 and permissions.  Many machines will be configured by default to share
857 the entire C drive as C$ using the administrator password.
858
859 If this machine uses DHCP you will also need to make sure the
860 NetBios name is set.  Go to Control Panel|System|Network Identification
861 (on Win2K) or Control Panel|System|Computer Name (on WinXP).
862 Also, you should go to Control Panel|Network Connections|Local Area
863 Connection|Properties|Internet Protocol (TCP/IP)|Properties|Advanced|WINS
864 and verify that NetBios is not disabled.
865
866 As an alternative to setting $Conf{XferMethod} to "smb" (using
867 smbclient) for WinXX clients, you can use an smb network filesystem (eg:
868 ksmbfs or similar) on your linux/unix server to mount the share,
869 and then set $Conf{XferMethod} to "tar" (use tar on the network
870 mounted file system).
871
872 Also, to make sure that file names with 8-bit characters are correctly
873 transferred by smbclient you should add this to samba's smb.conf file
874 for samba 2.x:
875
876     [global]
877         # Accept the windows charset
878         client code page = 850
879         character set = ISO8859-1
880
881 For samba 3.x this should instead be:
882
883     [global]
884         unix charset = ISO8859-1
885
886 This setting should work for western europe.  
887 See L<http://www.oreilly.com/catalog/samba/chapter/book/ch08_03.html>
888 for more information about settings for other languages.
889
890 =item Linux/Unix
891
892 The preferred setup for linux/unix clients is to set $Conf{XferMethod}
893 to "rsync", "rsyncd" or "tar".
894
895 You can use either rsync, smb, or tar for linux/unix machines. Smb requires
896 that the Samba server (smbd) be run to provide the shares. Since the smb
897 protocol can't represent special files like symbolic links and fifos,
898 tar and rsync are the better transport methods for linux/unix machines.
899 (In fact, by default samba makes symbolic links look like the file or
900 directory that they point to, so you could get an infinite loop if a
901 symbolic link points to the current or parent directory. If you really
902 need to use Samba shares for linux/unix backups you should turn off the
903 "follow symlinks" samba config setting. See the smb.conf manual page.)
904
905 The requirements for each Xfer Method are:
906
907 =over 4
908
909 =item tar
910
911 You must have GNU tar on the client machine.  Use "tar --version"
912 or "gtar --version" to verify.  The version should be at least
913 1.13.7, and 1.13.20 or greater is recommended.  Tar is run on
914 the client machine via rsh or ssh.
915
916 The relevant configuration settings are $Conf{TarClientPath},
917 $Conf{TarShareName}, $Conf{TarClientCmd}, $Conf{TarFullArgs},
918 $Conf{TarIncrArgs}, and $Conf{TarClientRestoreCmd}.
919
920 =item rsync
921
922 You should have at least rsync 2.5.5, and the latest version 2.5.6
923 is recommended.  Rsync is run on the remote client via rsh or ssh.
924
925 The relevant configuration settings are $Conf{RsyncClientPath},
926 $Conf{RsyncClientCmd}, $Conf{RsyncClientRestoreCmd}, $Conf{RsyncShareName},
927 $Conf{RsyncArgs}, and $Conf{RsyncRestoreArgs}.
928
929 =item rsyncd
930
931 You should have at least rsync 2.5.5, and the latest version 2.5.6
932 is recommended.  In this case the rsync daemon should be running on
933 the client machine and BackupPC connects directly to it.
934
935 The relevant configuration settings are $Conf{RsyncdClientPort},
936 $Conf{RsyncdUserName}, $Conf{RsyncdPasswd}, $Conf{RsyncdAuthRequired},
937 $Conf{RsyncShareName}, $Conf{RsyncArgs}, and $Conf{RsyncRestoreArgs}.
938 $Conf{RsyncShareName} is the name of an rsync module (ie: the thing
939 in square brackets in rsyncd's conf file -- see rsyncd.conf), not a
940 file system path.
941
942 Be aware that rsyncd will remove the leading '/' from path names in
943 symbolic links if you specify "use chroot = no" in the rsynd.conf file.
944 See the rsyncd.conf manual page for more information.
945
946 =back
947
948 For linux/unix machines you should not backup "/proc".  This directory
949 contains a variety of files that look like regular files but they are
950 special files that don't need to be backed up (eg: /proc/kcore is a
951 regular file that contains physical memory).  See $Conf{BackupFilesExclude}.
952 It is safe to back up /dev since it contains mostly character-special
953 and block-special files, which are correctly handed by BackupPC
954 (eg: backing up /dev/hda5 just saves the block-special file information,
955 not the contents of the disk).
956
957 Alternatively, rather than backup all the file systems as a single
958 share ("/"), it is easier to restore a single file system if you backup
959 each file system separately.  To do this you should list each file system
960 mount point in $Conf{TarShareName} or $Conf{RsyncShareName}, and add the
961 --one-file-system option to $Conf{TarClientCmd} or add --one-file-system
962 (note the different punctuation) to $Conf{RsyncArgs}.  In this case there
963 is no need to exclude /proc explicitly since it looks like a different
964 file system.
965
966 Next you should decide whether to run tar over ssh, rsh or nfs. Ssh is
967 the preferred method. Rsh is not secure and therefore not recommended.
968 Nfs will work, but you need to make sure that the BackupPC user (running
969 on the server) has sufficient permissions to read all the files below
970 the nfs mount.
971
972 Ssh allows BackupPC to run as a privileged user on the client (eg:
973 root), since it needs sufficient permissions to read all the backup
974 files. Ssh is setup so that BackupPC on the server (an otherwise low
975 privileged user) can ssh as root on the client, without being prompted
976 for a password. There are two common versions of ssh: v1 and v2. Here
977 are some instructions for one way to setup ssh.  (Check which version
978 of SSH you have by typing "ssh" or "man ssh".)
979
980 =item Mac OS X
981
982 In general this should be similar to Linux/Unix machines.
983
984 =over 4
985
986 =item OpenSSH Instructions
987
988 Depending upon your OpenSSH installation, many of these steps can be
989 replaced by running the scripts ssh-user-config and ssh-host-config
990 included with OpenSSH.  You still need to manually exchange the keys.
991
992 =over 4
993
994 =item Key generation
995
996 As root on the client machine, use ssh-keygen to generate a
997 public/private key pair, without a pass-phrase:
998
999     ssh-keygen -t rsa -N ''
1000
1001 This will save the public key in ~/.ssh/id_rsa.pub and the private
1002 key in ~/.ssh/id_rsa.
1003
1004 =item BackupPC setup
1005
1006 Repeat the above steps for the BackupPC user (__BACKUPPCUSER__) on the server.
1007 Make a copy of the public key to make it recognizable, eg:
1008
1009     ssh-keygen -t rsa -N ''
1010     cp ~/.ssh/id_rsa.pub ~/.ssh/BackupPC_id_rsa.pub
1011
1012 See the ssh and sshd manual pages for extra configuration information.
1013
1014 =item Key exchange
1015
1016 To allow BackupPC to ssh to the client as root, you need to place
1017 BackupPC's public key into root's authorized list on the client.
1018 Append BackupPC's public key (BackupPC_id_rsa.pub) to root's
1019 ~/.ssh/authorized_keys2 file on the client:
1020
1021     touch ~/.ssh/authorized_keys2
1022     cat BackupPC_id_rsa.pub >> ~/.ssh/authorized_keys2
1023
1024 You should edit ~/.ssh/authorized_keys2 and add further specifiers,
1025 eg: from, to limit which hosts can login using this key.  For example,
1026 if your BackupPC host is called backuppc.my.com, there should be
1027 one line in ~/.ssh/authorized_keys2 that looks like:
1028
1029     from="backuppc.my.com" ssh-rsa [base64 key, eg: ABwBCEAIIALyoqa8....]
1030
1031 =item Fix permissions
1032
1033 You will probably need to make sure that all the files
1034 in ~/.ssh have no group or other read/write permission:
1035
1036     chmod -R go-rwx ~/.ssh
1037
1038 You should do the same thing for the BackupPC user on the server.
1039
1040 =item Testing
1041
1042 As the BackupPC user on the server, verify that this command:
1043
1044     ssh -l root clientHostName whoami
1045
1046 prints
1047
1048     root
1049
1050 You might be prompted the first time to accept the client's host key and
1051 you might be prompted for root's password on the client.  Make sure that
1052 this command runs cleanly with no prompts after the first time.  You
1053 might need to check /etc/hosts.equiv on the client.  Look at the
1054 man pages for more information.  The "-v" option to ssh is a good way
1055 to get detailed information about what fails.
1056
1057 =back
1058
1059 =item SSH2 Instructions
1060
1061 =over 4
1062
1063 =item Key generation
1064
1065 As root on the client machine, use ssh-keygen2 to generate a
1066 public/private key pair, without a pass-phrase:
1067
1068     ssh-keygen2 -t rsa -P
1069
1070 or:
1071
1072     ssh-keygen -t rsa -N ''
1073
1074 (This command might just be called ssh-keygen on your machine.)
1075
1076 This will save the public key in /.ssh2/id_rsa_1024_a.pub and the private
1077 key in /.ssh2/id_rsa_1024_a.
1078
1079 =item Identification
1080
1081 Create the identification file /.ssh2/identification:
1082
1083     echo "IdKey id_rsa_1024_a" > /.ssh2/identification
1084
1085 =item BackupPC setup
1086
1087 Repeat the above steps for the BackupPC user (__BACKUPPCUSER__) on the server.
1088 Rename the key files to recognizable names, eg:
1089
1090     ssh-keygen2 -t rsa -P
1091     mv ~/.ssh2/id_rsa_1024_a.pub ~/.ssh2/BackupPC_id_rsa_1024_a.pub
1092     mv ~/.ssh2/id_rsa_1024_a     ~/.ssh2/BackupPC_id_rsa_1024_a
1093     echo "IdKey BackupPC_id_rsa_1024_a" > ~/.ssh2/identification
1094
1095 Based on your ssh2 configuration, you might also need to turn off
1096 StrictHostKeyChecking and PasswordAuthentication:
1097
1098     touch ~/.ssh2/ssh2_config
1099     echo "StrictHostKeyChecking ask" >> ~/.ssh2/ssh2_config
1100     echo "PasswordAuthentication no" >> ~/.ssh2/ssh2_config
1101
1102 =item Key exchange
1103
1104 To allow BackupPC to ssh to the client as root, you need to place
1105 BackupPC's public key into root's authorized list on the client.
1106 Copy BackupPC's public key (BackupPC_id_rsa_1024_a.pub) to the
1107 /.ssh2 directory on the client.  Add the following line to the
1108 /.ssh2/authorization file on the client (as root):
1109
1110     touch /.ssh2/authorization
1111     echo "Key BackupPC_id_rsa_1024_a.pub" >> /.ssh2/authorization
1112
1113 =item Fix permissions
1114
1115 You will probably need to make sure that all the files
1116 in ~/.ssh2 have no group or other read/write permission:
1117
1118     chmod -R go-rwx ~/.ssh2
1119
1120 You should do the same thing for the BackupPC user on the server.
1121
1122 =item Testing
1123
1124 As the BackupPC user on the server, verify that this command:
1125
1126     ssh2 -l root clientHostName whoami
1127
1128 prints
1129
1130     root
1131
1132 You might be prompted the first time to accept the client's host key and
1133 you might be prompted for root's password on the client.  Make sure that
1134 this command runs cleanly with no prompts after the first time.  You
1135 might need to check /etc/hosts.equiv on the client.  Look at the
1136 man pages for more information.  The "-v" option to ssh2 is a good way
1137 to get detailed information about what fails.
1138
1139 =back
1140
1141 =item SSH version 1 Instructions
1142
1143 The concept is identical and the steps are similar, but the specific
1144 commands and file names are slightly different.
1145
1146 First, run ssh-keygen on the client (as root) and server (as the BackupPC
1147 user) and simply hit enter when prompted for the pass-phrase:
1148
1149     ssh-keygen
1150
1151 This will save the public key in /.ssh/identity.pub and the private
1152 key in /.ssh/identity.
1153
1154 Next, append BackupPC's ~/.ssh/identity.pub (from the server) to root's
1155 /.ssh/authorized_keys file on the client.  It's a single long line that
1156 you can cut-and-paste with an editor (make sure it remains a single line).
1157
1158 Next, force protocol version 1 by adding:
1159
1160     Protocol 1
1161
1162 to BackupPC's ~/.ssh/config on the server.
1163
1164 Next, run "chmod -R go-rwx ~/.ssh" on the server and "chmod -R go-rwx ~/.ssh"
1165 on the client.
1166
1167 Finally, test using:
1168
1169     ssh -l root clientHostName whoami
1170
1171 =back
1172
1173 Finally, if this machine uses DHCP you will need to run nmbd (the
1174 NetBios name server) from the Samba distribution so that the machine
1175 responds to a NetBios name request. See the manual page and Samba
1176 documentation for more information.
1177
1178 =back
1179
1180 =head2 Step 6: Running BackupPC
1181
1182 The installation contains an init.d backuppc script that can be copied
1183 to /etc/init.d so that BackupPC can auto-start on boot.
1184 See init.d/README for further instructions.
1185
1186 BackupPC should be ready to start.  If you installed the init.d script,
1187 then you should be able to run BackupPC with:
1188
1189     /etc/init.d/backuppc start
1190
1191 (This script can also be invoked with "stop" to stop BackupPC and "reload"
1192 to tell BackupPC to reload config.pl and the hosts file.)
1193
1194 Otherwise, just run
1195
1196      __INSTALLDIR__/bin/BackupPC -d
1197
1198 as user __BACKUPPCUSER__.  The -d option tells BackupPC to run as a daemon
1199 (ie: it does an additional fork).
1200
1201 Any immediate errors will be printed to stderr and BackupPC will quit.
1202 Otherwise, look in __TOPDIR__/log/LOG and verify that BackupPC reports
1203 it has started and all is ok.
1204
1205 =head2 Step 7: Talking to BackupPC
1206
1207 Note: as of version 1.5.0, BackupPC no longer supports telnet
1208 to its TCP port.  First off, a unix domain socket is used
1209 instead of a TCP port.  (The TCP port can still be re-enabled
1210 if your installation has apache and BackupPC running on different
1211 machines.)  Secondly, even if you still use the TCP port, the
1212 messages exchanged over this interface are now protected by
1213 an MD5 digest based on a shared secret (see $Conf{ServerMesgSecret})
1214 as well as sequence numbers and per-session unique keys, preventing
1215 forgery and replay attacks.
1216
1217 You should verify that BackupPC is running by using BackupPC_serverMesg.
1218 This sends a message to BackupPC via the unix (or TCP) socket and prints
1219 the response.
1220
1221 You can request status information and start and stop backups using this
1222 interface. This socket interface is mainly provided for the CGI interface
1223 (and some of the BackupPC sub-programs use it too).  But right now we just
1224 want to make sure BackupPC is happy.  Each of these commands should
1225 produce some status output:
1226
1227     __INSTALLDIR__/bin/BackupPC_serverMesg status info
1228     __INSTALLDIR__/bin/BackupPC_serverMesg status jobs
1229     __INSTALLDIR__/bin/BackupPC_serverMesg status hosts
1230
1231 The output should be some hashes printed with Data::Dumper.  If it
1232 looks cryptic and confusing, and doesn't look like an error message,
1233 then all is ok.
1234
1235 The jobs status should initially show just BackupPC_trashClean.
1236 The hosts status should produce a list of every host you have listed
1237 in __TOPDIR__/conf/hosts as part of a big cryptic output line.
1238
1239 You can also request that all hosts be queued:
1240
1241     __INSTALLDIR__/bin/BackupPC_serverMesg backup all
1242
1243 At this point you should make sure the CGI interface works since
1244 it will be much easier to see what is going on.  That's our
1245 next subject.
1246
1247 =head2 Step 8: CGI interface
1248
1249 The CGI interface script, BackupPC_Admin, is a powerful and flexible
1250 way to see and control what BackupPC is doing.  It is written for an
1251 Apache server.  If you don't have Apache, see L<http://www.apache.org>.
1252
1253 There are two options for setting up the CGI interface: standard
1254 mode and using mod_perl.  Mod_perl provides much higher performance
1255 (around 15x) and is the best choice if your Apache was built with
1256 mod_perl support.  To see if your apache was built with mod_perl
1257 run this command:
1258
1259     httpd -l | egrep mod_perl
1260
1261 If this prints mod_perl.c then your Apache supports mod_perl.
1262
1263 Using mod_perl with BackupPC_Admin requires a dedicated Apache
1264 to be run as the BackupPC user (__BACKUPPCUSER__).  This is
1265 because BackupPC_Admin needs permission to access various files
1266 in BackupPC's data directories.  In contrast, the standard
1267 installation (without mod_perl) solves this problem by having
1268 BackupPC_Admin installed as setuid to the BackupPC user, so that
1269 BackupPC_Admin runs as the BackuPC user.
1270
1271 Here are some specifics for each setup:
1272
1273 =over 4
1274
1275 =item Standard Setup
1276
1277 The CGI interface should have been installed by the configure.pl script
1278 in __CGIDIR__/BackupPC_Admin.  BackupPC_Admin should have been installed
1279 as setuid to the BackupPC user (__BACKUPPCUSER__), in addition to user
1280 and group execute permission.
1281
1282 You should be very careful about permissions on BackupPC_Admin and
1283 the directory __CGIDIR__: it is important that normal users cannot
1284 directly execute or change BackupPC_Admin, otherwise they can access
1285 backup files for any PC. You might need to change the group ownership
1286 of BackupPC_Admin to a group that Apache belongs to so that Apache
1287 can execute it (don't add "other" execute permission!).
1288 The permissions should look like this:
1289
1290     ls -l __CGIDIR__/BackupPC_Admin
1291     -swxr-x---    1 __BACKUPPCUSER__   web      82406 Jun 17 22:58 __CGIDIR__/BackupPC_Admin
1292
1293 The setuid script won't work unless perl on your machine was installed
1294 with setuid emulation.  This is likely the problem if you get an error
1295 saying such as "Wrong user: my userid is 25, instead of 150", meaning
1296 the script is running as the httpd user, not the BackupPC user.
1297 This is because setuid scripts are disabled by the kernel in most
1298 flavors of unix and linux.
1299
1300 To see if your perl has setuid emulation, see if there is a program
1301 called sperl5.6.0 or sperl5.6.1 in the place where perl is installed.
1302 If you can't find this program, then you have two options: rebuild
1303 and reinstall perl with the setuid emulation turned on (answer "y" to
1304 the question "Do you want to do setuid/setgid emulation?" when you
1305 run perl's configure script), or switch to the mod_perl alternative
1306 for the CGI script (which doesn't need setuid to work).
1307
1308 =item Mod_perl Setup
1309
1310 The advantage of the mod_perl setup is that no setuid script is needed,
1311 and there is a huge performance advantage.  Not only does all the perl
1312 code need to be parsed just once, the config.pl and hosts files, plus
1313 the connection to the BackupPC server are cached between requests.  The
1314 typical speedup is around 15 times.
1315
1316 To use mod_perl you need to run Apache as user __BACKUPPCUSER__.
1317 If you need to run multiple Apache's for different services then
1318 you need to create multiple top-level Apache directories, each
1319 with their own config file.  You can make copies of /etc/init.d/httpd
1320 and use the -d option to httpd to point each http to a different
1321 top-level directory.  Or you can use the -f option to explicitly
1322 point to the config file.  Multiple Apache's will run on different
1323 Ports (eg: 80 is standard, 8080 is a typical alternative port accessed
1324 via http://yourhost.com:8080).
1325
1326 Inside BackupPC's Apache http.conf file you should check the
1327 settings for ServerRoot, DocumentRoot, User, Group, and Port.  See 
1328 L<http://httpd.apache.org/docs/server-wide.html> for more details.
1329
1330 For mod_perl, BackupPC_Admin should not have setuid permission, so
1331 you should turn it off:
1332
1333     chmod u-s __CGIDIR__/BackupPC_Admin
1334
1335 To tell Apache to use mod_perl to execute BackupPC_Admin, add this
1336 to Apache's 1.x httpd.conf file:
1337
1338     <IfModule mod_perl.c>
1339         PerlModule Apache::Registry
1340         PerlTaintCheck On
1341         <Location /cgi-bin/BackupPC/BackupPC_Admin>   # <--- change path as needed
1342            SetHandler perl-script
1343            PerlHandler Apache::Registry
1344            Options ExecCGI
1345            PerlSendHeader On
1346         </Location>
1347     </IfModule>
1348
1349 Apache 2.0.44 with Perl 5.8.0 on RedHat 7.1, Don Silvia reports that
1350 this works (with tweaks from Michael Tuzi):
1351
1352     LoadModule perl_module modules/mod_perl.so
1353     PerlModule Apache2
1354
1355     <Directory /path/to/cgi/>
1356         SetHandler perl-script
1357         PerlResponseHandler ModPerl::Registry
1358         PerlOptions +ParseHeaders
1359         Options +ExecCGI
1360
1361         Order deny,allow
1362         Deny from all
1363         Allow from 192.168.0  
1364         AuthName "Backup Admin"
1365         AuthType Basic
1366         AuthUserFile /path/to/user_file
1367         Require valid-user
1368     </Directory>
1369
1370 There are other optimizations and options with mod_perl.  For
1371 example, you can tell mod_perl to preload various perl modules,
1372 which saves memory compared to loading separate copies in every
1373 Apache process after they are forked.  See Stas's definitive
1374 mod_perl guide at L<http://perl.apache.org/guide>.
1375
1376 =back
1377
1378 BackupPC_Admin requires that users are authenticated by Apache.
1379 Specifically, it expects that Apache sets the REMOTE_USER environment
1380 variable when it runs.  There are several ways to do this.  One way
1381 is to create a .htaccess file in the cgi-bin directory that looks like:
1382
1383     AuthGroupFile /etc/httpd/conf/group    # <--- change path as needed
1384     AuthUserFile /etc/http/conf/passwd     # <--- change path as needed
1385     AuthType basic
1386     AuthName "access"
1387     require valid-user
1388
1389 You will also need "AllowOverride Indexes AuthConfig" in the Apache
1390 httpd.conf file to enable the .htaccess file. Alternatively, everything
1391 can go in the Apache httpd.conf file inside a Location directive. The
1392 list of users and password file above can be extracted from the NIS
1393 passwd file.
1394
1395 One alternative is to use LDAP.  In Apache's http.conf add these lines:
1396
1397     LoadModule auth_ldap_module   modules/auth_ldap.so
1398     AddModule auth_ldap.c
1399
1400     # cgi-bin - auth via LDAP (for BackupPC)
1401     <Location /cgi-binBackupPC/BackupPC_Admin>    # <--- change path as needed
1402       AuthType Basic
1403       AuthName "BackupPC login"
1404       # replace MYDOMAIN, PORT, ORG and CO as needed
1405       AuthLDAPURL ldap://ldap.MYDOMAIN.com:PORT/o=ORG,c=CO?uid?sub?(objectClass=*)
1406       require valid-user
1407     </Location>
1408
1409 If you want to disable the user authentication you can set
1410 $Conf{CgiAdminUsers} to '*', which allows any user to have
1411 full access to all hosts and backups.  In this case the REMOTE_USER
1412 environment variable does not have to be set by Apache.
1413
1414 Alternatively, you can force a particular user name by getting Apache
1415 to set REMOTE_USER, eg, to hardcode the user to www you could add
1416 this to Apache's httpd.conf:
1417
1418     <Location /cgi-bin/BackupPC/BackupPC_Admin>   # <--- change path as needed
1419         Setenv REMOTE_USER www
1420     </Location>
1421
1422 Finally, you should also edit the config.pl file and adjust, as necessary,
1423 the CGI-specific settings.  They're near the end of the config file. In
1424 particular, you should specify which users or groups have administrator
1425 (privileged) access: see the config settings $Conf{CgiAdminUserGroup}
1426 and $Conf{CgiAdminUsers}.  Also, the configure.pl script placed various
1427 images into $Conf{CgiImageDir} that BackupPC_Admin needs to serve
1428 up.  You should make sure that $Conf{CgiImageDirURL} is the correct
1429 URL for the image directory.
1430
1431 See the section L<Debugging installation problems|debugging installation problems> for suggestions on debugging the Apache authentication setup.
1432
1433 =head2 How BackupPC Finds Hosts
1434
1435 Starting with v2.0.0 the way hosts are discovered has changed.  In most
1436 cases you should specify 0 for the DHCP flag in the conf/hosts file,
1437 even if the host has a dynamically assigned IP address.
1438
1439 BackupPC (starting with v2.0.0) looks up hosts with DHCP = 0 in this manner:
1440
1441 =over 4
1442
1443 =item *
1444
1445 First DNS is used to lookup the IP address given the client's name
1446 using perl's gethostbyname() function.  This should succeed for machines
1447 that have fixed IP addresses that are known via DNS.  You can manually
1448 see whether a given host have a DNS entry according to perls'
1449 gethostbyname function with this command:
1450
1451     perl -e 'print(gethostbyname("myhost") ? "ok\n" : "not found\n");'
1452
1453 =item *
1454
1455 If gethostbyname() fails, BackupPC then attempts a NetBios multicast to
1456 find the host.  Provided your client machine is configured properly,
1457 it should respond to this NetBios multicast request.  Specifically,
1458 BackupPC runs a command of this form:
1459
1460     nmblookup myhost
1461
1462 If this fails you will see output like:
1463
1464     querying myhost on 10.10.255.255
1465     name_query failed to find name myhost
1466
1467 If this success you will see output like:
1468
1469     querying myhost on 10.10.255.255
1470     10.10.1.73 myhost<00>
1471
1472 Depending on your netmask you might need to specify the -B option to
1473 nmblookup.  For example:
1474
1475     nmblookup -B 10.10.1.255 myhost
1476     
1477 If necessary, experiment on the nmblookup command that will return the
1478 IP address of the client given its name.  Then update
1479 $Conf{NmbLookupFindHostCmd} with any necessary options to nmblookup.
1480
1481 =back
1482
1483 For hosts that have the DHCP flag set to 1, these machines are
1484 discovered as follows:
1485
1486 =over 4
1487
1488 =item *
1489
1490 A DHCP address pool ($Conf{DHCPAddressRanges}) needs to be specified.
1491 BackupPC will check the NetBIOS name of each machine in the range using
1492 a command of the form:
1493
1494     nmblookup -A W.X.Y.Z
1495
1496 where W.X.Y.Z is each candidate address from $Conf{DHCPAddressRanges}.
1497 Any host that has a valid NetBIOS name returned by this command (ie:
1498 matching an entry in the hosts file) will be backed up.  You can
1499 modify the specific nmblookup command if necessary via $Conf{NmbLookupCmd}.
1500
1501 =item *
1502
1503 You only need to use this DHCP feature if your client machine doesn't
1504 respond to the NetBios multicast request:
1505
1506     nmblookup myHost
1507
1508 but does respond to a request directed to its IP address:
1509
1510     nmblookup -A W.X.Y.Z
1511
1512 =back
1513
1514 =head2 Other installation topics
1515
1516 =over 4
1517
1518 =item Removing a client
1519
1520 If there is a machine that no longer needs to be backed up (eg: a retired
1521 machine) you have two choices.  First, you can keep the backups accessible
1522 and browsable, but disable all new backups.  Alternatively, you can
1523 completely remove the client and all its backups.
1524
1525 To disable backups for a client there are two special values for
1526 $Conf{FullPeriod} in that client's per-PC config.pl file:
1527
1528 =over 4
1529
1530 =item -1
1531
1532 Don't do any regular backups on this machine.  Manually
1533 requested backups (via the CGI interface) will still occur.
1534
1535 =item -2
1536
1537 Don't do any backups on this machine.  Manually requested
1538 backups (via the CGI interface) will be ignored.
1539
1540 =back
1541
1542 This will still allow that client's old backups to be browsable
1543 and restorable.
1544
1545 To completely remove a client and all its backups, you should remove its
1546 entry in the conf/hosts file, and then delete the __TOPDIR__/pc/$host
1547 directory.  Whenever you change the hosts file, you should send
1548 BackupPC a HUP (-1) signal so that it re-reads the hosts file.
1549 If you don't do this, BackupPC will automatically re-read the
1550 hosts file at the next regular wakeup.
1551
1552 Note that when you remove a client's backups you won't initially recover
1553 a lot of disk space.  That's because the client's files are still in
1554 the pool.  Overnight, when BackupPC_nightly next runs, all the unused
1555 pool files will be deleted and this will recover the disk space used
1556 by the client's backups.
1557
1558 =item Copying the pool
1559
1560 If the pool disk requirements grow you might need to copy the entire
1561 data directory to a new (bigger) file system.  Hopefully you are lucky
1562 enough to avoid this by having the data directory on a RAID file system
1563 or LVM that allows the capacity to be grown in place by adding disks.
1564
1565 The backup data directories contain large numbers of hardlinks.  If
1566 you try to copy the pool the target directory will occupy a lot more
1567 space if the hardlinks aren't re-established.
1568
1569 The GNU cp program with the -a option is aware of hardlinks and knows
1570 to re-establish them.  So GNU cp -a is the recommended way to copy
1571 the data directory and pool.  Don't forget to stop BackupPC while
1572 the copy runs.
1573
1574 =item Compressing an existing pool
1575
1576 If you are upgrading BackupPC and want to turn compression on you have
1577 two choices:
1578
1579 =over 4
1580
1581 =item *
1582
1583 Simply turn on compression.  All new backups will be compressed. Both old
1584 (uncompressed) and new (compressed) backups can be browsed and viewed.
1585 Eventually, the old backups will expire and all the pool data will be
1586 compressed. However, until the old backups expire, this approach could
1587 require 60% or more additional pool storage space to store both
1588 uncompressed and compressed versions of the backup files.
1589
1590 =item *
1591
1592 Convert all the uncompressed pool files and backups to compressed.
1593 The script __INSTALLDIR__/bin/BackupPC_compressPool does this.
1594 BackupPC must not be running when you run BackupPC_compressPool.
1595 Also, there must be no existing compressed backups when you
1596 run BackupPC_compressPool.
1597
1598 BackupPC_compressPool compresses all the files in the uncompressed pool
1599 (__TOPDIR__/pool) and moves them to the compressed pool
1600 (__TOPDIR__/cpool). It rewrites the files in place, so that the
1601 existing hardlinks are not disturbed.
1602
1603 =back
1604
1605 The rest of this section discusses how to run BackupPC_compressPool.
1606
1607 BackupPC_compressPool takes three command line options:
1608
1609 =over 4
1610
1611 =item -t
1612
1613 Test mode: do everything except actually replace the pool files.
1614 Useful for estimating total run time without making any real
1615 changes.
1616
1617 =item -r
1618
1619 Read check: re-read the compressed file and compare it against
1620 the original uncompressed file.  Can only be used in test mode.
1621
1622 =item -c #
1623
1624 Number of children to fork. BackupPC_compressPool can take a long time
1625 to run, so to speed things up it spawns four children, each working on a
1626 different part of the pool. You can change the number of children with
1627 the -c option.
1628
1629 =back
1630
1631 Here are the recommended steps for running BackupPC_compressPool:
1632
1633 =over 4
1634
1635 =item *
1636
1637 Stop BackupPC (eg: "/etc/init.d/backuppc stop").
1638
1639 =item *
1640
1641 Set $Conf{CompressLevel} to a non-zero number (eg: 3).
1642
1643 =item *
1644
1645 Do a dry run of BackupPC_compressPool.  Make sure you run this as
1646 the BackupPC user (__BACKUPPCUSER__):
1647
1648     BackupPC_compressPool -t -r
1649
1650 The -t option (test mode) makes BackupPC_compressPool do all the steps,
1651 but not actually change anything. The -r option re-reads the compressed
1652 file and compares it against the original.
1653
1654 BackupPC_compressPool gives a status as it completes each 1% of the job.
1655 It also shows the cumulative compression ratio and estimated completion
1656 time.  Once you are comfortable that things look ok, you can kill
1657 BackupPC_compressPool or wait for it to finish.
1658
1659 =item *
1660
1661 Now you are ready to run BackupPC_compressPool for real.  Once again,
1662 as the BackupPC user (__BACKUPPCUSER__), run:
1663
1664     BackupPC_compressPool
1665
1666 You should put the output into a file and tail this file.  (The running
1667 time could be twice as long as the test mode since the test mode file
1668 writes are immediately followed by an unlink, so in test mode it is
1669 likely the file writes never make it to disk.)
1670
1671 It is B<critical> that BackupPC_compressPool runs to completion before
1672 re-starting BackupPC.  Before BackupPC_compressPool completes, none of
1673 the existing backups will be in a consistent state.  If you must stop
1674 BackupPC_compressPool for some reason, send it an INT or TERM signal
1675 and give it several seconds (or more) to clean up gracefully.
1676 After that, you can re-run BackupPC_compressPool and it will start
1677 again where it left off.  Once again, it is critical that it runs
1678 to 100% completion.
1679
1680 =back
1681
1682 After BackupPC_compressPool completes you should have a complete set
1683 of compressed backups (and your disk usage should be lower).  You
1684 can now re-start BackupPC.
1685
1686 =back
1687
1688 =head2 Debugging installation problems
1689
1690 This section will probably grow based on the types of questions on
1691 the BackupPC mail list.  Eventually the FAQ at
1692 L<http://backuppc.sourceforge.net/faq/> will include more details
1693 than this section.
1694
1695 =over 4
1696
1697 =item Check log files
1698
1699 Assuming BackupPC can start correctly you should inspect __TOPDIR__/log/LOG
1700 for any errors.  Assuming backups for a particular host start, you
1701 should be able to look in __TOPDIR__/pc/$host/LOG for error messages
1702 specific to that host.  Always check both log files.
1703
1704 =item CGI script doesn't run
1705
1706 Perhaps the most common program with the installation is getting the
1707 CGI script to run.  Often the setuid isn't configured correctly, or
1708 doesn't work on your system.
1709
1710 First, try running BackupPC_Admin manually as the BackupPC user, eg:
1711
1712     su __BACKUPPCUSER__
1713     __CGIDIR__/BackupPC_Admin
1714
1715 Now try running it as the httpd user (which ever user apache runs as);
1716
1717     su httpd
1718     __CGIDIR__/BackupPC_Admin
1719
1720 In both cases do you get normal html output?
1721
1722 If the first case works but the second case fails with an error that
1723 the wrong user is running the script then you have a setuid problem.
1724 (This assumes you are running BackupPC_Admin without mod_perl, and
1725 you therefore need seduid to work.  If you are using mod_perl then
1726 apache should run as user __BACKUPPCUSER__.)
1727
1728 First you should make sure the cgi-bin directory is on a file system
1729 that doesn't have the "nosuid" mount option.  
1730
1731 Next, experiment by creating this script:
1732
1733     #!/bin/perl
1734
1735     printf("My userid is $> (%s)\n", (getpwuid($>))[0]);
1736
1737 then chown it to backuppc and chmod u+s:
1738
1739     root# chown backuppc testsetuid
1740     root# chmod u+s testsetuid
1741     root# chmod a+x testsetuid
1742     root# ls -l testsetuid
1743     -rwsr-xr-x    1 backuppc  wheel          76 Aug 26 09:46 testsetuid*
1744
1745 Now run this program as a normal user.  What uid does it print?
1746 Try changing the first line of the script to directly call sperl:
1747
1748     #!/usr/bin/sperl5.8.0
1749
1750 (modify according to your version and path).  Does this work
1751 instead?
1752
1753 Finally, you should invoke the CGI script from a browser, using
1754 a URL like:
1755
1756     http://myHost/cgi-bin/BackupPC/BackupPC_Admin
1757
1758 You should make sure REMOTE_USER is being set by apache (see the
1759 earlier section) so that user authentication works.  Make sure
1760 the config settings $Conf{CgiAdminUserGroup} and $Conf{CgiAdminUsers}
1761 correctly specify the privileged administrator users.
1762
1763 =item You cannot access per-host information in the CGI interface
1764
1765 If you get the error
1766
1767     Only privileged users can view information about host xyz
1768
1769 it means that BackupPC_Admin is unable to match the user's login
1770 name (supplied by Apache via the REMOTE_USER environment variable)
1771 with either that host's user name (in the conf/hosts file) or
1772 with the administrators specified in the $Conf{CgiAdminUsers}
1773 or $Conf{CgiAdminUserGroup} settings.
1774
1775 The most common problem is that REMOTE_USER is not set because the
1776 Apache authentication is not correctly configured.  In this case
1777 BackupPC_Admin will report this additional error:
1778
1779     Note: $ENV{REMOTE_USER} is not set, which could mean there is an
1780     installation problem.  BackupPC_Admin expects Apache to authenticate
1781     the user and pass their user name into this script as the REMOTE_USER
1782     environment variable.  See the documentation.
1783
1784 You should review the configuration instructions to setup Apache
1785 authentication correctly.  To test if REMOTE_USER is being set
1786 correctly, there is a simple script called printenv that is
1787 included with Apache.  This is a simple CGI script that prints
1788 out all the environment variables.  Place this script in the
1789 same directory as BackupPC_Admin and run it with a URL like:
1790
1791     http://myHost/cgi-bin/BackupPC/printenv
1792
1793 Check the value of the REMOTE_USER environment variable.
1794 Here's a copy of the printenv script:
1795
1796     #!/usr/bin/perl
1797     ##
1798     ##  printenv -- demo CGI program which just prints its environment
1799     ##
1800
1801     print "Content-type: text/plain\n\n";
1802     foreach $var (sort(keys(%ENV))) {
1803         $val = $ENV{$var};
1804         $val =~ s|\n|\\n|g;
1805         $val =~ s|"|\\"|g;
1806         print "${var}=\"${val}\"\n";
1807     }
1808
1809 =item Can't ping or find host
1810
1811 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>.
1812
1813 The BackupPC_dump command now has a -v option, so the easiest way to
1814 debug backup problems on a specific host is to run BackupPC_dump
1815 manually as the BackupPC user:
1816
1817     su __BACKUPPCUSER__
1818     __INSTALLDIR__/bin/BackupPC_dump -v -f hostName
1819
1820 This will run a full dump on hostName (replace with your host name).
1821 It will show each command (eg: ping, nmblookup and the full dump
1822 commands) and the output from each command.  Reading the output
1823 carefully should show you what the problem is.
1824
1825 You can also verify that nmblookup correctly returns the netbios name.
1826 This is essential for DHCP hosts, and depending upon the setting of
1827 $Conf{FixedIPNetBiosNameCheck} might also be required for fixed IP
1828 address hosts too.  Run this command:
1829
1830     nmblookup -A hostName
1831
1832 Verify that the host name is printed.  The output might look like:
1833
1834     received 7 names
1835             DELLLS13        <00> -         P <ACTIVE> 
1836             DOMAINNAME      <00> - <GROUP> P <ACTIVE> 
1837             DELLLS13        <20> -         P <ACTIVE> 
1838             DOMAINNAME      <1e> - <GROUP> P <ACTIVE> 
1839             DELLLS13        <03> -         P <ACTIVE> 
1840             DELLLS13$       <03> -         P <ACTIVE> 
1841             CRAIG           <03> -         P <ACTIVE> 
1842
1843 The first name, converted to lower case, is used for the host name.
1844
1845 =item Transport method doesn't work
1846
1847 The BackupPC_dump command has a -v option, so the easiest way to
1848 debug backup problems on a specific host is to run BackupPC_dump
1849 manually as the BackupPC user:
1850
1851     su __BACKUPPCUSER__
1852     __INSTALLDIR__/bin/BackupPC_dump -v -f hostName
1853
1854 This will run a full dump on hostName (replace with your host name)
1855 and will print all the output from each command, including the log
1856 output.
1857
1858 The most likely problems will relate to connecting to the smb shares on
1859 each host.  On each failed backup, a file __TOPDIR__/pc/$host/XferLOG.bad.z
1860 will be created.  This is the stderr output from the transport program.
1861 You can view this file via the CGI interface, or manually uncompress it
1862 with;
1863
1864     __INSTALLDIR__/bin/BackupPC_zcat __TOPDIR__/pc/$host/XferLOG.bad.z | more
1865
1866 The first line will show the full command that was run (eg: rsync, tar
1867 or smbclient).  Based on the error messages you should figure out what
1868 is wrong.  Possible errors on the server side are invalid host, invalid
1869 share name, bad username or password.  Possible errors on the client
1870 side are misconfiguration of the share, username or password.
1871
1872 You should try running the command manually to see what happens.
1873 For example, for smbclient you should it manually and verify that
1874 you can connect to the host in interactive mode, eg:
1875
1876     smbclient '\\hostName\shareName' -U userName
1877
1878 shareName should match the $Conf{SmbShareName} setting and userName
1879 should match the the $Conf{SmbShareUserName} setting.
1880
1881 You will be prompted for the password. You should then see this prompt:
1882
1883     smb: \>
1884
1885 Verify that "ls" works and then type "quit" to exit.
1886
1887 =back
1888
1889 =head1 Restore functions
1890
1891 BackupPC supports several different methods for restoring files. The
1892 most convenient restore options are provided via the CGI interface.
1893 Alternatively, backup files can be restored using manual commands.
1894
1895 =head2 CGI restore options
1896
1897 By selecting a host in the CGI interface, a list of all the backups
1898 for that machine will be displayed.  By selecting the backup number
1899 you can navigate the shares and directory tree for that backup.
1900
1901 BackupPC's CGI interface automatically fills incremental backups
1902 with the corresponding full backup, which means each backup has
1903 a filled appearance.  Therefore, there is no need to do multiple
1904 restores from the incremental and full backups: BackupPC does all
1905 the hard work for you.  You simply select the files and directories
1906 you want from the correct backup vintage in one step.
1907
1908 You can download a single backup file at any time simply by selecting
1909 it.  Your browser should prompt you with the file name and ask you
1910 whether to open the file or save it to disk.
1911
1912 Alternatively, you can select one or more files or directories in
1913 the currently selected directory and select "Restore selected files".
1914 (If you need to restore selected files and directories from several
1915 different parent directories you will need to do that in multiple
1916 steps.)
1917
1918 If you select all the files in a directory, BackupPC will replace
1919 the list of files with the parent directory.  You will be presented
1920 with a screen that has three options:
1921
1922 =over 4
1923
1924 =item Option 1: Direct Restore
1925
1926 With this option the selected files and directories are restored
1927 directly back onto the host, by default in their original location.
1928 Any old files with the same name will be overwritten, so use caution.
1929 You can optionally change the target host name, target share name,
1930 and target path prefix for the restore, allowing you to restore the
1931 files to a different location.
1932
1933 Once you select "Start Restore" you will be prompted one last time
1934 with a summary of the exact source and target files and directories
1935 before you commit.  When you give the final go ahead the restore
1936 operation will be queued like a normal backup job, meaning that it
1937 will be deferred if there is a backup currently running for that host.
1938 When the restore job is run, smbclient or tar is used (depending upon
1939 $Conf{XferMethod}) to actually restore the files.  Sorry, there is
1940 currently no option to cancel a restore that has been started.
1941
1942 A record of the restore request, including the result and list of
1943 files and directories, is kept.  It can be browsed from the host's
1944 home page.  $Conf{RestoreInfoKeepCnt} specifies how many old restore
1945 status files to keep.
1946
1947 =item Option 2: Download Zip archive
1948
1949 With this option a zip file containing the selected files and directories
1950 is downloaded.  The zip file can then be unpacked or individual files
1951 extracted as necessary on the host machine. The compression level can be
1952 specified.  A value of 0 turns off compression.
1953
1954 When you select "Download Zip File" you should be prompted where to
1955 save the restore.zip file.
1956
1957 BackupPC does not consider downloading a zip file as an actual
1958 restore operation, so the details are not saved for later browsing
1959 as in the first case.  However, a mention that a zip file was
1960 downloaded by a particular user, and a list of the files, does
1961 appear in BackupPC's log file.
1962
1963 =item Option 3: Download Tar archive
1964
1965 This is identical to the previous option, except a tar file is downloaded
1966 rather than a zip file (and there is currently no compression option).
1967
1968 =back
1969
1970 =head2 Command-line restore options
1971
1972 Apart from the CGI interface, BackupPC allows you to restore files
1973 and directories from the command line.  The following programs can
1974 be used:
1975
1976 =over 4
1977
1978 =item BackupPC_zcat
1979
1980 For each file name argument it inflates (uncompresses) the file and
1981 writes it to stdout.  To use BackupPC_zcat you could give it the
1982 full file name, eg:
1983
1984     __INSTALLDIR__/bin/BackupPC_zcat __TOPDIR__/pc/host/5/fc/fcraig/fexample.txt > example.txt
1985
1986 It's your responsibility to make sure the file is really compressed:
1987 BackupPC_zcat doesn't check which backup the requested file is from.
1988
1989 =item BackupPC_tarCreate
1990
1991 BackupPC_tarCreate creates a tar file for any files or directories in
1992 a particular backup.  Merging of incrementals is done automatically,
1993 so you don't need to worry about whether certain files appear in the
1994 incremental or full backup.
1995
1996 The usage is:
1997
1998    BackupPC_tarCreate [-t] [-h host] [-n dumpNum] [-s shareName]
1999                     [-r pathRemove] [-p pathAdd]
2000                     files/directories...
2001
2002 The command-line files and directories are relative to the specified
2003 shareName.  The tar file is written to stdout.
2004
2005 The required options are:
2006
2007 =over 4
2008
2009 =item -h host
2010
2011 host from which the tar archive is created
2012
2013 =item -n dumpNum
2014
2015 dump number from which the tar archive is created
2016
2017 =item -s shareName
2018
2019 share name from which the tar archive is created
2020
2021 =back
2022
2023 Other options are:
2024
2025 =over 4
2026
2027 =item -t
2028
2029 print summary totals
2030
2031 =item -r pathRemove
2032
2033 path prefix that will be replaced with pathAdd
2034
2035 =item -p pathAdd
2036
2037 new path prefix
2038
2039 =back
2040
2041 The -h, -n and -s options specify which dump is used to generate
2042 the tar archive.  The -r and -p options can be used to relocate
2043 the paths in the tar archive so extracted files can be placed
2044 in a location different from their original location.
2045
2046 =item BackupPC_zipCreate
2047
2048 BackupPC_zipCreate creates a zip file for any files or directories in
2049 a particular backup.  Merging of incrementals is done automatically,
2050 so you don't need to worry about whether certain files appear in the
2051 incremental or full backup.
2052
2053 The usage is:
2054
2055    BackupPC_zipCreate [-t] [-h host] [-n dumpNum] [-s shareName]
2056                     [-r pathRemove] [-p pathAdd] [-c compressionLevel]
2057                    files/directories...
2058
2059 The command-line files and directories are relative to the specified
2060 shareName.  The zip file is written to stdout.
2061
2062 The required options are:
2063
2064 =over 4
2065
2066 =item -h host
2067
2068 host from which the zip archive is created
2069
2070 =item -n dumpNum
2071
2072 dump number from which the zip archive is created
2073
2074 =item -s shareName
2075
2076 share name from which the zip archive is created
2077
2078 =back
2079
2080 Other options are:
2081
2082 =over 4
2083
2084 =item -t
2085
2086 print summary totals
2087
2088 =item -r pathRemove
2089
2090 path prefix that will be replaced with pathAdd
2091
2092 =item -p pathAdd
2093
2094 new path prefix
2095
2096 =item -c level
2097
2098 compression level (default is 0, no compression)
2099
2100 =back
2101
2102 The -h, -n and -s options specify which dump is used to generate
2103 the zip archive.  The -r and -p options can be used to relocate
2104 the paths in the zip archive so extracted files can be placed
2105 in a location different from their original location.
2106
2107 =back
2108
2109 Each of these programs reside in __INSTALLDIR__/bin.
2110
2111 =head1 Archive functions
2112
2113 BackupPC supports archiving to removable media. For users that require
2114 offsite backups, BackupPC can create archives that stream to tape
2115 devices, or create files of specified sizes to fit onto cd or dvd media.
2116
2117 Each archive type is specified by a BackupPC host with its XferMethod
2118 set to 'archive'. This allows for multiple configurations at sites where
2119 there might be a combination of tape and cd/dvd backups being made.
2120
2121 BackupPC provides a menu that allows one or more hosts to be archived.
2122 The most recent backup of each host is archived using BackupPC_tarCreate,
2123 and the output is optionally compressed and split into fixed-sized
2124 files (eg: 650MB).
2125
2126 The archive for each host is done by default using
2127 __INSTALLDIR__/BackupPC_archiveHost.  This script can be copied
2128 and customized as needed.
2129
2130 =head2 Configuring an Archive Host
2131
2132 To create an Archive Host, add it to the hosts file just as any other host
2133 and call it a name that best describes the type of archive, e.g. ArchiveDLT
2134
2135 To tell BackupPC that the Host is for Archives, create a config.pl file in 
2136 the Archive Hosts's pc directory, adding the following line:
2137
2138 $Conf{XferMethod} = 'archive';
2139
2140 To further customise the archive's parameters you can adding the changed
2141 parameters in the host's config.pl file. The parameters are explained in
2142 the config.pl file.  Parameters may be fixed or the user can be allowed 
2143 to change them (eg: output device).
2144
2145 The per-host archive command is $Conf{ArchiveClientCmd}.  By default
2146 this invokes __INSTALLDIR__/BackupPC_archiveHost, which you can
2147 copy and customize as necessary.
2148
2149 =head2 Starting an Archive
2150
2151 In the web interface, click on the Archive Host you wish to use. You will see a
2152 list of previous archives and a summary on each. By clicking the "Start Archive"
2153 button you are presented with the list of hosts and the approximate backup size
2154 (note this is raw size, not projected compressed size) Select the hosts you wish
2155 to archive and press the "Archive Selected Hosts" button.
2156
2157 The next screen allows you to adjust the parameters for this archive run.
2158 Press the "Start the Archive" to start archiving the selected hosts with the
2159 parameters displayed.
2160
2161 =head1 BackupPC Design
2162
2163 =head2 Some design issues
2164
2165 =over 4
2166
2167 =item Pooling common files
2168
2169 To quickly see if a file is already in the pool, an MD5 digest of the
2170 file length and contents is used as the file name in the pool. This
2171 can't guarantee a file is identical: it just reduces the search to
2172 often a single file or handful of files. A complete file comparison
2173 is always done to verify if two files are really the same.
2174
2175 Identical files on multiples backups are represented by hard links.
2176 Hardlinks are used so that identical files all refer to the same
2177 physical file on the server's disk. Also, hard links maintain
2178 reference counts so that BackupPC knows when to delete unused files
2179 from the pool.
2180
2181 For the computer-science majors among you, you can think of the pooling
2182 system used by BackupPC as just a chained hash table stored on a (big)
2183 file system.
2184
2185 =item The hashing function
2186
2187 There is a tradeoff between how much of file is used for the MD5 digest
2188 and the time taken comparing all the files that have the same hash.
2189
2190 Using the file length and just the first 4096 bytes of the file for the
2191 MD5 digest produces some repetitions.  One example: with 900,000 unique
2192 files in the pool, this hash gives about 7,000 repeated files, and in
2193 the worst case 500 files have the same hash.  That's not bad: we only
2194 have to do a single file compare 99.2% of the time.  But in the worst
2195 case we have to compare as many as 500 files checking for a match.
2196
2197 With a modest increase in CPU time, if we use the file length and the
2198 first 256K of the file we now only have 500 repeated files and in the
2199 worst case around 20 files have the same hash. Furthermore, if we
2200 instead use the first and last 128K of the file (more specifically, the
2201 first and eighth 128K chunks for files larger than 1MB) we get only 300
2202 repeated files and in the worst case around 20 files have the same hash.
2203
2204 Based on this experimentation, this is the hash function used by BackupPC.
2205 It is important that you don't change the hash function after files
2206 are already in the pool.  Otherwise your pool will grow to twice the
2207 size until all the old backups (and all the old files with old hashes)
2208 eventually expire.
2209
2210 =item Compression
2211
2212 BackupPC supports compression. It uses the deflate and inflate methods
2213 in the Compress::Zlib module, which is based on the zlib compression
2214 library (see L<http://www.gzip.org/zlib/>).
2215
2216 The $Conf{CompressLevel} setting specifies the compression level to use.
2217 Zero (0) means no compression. Compression levels can be from 1 (least
2218 cpu time, slightly worse compression) to 9 (most cpu time, slightly
2219 better compression). The recommended value is 3. Changing it to 5, for
2220 example, will take maybe 20% more cpu time and will get another 2-3%
2221 additional compression. Diminishing returns set in above 5.  See the zlib
2222 documentation for more information about compression levels.
2223
2224 BackupPC implements compression with minimal CPU load. Rather than
2225 compressing every incoming backup file and then trying to match it
2226 against the pool, BackupPC computes the MD5 digest based on the
2227 uncompressed file, and matches against the candidate pool files by
2228 comparing each uncompressed pool file against the incoming backup file.
2229 Since inflating a file takes roughly a factor of 10 less CPU time than
2230 deflating there is a big saving in CPU time.
2231
2232 The combination of pooling common files and compression can yield
2233 a factor of 8 or more overall saving in backup storage.
2234
2235 =back
2236
2237 =head2 BackupPC operation
2238
2239 BackupPC reads the configuration information from
2240 __TOPDIR__/conf/config.pl. It then runs and manages all the backup
2241 activity. It maintains queues of pending backup requests, user backup
2242 requests and administrative commands. Based on the configuration various
2243 requests will be executed simultaneously.
2244
2245 As specified by $Conf{WakeupSchedule}, BackupPC wakes up periodically
2246 to queue backups on all the PCs.  This is a four step process:
2247
2248 =over 4
2249
2250 =item 1
2251
2252 For each host and DHCP address backup requests are queued on the
2253 background command queue.
2254
2255 =item 2
2256
2257 For each PC, BackupPC_dump is forked. Several of these may be run in
2258 parallel, based on the configuration. First a ping is done to see if the
2259 machine is alive. If this is a DHCP address, nmblookup is run to get
2260 the netbios name, which is used as the host name. The file
2261 __TOPDIR__/pc/$host/backups is read to decide whether a full or
2262 incremental backup needs to be run. If no backup is scheduled, or the ping
2263 to $host fails, then BackupPC_dump exits.
2264
2265 The backup is done using samba's smbclient or tar over ssh/rsh/nfs piped
2266 into BackupPC_tarExtract, extracting the backup into __TOPDIR__/pc/$host/new.
2267 The smbclient or tar output is put into __TOPDIR__/pc/$host/XferLOG.
2268
2269 As BackupPC_tarExtract extracts the files from smbclient, it checks each
2270 file in the backup to see if it is identical to an existing file from
2271 any previous backup of any PC. It does this without needed to write the
2272 file to disk. If the file matches an existing file, a hardlink is
2273 created to the existing file in the pool. If the file does not match any
2274 existing files, the file is written to disk and the file name is saved
2275 in __TOPDIR__/pc/$host/NewFileList for later processing by
2276 BackupPC_link.  BackupPC_tarExtract can handle arbitrarily large
2277 files and multiple candidate matching files without needing to
2278 write the file to disk in the case of a match.  This significantly
2279 reduces disk writes (and also reads, since the pool file comparison
2280 is done disk to memory, rather than disk to disk).
2281
2282 Based on the configuration settings, BackupPC_dump checks each
2283 old backup to see if any should be removed.  Any expired backups
2284 are moved to __TOPDIR__/trash for later removal by BackupPC_trashClean.
2285
2286 =item 3
2287
2288 For each complete, good, backup, BackupPC_link is run.
2289 To avoid race conditions as new files are linked into the
2290 pool area, only a single BackupPC_link program runs
2291 at a time and the rest are queued.
2292
2293 BackupPC_link reads the NewFileList written by BackupPC_dump and
2294 inspects each new file in the backup. It re-checks if there is a
2295 matching file in the pool (another BackupPC_link
2296 could have added the file since BackupPC_dump checked). If so, the file
2297 is removed and replaced by a hard link to the existing file. If the file
2298 is new, a hard link to the file is made in the pool area, so that this
2299 file is available for checking against each new file and new backup.
2300
2301 Then, assuming $Conf{IncrFill} is set, for each incremental backup,
2302 hard links are made in the new backup to all files that were not extracted
2303 during the incremental backups.  The means the incremental backup looks
2304 like a complete image of the PC (with the exception that files
2305 that were removed on the PC since the last full backup will still
2306 appear in the backup directory tree).
2307
2308 As of v1.03, the CGI interface knows how to merge unfilled
2309 incremental backups will the most recent prior filled (full)
2310 backup, giving the incremental backups a filled appearance.  The
2311 default for $Conf{IncrFill} is off, since there is now no need to
2312 fill incremental backups.  This saves some level of disk activity,
2313 since lots of extra hardlinks are no longer needed (and don't have
2314 to be deleted when the backup expires).
2315
2316 =item 4
2317
2318 BackupPC_trashClean is always run in the background to remove any
2319 expired backups. Every 5 minutes it wakes up and removes all the files
2320 in __TOPDIR__/trash.
2321
2322 Also, once each night, BackupPC_nightly is run to complete some additional
2323 administrative tasks, such as cleaning the pool.  This involves removing
2324 any files in the pool that only have a single hard link (meaning no backups
2325 are using that file).  Again, to avoid race conditions, BackupPC_nightly
2326 is only run when there are no BackupPC_dump or BackupPC_link processes
2327 running.
2328
2329 =back
2330
2331 BackupPC also listens for TCP connections on $Conf{ServerPort}, which
2332 is used by the CGI script BackupPC_Admin for status reporting and
2333 user-initiated backup or backup cancel requests.
2334
2335 =head2 Storage layout
2336
2337 BackupPC resides in three directories:
2338
2339 =over 4
2340
2341 =item __INSTALLDIR__
2342
2343 Perl scripts comprising BackupPC reside in __INSTALLDIR__/bin,
2344 libraries are in __INSTALLDIR__/lib and documentation
2345 is in __INSTALLDIR__/doc.
2346
2347 =item __CGIDIR__
2348
2349 The CGI script BackupPC_Admin resides in this cgi binary directory.
2350
2351 =item __TOPDIR__
2352
2353 All of BackupPC's data (PC backup images, logs, configuration information)
2354 is stored below this directory.
2355
2356 =back
2357
2358 Below __TOPDIR__ are several directories:
2359
2360 =over 4
2361
2362 =item __TOPDIR__/conf
2363
2364 The directory __TOPDIR__/conf contains:
2365
2366 =over 4
2367
2368 =item config.pl
2369
2370 Configuration file. See L<Configuration file|configuration file>
2371 below for more details.
2372
2373 =item hosts
2374
2375 Hosts file, which lists all the PCs to backup.
2376
2377 =back
2378
2379 =item __TOPDIR__/log
2380
2381 The directory __TOPDIR__/log contains:
2382
2383 =over 4
2384
2385 =item LOG
2386
2387 Current (today's) log file output from BackupPC.
2388
2389 =item LOG.0 or LOG.0.z
2390
2391 Yesterday's log file output.  Log files are aged daily and compressed
2392 (if compression is enabled), and old LOG files are deleted.
2393
2394 =item BackupPC.pid
2395
2396 Contains BackupPC's process id.
2397
2398 =item status.pl
2399
2400 A summary of BackupPC's status written periodically by BackupPC so
2401 that certain state information can be maintained if BackupPC is
2402 restarted.  Should not be edited.
2403
2404 =item UserEmailInfo.pl
2405
2406 A summary of what email was last sent to each user, and when the
2407 last email was sent.  Should not be edited.
2408
2409 =back
2410
2411 =item __TOPDIR__/trash
2412
2413 Any directories and files below this directory are periodically deleted
2414 whenever BackupPC_trashClean checks. When a backup is aborted or when an
2415 old backup expires, BackupPC_dump simply moves the directory to
2416 __TOPDIR__/trash for later removal by BackupPC_trashClean.
2417
2418 =item __TOPDIR__/pool
2419
2420 All uncompressed files from PC backups are stored below __TOPDIR__/pool.
2421 Each file's name is based on the MD5 hex digest of the file contents.
2422 Specifically, for files less than 256K, the file length and the entire
2423 file is used. For files up to 1MB, the file length and the first and
2424 last 128K are used. Finally, for files longer than 1MB, the file length,
2425 and the first and eighth 128K chunks for the file are used.
2426
2427 Each file is stored in a subdirectory X/Y/Z, where X, Y, Z are the
2428 first 3 hex digits of the MD5 digest.
2429
2430 For example, if a file has an MD5 digest of 123456789abcdef0,
2431 the file is stored in __TOPDIR__/pool/1/2/3/123456789abcdef0.
2432
2433 The MD5 digest might not be unique (especially since not all the file's
2434 contents are used for files bigger than 256K). Different files that have
2435 the same MD5 digest are stored with a trailing suffix "_n" where n is
2436 an incrementing number starting at 0. So, for example, if two additional
2437 files were identical to the first, except the last byte was different,
2438 and assuming the file was larger than 1MB (so the MD5 digests are the
2439 same but the files are actually different), the three files would be
2440 stored as:
2441
2442         __TOPDIR__/pool/1/2/3/123456789abcdef0
2443         __TOPDIR__/pool/1/2/3/123456789abcdef0_0
2444         __TOPDIR__/pool/1/2/3/123456789abcdef0_1
2445
2446 Both BackupPC_dump (actually, BackupPC_tarExtract) and BackupPC_link are
2447 responsible for checking newly backed up files against the pool. For
2448 each file, the MD5 digest is used to generate a file name in the pool
2449 directory. If the file exists in the pool, the contents are compared.
2450 If there is no match, additional files ending in "_n" are checked.
2451 (Actually, BackupPC_tarExtract compares multiple candidate files in
2452 parallel.)  If the file contents exactly match, the file is created by
2453 simply making a hard link to the pool file (this is done by
2454 BackupPC_tarExtract as the backup proceeds). Otherwise,
2455 BackupPC_tarExtract writes the new file to disk and a new hard link is
2456 made in the pool to the file (this is done later by BackupPC_link).
2457
2458 Therefore, every file in the pool will have at least 2 hard links
2459 (one for the pool file and one for the backup file below __TOPDIR__/pc).
2460 Identical files from different backups or PCs will all be linked to
2461 the same file.  When old backups are deleted, some files in the pool
2462 might only have one link.  BackupPC_nightly checks the entire pool
2463 and removes all files that have only a single link, thereby recovering
2464 the storage for that file.
2465
2466 One other issue: zero length files are not pooled, since there are a lot
2467 of these files and on most file systems it doesn't save any disk space
2468 to turn these files into hard links.
2469
2470 =item __TOPDIR__/cpool
2471
2472 All compressed files from PC backups are stored below __TOPDIR__/cpool.
2473 Its layout is the same as __TOPDIR__/pool, and the hashing function
2474 is the same (and, importantly, based on the uncompressed file, not
2475 the compressed file).
2476
2477 =item __TOPDIR__/pc/$host
2478
2479 For each PC $host, all the backups for that PC are stored below
2480 the directory __TOPDIR__/pc/$host.  This directory contains the
2481 following files:
2482
2483 =over 4
2484
2485 =item LOG
2486
2487 Current log file for this PC from BackupPC_dump.
2488
2489 =item LOG.0 or LOG.0.z
2490
2491 Last month's log file.  Log files are aged monthly and compressed
2492 (if compression is enabled), and old LOG files are deleted.
2493
2494 =item XferERR or XferERR.z
2495
2496 Output from the transport program (ie: smbclient or tar)
2497 for the most recent failed backup.
2498
2499 =item new
2500
2501 Subdirectory in which the current backup is stored.  This
2502 directory is renamed if the backup succeeds.
2503
2504 =item XferLOG or XferLOG.z
2505
2506 Output from the transport program (ie: smbclient or tar)
2507 for the current backup.
2508
2509 =item nnn (an integer)
2510
2511 Successful backups are in directories numbered sequentially starting at 0.
2512
2513 =item XferLOG.nnn or XferLOG.nnn.z
2514
2515 Output from the transport program (ie: smbclient or tar)
2516 corresponding to backup number nnn.
2517
2518 =item RestoreInfo.nnn
2519
2520 Information about restore request #nnn including who, what, when, and
2521 why. This file is in Data::Dumper format.  (Note that the restore
2522 numbers are not related to the backup number.)
2523
2524 =item RestoreLOG.nnn.z
2525
2526 Output from smbclient or tar during restore #nnn.  (Note that the restore
2527 numbers are not related to the backup number.)
2528
2529 =item config.pl
2530
2531 Optional configuration settings specific to this host.  Settings in this
2532 file override the main configuration file.
2533
2534 =item backups
2535
2536 A tab-delimited ascii table listing information about each successful
2537 backup, one per row.  The columns are:
2538
2539 =over 4
2540
2541 =item num
2542
2543 The backup number, an integer that starts at 0 and increments
2544 for each successive backup.  The corresponding backup is stored
2545 in the directory num (eg: if this field is 5, then the backup is
2546 stored in __TOPDIR__/pc/$host/5).
2547
2548 =item type
2549
2550 Set to "full" or "incr" for full or incremental backup.
2551
2552 =item startTime
2553
2554 Start time of the backup in unix seconds.
2555
2556 =item endTime
2557
2558 Stop time of the backup in unix seconds.
2559
2560 =item nFiles
2561
2562 Number of files backed up (as reported by smbclient or tar).
2563
2564 =item size
2565
2566 Total file size backed up (as reported by smbclient or tar).
2567
2568 =item nFilesExist
2569
2570 Number of files that were already in the pool
2571 (as determined by BackupPC_dump and BackupPC_link).
2572
2573 =item sizeExist
2574
2575 Total size of files that were already in the pool
2576 (as determined by BackupPC_dump and BackupPC_link).
2577
2578 =item nFilesNew
2579
2580 Number of files that were not in the pool
2581 (as determined by BackupPC_link).
2582
2583 =item sizeNew
2584
2585 Total size of files that were not in the pool
2586 (as determined by BackupPC_link).
2587
2588 =item xferErrs
2589
2590 Number of errors or warnings from smbclient (zero for tar).
2591
2592 =item xferBadFile
2593
2594 Number of errors from smbclient that were bad file errors (zero for tar).
2595
2596 =item xferBadShare
2597
2598 Number of errors from smbclient that were bad share errors (zero for tar).
2599
2600 =item tarErrs
2601
2602 Number of errors from BackupPC_tarExtract.
2603
2604 =item compress
2605
2606 The compression level used on this backup.  Zero or empty means no
2607 compression.
2608
2609 =item sizeExistComp
2610
2611 Total compressed size of files that were already in the pool
2612 (as determined by BackupPC_dump and BackupPC_link).
2613
2614 =item sizeNewComp
2615
2616 Total compressed size of files that were not in the pool
2617 (as determined by BackupPC_link).
2618
2619 =item noFill
2620
2621 Set if this backup has not been filled in with the most recent
2622 previous filled or full backup.  See $Conf{IncrFill}.
2623
2624 =item fillFromNum
2625
2626 If this backup was filled (ie: noFill is 0) then this is the
2627 number of the backup that it was filled from
2628
2629 =item mangle
2630
2631 Set if this backup has mangled file names and attributes.  Always
2632 true for backups in v1.4.0 and above.  False for all backups prior
2633 to v1.4.0.
2634
2635 =item xferMethod
2636
2637 Set to the value of $Conf{XferMethod} when this dump was done.
2638
2639 =item level
2640
2641 The level of this dump.  A full dump is level 0.  Currently incrementals
2642 are 1.  But when multi-level incrementals are supported this will reflect
2643 each dump's incremental level.
2644
2645 =back
2646
2647 =item restores
2648
2649 A tab-delimited ascii table listing information about each requested
2650 restore, one per row.  The columns are:
2651
2652 =over 4
2653
2654 =item num
2655
2656 Restore number (matches the suffix of the RestoreInfo.nnn and
2657 RestoreLOG.nnn.z file), unrelated to the backup number.
2658
2659 =item startTime
2660
2661 Start time of the restore in unix seconds.
2662
2663 =item endTime
2664
2665 End time of the restore in unix seconds.
2666
2667 =item result
2668
2669 Result (ok or failed).
2670
2671 =item errorMsg
2672
2673 Error message if restore failed.
2674
2675 =item nFiles
2676
2677 Number of files restored.
2678
2679 =item size
2680
2681 Size in bytes of the restored files.
2682
2683 =item tarCreateErrs
2684
2685 Number of errors from BackupPC_tarCreate during restore.
2686
2687 =item xferErrs
2688
2689 Number of errors from smbclient or tar during restore.
2690
2691 =back
2692
2693 =back
2694
2695 =back
2696
2697 =head2 Compressed file format
2698
2699 The compressed file format is as generated by Compress::Zlib::deflate
2700 with one minor, but important, tweak. Since Compress::Zlib::inflate
2701 fully inflates its argument in memory, it could take large amounts of
2702 memory if it was inflating a highly compressed file. For example, a
2703 200MB file of 0x0 bytes compresses to around 200K bytes. If
2704 Compress::Zlib::inflate was called with this single 200K buffer, it
2705 would need to allocate 200MB of memory to return the result.
2706
2707 BackupPC watches how efficiently a file is compressing. If a big file
2708 has very high compression (meaning it will use too much memory when it
2709 is inflated), BackupPC calls the flush() method, which gracefully
2710 completes the current compression.  BackupPC then starts another
2711 deflate and simply appends the output file.  So the BackupPC compressed
2712 file format is one or more concatenated deflations/flushes.  The specific
2713 ratios that BackupPC uses is that if a 6MB chunk compresses to less
2714 than 64K then a flush will be done.
2715
2716 Back to the example of the 200MB file of 0x0 bytes.  Adding flushes
2717 every 6MB adds only 200 or so bytes to the 200K output.  So the
2718 storage cost of flushing is negligible.
2719
2720 To easily decompress a BackupPC compressed file, the script
2721 BackupPC_zcat can be found in __INSTALLDIR__/bin.  For each
2722 file name argument it inflates the file and writes it to stdout.
2723
2724 =head2 File name mangling
2725
2726 Backup file names are stored in "mangled" form. Each node of
2727 a path is preceded by "f" (mnemonic: file), and special characters
2728 (\n, \r, % and /) are URI-encoded as "%xx", where xx is the ascii
2729 character's hex value.  So c:/craig/example.txt is now stored as
2730 fc/fcraig/fexample.txt.
2731
2732 This was done mainly so meta-data could be stored alongside the backup
2733 files without name collisions. In particular, the attributes for the
2734 files in a directory are stored in a file called "attrib", and mangling
2735 avoids file name collisions (I discarded the idea of having a duplicate
2736 directory tree for every backup just to store the attributes). Other
2737 meta-data (eg: rsync checksums) could be stored in file names preceded
2738 by, eg, "c". There are two other benefits to mangling: the share name
2739 might contain "/" (eg: "/home/craig" for tar transport), and I wanted
2740 that represented as a single level in the storage tree. Secondly, as
2741 files are written to NewFileList for later processing by BackupPC_link,
2742 embedded newlines in the file's path will cause problems which are
2743 avoided by mangling.
2744
2745 The CGI script undoes the mangling, so it is invisible to the user.
2746 Old (unmangled) backups are still supported by the CGI
2747 interface.
2748
2749 =head2 Special files
2750
2751 Linux/unix file systems support several special file types: symbolic
2752 links, character and block device files, fifos (pipes) and unix-domain
2753 sockets. All except unix-domain sockets are supported by BackupPC
2754 (there's no point in backing up or restoring unix-domain sockets since
2755 they only have meaning after a process creates them). Symbolic links are
2756 stored as a plain file whose contents are the contents of the link (not
2757 the file it points to). This file is compressed and pooled like any
2758 normal file. Character and block device files are also stored as plain
2759 files, whose contents are two integers separated by a comma; the numbers
2760 are the major and minor device number. These files are compressed and
2761 pooled like any normal file. Fifo files are stored as empty plain files
2762 (which are not pooled since they have zero size). In all cases, the
2763 original file type is stored in the attrib file so it can be correctly
2764 restored.
2765
2766 Hardlinks are also supported.  When GNU tar first encounters a file with
2767 more than one link (ie: hardlinks) it dumps it as a regular file.  When
2768 it sees the second and subsequent hardlinks to the same file, it dumps
2769 just the hardlink information.  BackupPC correctly recognizes these
2770 hardlinks and stores them just like symlinks: a regular text file
2771 whose contents is the path of the file linked to.  The CGI script
2772 will download the original file when you click on a hardlink.
2773
2774 Also, BackupPC_tarCreate has enough magic to re-create the hardlinks
2775 dynamically based on whether or not the original file and hardlinks
2776 are both included in the tar file.  For example, imagine a/b/x is a
2777 hardlink to a/c/y.  If you use BackupPC_tarCreate to restore directory
2778 a, then the tar file will include a/b/x as the original file and a/c/y
2779 will be a hardlink to a/b/x.  If, instead you restore a/c, then the
2780 tar file will include a/c/y as the original file, not a hardlink.
2781
2782 =head2 Attribute file format
2783
2784 The unix attributes for the contents of a directory (all the files and
2785 directories in that directory) are stored in a file called attrib.
2786 There is a single attrib file for each directory in a backup.
2787 For example, if c:/craig contains a single file c:/craig/example.txt,
2788 that file would be stored as fc/fcraig/fexample.txt and there would be an
2789 attribute file in fc/fcraig/attrib (and also fc/attrib and ./attrib).
2790 The file fc/fcraig/attrib would contain a single entry containing the
2791 attributes for fc/fcraig/fexample.txt.
2792
2793 The attrib file starts with a magic number, followed by the
2794 concatenation of the following information for each file:
2795
2796 =over 4
2797
2798 =item *
2799
2800 File name length in perl's pack "w" format (variable length base 128).
2801
2802 =item *
2803
2804 File name.
2805
2806 =item *
2807
2808 The unix file type, mode, uid, gid and file size divided by 4GB and
2809 file size modulo 4GB (type mode uid gid sizeDiv4GB sizeMod4GB),
2810 in perl's pack "w" format (variable length base 128).
2811
2812 =item *
2813
2814 The unix mtime (unix seconds) in perl's pack "N" format (32 bit integer).
2815
2816 =back
2817
2818 The attrib file is also compressed if compression is enabled.
2819 See the lib/BackupPC/Attrib.pm module for full details.
2820
2821 Attribute files are pooled just like normal backup files.  This saves
2822 space if all the files in a directory have the same attributes across
2823 multiple backups, which is common.
2824
2825 =head2 Optimizations
2826
2827 BackupPC doesn't care about the access time of files in the pool
2828 since it saves attribute meta-data separate from the files.  Since
2829 BackupPC mostly does reads from disk, maintaining the access time of
2830 files generates a lot of unnecessary disk writes.  So, provided 
2831 BackupPC has a dedicated data disk, you should consider mounting
2832 BackupPC's data directory with the noatime attribute (see mount(1)).
2833
2834 =head2 Limitations
2835
2836 BackupPC isn't perfect (but it is getting better).  Here are some
2837 limitations of BackupPC:
2838
2839 =over 4
2840
2841 =item Non-unix file attributes not backed up
2842
2843 smbclient doesn't extract the WinXX ACLs, so file attributes other than
2844 the equivalent (as provided by smbclient) unix attributes are not
2845 backed up.
2846
2847 =item Locked files are not backed up
2848
2849 Under WinXX a locked file cannot be read by smbclient.  Such files will
2850 not be backed up.  This includes the WinXX system registry files.
2851
2852 This is especially troublesome for Outlook, which stores all its data
2853 in a single large file and keeps it locked whenever it is running.
2854 Since many users keep Outlook running all the time their machine
2855 is up their Outlook file will not be backed up.  Sadly, this file
2856 is the most important file to backup.  As one workaround, Microsoft has
2857 a user-level application that periodically asks the user if they want to
2858 make a copy of their outlook.pst file.  This copy can then be backed up
2859 by BackupPC.  See L<http://office.microsoft.com/downloads/2002/pfbackup.aspx>.
2860
2861 Similarly, all of the data for WinXX services like SQL databases,
2862 Exchange etc won't be backed up.  If these applications support
2863 some kind of export or utility to save their data to disk then this
2864 can =used to create files that BackupPC can backup.
2865
2866 So far, the best that BackupPC can do is send warning emails to
2867 the user saying that their outlook files haven't been backed up in
2868 X days.  (X is configurable.)  The message invites the user to
2869 exit Outlook and gives a URL to manually start a backup.
2870
2871 I suspect there is a way of mirroring the outlook.pst file so
2872 that at least the mirror copy can be backed up.  Or perhaps a
2873 manual copy can be started at login.   Does some WinXX expert
2874 know how to do this?
2875
2876 Comment: two users have noted that there are commercial OFM (open file
2877 manager) products that are designed to solve this problem, for example
2878 from St. Bernard or Columbia Data Products. Apparently Veritas and
2879 Legato bundle this product with their commercial products.  See for
2880 example L<http://www.stbernard.com/products/docs/ofm_whitepaperV8.pdf>.
2881 If anyone tries these programs with BackupPC please tell us whether or
2882 not they work.
2883
2884 =item Don't expect to reconstruct a complete WinXX drive
2885
2886 The conclusion from the last few items is that BackupPC is not intended
2887 to allow a complete WinXX disk to be re-imaged from the backup. Our
2888 approach to system restore in the event of catastrophic failure is to
2889 re-image a new disk from a generic master, and then use the BackupPC
2890 archive to restore user files.
2891
2892 It is likely that linux/unix backups done using tar (rather than
2893 smb) can be used to reconstruct a complete file system, although
2894 I haven't tried it.
2895
2896 =item Maximum Backup File Sizes
2897
2898 BackupPC can backup and manage very large file sizes, probably as large
2899 as 2^51 bytes (when a double-precision number's mantissa can no longer
2900 represent an integer exactly).  In practice, several things outside
2901 BackupPC limit the maximum individual file size.  Any one of the
2902 following items will limit the maximum individual file size:
2903
2904 =over 4
2905
2906 =item Perl
2907
2908 Perl needs to be compiled with uselargefiles defined. Check your
2909 installation with:
2910
2911     perl -V | egrep largefiles
2912
2913 Without this, the maximum file size will be 2GB.
2914
2915 =item File system
2916
2917 The BackupPC pool and data directories must be on a file system that
2918 supports large files.
2919
2920 Without this, the maximum file size will be 2GB.
2921
2922 =item Transport
2923
2924 The transport mechanism also limits the maximum individual file size.
2925
2926 GNU tar maximum file size is limited by the tar header format. The tar
2927 header uses 11 octal digits to represent the file size, which is 33 bits
2928 or 8GB.  I vaguely recall (but I haven't recently checked) that GNU tar
2929 uses an extra octal digit (replacing a trailing delimiter) if necessary,
2930 allowing 64GB files.  So tar transport limits the maximum file size to
2931 8GB or perhaps 64GB.  It is possible that files >= 8GB don't work; this
2932 needs to be looked into.
2933
2934 Smbclient is limited to 4GB file sizes.  Moreover, a bug in smbclient
2935 (mixing signed and unsigned 32 bit values) causes it to incorrectly
2936 do the tar octal conversion for file sizes from 2GB-4GB.  BackupPC_tarExtract
2937 knows about this bug and can recover the correct file size.  So smbclient
2938 transport works up to 4GB file sizes.
2939
2940 Rsync running on Cygwin is limited to either 2GB or 4GB file sizes.
2941 More testing needs to be done to verify the file size limit for
2942 rsync on various platforms.
2943
2944 =back
2945
2946 =item Some tape backup systems aren't smart about hard links
2947
2948 If you backup the BackupPC pool to tape you need to make sure that the
2949 tape backup system is smart about hard links. For example, if you
2950 simply try to tar the BackupPC pool to tape you will backup a lot more
2951 data than is necessary.
2952
2953 Using the example at the start of the installation section, 65 hosts are
2954 backed up with each full backup averaging 3.2GB. Storing one full backup
2955 and two incremental backups per laptop is around 240GB of raw data. But
2956 because of the pooling of identical files, only 87GB is used (with
2957 compression the total is lower). If you run du or tar on the data
2958 directory, there will appear to be 240GB of data, plus the size of the
2959 pool (around 87GB), or 327GB total.
2960
2961 If your tape backup system is not smart about hard links an alternative
2962 is to periodically backup just the last successful backup for each host
2963 to tape.  Another alternative is to do a low-level dump of the pool
2964 file system (ie: /dev/hda1 or similar) using dump(1).
2965
2966 Supporting more efficient tape backup is an area for further
2967 development.
2968
2969 =item Incremental backups might included deleted files
2970
2971 To make browsing and restoring backups easier, incremental backups
2972 are "filled-in" from the last complete backup when the backup is
2973 browsed or restored.
2974
2975 However, if a file was deleted by a user after the last full backup, that
2976 file will still appear in the "filled-in" incremental backup. This is not
2977 really a specific problem with BackupPC, rather it is a general issue
2978 with the full/incremental backup paradigm.  This minor problem could be
2979 solved by having smbclient list all files when it does the incremental
2980 backup.  Volunteers anyone?
2981
2982 =back
2983
2984 Comments or suggestions on these issues are welcome.
2985
2986 =head2 Security issues
2987
2988 Please read this section and consider each of the issues carefully.
2989
2990 =over 4
2991
2992 =item Smb share password
2993
2994 An important security risk is the manner in which the smb share
2995 passwords are stored. They are in plain text. As described in
2996 L<Step 3: Setting up config.pl|step 3: setting up config.pl> there are four
2997 ways to tell BackupPC the smb share password (manually setting an environment
2998 variable, setting the environment variable in /etc/init.d/backuppc,
2999 putting the password in __TOPDIR__/conf/config.pl, or putting the
3000 password in __TOPDIR__/pc/$host/config.pl). In the latter 3 cases the
3001 smb share password appears in plain text in a file.
3002
3003 If you use any of the latter three methods please make sure that the file's
3004 permission is appropriately restricted.  If you also use RCS or CVS, double
3005 check the file permissions of the config.pl,v file.
3006
3007 In future versions there will probably be support for encryption of the
3008 smb share password, but a private key will still have to be stored in a
3009 protected place.  Comments and suggestions are welcome.
3010
3011 =item BackupPC socket server
3012
3013 In v1.5.0 the primary method for communication between the CGI program
3014 (BackupPC_Admin) and the server (BackupPC) is via a unix-domain socket.
3015 Since this socket has restricted permissions, no local user should be
3016 able to connect to this port.  No backup or restore data passes through
3017 this interface, but an attacker can start or stop backups and get status
3018 through this port.
3019
3020 If the Apache server and BackupPC_Admin run on a different host to
3021 BackupPC then a TCP port must be enabled by setting $Conf{ServerPort}.
3022 Anyone can connect to this port.  To avoid possible attacks via the TCP
3023 socket interface, every client message is protected by an MD5 digest.
3024 The MD5 digest includes four items:
3025
3026 =over 4
3027
3028 =item *
3029
3030 a seed that is sent to the client when the connection opens
3031
3032 =item *
3033
3034 a sequence number that increments for each message
3035
3036 =item *
3037
3038 a shared secret that is stored in $Conf{ServerMesgSecret}
3039
3040 =item *
3041
3042 the message itself.
3043
3044 =back
3045
3046 The message is sent in plain text preceded by the MD5 digest.  A
3047 snooper can see the plain-text seed sent by BackupPC and plain-text
3048 message from the client, but cannot construct a valid MD5 digest since
3049 the secret in $Conf{ServerMesgSecret} is unknown.  A replay attack is
3050 not possible since the seed changes on a per-connection and
3051 per-message basis.
3052
3053 So if you do enable the TCP port, please set $Conf{ServerMesgSecret}
3054 to some hard-to-guess string.  A denial-of-service attack is possible
3055 with the TCP port enabled.  Someone could simply connect many times
3056 to this port, until BackupPC had exhausted all its file descriptors,
3057 and this would cause new backups and the CGI interface to fail.  The
3058 most secure solution is to run BackupPC and Apache on the same machine
3059 and disable the TCP port.
3060
3061 By the way, if you have upgraded from a version of BackupPC prior to
3062 v1.5.0 you should set $Conf{ServerPort} to -1 to disable the TCP port.
3063
3064 =item Installation permissions
3065
3066 It is important to check that the BackupPC scripts in __INSTALLDIR__/bin
3067 and __INSTALLDIR__/lib cannot be edited by normal users. Check the
3068 directory permissions too.
3069
3070 =item Pool permissions
3071
3072 It is important to check that the data files in __TOPDIR__/pool,
3073 __TOPDIR__/pc and __TOPDIR__/trash cannot be read by normal users.
3074 Normal users should not be able to see anything below __TOPDIR__.
3075
3076 =item Host shares
3077
3078 Enabling shares on hosts carries security risks.  If you are on a private
3079 network and you generally trust your users then there should not be a
3080 problem. But if you have a laptop that is sometimes on public networks
3081 (eg: broadband or even dialup) you should be concerned.  A conservative
3082 approach is to use firewall software, and only enable the netbios and
3083 smb ports (137 and 139) on connections from the host running BackupPC.
3084
3085 =item SSH key security
3086
3087 Using ssh for linux/unix clients is quite secure, but the security is
3088 only as good as the protection of ssh's private keys. If an attacker can
3089 devise a way to run a shell as the BackupPC user then they will have
3090 access to BackupPC's private ssh keys. They can then, in turn, ssh to
3091 any client machine as root (or whichever user you have configured
3092 BackupPC to use). This represents a serious compromise of your entire
3093 network.  So in vulnerable networks, think carefully about how to protect
3094 the machine running BackupPC and how to prevent attackers from gaining
3095 shell access (as the BackupPC user) to the machine.
3096
3097 =item CGI interface
3098
3099 The CGI interface, __CGIDIR__/BackupPC_Admin, needs access to the pool
3100 files so it is installed setuid to __BACKUPPCUSER__. The permissions of
3101 this file need to checked carefully. It should be owned by
3102 __BACKUPPCUSER__ and have user and group (but not other) execute
3103 permission. To allow apache/httpd to execute it, the group ownership
3104 should be something that apache/httpd belongs to.
3105
3106 The Apache configuration should be setup for AuthConfig style,
3107 using a .htaccess file so that the user's name is passed into
3108 the script as $ENV{REMOTE_USER}.
3109
3110 If normal users could directly run BackupPC_Admin then there is a serious
3111 security hole: since it is setuid to __BACKUPPCUSER__ any user can
3112 browse and restore any backups. Be aware that anyone who is allowed to
3113 edit or create cgi scripts on your server can execute BackupPC_Admin as
3114 any user!  They simply write a cgi script that sets $ENV{REMOTE_USER} and
3115 then execs BackupPC_Admin.  The exec succeeds since httpd runs the first
3116 script as user httpd/apache, which in turn has group permission to
3117 execute BackupPC_Admin.
3118
3119 While this setup should be safe, a more conservative approach is to
3120 run a dedicated Apache as user __BACKUPPCUSER__ on a different port.
3121 Then BackupPC_Admin no longer needs to be setuid, and the cgi
3122 directories can be locked down from normal users.  Moreover, this
3123 setup is exactly the one used to support mod_perl, so this provides
3124 both the highest performance and the lowest security risk.
3125
3126 =back
3127
3128 Comments and suggestions are welcome.
3129
3130 =head1 Configuration File
3131
3132 The BackupPC configuration file resides in __TOPDIR__/conf/config.pl.
3133 Optional per-PC configuration files reside in __TOPDIR__/pc/$host/config.pl.
3134 This file can be used to override settings just for a particular PC.
3135
3136 =head2 Modifying the main configuration file
3137
3138 The configuration file is a perl script that is executed by BackupPC, so
3139 you should be careful to preserve the file syntax (punctuation, quotes
3140 etc) when you edit it. It is recommended that you use CVS, RCS or some
3141 other method of source control for changing config.pl.
3142
3143 BackupPC reads or re-reads the main configuration file and
3144 the hosts file in three cases:
3145
3146 =over 4
3147
3148 =item *
3149
3150 Upon startup.
3151
3152 =item *
3153
3154 When BackupPC is sent a HUP (-1) signal.  Assuming you installed the 
3155 init.d script, you can also do this with "/etc/init.d/backuppc reload".
3156
3157 =item *
3158
3159 When the modification time of config.pl file changes.  BackupPC
3160 checks the modification time once during each regular wakeup.
3161
3162 =back
3163
3164 Whenever you change the configuration file you can either do
3165 a kill -HUP BackupPC_pid or simply wait until the next regular
3166 wakeup period.
3167
3168 Each time the configuration file is re-read a message is reported in the
3169 LOG file, so you can tail it (or view it via the CGI interface) to make
3170 sure your kill -HUP worked. Errors in parsing the configuration file are
3171 also reported in the LOG file.
3172
3173 The optional per-PC configuration file (__TOPDIR__/pc/$host/config.pl)
3174 is read whenever it is needed by BackupPC_dump, BackupPC_link and others.
3175
3176 =head2 Configuration file includes
3177
3178 If you have a heterogeneous set of clients (eg: a variety of WinXX and
3179 linux/unix machines) you will need to create host-specific config.pl files
3180 for some or all of these machines to customize the default settings from
3181 the master config.pl file (at a minimum to set $Conf{XferMethod}).
3182
3183 Since the config.pl file is just regular perl code, you can include
3184 one config file from another.  For example, imagine you had three general
3185 classes of machines: WinXX desktops, linux machines in the DMZ and
3186 linux desktops.  You could create three config files in __TOPDIR__/conf:
3187
3188     __TOPDIR__/conf/ConfigWinDesktop.pl
3189     __TOPDIR__/conf/ConfigLinuxDMZ.pl
3190     __TOPDIR__/conf/ConfigLinuxDesktop.pl
3191
3192 From each client's directory you can either add a symbolic link to
3193 the appropriate config file:
3194
3195     cd __TOPDIR__/pc/$host
3196     ln -s ../../conf/ConfigWinDesktop.pl config.pl
3197
3198 or, better yet, create a config.pl file in __TOPDIR__/pc/$host
3199 that includes the default config.pl file using perl's "do"
3200 command:
3201
3202     do "__TOPDIR__/conf/ConfigWinDesktop.pl";
3203
3204 This alternative allows you to set other configuration options
3205 specific to each host after the "do" command (perhaps even
3206 overriding the settings in the included file).
3207
3208 Note that you could also include snippets of configuration settings
3209 from the main configuration file.  However, be aware that the
3210 modification-time checking that BackupPC does only applies to the
3211 main configuration file: if you change one of the included files,
3212 BackupPC won't notice.  You will need to either touch the main
3213 configuration file too, or send BackupPC a HUP (-1) signal.
3214
3215 =head1 Configuration Parameters
3216
3217 The configuration parameters are divided into five general groups.
3218 The first group (general server configuration) provides general
3219 configuration for BackupPC.  The next two groups describe what to
3220 backup, when to do it, and how long to keep it.  The fourth group
3221 are settings for email reminders, and the final group contains
3222 settings for the CGI interface.
3223
3224 All configuration settings in the second through fifth groups can
3225 be overridden by the per-PC config.pl file.
3226
3227 __CONFIGPOD__
3228
3229 =head1 Version Numbers
3230
3231 Starting with v1.4.0 BackupPC switched to a X.Y.Z version numbering
3232 system, instead of X.0Y. The first digit is for major new releases, the
3233 middle digit is for significant feature releases and improvements (most
3234 of the releases have been in this category), and the last digit is for
3235 bug fixes. You should think of the old 1.00, 1.01, 1.02 and 1.03 as
3236 1.0.0, 1.1.0, 1.2.0 and 1.3.0.
3237
3238 =head1 Author
3239
3240 Craig Barratt  <cbarratt@users.sourceforge.net>
3241
3242 See L<http://backuppc.sourceforge.net>.
3243
3244 =head1 Copyright
3245
3246 Copyright (C) 2001-2004 Craig Barratt
3247
3248 =head1 Credits
3249
3250 Xavier Nicollet, with additions from Guillaume Filion, added the
3251 internationalization (i18n) support to the CGI interface for v2.0.0.
3252 Xavier provided the French translation fr.pm, with additions from
3253 Guillaume.
3254
3255 Ryan Kucera contributed the directory navigation code and images
3256 for v1.5.0.  He contributed the first skeleton of BackupPC_restore.
3257 He also added a significant revision to the CGI interface, including
3258 CSS tags, in v2.1.0.
3259
3260 Guillaume Filion wrote BackupPC_zipCreate and added the CGI support
3261 for zip download, in addition to some CGI cleanup, for v1.5.0.
3262 Guillaume continues to support fr.pm updates for each
3263 new version.
3264
3265 Josh Marshall implemented the Archive feature in v2.1.0.
3266
3267 Javier Gonzalez provided the Spanish translation, es.pm for v2.0.0.
3268
3269 Manfred Herrmann provided the German translation, de.pm for v2.0.0.
3270 Manfred continues to support de.pm updates for each new version.
3271
3272 Lorenzo Cappelletti provided the Italian translation, it.pm for v2.1.0.
3273
3274 Many people have reported bugs, made useful suggestions and helped
3275 with testing; see the ChangeLog and the mail lists.
3276
3277 Your name could appear here in the next version!
3278
3279 =head1 License
3280
3281 This program is free software; you can redistribute it and/or modify it
3282 under the terms of the GNU General Public License as published by the
3283 Free Software Foundation; either version 2 of the License, or (at your
3284 option) any later version.
3285
3286 This program is distributed in the hope that it will be useful,
3287 but WITHOUT ANY WARRANTY; without even the implied warranty of
3288 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3289 General Public License for more details.
3290
3291 You should have received a copy of the GNU General Public License in the
3292 LICENSE file along with this program; if not, write to the Free Software
3293 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.