* Add run-time check that IO::Dirent is functioning correctly,
[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 Unix, Linux, WinXX, and MacOSX PCs, desktops and laptops to a server's
10 disk.  BackupPC 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
14 a 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
38 the current status, edit configuration, add/delete hosts, view log
39 files, and allows users to initiate and cancel backups and browse
40 and restore files from backups.
41
42 =item *
43
44 The http/cgi user interface has internationalization (i18n) support,
45 currently providing English, French, German, Spanish, Italian,
46 Dutch and Portuguese-Brazilian.
47
48 =item *
49
50 No client-side software is needed. On WinXX the standard smb protocol is
51 used to extract backup data. On linux, unix or MacOSX clients, rsync or
52 tar (over ssh/rsh/nfs) is used to extract backup data. Alternatively,
53 rsync can also be used on WinXX (using cygwin), and Samba could be
54 installed on the linux or unix client to provide smb shares).
55
56 =item *
57
58 Flexible restore options.  Single files can be downloaded from
59 any backup directly from the CGI interface.  Zip or Tar archives
60 for selected files or directories from any backup can also be
61 downloaded from the CGI interface.  Finally, direct restore to
62 the client machine (using smb or tar) for selected files or
63 directories is also supported from the CGI interface.
64
65 =item *
66
67 BackupPC supports mobile environments where laptops are only
68 intermittently connected to the network and have dynamic IP addresses
69 (DHCP).  Configuration settings allow machines connected via slower WAN
70 connections (eg: dial up, DSL, cable) to not be backed up, even if they
71 use the same fixed or dynamic IP address as when they are connected
72 directly to the LAN.
73
74 =item *
75
76 Flexible configuration parameters allow multiple backups to be performed
77 in parallel, specification of which shares to backup, which directories
78 to backup or not backup, various schedules for full and incremental
79 backups, schedules for email reminders to users and so on.  Configuration
80 parameters can be set system-wide or also on a per-PC basis.
81
82 =item *
83
84 Users are sent periodic email reminders if their PC has not
85 recently been backed up.  Email content, timing and policies
86 are configurable.
87
88 =item *
89
90 BackupPC is Open Source software hosted by SourceForge.
91
92 =back
93
94 =head2 Backup basics
95
96 =over 4
97
98 =item Full Backup
99
100 A full backup is a complete backup of a share. BackupPC can be
101 configured to do a full backup at a regular interval (typically
102 weekly).  BackupPC can be configured to keep a certain number
103 of full backups.  Exponential expiry is also supported, allowing
104 full backups with various vintages to be kept (for example, a
105 settable number of most recent weekly fulls, plus a settable
106 number of older fulls that are 2, 4, 8, or 16 weeks apart).
107
108 =item Incremental Backup
109
110 An incremental backup is a backup of files that have changed
111 since the last successful full or incremental backup.  Starting
112 in BackupPC 3.0 multi-level incrementals are supported.
113 A full backup has level 0.  A new incremental of level N will
114 backup all files that have changed since the most recent backup
115 of a lower level.  $Conf{IncrLevels} is used to specify the
116 level of each successive incremental.  The default value is
117 all level 1, which makes the behavior the same as earlier
118 versions of BackupPC: each incremental will back up all the
119 files that changed since the last full (level 0).
120
121 For SMB and tar, BackupPC uses the modification time (mtime) to
122 determine which files have changed since the last lower-level
123 backup.  That means SMB and tar incrementals are not able to detect
124 deleted files, renamed files or new files whose modification time
125 is prior to the last lower-level backup.
126
127 Rsync is more clever: any files whose attributes have changed (ie: uid,
128 gid, mtime, modes, size) since the last full are backed up.  Deleted,
129 new files and renamed files are detected by Rsync incrementals.
130
131 BackupPC can also be configured to keep a certain number of incremental
132 backups, and to keep a smaller number of very old incremental backups.
133 If multi-level incrementals are specified then it is likely that
134 more incrementals will need to be kept since lower-level incrementals
135 (and the full backup) are needed to reconstruct a higher-level
136 incremental.
137
138 BackupPC "fills-in" incremental backups when browsing or restoring,
139 based on the levels of each backup, giving every backup a "full"
140 appearance.  This makes browsing and restoring backups much easier:
141 you can restore from any one backup independent of whether it was
142 an incremental or full.
143
144 =item Partial Backup
145
146 When a full backup fails or is canceled, and some files have already
147 been backed up, BackupPC keeps a partial backup containing just the
148 files that were backed up successfully.  The partial backup is removed
149 when the next successful backup completes, or if another full backup
150 fails resulting in a newer partial backup.  A failed full backup
151 that has not backed up any files, or any failed incremental backup,
152 is removed; no partial backup is saved in these cases.
153
154 The partial backup may be browsed or used to restore files just like
155 a successful full or incremental backup.
156
157 With the rsync transfer method the partial backup is used to resume
158 the next full backup, avoiding the need to retransfer the file data
159 already in the partial backup.
160
161 =item Identical Files
162
163 BackupPC pools identical files using hardlinks.  By "identical
164 files" we mean files with identical contents, not necessary the
165 same permissions, ownership or modification time.  Two files might
166 have different permissions, ownership, or modification time but
167 will still be pooled whenever the contents are identical.  This
168 is possible since BackupPC stores the file meta-data (permissions,
169 ownership, and modification time) separately from the file contents.
170
171 =item Backup Policy
172
173 Based on your site's requirements you need to decide what your backup
174 policy is.  BackupPC is not designed to provide exact re-imaging of
175 failed disks.  See L<Limitations|limitations> for more information.
176 However, the addition of tar transport for linux/unix clients, plus
177 full support for special file types and unix attributes in v1.4.0
178 likely means an exact image of a linux/unix file system can be made.
179
180 BackupPC saves backups onto disk. Because of pooling you can relatively
181 economically keep several weeks of old backups.
182
183 At some sites the disk-based backup will be adequate, without a
184 secondary tape backup. This system is robust to any single failure: if a
185 client disk fails or loses files, the BackupPC server can be used to
186 restore files. If the server disk fails, BackupPC can be restarted on a
187 fresh file system, and create new backups from the clients. The chance
188 of the server disk failing can be made very small by spending more money
189 on increasingly better RAID systems.  However, there is still the risk
190 of catastrophic events like fires or earthquakes that can destroy
191 both the BackupPC server and the clients it is backing up if they
192 are physically nearby.
193
194 Some sites might choose to do periodic backups to tape or cd/dvd.
195 This backup can be done perhaps weekly using the archive function of
196 BackupPC.
197
198 Other users have reported success with removable disks to rotate the
199 BackupPC data drives, or using rsync to mirror the BackupPC data pool
200 offsite.
201
202 =back
203
204 =head2 Resources
205
206 =over 4
207
208 =item BackupPC home page
209
210 The BackupPC Open Source project is hosted on SourceForge.  The
211 home page can be found at:
212
213     http://backuppc.sourceforge.net
214
215 This page has links to the current documentation, the SourceForge
216 project page and general information.
217
218 =item SourceForge project
219
220 The SourceForge project page is at:
221
222     http://sourceforge.net/projects/backuppc
223
224 This page has links to the current releases of BackupPC.
225
226 =item BackupPC Wiki
227
228 BackupPC has a Wiki at L<http://backuppc.wiki.sourceforge.net>.
229 Everyone is encouraged to contribute to the Wiki.  Anyone with
230 a SourceForge account can edit the Wiki.
231
232 The old FAQ is at L<http://backuppc.sourceforge.net/faq>, but
233 is deprecated in favor of the Wiki.
234
235 =item Mailing lists
236
237 Three BackupPC mailing lists exist for announcements (backuppc-announce),
238 developers (backuppc-devel), and a general user list for support, asking
239 questions or any other topic relevant to BackupPC (backuppc-users).
240
241 The lists are archived on SourceForge and Gmane.  The SourceForge lists
242 are not always up to date and the searching is limited, so Gmane is
243 a good alternative.  See:
244
245     http://news.gmane.org/index.php?prefix=gmane.comp.sysutils.backup.backuppc
246     http://sourceforge.net/mailarchive/forum.php?forum=backuppc-users
247
248 You can subscribe to these lists by visiting:
249
250     http://lists.sourceforge.net/lists/listinfo/backuppc-announce
251     http://lists.sourceforge.net/lists/listinfo/backuppc-users
252     http://lists.sourceforge.net/lists/listinfo/backuppc-devel
253
254 The backuppc-announce list is moderated and is used only for
255 important announcements (eg: new versions).  It is low traffic.
256 You only need to subscribe to one of backuppc-announce and
257 backuppc-users: backuppc-users also receives any messages on
258 backuppc-announce.
259
260 The backuppc-devel list is only for developers who are working on BackupPC.
261 Do not post questions or support requests there.  But detailed technical
262 discussions should happen on this list.
263
264 To post a message to the backuppc-users list, send an email to
265
266     backuppc-users@lists.sourceforge.net
267
268 Do not send subscription requests to this address!
269
270 =item Other Programs of Interest
271
272 If you want to mirror linux or unix files or directories to a remote server
273 you should use rsync, L<http://rsync.samba.org>.  BackupPC uses
274 rsync as a transport mechanism; if you are already an rsync user you
275 can think of BackupPC as adding efficient storage (compression and
276 pooling) and a convenient user interface to rsync.
277
278 Two popular open source packages that do tape backup are
279 Amanda (L<http://www.amanda.org>)
280 and Bacula (L<http://www.bacula.org>).
281 Amanda can also backup WinXX machines to tape using samba.
282 These packages can be used as back ends to BackupPC to backup the
283 BackupPC server data to tape.
284
285 Various programs and scripts use rsync to provide hardlinked backups.
286 See, for example, Mike Rubel's site (L<http://www.mikerubel.org/computers/rsync_snapshots>),
287 JW Schultz's dirvish (L<http://www.dirvish.org/>),
288 Ben Escoto's rdiff-backup (L<http://www.nongnu.org/rdiff-backup>),
289 and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>).
290
291 Unison is a utility that can do two-way, interactive, synchronization.
292 See L<http://freshmeat.net/projects/unison>.  An external wrapper around
293 rsync that maintains transfer data to enable two-way synchronization is
294 drsync; see L<http://freshmeat.net/projects/drsync>.
295
296 BackupPC provides many additional features, such as compressed storage,
297 hardlinking any matching files (rather than just files with the same name),
298 and storing special files without root privileges.  But these other programs
299 provide simple, effective and fast solutions and are definitely worthy of
300 consideration.
301
302 =back
303
304 =head2 Road map
305
306 The new features planned for future releases of BackupPC
307 are at L<http://backuppc.sourceforge.net/faq/roadMap.html>.
308
309 Comments and suggestions are welcome.
310
311 =head2 You can help
312
313 BackupPC is free. I work on BackupPC because I enjoy doing it and I like
314 to contribute to the open source community.
315
316 BackupPC already has more than enough features for my own needs.  The
317 main compensation for continuing to work on BackupPC is knowing that
318 more and more people find it useful.  So feedback is certainly
319 appreciated, both positive and negative.
320
321 Beyond being a satisfied user and telling other people about it, everyone
322 is encouraged to add links to L<http://backuppc.sourceforge.net>
323 (I'll see them via Google) or otherwise publicize BackupPC.  Unlike
324 the commercial products in this space, I have a zero budget (in both
325 time and money) for marketing, PR and advertising, so it's up to
326 all of you!  Feel free to vote for BackupPC at
327 L<http://freshmeat.net/projects/backuppc>.
328
329 Also, everyone is encouraged to contribute patches, bug reports,
330 feature and design suggestions, new code, Wiki additions (you can
331 do those directly) and documentation corrections or improvements.
332 Answering questions on the mailing list is a big help too.
333
334 =head1 Installing BackupPC
335
336 =head2 Requirements
337
338 BackupPC requires:
339
340 =over 4
341
342 =item *
343
344 A linux, solaris, or unix based server with a substantial amount of free
345 disk space (see the next section for what that means). The CPU and disk
346 performance on this server will determine how many simultaneous backups
347 you can run. You should be able to run 4-8 simultaneous backups on a
348 moderately configured server.
349
350 Several users have reported significantly better performance using
351 reiserfs compared to ext3 for the BackupPC data file system.  It is
352 also recommended you consider either an LVM or RAID setup (either
353 in HW or SW; eg: 3Ware RAID5) so that you can expand the
354 file system as necessary.
355
356 When BackupPC starts with an empty pool, all the backup data will be
357 written to the pool on disk. After more backups are done, a higher
358 percentage of incoming files will already be in the pool. BackupPC is
359 able to avoid writing to disk new files that are already in the pool.
360 So over time disk writes will reduce significantly (by perhaps a factor
361 of 20 or more), since eventually 95% or more of incoming backup files
362 are typically in the pool. Disk reads from the pool are still needed to
363 do file compares to verify files are an exact match. So, with a mature
364 pool, if a relatively fast client generates data at say 1MB/sec, and you
365 run 4 simultaneous backups, there will be an average server disk load of
366 about 4MB/sec reads and 0.2MB/sec writes (assuming 95% of the incoming
367 files are in the pool). These rates will be perhaps 40% lower if
368 compression is on.
369
370 =item *
371
372 Perl version 5.8.0 or later.  If you don't have perl, please
373 see L<http://www.cpan.org>.
374
375 =item *
376
377 Perl modules Compress::Zlib, Archive::Zip and File::RsyncP.  Try "perldoc
378 Compress::Zlib" and "perldoc Archive::Zip" to see if you have these
379 modules.  If not, fetch them from L<http://www.cpan.org> and see the
380 instructions below for how to build and install them.
381
382 The File::RsyncP module is available from L<http://perlrsync.sourceforge.net>
383 or CPAN.  You'll need to install the File::RsyncP module if you want to use
384 Rsync as a transport method.
385
386 =item *
387
388 If you are using smb to backup WinXX machines you need smbclient and
389 nmblookup from the samba package.  You will also need nmblookup if
390 you are backing up linux/unix DHCP machines.  See L<http://www.samba.org>.
391 Samba versions 3.x are stable and now recommended instead of 2.x.
392
393 See L<http://www.samba.org> for source and binaries.  It's pretty easy to
394 fetch and compile samba, and just grab smbclient and nmblookup, without
395 doing the installation. Alternatively, L<http://www.samba.org> has binary
396 distributions for most platforms.
397
398 =item *
399
400 If you are using tar to backup linux/unix machines you should have version
401 1.13.7 at a minimum, with version 1.13.20 or higher recommended.  Use
402 "tar --version" to check your version.  Various GNU mirrors have the newest
403 versions of tar, see for example L<http://www.funet.fi/pub/gnu/alpha/gnu/tar>.
404 As of July 2006 the latest version is 1.15.1.
405
406 =item *
407
408 If you are using rsync to backup linux/unix machines you should have
409 version 2.6.3 or higher on each client machine.  See
410 L<http://rsync.samba.org>. Use "rsync --version" to check your version.
411
412 For BackupPC to use Rsync you will also need to install the perl
413 File::RsyncP module, which is available from
414 L<http://perlrsync.sourceforge.net>.
415 Version 0.68 or later is required.
416
417 =item *
418
419 The Apache web server, see L<http://www.apache.org>, preferably built
420 with mod_perl support.
421
422 =back
423
424 =head2 What type of storage space do I need?
425
426 BackupPC uses hardlinks to pool files common to different backups.
427 Therefore BackupPC's data store (__TOPDIR__) must point to a single
428 file system that supports hardlinks.  You cannot split this file
429 system with multiple mount points or using symbolic links to point a
430 sub-directory to a different file system (it is ok to use a single
431 symbolic link at the top-level directory (__TOPDIR__) to point the
432 entire data store somewhere else).  You can of course use any kind of
433 RAID system or logical volume manager that combines the capacity of
434 multiple disks into a single, larger, file system. Such approaches
435 have the advantage that the file system can be expanded without having
436 to copy it.
437
438 Any standard linux or unix file system supports hardlinks.  NFS mounted
439 file systems work too (provided the underlying file system supports
440 hardlinks).  But windows based FAT and NTFS file systems will not work.
441
442 Starting with BackupPC 3.1.0, run-time checks are done at startup and
443 at the start of each backup to ensure that the file system can support
444 hardlinks, since this is a common area of configuration problems.
445
446 =head2 How much disk space do I need?
447
448 Here's one real example for an environment that is backing up 65 laptops
449 with compression off. Each full backup averages 3.2GB. Each incremental
450 backup averages about 0.2GB. Storing one full backup and two incremental
451 backups per laptop is around 240GB of raw data. But because of the
452 pooling of identical files, only 87GB is used.  This is without
453 compression.
454
455 Another example, with compression on: backing up 95 laptops, where
456 each backup averages 3.6GB and each incremental averages about 0.3GB.
457 Keeping three weekly full backups, and six incrementals is around
458 1200GB of raw data.  Because of pooling and compression, only 150GB
459 is needed.
460
461 Here's a rule of thumb. Add up the disk usage of all the machines you
462 want to backup (210GB in the first example above). This is a rough
463 minimum space estimate that should allow a couple of full backups and at
464 least half a dozen incremental backups per machine. If compression is on
465 you can reduce the storage requirements by maybe 30-40%.  Add some margin
466 in case you add more machines or decide to keep more old backups.
467
468 Your actual mileage will depend upon the types of clients, operating
469 systems and applications you have. The more uniform the clients and
470 applications the bigger the benefit from pooling common files.
471
472 For example, the Eudora email tool stores each mail folder in a separate
473 file, and attachments are extracted as separate files. So in the sadly
474 common case of a large attachment emailed to many recipients, Eudora
475 will extract the attachment into a new file. When these machines are
476 backed up, only one copy of the file will be stored on the server, even
477 though the file appears in many different full or incremental backups. In
478 this sense Eudora is a "friendly" application from the point of view of
479 backup storage requirements.
480
481 An example at the other end of the spectrum is Outlook. Everything
482 (email bodies, attachments, calendar, contact lists) is stored in a
483 single file, which often becomes huge. Any change to this file requires
484 a separate copy of the file to be saved during backup. Outlook is even
485 more troublesome, since it keeps this file locked all the time, so it
486 cannot be read by smbclient whenever Outlook is running.  See the
487 L<Limitations|limitations> section for more discussion of this problem.
488
489 In addition to total disk space, you should make sure you have
490 plenty of inodes on your BackupPC data partition. Some users have
491 reported running out of inodes on their BackupPC data partition.
492 So even if you have plenty of disk space, BackupPC will report
493 failures when the inodes are exhausted.  This is a particular
494 problem with ext2/ext3 file systems that have a fixed number of
495 inodes when the file system is built.  Use "df -i" to see your
496 inode usage.
497
498 =head2 Step 1: Getting BackupPC
499
500 Some linux distributions now include BackupPC.  The Debian
501 distribution, supported by Ludovic Drolez, can be found at
502 L<http://packages.debian.org/backuppc> and is included
503 in the current stable Debian release.  On Debian, BackupPC can
504 be installed with the command:
505
506     apt-get install backuppc
507
508 In the future there might be packages for Gentoo and other
509 linux flavors.  If the packaged version is older than the
510 released version then you may want to install the
511 latest version as described below.
512
513 Otherwise, manually fetching and installing BackupPC is easy.
514 Start by downloading the latest version from
515 L<http://backuppc.sourceforge.net>.  Hit the "Code" button,
516 then select the "backuppc" or "backuppc-beta" package and
517 download the latest version.
518
519 =head2 Step 2: Installing the distribution
520
521 Note: most information in this step is only relevant if you build
522 and install BackupPC yourself.  If you use a package provided by a
523 distribution, the package management system should take of installing
524 any needed dependencies.
525
526 First off, there are three perl modules you should install.
527 These are all optional, but highly recommended:
528
529 =over 4
530
531 =item Compress::Zlib
532
533 To enable compression, you will need to install Compress::Zlib
534 from L<http://www.cpan.org>.
535 You can run "perldoc Compress::Zlib" to see if this module is installed.
536
537 =item Archive::Zip
538
539 To support restore via Zip archives you will need to install
540 Archive::Zip, also from L<http://www.cpan.org>.
541 You can run "perldoc Archive::Zip" to see if this module is installed.
542
543 =item XML::RSS
544
545 To support the RSS feature you will need to install XML::RSS, also from
546 L<http://www.cpan.org>.  There is not need to install this module if you
547 don't plan on using RSS. You can run "perldoc XML::RSS" to see if this
548 module is installed.
549
550 =item File::RsyncP
551
552 To use rsync and rsyncd with BackupPC you will need to install File::RsyncP.
553 You can run "perldoc File::RsyncP" to see if this module is installed.
554 File::RsyncP is available from L<http://perlrsync.sourceforge.net>.
555 Version 0.52 or later is required.
556
557 =back
558
559 To build and install these packages, fetch the tar.gz file and
560 then run these commands:
561
562     tar zxvf Archive-Zip-1.16.tar.gz
563     cd Archive-Zip-1.16
564     perl Makefile.PL
565     make
566     make test
567     make install
568
569 The same sequence of commands can be used for each module.
570
571 Now let's move onto BackupPC itself.  After fetching
572 BackupPC-__VERSION__.tar.gz, run these commands as root:
573
574     tar zxf BackupPC-__VERSION__.tar.gz
575     cd BackupPC-__VERSION__
576     perl configure.pl
577
578 In the future this release might also have patches available on the
579 SourceForge site.  These patch files are text files, with a name of
580 the form
581
582     BackupPC-__VERSION__plN.diff
583
584 where N is the patch level, eg: pl2 is patch-level 2.  These
585 patch files are cumulative: you only need apply the last patch
586 file, not all the earlier patch files.  If a patch file is
587 available, eg: BackupPC-__VERSION__pl2.diff, you should apply
588 the patch after extracting the tar file:
589
590      # fetch BackupPC-__VERSION__.tar.gz
591      # fetch BackupPC-__VERSION__pl2.diff
592      tar zxf BackupPC-__VERSION__.tar.gz
593      cd BackupPC-__VERSION__
594      patch -p0 < ../BackupPC-__VERSION__pl2.diff
595      perl configure.pl
596
597 A patch file includes comments that describe that bug fixes
598 and changes.  Feel free to review it before you apply the patch.
599
600 The configure.pl script also accepts command-line options if you
601 wish to run it in a non-interactive manner.  It has self-contained
602 documentation for all the command-line options, which you can
603 read with perldoc:
604
605     perldoc configure.pl
606
607 Starting with BackupPC 3.0.0, the configure.pl script by default
608 complies with the file system hierarchy (FHS) conventions.  The
609 major difference compared to earlier versions is that by default
610 configuration files will be stored in /etc/BackupPC
611 rather than below the data directory, __TOPDIR__/conf,
612 and the log files will be stored in /var/log/BackupPC
613 rather than below the data directory, __TOPDIR__/log.
614
615 Note that distributions may choose to use different locations for
616 BackupPC files than these defaults.
617
618 If you are upgrading from an earlier version the configure.pl script
619 will keep the configuration files and log files in their original
620 location.
621
622 When you run configure.pl you will be prompted for the full paths
623 of various executables, and you will be prompted for the following
624 information.
625
626 =over 4
627
628 =item BackupPC User
629
630 It is best if BackupPC runs as a special user, eg backuppc, that has
631 limited privileges. It is preferred that backuppc belongs to a system
632 administrator group so that sys admin members can browse BackupPC files,
633 edit the configuration files and so on. Although configurable, the
634 default settings leave group read permission on pool files, so make
635 sure the BackupPC user's group is chosen restrictively.
636
637 On this installation, this is __BACKUPPCUSER__.
638
639 For security purposes you might choose to configure the BackupPC
640 user with the shell set to /bin/false.  Since you might need to
641 run some BackupPC programs as the BackupPC user for testing
642 purposes, you can use the -s option to su to explicitly run
643 a shell, eg:
644
645     su -s /bin/bash __BACKUPPCUSER__
646
647 Depending upon your configuration you might also need the -l option.
648
649 =item Data Directory
650
651 You need to decide where to put the data directory, below which
652 all the BackupPC data is stored.  This needs to be a big file system.
653
654 On this installation, this is __TOPDIR__.
655
656 =item Install Directory
657
658 You should decide where the BackupPC scripts, libraries and documentation
659 should be installed, eg: /usr/local/BackupPC.
660
661 On this installation, this is __INSTALLDIR__.
662
663 =item CGI bin Directory
664
665 You should decide where the BackupPC CGI script resides.  This will
666 usually be below Apache's cgi-bin directory.
667
668 It is also possible to use a different directory and use Apache's
669 ``<Directory>'' directive to specifiy that location.  See the Apache
670 HTTP Server documentation for additional information.
671
672 On this installation, this is __CGIDIR__.
673
674 =item Apache image Directory
675
676 A directory where BackupPC's images are stored so that Apache can
677 serve them.  You should ensure this directory is readable by Apache and
678 create a symlink to this directory from the BackupPC CGI bin Directory.
679
680 =item Config and Log Directories
681
682 In this installation the configuration and log directories are
683 located in the following locations:
684
685     __CONFDIR__/config.pl    main config file
686     __CONFDIR__/hosts        hosts file
687     __CONFDIR__/pc/HOST.pl   per-pc config file
688     __LOGDIR__/BackupPC      log files, pid, status
689
690 The configure.pl script doesn't prompt for these locations but
691 they can be set for new installations using command-line options.
692
693 =back
694
695 =head2 Step 3: Setting up config.pl
696
697 After running configure.pl, browse through the config file,
698 __CONFDIR__/config.pl, and make sure all the default settings
699 are correct. In particular, you will need to decide whether to use
700 smb, tar or rsync transport (or whether to set it on a per-PC basis)
701 and set the relevant parameters for that transport method.
702 See the section L<Client Setup|step 5: client setup> for more details.
703
704 =head2 Step 4: Setting up the hosts file
705
706 The file __CONFDIR__/hosts contains the list of clients to backup.
707 BackupPC reads this file in three cases:
708
709 =over 4
710
711 =item *
712
713 Upon startup.
714
715 =item *
716
717 When BackupPC is sent a HUP (-1) signal.  Assuming you installed the
718 init.d script, you can also do this with "/etc/init.d/backuppc reload".
719
720 =item *
721
722 When the modification time of the hosts file changes.  BackupPC
723 checks the modification time once during each regular wakeup.
724
725 =back
726
727 Whenever you change the hosts file (to add or remove a host) you can
728 either do a kill -HUP BackupPC_pid or simply wait until the next regular
729 wakeup period.
730
731 Each line in the hosts file contains three fields, separated
732 by white space:
733
734 =over 4
735
736 =item Host name
737
738 This is typically the host name or NetBios name of the client machine
739 and should be in lower case.  The host name can contain spaces (escape
740 with a backslash), but it is not recommended.
741
742 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>.
743
744 In certain cases you might want several distinct clients to refer
745 to the same physical machine.  For example, you might have a database
746 you want to backup, and you want to bracket the backup of the database
747 with shutdown/restart using $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}.
748 But you also want to backup the rest of the machine while the database
749 is still running.  In the case you can specify two different clients in
750 the host file, using any mnemonic name (eg: myhost_mysql and myhost), and
751 use $Conf{ClientNameAlias} in myhost_mysql's config.pl to specify the
752 real host name of the machine.
753
754 =item DHCP flag
755
756 Starting with v2.0.0 the way hosts are discovered has changed and now
757 in most cases you should specify 0 for the DHCP flag, even if the host
758 has a dynamically assigned IP address.
759 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>
760 to understand whether you need to set the DHCP flag.
761
762 You only need to set DHCP to 1 if your client machine doesn't
763 respond to the NetBios multicast request:
764
765     nmblookup myHost
766
767 but does respond to a request directed to its IP address:
768
769     nmblookup -A W.X.Y.Z
770
771 If you do set DHCP to 1 on any client you will need to specify the range of
772 DHCP addresses to search is specified in $Conf{DHCPAddressRanges}.
773
774 Note also that the $Conf{ClientNameAlias} feature does not work for
775 clients with DHCP set to 1.
776
777 =item User name
778
779 This should be the unix login/email name of the user who "owns" or uses
780 this machine. This is the user who will be sent email about this
781 machine, and this user will have permission to stop/start/browse/restore
782 backups for this host.  Leave this blank if no specific person should
783 receive email or be allowed to stop/start/browse/restore backups
784 for this host.  Administrators will still have full permissions.
785
786 =item More users
787
788 Additional user names, separate by commas and with no white space,
789 can be specified.  These users will also have full permission in
790 the CGI interface to stop/start/browse/restore backups for this host.
791 These users will not be sent email about this host.
792
793 =back
794
795 The first non-comment line of the hosts file is special: it contains
796 the names of the columns and should not be edited.
797
798 Here's a simple example of a hosts file:
799
800     host        dhcp    user      moreUsers
801     farside     0       craig     jim,dave
802     larson      1       gary      andy
803
804 =head2 Step 5: Client Setup
805
806 Three methods for getting backup data from a client are supported: smb,
807 tar and rsync.  Smb or rsync are the preferred methods for WinXX clients
808 and rsync or tar are the preferred methods for linux/unix/MacOSX clients.
809
810 The transfer method is set using the $Conf{XferMethod} configuration
811 setting. If you have a mixed environment (ie: you will use smb for some
812 clients and tar for others), you will need to pick the most common
813 choice for $Conf{XferMethod} for the main config.pl file, and then
814 override it in the per-PC config file for those hosts that will use
815 the other method.  (Or you could run two completely separate instances
816 of BackupPC, with different data directories, one for WinXX and the
817 other for linux/unix, but then common files between the different
818 machine types will duplicated.)
819
820 Here are some brief client setup notes:
821
822 =over 4
823
824 =item WinXX
825
826 One setup for WinXX clients is to set $Conf{XferMethod} to "smb".
827 Actually, rsyncd is the better method for WinXX if you are prepared to
828 run rsync/cygwin on your WinXX client.
829
830 If you want to use rsyncd for WinXX clients you can find a pre-packaged
831 zip file on L<http://backuppc.sourceforge.net>. The package is called
832 cygwin-rsync. It contains rsync.exe, template setup files and the
833 minimal set of cygwin libraries for everything to run.  The README file
834 contains instructions for running rsync as a service, so it starts
835 automatically everytime you boot your machine.  If you use rsync
836 to backup WinXX machines, be sure to set $Conf{ClientCharset}
837 correctly (eg: 'cp1252') so that the WinXX file name encoding is
838 correctly converted to utf8.
839
840 Otherwise, to use SMB, you can either create shares for the data you want
841 to backup or your can use the existing C$ share.  To create a new 
842 share, open "My Computer", right click on the drive (eg: C), and
843 select "Sharing..." (or select "Properties" and select the "Sharing"
844 tab). In this dialog box you can enable sharing, select the share name
845 and permissions.
846
847 All Windows NT based OS (NT, 2000, XP Pro), are configured by default 
848 to share the entire C drive as C$.  This is a special share used for 
849 various administration functions, one of which is to grant access to backup 
850 operators. All you need to do is create a new domain user, specifically 
851 for backup. Then add the new backup user to the built in "Backup 
852 Operators" group. You now have backup capability for any directory on 
853 any computer in the domain in one easy step. This avoids using 
854 administrator accounts and only grants permission to do exactly what you 
855 want for the given user, i.e.: backup.
856 Also, for additional security, you may wish to deny the ability for this 
857 user to logon to computers in the default domain policy.
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 The relevant configuration settings are $Conf{SmbShareName},
867 $Conf{SmbShareUserName}, $Conf{SmbSharePasswd}, $Conf{SmbClientPath},
868 $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
869 $Conf{SmbClientRestoreCmd}.
870
871 BackupPC needs to know the smb share user name and password for a
872 client machine that uses smb.  The user name is specified in
873 $Conf{SmbShareUserName}. There are four ways to tell BackupPC the
874 smb share password:
875
876 =over 4
877
878 =item *
879
880 As an environment variable BPC_SMB_PASSWD set before BackupPC starts.
881 If you start BackupPC manually the BPC_SMB_PASSWD variable must be set
882 manually first.  For backward compatibility for v1.5.0 and prior, the
883 environment variable PASSWD can be used if BPC_SMB_PASSWD is not set.
884 Warning: on some systems it is possible to see environment variables of
885 running processes.
886
887 =item *
888
889 Alternatively the BPC_SMB_PASSWD setting can be included in
890 /etc/init.d/backuppc, in which case you must make sure this file
891 is not world (other) readable.
892
893 =item *
894
895 As a configuration variable $Conf{SmbSharePasswd} in
896 __CONFDIR__/config.pl.  If you put the password
897 here you must make sure this file is not world (other) readable.
898
899 =item *
900
901 As a configuration variable $Conf{SmbSharePasswd} in the per-PC
902 configuration file (__CONFDIR__/pc/$host.pl or
903 __TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC).
904 You will have to use this option if the smb share password is different
905 for each host. If you put the password here you must make sure this file
906 is not world (other) readable.
907
908 =back
909
910 Placement and protection of the smb share password is a possible
911 security risk, so please double-check the file and directory
912 permissions.  In a future version there might be support for
913 encryption of this password, but a private key will still have to
914 be stored in a protected place.  Suggestions are welcome.
915
916 As an alternative to setting $Conf{XferMethod} to "smb" (using
917 smbclient) for WinXX clients, you can use an smb network filesystem (eg:
918 ksmbfs or similar) on your linux/unix server to mount the share,
919 and then set $Conf{XferMethod} to "tar" (use tar on the network
920 mounted file system).
921
922 Also, to make sure that file names with special characters are correctly
923 transferred by smbclient you should make sure that the smb.conf file
924 has (for samba 3.x):
925
926     [global]
927         unix charset = UTF8
928
929 UTF8 is the default setting, so if the parameter is missing then it
930 is ok.  With this setting $Conf{ClientCharset} should be emtpy,
931 since smbclient has already converted the file names to utf8.
932
933 =item Linux/Unix
934
935 The preferred setup for linux/unix clients is to set $Conf{XferMethod}
936 to "rsync", "rsyncd" or "tar".
937
938 You can use either rsync, smb, or tar for linux/unix machines. Smb requires
939 that the Samba server (smbd) be run to provide the shares. Since the smb
940 protocol can't represent special files like symbolic links and fifos,
941 tar and rsync are the better transport methods for linux/unix machines.
942 (In fact, by default samba makes symbolic links look like the file or
943 directory that they point to, so you could get an infinite loop if a
944 symbolic link points to the current or parent directory. If you really
945 need to use Samba shares for linux/unix backups you should turn off the
946 "follow symlinks" samba config setting. See the smb.conf manual page.)
947
948 The requirements for each Xfer Method are:
949
950 =over 4
951
952 =item tar
953
954 You must have GNU tar on the client machine.  Use "tar --version"
955 or "gtar --version" to verify.  The version should be at least
956 1.13.7, and 1.13.20 or greater is recommended.  Tar is run on
957 the client machine via rsh or ssh.
958
959 The relevant configuration settings are $Conf{TarClientPath},
960 $Conf{TarShareName}, $Conf{TarClientCmd}, $Conf{TarFullArgs},
961 $Conf{TarIncrArgs}, and $Conf{TarClientRestoreCmd}.
962
963 =item rsync
964
965 You should have at least rsync 2.6.3, and the latest version is
966 recommended.  Rsync is run on the remote client via rsh or ssh.
967
968 The relevant configuration settings are $Conf{RsyncClientPath},
969 $Conf{RsyncClientCmd}, $Conf{RsyncClientRestoreCmd}, $Conf{RsyncShareName},
970 $Conf{RsyncArgs}, and $Conf{RsyncRestoreArgs}.
971
972 =item rsyncd
973
974 You should have at least rsync 2.6.3, and the latest version is
975 recommended.  In this case the rsync daemon should be running on
976 the client machine and BackupPC connects directly to it.
977
978 The relevant configuration settings are $Conf{RsyncdClientPort},
979 $Conf{RsyncdUserName}, $Conf{RsyncdPasswd}, $Conf{RsyncdAuthRequired},
980 $Conf{RsyncShareName}, $Conf{RsyncArgs}, and $Conf{RsyncRestoreArgs}.
981 $Conf{RsyncShareName} is the name of an rsync module (ie: the thing
982 in square brackets in rsyncd's conf file -- see rsyncd.conf), not a
983 file system path.
984
985 Be aware that rsyncd will remove the leading '/' from path names in
986 symbolic links if you specify "use chroot = no" in the rsynd.conf file.
987 See the rsyncd.conf manual page for more information.
988
989 =back
990
991 You need to set $Conf{ClientCharset} to the client's charset so that
992 file names are correctly converted to utf8.  Use "locale charmap"
993 on the client to see its charset.
994
995 For linux/unix machines you should not backup "/proc".  This directory
996 contains a variety of files that look like regular files but they are
997 special files that don't need to be backed up (eg: /proc/kcore is a
998 regular file that contains physical memory).  See $Conf{BackupFilesExclude}.
999 It is safe to back up /dev since it contains mostly character-special
1000 and block-special files, which are correctly handed by BackupPC
1001 (eg: backing up /dev/hda5 just saves the block-special file information,
1002 not the contents of the disk).
1003
1004 Alternatively, rather than backup all the file systems as a single
1005 share ("/"), it is easier to restore a single file system if you backup
1006 each file system separately.  To do this you should list each file system
1007 mount point in $Conf{TarShareName} or $Conf{RsyncShareName}, and add the
1008 --one-file-system option to $Conf{TarClientCmd} or $Conf{RsyncArgs}.
1009 In this case there is no need to exclude /proc explicitly since it looks
1010 like a different file system.
1011
1012 Next you should decide whether to run tar over ssh, rsh or nfs. Ssh is
1013 the preferred method. Rsh is not secure and therefore not recommended.
1014 Nfs will work, but you need to make sure that the BackupPC user (running
1015 on the server) has sufficient permissions to read all the files below
1016 the nfs mount.
1017
1018 Ssh allows BackupPC to run as a privileged user on the client (eg:
1019 root), since it needs sufficient permissions to read all the backup
1020 files. Ssh is setup so that BackupPC on the server (an otherwise low
1021 privileged user) can ssh as root on the client, without being prompted
1022 for a password. There are two common versions of ssh: v1 and v2. Here
1023 are some instructions for one way to setup ssh.  (Check which version
1024 of SSH you have by typing "ssh" or "man ssh".)
1025
1026 =item MacOSX
1027
1028 In general this should be similar to Linux/Unix machines.
1029 In versions 10.4 and later, the native MacOSX tar works,
1030 and also supports resource forks.  xtar is another option,
1031 and rsync works too (although the MacOSX-supplied rsync
1032 has an extension for extended attributes that is not
1033 compatible with standard rsync).
1034
1035 =item SSH Setup
1036
1037 SSH is a secure way to run tar or rsync on a backup client to extract
1038 the data.  SSH provides strong authentication and encryption of
1039 the network data.
1040
1041 Note that if you run rsyncd (rsync daemon), ssh is not used.
1042 In this case, rsyncd provides its own authentication, but there
1043 is no encryption of network data.  If you want encryption of
1044 network data you can use ssh to create a tunnel, or use a
1045 program like stunnel.
1046
1047 Setup instructions for ssh can be found at
1048 L<http://backuppc.sourceforge.net/faq/ssh.html>.
1049
1050 =item Clients that use DHCP
1051
1052 If a client machine uses DHCP BackupPC needs some way to find the
1053 IP address given the host name.  One alternative is to set dhcp
1054 to 1 in the hosts file, and BackupPC will search a pool of IP
1055 addresses looking for hosts.  More efficiently, it is better to
1056 set dhcp = 0 and provide a mechanism for BackupPC to find the
1057 IP address given the host name.
1058
1059 For WinXX machines BackupPC uses the NetBios name server to determine
1060 the IP address given the host name.
1061 For unix machines you can run nmbd (the NetBios name server) from
1062 the Samba distribution so that the machine responds to a NetBios
1063 name request. See the manual page and Samba documentation for more
1064 information.
1065
1066 Alternatively, you can set $Conf{NmbLookupFindHostCmd} to any command
1067 that returns the IP address given the host name.
1068
1069 Please read the section L<How BackupPC Finds Hosts|how backuppc finds hosts>
1070 for more details.
1071
1072 =back
1073
1074 =head2 Step 6: Running BackupPC
1075
1076 The installation contains an init.d backuppc script that can be copied
1077 to /etc/init.d so that BackupPC can auto-start on boot.
1078 See init.d/README for further instructions.
1079
1080 BackupPC should be ready to start.  If you installed the init.d script,
1081 then you should be able to run BackupPC with:
1082
1083     /etc/init.d/backuppc start
1084
1085 (This script can also be invoked with "stop" to stop BackupPC and "reload"
1086 to tell BackupPC to reload config.pl and the hosts file.)
1087
1088 Otherwise, just run
1089
1090      __INSTALLDIR__/bin/BackupPC -d
1091
1092 as user __BACKUPPCUSER__.  The -d option tells BackupPC to run as a daemon
1093 (ie: it does an additional fork).
1094
1095 Any immediate errors will be printed to stderr and BackupPC will quit.
1096 Otherwise, look in __LOGDIR__/LOG and verify that BackupPC reports
1097 it has started and all is ok.
1098
1099 =head2 Step 7: Talking to BackupPC
1100
1101 You should verify that BackupPC is running by using BackupPC_serverMesg.
1102 This sends a message to BackupPC via the unix (or TCP) socket and prints
1103 the response.  Like all BackupPC programs, BackupPC_serverMesg
1104 should be run as the BackupPC user (__BACKUPPCUSER__), so you
1105 should
1106
1107     su __BACKUPPCUSER__
1108
1109 before running BackupPC_serverMesg.  If the BackupPC user is
1110 configured with /bin/false as the shell, you can use the -s
1111 option to su to explicitly run a shell, eg:
1112
1113     su -s /bin/bash __BACKUPPCUSER__
1114
1115 Depending upon your configuration you might also need
1116 the -l option.
1117
1118 You can request status information and start and stop backups using this
1119 interface. This socket interface is mainly provided for the CGI interface
1120 (and some of the BackupPC sub-programs use it too).  But right now we just
1121 want to make sure BackupPC is happy.  Each of these commands should
1122 produce some status output:
1123
1124     __INSTALLDIR__/bin/BackupPC_serverMesg status info
1125     __INSTALLDIR__/bin/BackupPC_serverMesg status jobs
1126     __INSTALLDIR__/bin/BackupPC_serverMesg status hosts
1127
1128 The output should be some hashes printed with Data::Dumper.  If it
1129 looks cryptic and confusing, and doesn't look like an error message,
1130 then all is ok.
1131
1132 The jobs status should initially show just BackupPC_trashClean.
1133 The hosts status should produce a list of every host you have listed
1134 in __CONFDIR__/hosts as part of a big cryptic output line.
1135
1136 You can also request that all hosts be queued:
1137
1138     __INSTALLDIR__/bin/BackupPC_serverMesg backup all
1139
1140 At this point you should make sure the CGI interface works since
1141 it will be much easier to see what is going on.  That's our
1142 next subject.
1143
1144 =head2 Step 8: Checking email delivery
1145
1146 The script BackupPC_sendEmail sends status and error emails to
1147 the administrator and users.  It is usually run each night
1148 by BackupPC_nightly.
1149
1150 To verify that it can run sendmail and deliver email correctly
1151 you should ask it to send a test email to you:
1152
1153     su __BACKUPPCUSER__
1154     __INSTALLDIR__/bin/BackupPC_sendEmail -u MYNAME@MYDOMAIN.COM
1155
1156 BackupPC_sendEmail also takes a -c option that checks if BackupPC
1157 is running, and it sends an email to $Conf{EMailAdminUserName}
1158 if it is not.  That can be used as a keep-alive check by adding
1159
1160     __INSTALLDIR__/bin/BackupPC_sendEmail -c
1161
1162 to __BACKUPPCUSER__'s cron.
1163
1164 The -t option to BackupPC_sendEmail causes it to print the email
1165 message instead of invoking sendmail to deliver the message.
1166
1167 =head2 Step 9: CGI interface
1168
1169 The CGI interface script, BackupPC_Admin, is a powerful and flexible
1170 way to see and control what BackupPC is doing.  It is written for an
1171 Apache server.  If you don't have Apache, see L<http://www.apache.org>.
1172
1173 There are two options for setting up the CGI interface: standard
1174 mode and using mod_perl.  Mod_perl provides much higher performance
1175 (around 15x) and is the best choice if your Apache was built with
1176 mod_perl support.  To see if your apache was built with mod_perl
1177 run this command:
1178
1179     httpd -l | egrep mod_perl
1180
1181 If this prints mod_perl.c then your Apache supports mod_perl.
1182
1183 Note: on some distributions (like Debian) the command is not ``httpd'',
1184 but ``apache'' or ``apache2''. Those distributions will generally also
1185 use ``apache'' for the Apache user account and configuration files.
1186
1187 Using mod_perl with BackupPC_Admin requires a dedicated Apache
1188 to be run as the BackupPC user (__BACKUPPCUSER__).  This is
1189 because BackupPC_Admin needs permission to access various files
1190 in BackupPC's data directories.  In contrast, the standard
1191 installation (without mod_perl) solves this problem by having
1192 BackupPC_Admin installed as setuid to the BackupPC user, so that
1193 BackupPC_Admin runs as the BackupPC user.
1194
1195 Here are some specifics for each setup:
1196
1197 =over 4
1198
1199 =item Standard Setup
1200
1201 The CGI interface should have been installed by the configure.pl script
1202 in __CGIDIR__/BackupPC_Admin.  BackupPC_Admin should have been installed
1203 as setuid to the BackupPC user (__BACKUPPCUSER__), in addition to user
1204 and group execute permission.
1205
1206 You should be very careful about permissions on BackupPC_Admin and
1207 the directory __CGIDIR__: it is important that normal users cannot
1208 directly execute or change BackupPC_Admin, otherwise they can access
1209 backup files for any PC. You might need to change the group ownership
1210 of BackupPC_Admin to a group that Apache belongs to so that Apache
1211 can execute it (don't add "other" execute permission!).
1212 The permissions should look like this:
1213
1214     ls -l __CGIDIR__/BackupPC_Admin
1215     -swxr-x---    1 __BACKUPPCUSER__   web      82406 Jun 17 22:58 __CGIDIR__/BackupPC_Admin
1216
1217 The setuid script won't work unless perl on your machine was installed
1218 with setuid emulation.  This is likely the problem if you get an error
1219 saying such as "Wrong user: my userid is 25, instead of 150", meaning
1220 the script is running as the httpd user, not the BackupPC user.
1221 This is because setuid scripts are disabled by the kernel in most
1222 flavors of unix and linux.
1223
1224 To see if your perl has setuid emulation, see if there is a program
1225 called sperl5.8.0 (or sperl5.8.2 etc, based on your perl version)
1226 in the place where perl is installed. If you can't find this program,
1227 then you have two options: rebuild and reinstall perl with the setuid
1228 emulation turned on (answer "y" to the question "Do you want to do
1229 setuid/setgid emulation?" when you run perl's configure script), or
1230 switch to the mod_perl alternative for the CGI script (which doesn't
1231 need setuid to work).
1232
1233 =item Mod_perl Setup
1234
1235 The advantage of the mod_perl setup is that no setuid script is needed,
1236 and there is a huge performance advantage.  Not only does all the perl
1237 code need to be parsed just once, the config.pl and hosts files, plus
1238 the connection to the BackupPC server are cached between requests.  The
1239 typical speedup is around 15 times.
1240
1241 To use mod_perl you need to run Apache as user __BACKUPPCUSER__.
1242 If you need to run multiple Apache's for different services then
1243 you need to create multiple top-level Apache directories, each
1244 with their own config file.  You can make copies of /etc/init.d/httpd
1245 and use the -d option to httpd to point each http to a different
1246 top-level directory.  Or you can use the -f option to explicitly
1247 point to the config file.  Multiple Apache's will run on different
1248 Ports (eg: 80 is standard, 8080 is a typical alternative port accessed
1249 via http://yourhost.com:8080).
1250
1251 Inside BackupPC's Apache http.conf file you should check the
1252 settings for ServerRoot, DocumentRoot, User, Group, and Port.  See 
1253 L<http://httpd.apache.org/docs/server-wide.html> for more details.
1254
1255 For mod_perl, BackupPC_Admin should not have setuid permission, so
1256 you should turn it off:
1257
1258     chmod u-s __CGIDIR__/BackupPC_Admin
1259
1260 To tell Apache to use mod_perl to execute BackupPC_Admin, add this
1261 to Apache's 1.x httpd.conf file:
1262
1263     <IfModule mod_perl.c>
1264         PerlModule Apache::Registry
1265         PerlTaintCheck On
1266         <Location /cgi-bin/BackupPC/BackupPC_Admin>   # <--- change path as needed
1267            SetHandler perl-script
1268            PerlHandler Apache::Registry
1269            Options ExecCGI
1270            PerlSendHeader On
1271         </Location>
1272     </IfModule>
1273
1274 Apache 2.0.44 with Perl 5.8.0 on RedHat 7.1, Don Silvia reports that
1275 this works (with tweaks from Michael Tuzi):
1276
1277     LoadModule perl_module modules/mod_perl.so
1278     PerlModule Apache2
1279
1280     <Directory /path/to/cgi/>
1281         SetHandler perl-script
1282         PerlResponseHandler ModPerl::Registry
1283         PerlOptions +ParseHeaders
1284         Options +ExecCGI
1285         Order deny,allow
1286         Deny from all
1287         Allow from 192.168.0  
1288         AuthName "Backup Admin"
1289         AuthType Basic
1290         AuthUserFile /path/to/user_file
1291         Require valid-user
1292     </Directory>
1293
1294 There are other optimizations and options with mod_perl.  For
1295 example, you can tell mod_perl to preload various perl modules,
1296 which saves memory compared to loading separate copies in every
1297 Apache process after they are forked.  See Stas's definitive
1298 mod_perl guide at L<http://perl.apache.org/guide>.
1299
1300 =back
1301
1302 BackupPC_Admin requires that users are authenticated by Apache.
1303 Specifically, it expects that Apache sets the REMOTE_USER environment
1304 variable when it runs.  There are several ways to do this.  One way
1305 is to create a .htaccess file in the cgi-bin directory that looks like:
1306
1307     AuthGroupFile /etc/httpd/conf/group    # <--- change path as needed
1308     AuthUserFile /etc/http/conf/passwd     # <--- change path as needed
1309     AuthType basic
1310     AuthName "access"
1311     require valid-user
1312
1313 You will also need "AllowOverride Indexes AuthConfig" in the Apache
1314 httpd.conf file to enable the .htaccess file. Alternatively, everything
1315 can go in the Apache httpd.conf file inside a Location directive. The
1316 list of users and password file above can be extracted from the NIS
1317 passwd file.
1318
1319 One alternative is to use LDAP.  In Apache's http.conf add these lines:
1320
1321     LoadModule auth_ldap_module   modules/auth_ldap.so
1322     AddModule auth_ldap.c
1323
1324     # cgi-bin - auth via LDAP (for BackupPC)
1325     <Location /cgi-binBackupPC/BackupPC_Admin>    # <--- change path as needed
1326       AuthType Basic
1327       AuthName "BackupPC login"
1328       # replace MYDOMAIN, PORT, ORG and CO as needed
1329       AuthLDAPURL ldap://ldap.MYDOMAIN.com:PORT/o=ORG,c=CO?uid?sub?(objectClass=*)
1330       require valid-user
1331     </Location>
1332
1333 If you want to disable the user authentication you can set
1334 $Conf{CgiAdminUsers} to '*', which allows any user to have
1335 full access to all hosts and backups.  In this case the REMOTE_USER
1336 environment variable does not have to be set by Apache.
1337
1338 Alternatively, you can force a particular user name by getting Apache
1339 to set REMOTE_USER, eg, to hardcode the user to www you could add
1340 this to Apache's httpd.conf:
1341
1342     <Location /cgi-bin/BackupPC/BackupPC_Admin>   # <--- change path as needed
1343         Setenv REMOTE_USER www
1344     </Location>
1345
1346 Finally, you should also edit the config.pl file and adjust, as necessary,
1347 the CGI-specific settings.  They're near the end of the config file. In
1348 particular, you should specify which users or groups have administrator
1349 (privileged) access: see the config settings $Conf{CgiAdminUserGroup}
1350 and $Conf{CgiAdminUsers}.  Also, the configure.pl script placed various
1351 images into $Conf{CgiImageDir} that BackupPC_Admin needs to serve
1352 up.  You should make sure that $Conf{CgiImageDirURL} is the correct
1353 URL for the image directory.
1354
1355 See the section L<Fixing installation problems|fixing installation problems> for suggestions on debugging the Apache authentication setup.
1356
1357 =head2 How BackupPC Finds Hosts
1358
1359 Starting with v2.0.0 the way hosts are discovered has changed.  In most
1360 cases you should specify 0 for the DHCP flag in the conf/hosts file,
1361 even if the host has a dynamically assigned IP address.
1362
1363 BackupPC (starting with v2.0.0) looks up hosts with DHCP = 0 in this manner:
1364
1365 =over 4
1366
1367 =item *
1368
1369 First DNS is used to lookup the IP address given the client's name
1370 using perl's gethostbyname() function.  This should succeed for machines
1371 that have fixed IP addresses that are known via DNS.  You can manually
1372 see whether a given host have a DNS entry according to perl's
1373 gethostbyname function with this command:
1374
1375     perl -e 'print(gethostbyname("myhost") ? "ok\n" : "not found\n");'
1376
1377 =item *
1378
1379 If gethostbyname() fails, BackupPC then attempts a NetBios multicast to
1380 find the host.  Provided your client machine is configured properly,
1381 it should respond to this NetBios multicast request.  Specifically,
1382 BackupPC runs a command of this form:
1383
1384     nmblookup myhost
1385
1386 If this fails you will see output like:
1387
1388     querying myhost on 10.10.255.255
1389     name_query failed to find name myhost
1390
1391 If it is successful you will see output like:
1392
1393     querying myhost on 10.10.255.255
1394     10.10.1.73 myhost<00>
1395
1396 Depending on your netmask you might need to specify the -B option to
1397 nmblookup.  For example:
1398
1399     nmblookup -B 10.10.1.255 myhost
1400
1401 If necessary, experiment with the nmblookup command which will return the
1402 IP address of the client given its name.  Then update
1403 $Conf{NmbLookupFindHostCmd} with any necessary options to nmblookup.
1404
1405 =back
1406
1407 For hosts that have the DHCP flag set to 1, these machines are
1408 discovered as follows:
1409
1410 =over 4
1411
1412 =item *
1413
1414 A DHCP address pool ($Conf{DHCPAddressRanges}) needs to be specified.
1415 BackupPC will check the NetBIOS name of each machine in the range using
1416 a command of the form:
1417
1418     nmblookup -A W.X.Y.Z
1419
1420 where W.X.Y.Z is each candidate address from $Conf{DHCPAddressRanges}.
1421 Any host that has a valid NetBIOS name returned by this command (ie:
1422 matching an entry in the hosts file) will be backed up.  You can
1423 modify the specific nmblookup command if necessary via $Conf{NmbLookupCmd}.
1424
1425 =item *
1426
1427 You only need to use this DHCP feature if your client machine doesn't
1428 respond to the NetBios multicast request:
1429
1430     nmblookup myHost
1431
1432 but does respond to a request directed to its IP address:
1433
1434     nmblookup -A W.X.Y.Z
1435
1436 =back
1437
1438 =head2 Other installation topics
1439
1440 =over 4
1441
1442 =item Removing a client
1443
1444 If there is a machine that no longer needs to be backed up (eg: a retired
1445 machine) you have two choices.  First, you can keep the backups accessible
1446 and browsable, but disable all new backups.  Alternatively, you can
1447 completely remove the client and all its backups.
1448
1449 To disable backups for a client there are two special values for
1450 $Conf{FullPeriod} in that client's per-PC config.pl file:
1451
1452 =over 4
1453
1454 =item -1
1455
1456 Don't do any regular backups on this machine.  Manually
1457 requested backups (via the CGI interface) will still occur.
1458
1459 =item -2
1460
1461 Don't do any backups on this machine.  Manually requested
1462 backups (via the CGI interface) will be ignored.
1463
1464 =back
1465
1466 This will still allow the client's old backups to be browsable
1467 and restorable.
1468
1469 To completely remove a client and all its backups, you should remove its
1470 entry in the conf/hosts file, and then delete the __TOPDIR__/pc/$host
1471 directory.  Whenever you change the hosts file, you should send
1472 BackupPC a HUP (-1) signal so that it re-reads the hosts file.
1473 If you don't do this, BackupPC will automatically re-read the
1474 hosts file at the next regular wakeup.
1475
1476 Note that when you remove a client's backups you won't initially recover
1477 a lot of disk space.  That's because the client's files are still in
1478 the pool.  Overnight, when BackupPC_nightly next runs, all the unused
1479 pool files will be deleted and this will recover the disk space used
1480 by the client's backups.
1481
1482 =item Copying the pool
1483
1484 If the pool disk requirements grow you might need to copy the entire
1485 data directory to a new (bigger) file system.  Hopefully you are lucky
1486 enough to avoid this by having the data directory on a RAID file system
1487 or LVM that allows the capacity to be grown in place by adding disks.
1488
1489 The backup data directories contain large numbers of hardlinks.  If
1490 you try to copy the pool the target directory will occupy a lot more
1491 space if the hardlinks aren't re-established.
1492
1493 The best way to copy a pool file system, if possible, is by copying
1494 the raw device at the block level (eg: using dd).  Application level
1495 programs that understand hardlinks include the GNU cp program with
1496 the -a option and rsync -H.  However, the large number of hardlinks
1497 in the pool will make the memory usage large and the copy very slow.
1498 Don't forget to stop BackupPC while the copy runs.
1499
1500 Starting in 3.0.0 a new script bin/BackupPC_tarPCCopy can be
1501 used to assist the copy process.  Given one or more pc paths
1502 (eg: TOPDIR/pc/HOST or TOPDIR/pc/HOST/nnn), BackupPC_tarPCCopy 
1503 creates a tar archive with all the hardlinks pointing to ../cpool/....
1504 Any files not hardlinked (eg: backups, LOG etc) are included
1505 verbatim.
1506
1507 You will need to specify the -P option to tar when you extract
1508 the archive generated by BackupPC_tarPCCopy since the hardlink
1509 targets are outside of the directory being extracted.
1510
1511 To copy a complete store (ie: __TOPDIR__) using BackupPC_tarPCCopy
1512 you should:
1513
1514 =over 4
1515
1516 =item *
1517
1518 stop BackupPC so that the store is static.
1519
1520 =item *
1521
1522 copy the cpool, conf and log directory trees using any technique
1523 (like cp, rsync or tar) without the need to preserve hardlinks.
1524
1525 =item *
1526
1527 copy the pc directory using BackupPC_tarPCCopy:
1528
1529     su __BACKUPPCUSER__
1530     cd NEW_TOPDIR
1531     mkdir pc
1532     cd pc
1533     __INSTALLDIR__/bin/BackupPC_tarPCCopy __TOPDIR__/pc | tar xvPf -
1534
1535 =back
1536
1537 =back
1538
1539 =head2 Fixing installation problems
1540
1541 Please see the Wiki at L<http://backuppc.wiki.sourceforge.net> for
1542 debugging suggestions.  If you find a solution to your problem that
1543 could help other users please add it to the Wiki!
1544
1545 =head1 Restore functions
1546
1547 BackupPC supports several different methods for restoring files. The
1548 most convenient restore options are provided via the CGI interface.
1549 Alternatively, backup files can be restored using manual commands.
1550
1551 =head2 CGI restore options
1552
1553 By selecting a host in the CGI interface, a list of all the backups
1554 for that machine will be displayed.  By selecting the backup number
1555 you can navigate the shares and directory tree for that backup.
1556
1557 BackupPC's CGI interface automatically fills incremental backups
1558 with the corresponding full backup, which means each backup has
1559 a filled appearance.  Therefore, there is no need to do multiple
1560 restores from the incremental and full backups: BackupPC does all
1561 the hard work for you.  You simply select the files and directories
1562 you want from the correct backup vintage in one step.
1563
1564 You can download a single backup file at any time simply by selecting
1565 it.  Your browser should prompt you with the file name and ask you
1566 whether to open the file or save it to disk.
1567
1568 Alternatively, you can select one or more files or directories in
1569 the currently selected directory and select "Restore selected files".
1570 (If you need to restore selected files and directories from several
1571 different parent directories you will need to do that in multiple
1572 steps.)
1573
1574 If you select all the files in a directory, BackupPC will replace
1575 the list of files with the parent directory.  You will be presented
1576 with a screen that has three options:
1577
1578 =over 4
1579
1580 =item Option 1: Direct Restore
1581
1582 With this option the selected files and directories are restored
1583 directly back onto the host, by default in their original location.
1584 Any old files with the same name will be overwritten, so use caution.
1585 You can optionally change the target host name, target share name,
1586 and target path prefix for the restore, allowing you to restore the
1587 files to a different location.
1588
1589 Once you select "Start Restore" you will be prompted one last time
1590 with a summary of the exact source and target files and directories
1591 before you commit.  When you give the final go ahead the restore
1592 operation will be queued like a normal backup job, meaning that it
1593 will be deferred if there is a backup currently running for that host.
1594 When the restore job is run, smbclient, tar, rsync or rsyncd is used
1595 (depending upon $Conf{XferMethod}) to actually restore the files.
1596 Sorry, there is currently no option to cancel a restore that has been
1597 started.
1598
1599 A record of the restore request, including the result and list of
1600 files and directories, is kept.  It can be browsed from the host's
1601 home page.  $Conf{RestoreInfoKeepCnt} specifies how many old restore
1602 status files to keep.
1603
1604 Note that for direct restore to work, the $Conf{XferMethod} must
1605 be able to write to the client.  For example, that means an SMB
1606 share for smbclient needs to be writable, and the rsyncd module
1607 needs "read only" set to "false".  This creates additional security
1608 risks.  If you only create read-only SMB shares (which is a good
1609 idea), then the direct restore will fail.  You can disable the
1610 direct restore option by setting $Conf{SmbClientRestoreCmd},
1611 $Conf{TarClientRestoreCmd} and $Conf{RsyncRestoreArgs} to undef.
1612
1613 =item Option 2: Download Zip archive
1614
1615 With this option a zip file containing the selected files and directories
1616 is downloaded.  The zip file can then be unpacked or individual files
1617 extracted as necessary on the host machine. The compression level can be
1618 specified.  A value of 0 turns off compression.
1619
1620 When you select "Download Zip File" you should be prompted where to
1621 save the restore.zip file.
1622
1623 BackupPC does not consider downloading a zip file as an actual
1624 restore operation, so the details are not saved for later browsing
1625 as in the first case.  However, a mention that a zip file was
1626 downloaded by a particular user, and a list of the files, does
1627 appear in BackupPC's log file.
1628
1629 =item Option 3: Download Tar archive
1630
1631 This is identical to the previous option, except a tar file is downloaded
1632 rather than a zip file (and there is currently no compression option).
1633
1634 =back
1635
1636 =head2 Command-line restore options
1637
1638 Apart from the CGI interface, BackupPC allows you to restore files
1639 and directories from the command line.  The following programs can
1640 be used:
1641
1642 =over 4
1643
1644 =item BackupPC_zcat
1645
1646 For each file name argument it inflates (uncompresses) the file and
1647 writes it to stdout.  To use BackupPC_zcat you could give it the
1648 full file name, eg:
1649
1650     __INSTALLDIR__/bin/BackupPC_zcat __TOPDIR__/pc/host/5/fc/fcraig/fexample.txt > example.txt
1651
1652 It's your responsibility to make sure the file is really compressed:
1653 BackupPC_zcat doesn't check which backup the requested file is from.
1654 BackupPC_zcat returns a non-zero status if it fails to uncompress
1655 a file.
1656
1657 =item BackupPC_tarCreate
1658
1659 BackupPC_tarCreate creates a tar file for any files or directories in
1660 a particular backup.  Merging of incrementals is done automatically,
1661 so you don't need to worry about whether certain files appear in the
1662 incremental or full backup.
1663
1664 The usage is:
1665
1666     BackupPC_tarCreate [options] files/directories...
1667     Required options:
1668        -h host         host from which the tar archive is created
1669        -n dumpNum      dump number from which the tar archive is created
1670                        A negative number means relative to the end (eg -1
1671                        means the most recent dump, -2 2nd most recent etc).
1672        -s shareName    share name from which the tar archive is created
1673   
1674     Other options:
1675        -t              print summary totals
1676        -r pathRemove   path prefix that will be replaced with pathAdd
1677        -p pathAdd      new path prefix
1678        -b BLOCKS       BLOCKS x 512 bytes per record (default 20; same as tar)
1679        -w writeBufSz   write buffer size (default 1048576 = 1MB)
1680        -e charset      charset for encoding file names (default: value of
1681                        $Conf{ClientCharset} when backup was done)
1682        -l              just print a file listing; don't generate an archive
1683        -L              just print a detailed file listing; don't generate an archive
1684
1685 The command-line files and directories are relative to the specified
1686 shareName.  The tar file is written to stdout.
1687
1688 The -h, -n and -s options specify which dump is used to generate
1689 the tar archive.  The -r and -p options can be used to relocate
1690 the paths in the tar archive so extracted files can be placed
1691 in a location different from their original location.
1692
1693 =item BackupPC_zipCreate
1694
1695 BackupPC_zipCreate creates a zip file for any files or directories in
1696 a particular backup.  Merging of incrementals is done automatically,
1697 so you don't need to worry about whether certain files appear in the
1698 incremental or full backup.
1699
1700 The usage is:
1701
1702     BackupPC_zipCreate [options] files/directories...
1703     Required options:
1704        -h host         host from which the zip archive is created
1705        -n dumpNum      dump number from which the tar archive is created
1706                        A negative number means relative to the end (eg -1
1707                        means the most recent dump, -2 2nd most recent etc).
1708        -s shareName    share name from which the zip archive is created
1709   
1710     Other options:
1711        -t              print summary totals
1712        -r pathRemove   path prefix that will be replaced with pathAdd
1713        -p pathAdd      new path prefix
1714        -c level        compression level (default is 0, no compression)
1715        -e charset      charset for encoding file names (default: cp1252)
1716
1717 The command-line files and directories are relative to the specified
1718 shareName.  The zip file is written to stdout. The -h, -n and -s
1719 options specify which dump is used to generate the zip archive.  The
1720 -r and -p options can be used to relocate the paths in the zip archive
1721 so extracted files can be placed in a location different from their
1722 original location.
1723
1724 =back
1725
1726 Each of these programs reside in __INSTALLDIR__/bin.
1727
1728 =head1 Archive functions
1729
1730 BackupPC supports archiving to removable media. For users that require
1731 offsite backups, BackupPC can create archives that stream to tape
1732 devices, or create files of specified sizes to fit onto cd or dvd media.
1733
1734 Each archive type is specified by a BackupPC host with its XferMethod
1735 set to 'archive'. This allows for multiple configurations at sites where
1736 there might be a combination of tape and cd/dvd backups being made.
1737
1738 BackupPC provides a menu that allows one or more hosts to be archived.
1739 The most recent backup of each host is archived using BackupPC_tarCreate,
1740 and the output is optionally compressed and split into fixed-sized
1741 files (eg: 650MB).
1742
1743 The archive for each host is done by default using
1744 __INSTALLDIR__/BackupPC_archiveHost.  This script can be copied
1745 and customized as needed.
1746
1747 =head2 Configuring an Archive Host
1748
1749 To create an Archive Host, add it to the hosts file just as any other host
1750 and call it a name that best describes the type of archive, e.g. ArchiveDLT
1751
1752 To tell BackupPC that the Host is for Archives, create a config.pl file in 
1753 the Archive Hosts's pc directory, adding the following line:
1754
1755 $Conf{XferMethod} = 'archive';
1756
1757 To further customise the archive's parameters you can adding the changed
1758 parameters in the host's config.pl file. The parameters are explained in
1759 the config.pl file.  Parameters may be fixed or the user can be allowed 
1760 to change them (eg: output device).
1761
1762 The per-host archive command is $Conf{ArchiveClientCmd}.  By default
1763 this invokes
1764
1765      __INSTALLDIR__/BackupPC_archiveHost
1766
1767 which you can copy and customize as necessary.
1768
1769 =head2 Starting an Archive
1770
1771 In the web interface, click on the Archive Host you wish to use. You will see a
1772 list of previous archives and a summary on each. By clicking the "Start Archive"
1773 button you are presented with the list of hosts and the approximate backup size
1774 (note this is raw size, not projected compressed size) Select the hosts you wish
1775 to archive and press the "Archive Selected Hosts" button.
1776
1777 The next screen allows you to adjust the parameters for this archive run.
1778 Press the "Start the Archive" to start archiving the selected hosts with the
1779 parameters displayed.
1780
1781 =head2 Starting an Archive from the command line
1782
1783 The script BackupPC_archiveStart can be used to start an archive from
1784 the command line (or cron etc).  The usage is:
1785
1786     BackupPC_archiveStart archiveHost userName hosts...
1787
1788 This creates an archive of the most recent backup of each of
1789 the specified hosts.  The first two arguments are the archive
1790 host and the user name making the request.
1791
1792 =head1 Other CGI Functions
1793
1794 =head2 Configuration and Host Editor
1795
1796 The CGI interface has a complete configuration and host editor.
1797 Only the administrator can edit the main configuration settings
1798 and hosts.  The edit links are in the left navigation bar.
1799
1800 When changes are made to any parameter a "Save" button appears
1801 at the top of the page.  If you are editing a text box you will
1802 need to click outside of the text box to make the Save button
1803 appear.  If you don't select Save then the changes won't be saved.
1804
1805 The host-specific configuration can be edited from the host
1806 summary page using the link in the left navigation bar.
1807 The administrator can edit any of the host-specific
1808 configuration settings.
1809
1810 When editing the host-specific configuration, each parameter has
1811 an "override" setting that denotes the value is host-specific,
1812 meaning that it overrides the setting in the main configuration.
1813 If you unselect "override" then the setting is removed from
1814 the host-specific configuration, and the main configuration
1815 file is displayed.
1816
1817 User's can edit their host-specific configuration if enabled
1818 via $Conf{CgiUserConfigEditEnable}.  The specific subset
1819 of configuration settings that a user can edit is specified
1820 with $Conf{CgiUserConfigEdit}.  It is recommended to make this
1821 list short as possible (you probably don't want your users saving
1822 dozens of backups) and it is essential that they can't edit any
1823 of the Cmd configuration settings, otherwise they can specify
1824 an arbitrary command that will be executed as the BackupPC
1825 user.
1826
1827 =head2 RSS
1828
1829 BackupPC supports a very basic RSS feed.  Provided you have the
1830 XML::RSS perl module installed, a URL similar to this will
1831 provide RSS information:
1832
1833     http://localhost/cgi-bin/BackupPC/BackupPC_Admin?action=rss
1834
1835 This feature is experimental.  The information included will
1836 probably change.
1837
1838 =head1 BackupPC Design
1839
1840 =head2 Some design issues
1841
1842 =over 4
1843
1844 =item Pooling common files
1845
1846 To quickly see if a file is already in the pool, an MD5 digest of the
1847 file length and contents is used as the file name in the pool. This
1848 can't guarantee a file is identical: it just reduces the search to
1849 often a single file or handful of files. A complete file comparison
1850 is always done to verify if two files are really the same.
1851
1852 Identical files on multiples backups are represented by hard links.
1853 Hardlinks are used so that identical files all refer to the same
1854 physical file on the server's disk. Also, hard links maintain
1855 reference counts so that BackupPC knows when to delete unused files
1856 from the pool.
1857
1858 For the computer-science majors among you, you can think of the pooling
1859 system used by BackupPC as just a chained hash table stored on a (big)
1860 file system.
1861
1862 =item The hashing function
1863
1864 There is a tradeoff between how much of file is used for the MD5 digest
1865 and the time taken comparing all the files that have the same hash.
1866
1867 Using the file length and just the first 4096 bytes of the file for the
1868 MD5 digest produces some repetitions.  One example: with 900,000 unique
1869 files in the pool, this hash gives about 7,000 repeated files, and in
1870 the worst case 500 files have the same hash.  That's not bad: we only
1871 have to do a single file compare 99.2% of the time.  But in the worst
1872 case we have to compare as many as 500 files checking for a match.
1873
1874 With a modest increase in CPU time, if we use the file length and the
1875 first 256K of the file we now only have 500 repeated files and in the
1876 worst case around 20 files have the same hash. Furthermore, if we
1877 instead use the first and last 128K of the file (more specifically, the
1878 first and eighth 128K chunks for files larger than 1MB) we get only 300
1879 repeated files and in the worst case around 20 files have the same hash.
1880
1881 Based on this experimentation, this is the hash function used by BackupPC.
1882 It is important that you don't change the hash function after files
1883 are already in the pool.  Otherwise your pool will grow to twice the
1884 size until all the old backups (and all the old files with old hashes)
1885 eventually expire.
1886
1887 =item Compression
1888
1889 BackupPC supports compression. It uses the deflate and inflate methods
1890 in the Compress::Zlib module, which is based on the zlib compression
1891 library (see L<http://www.gzip.org/zlib/>).
1892
1893 The $Conf{CompressLevel} setting specifies the compression level to use.
1894 Zero (0) means no compression. Compression levels can be from 1 (least
1895 cpu time, slightly worse compression) to 9 (most cpu time, slightly
1896 better compression). The recommended value is 3. Changing it to 5, for
1897 example, will take maybe 20% more cpu time and will get another 2-3%
1898 additional compression. Diminishing returns set in above 5.  See the zlib
1899 documentation for more information about compression levels.
1900
1901 BackupPC implements compression with minimal CPU load. Rather than
1902 compressing every incoming backup file and then trying to match it
1903 against the pool, BackupPC computes the MD5 digest based on the
1904 uncompressed file, and matches against the candidate pool files by
1905 comparing each uncompressed pool file against the incoming backup file.
1906 Since inflating a file takes roughly a factor of 10 less CPU time than
1907 deflating there is a big saving in CPU time.
1908
1909 The combination of pooling common files and compression can yield
1910 a factor of 8 or more overall saving in backup storage.
1911
1912 =back
1913
1914 =head2 BackupPC operation
1915
1916 BackupPC reads the configuration information from
1917 __CONFDIR__/config.pl. It then runs and manages all the backup
1918 activity. It maintains queues of pending backup requests, user backup
1919 requests and administrative commands. Based on the configuration various
1920 requests will be executed simultaneously.
1921
1922 As specified by $Conf{WakeupSchedule}, BackupPC wakes up periodically
1923 to queue backups on all the PCs.  This is a four step process:
1924
1925 =over 4
1926
1927 =item 1
1928
1929 For each host and DHCP address backup requests are queued on the
1930 background command queue.
1931
1932 =item 2
1933
1934 For each PC, BackupPC_dump is forked. Several of these may be run in
1935 parallel, based on the configuration. First a ping is done to see if
1936 the machine is alive. If this is a DHCP address, nmblookup is run to
1937 get the netbios name, which is used as the host name. If DNS lookup
1938 fails, $Conf{NmbLookupFindHostCmd} is run to find the IP address from
1939 the host name.  The file __TOPDIR__/pc/$host/backups is read to decide
1940 whether a full or incremental backup needs to be run. If no backup is
1941 scheduled, or the ping to $host fails, then BackupPC_dump exits.
1942
1943 The backup is done using the specified XferMethod.  Either samba's smbclient
1944 or tar over ssh/rsh/nfs piped into BackupPC_tarExtract, or rsync over ssh/rsh
1945 is run, or rsyncd is connected to, with the incoming data
1946 extracted to __TOPDIR__/pc/$host/new.  The XferMethod output is put
1947 into __TOPDIR__/pc/$host/XferLOG.
1948
1949 The letter in the XferLOG file shows the type of object, similar to the
1950 first letter of the modes displayed by ls -l:
1951
1952     d -> directory
1953     l -> symbolic link
1954     b -> block special file
1955     c -> character special file
1956     p -> pipe file (fifo)
1957     nothing -> regular file
1958
1959 The words mean:
1960
1961 =over 4
1962
1963 =item create
1964
1965 new for this backup (ie: directory or file not in pool)
1966
1967 =item pool
1968
1969 found a match in the pool
1970
1971 =item same
1972
1973 file is identical to previous backup (contents were
1974 checksummed and verified during full dump).
1975
1976 =item skip
1977
1978 file skipped in incremental because attributes are the
1979 same (only displayed if $Conf{XferLogLevel} >= 2).
1980
1981 =back
1982
1983 As BackupPC_tarExtract extracts the files from smbclient or tar, or as
1984 rsync runs, it checks each file in the backup to see if it is identical
1985 to an existing file from any previous backup of any PC. It does this
1986 without needed to write the file to disk. If the file matches an
1987 existing file, a hardlink is created to the existing file in the pool.
1988 If the file does not match any existing files, the file is written to
1989 disk and the file name is saved in __TOPDIR__/pc/$host/NewFileList for
1990 later processing by BackupPC_link.  BackupPC_tarExtract and rsync can handle
1991 arbitrarily large files and multiple candidate matching files without
1992 needing to write the file to disk in the case of a match.  This
1993 significantly reduces disk writes (and also reads, since the pool file
1994 comparison is done disk to memory, rather than disk to disk).
1995
1996 Based on the configuration settings, BackupPC_dump checks each
1997 old backup to see if any should be removed.  Any expired backups
1998 are moved to __TOPDIR__/trash for later removal by BackupPC_trashClean.
1999
2000 =item 3
2001
2002 For each complete, good, backup, BackupPC_link is run.
2003 To avoid race conditions as new files are linked into the
2004 pool area, only a single BackupPC_link program runs
2005 at a time and the rest are queued.
2006
2007 BackupPC_link reads the NewFileList written by BackupPC_dump and
2008 inspects each new file in the backup. It re-checks if there is a
2009 matching file in the pool (another BackupPC_link
2010 could have added the file since BackupPC_dump checked). If so, the file
2011 is removed and replaced by a hard link to the existing file. If the file
2012 is new, a hard link to the file is made in the pool area, so that this
2013 file is available for checking against each new file and new backup.
2014
2015 Then, if $Conf{IncrFill} is set (note that the default setting is
2016 off), for each incremental backup, hard links are made in the new
2017 backup to all files that were not extracted during the incremental
2018 backups.  The means the incremental backup looks like a complete
2019 image of the PC (with the exception that files that were removed on
2020 the PC since the last full backup will still appear in the backup
2021 directory tree).
2022
2023 The CGI interface knows how to merge unfilled incremental backups will
2024 the most recent prior filled (full) backup, giving the incremental
2025 backups a filled appearance.  The default for $Conf{IncrFill} is off,
2026 since there is no need to fill incremental backups.  This saves
2027 some level of disk activity, since lots of extra hardlinks are no
2028 longer needed (and don't have to be deleted when the backup expires).
2029
2030 =item 4
2031
2032 BackupPC_trashClean is always run in the background to remove any
2033 expired backups. Every 5 minutes it wakes up and removes all the files
2034 in __TOPDIR__/trash.
2035
2036 Also, once each night, BackupPC_nightly is run to complete some
2037 additional administrative tasks, such as cleaning the pool.  This
2038 involves removing any files in the pool that only have a single
2039 hard link (meaning no backups are using that file).  Again, to
2040 avoid race conditions, BackupPC_nightly is only run when there
2041 are no BackupPC_link processes running.  When BackupPC_nightly is
2042 run no new BackupPC_link jobs are started.  If BackupPC_nightly
2043 takes too long to run, the settings $Conf{MaxBackupPCNightlyJobs}
2044 and $Conf{BackupPCNightlyPeriod} can be used to run several
2045 BackupPC_nightly processes in parallel, and to split its job over
2046 several nights.
2047
2048 =back
2049
2050 BackupPC also listens for TCP connections on $Conf{ServerPort}, which
2051 is used by the CGI script BackupPC_Admin for status reporting and
2052 user-initiated backup or backup cancel requests.
2053
2054 =head2 Storage layout
2055
2056 BackupPC resides in several directories:
2057
2058 =over 4
2059
2060 =item __INSTALLDIR__
2061
2062 Perl scripts comprising BackupPC reside in __INSTALLDIR__/bin,
2063 libraries are in __INSTALLDIR__/lib and documentation
2064 is in __INSTALLDIR__/doc.
2065
2066 =item __CGIDIR__
2067
2068 The CGI script BackupPC_Admin resides in this cgi binary directory.
2069
2070 =item __CONFDIR__
2071
2072 All the configuration information resides below __CONFDIR__.
2073 This directory contains:
2074
2075 The directory __CONFDIR__ contains:
2076
2077 =over 4
2078
2079 =item config.pl
2080
2081 Configuration file. See L<Configuration file|configuration file>
2082 below for more details.
2083
2084 =item hosts
2085
2086 Hosts file, which lists all the PCs to backup.
2087
2088 =item pc
2089
2090 The directory __CONFDIR__/pc contains per-client configuration files
2091 that override settings in the main configuration file.  Each file
2092 is named __CONFDIR__/pc/HOST.pl, where HOST is the host name.
2093
2094 In pre-FHS versions of BackupPC these files were located in
2095 __TOPDIR__/pc/HOST/config.pl.
2096
2097 =back
2098
2099 =item __LOGDIR__
2100
2101 The directory __LOGDIR__ (__TOPDIR__/log on pre-FHS versions
2102 of BackupPC) contains:
2103
2104 =over 4
2105
2106 =item LOG
2107
2108 Current (today's) log file output from BackupPC.
2109
2110 =item LOG.0 or LOG.0.z
2111
2112 Yesterday's log file output.  Log files are aged daily and compressed
2113 (if compression is enabled), and old LOG files are deleted.
2114
2115 =item BackupPC.pid
2116
2117 Contains BackupPC's process id.
2118
2119 =item status.pl
2120
2121 A summary of BackupPC's status written periodically by BackupPC so
2122 that certain state information can be maintained if BackupPC is
2123 restarted.  Should not be edited.
2124
2125 =item UserEmailInfo.pl
2126
2127 A summary of what email was last sent to each user, and when the
2128 last email was sent.  Should not be edited.
2129
2130 =back
2131
2132 =item __TOPDIR__
2133
2134 All of BackupPC's data (PC backup images, logs, configuration information)
2135 is stored below this directory.
2136
2137 Below __TOPDIR__ are several directories:
2138
2139 =over 4
2140
2141 =item __TOPDIR__/trash
2142
2143 Any directories and files below this directory are periodically deleted
2144 whenever BackupPC_trashClean checks. When a backup is aborted or when an
2145 old backup expires, BackupPC_dump simply moves the directory to
2146 __TOPDIR__/trash for later removal by BackupPC_trashClean.
2147
2148 =item __TOPDIR__/pool
2149
2150 All uncompressed files from PC backups are stored below __TOPDIR__/pool.
2151 Each file's name is based on the MD5 hex digest of the file contents.
2152 Specifically, for files less than 256K, the file length and the entire
2153 file is used. For files up to 1MB, the file length and the first and
2154 last 128K are used. Finally, for files longer than 1MB, the file length,
2155 and the first and eighth 128K chunks for the file are used.
2156
2157 Each file is stored in a subdirectory X/Y/Z, where X, Y, Z are the
2158 first 3 hex digits of the MD5 digest.
2159
2160 For example, if a file has an MD5 digest of 123456789abcdef0,
2161 the file is stored in __TOPDIR__/pool/1/2/3/123456789abcdef0.
2162
2163 The MD5 digest might not be unique (especially since not all the file's
2164 contents are used for files bigger than 256K). Different files that have
2165 the same MD5 digest are stored with a trailing suffix "_n" where n is
2166 an incrementing number starting at 0. So, for example, if two additional
2167 files were identical to the first, except the last byte was different,
2168 and assuming the file was larger than 1MB (so the MD5 digests are the
2169 same but the files are actually different), the three files would be
2170 stored as:
2171
2172         __TOPDIR__/pool/1/2/3/123456789abcdef0
2173         __TOPDIR__/pool/1/2/3/123456789abcdef0_0
2174         __TOPDIR__/pool/1/2/3/123456789abcdef0_1
2175
2176 Both BackupPC_dump (actually, BackupPC_tarExtract) and BackupPC_link are
2177 responsible for checking newly backed up files against the pool. For
2178 each file, the MD5 digest is used to generate a file name in the pool
2179 directory. If the file exists in the pool, the contents are compared.
2180 If there is no match, additional files ending in "_n" are checked.
2181 (Actually, BackupPC_tarExtract compares multiple candidate files in
2182 parallel.)  If the file contents exactly match, the file is created by
2183 simply making a hard link to the pool file (this is done by
2184 BackupPC_tarExtract as the backup proceeds). Otherwise,
2185 BackupPC_tarExtract writes the new file to disk and a new hard link is
2186 made in the pool to the file (this is done later by BackupPC_link).
2187
2188 Therefore, every file in the pool will have at least 2 hard links
2189 (one for the pool file and one for the backup file below __TOPDIR__/pc).
2190 Identical files from different backups or PCs will all be linked to
2191 the same file.  When old backups are deleted, some files in the pool
2192 might only have one link.  BackupPC_nightly checks the entire pool
2193 and removes all files that have only a single link, thereby recovering
2194 the storage for that file.
2195
2196 One other issue: zero length files are not pooled, since there are a lot
2197 of these files and on most file systems it doesn't save any disk space
2198 to turn these files into hard links.
2199
2200 =item __TOPDIR__/cpool
2201
2202 All compressed files from PC backups are stored below __TOPDIR__/cpool.
2203 Its layout is the same as __TOPDIR__/pool, and the hashing function
2204 is the same (and, importantly, based on the uncompressed file, not
2205 the compressed file).
2206
2207 =item __TOPDIR__/pc/$host
2208
2209 For each PC $host, all the backups for that PC are stored below
2210 the directory __TOPDIR__/pc/$host.  This directory contains the
2211 following files:
2212
2213 =over 4
2214
2215 =item LOG
2216
2217 Current log file for this PC from BackupPC_dump.
2218
2219 =item LOG.DDMMYYYY or LOG.DDMMYYYY.z
2220
2221 Last month's log file.  Log files are aged monthly and compressed
2222 (if compression is enabled), and old LOG files are deleted.
2223 In earlier versions of BackupPC these files used to have
2224 a suffix of 0, 1, ....
2225
2226 =item XferERR or XferERR.z
2227
2228 Output from the transport program (ie: smbclient, tar or rsync)
2229 for the most recent failed backup.
2230
2231 =item new
2232
2233 Subdirectory in which the current backup is stored.  This
2234 directory is renamed if the backup succeeds.
2235
2236 =item XferLOG or XferLOG.z
2237
2238 Output from the transport program (ie: smbclient, tar or rsync)
2239 for the current backup.
2240
2241 =item nnn (an integer)
2242
2243 Successful backups are in directories numbered sequentially starting at 0.
2244
2245 =item XferLOG.nnn or XferLOG.nnn.z
2246
2247 Output from the transport program (ie: smbclient, tar or rsync)
2248 corresponding to backup number nnn.
2249
2250 =item RestoreInfo.nnn
2251
2252 Information about restore request #nnn including who, what, when, and
2253 why. This file is in Data::Dumper format.  (Note that the restore
2254 numbers are not related to the backup number.)
2255
2256 =item RestoreLOG.nnn.z
2257
2258 Output from smbclient, tar or rsync during restore #nnn.  (Note that the restore
2259 numbers are not related to the backup number.)
2260
2261 =item ArchiveInfo.nnn
2262
2263 Information about archive request #nnn including who, what, when, and
2264 why. This file is in Data::Dumper format.  (Note that the archive
2265 numbers are not related to the restore or backup number.)
2266
2267 =item ArchiveLOG.nnn.z
2268
2269 Output from archive #nnn.  (Note that the archive numbers are not related
2270 to the backup or restore number.)
2271
2272 =item config.pl
2273
2274 Old location of optional configuration settings specific to this host.
2275 Settings in this file override the main configuration file.
2276 In new versions of BackupPC the per-host configuration files are
2277 stored in __CONFDIR__/pc/HOST.pl.
2278
2279 =item backups
2280
2281 A tab-delimited ascii table listing information about each successful
2282 backup, one per row.  The columns are:
2283
2284 =over 4
2285
2286 =item num
2287
2288 The backup number, an integer that starts at 0 and increments
2289 for each successive backup.  The corresponding backup is stored
2290 in the directory num (eg: if this field is 5, then the backup is
2291 stored in __TOPDIR__/pc/$host/5).
2292
2293 =item type
2294
2295 Set to "full" or "incr" for full or incremental backup.
2296
2297 =item startTime
2298
2299 Start time of the backup in unix seconds.
2300
2301 =item endTime
2302
2303 Stop time of the backup in unix seconds.
2304
2305 =item nFiles
2306
2307 Number of files backed up (as reported by smbclient, tar or rsync).
2308
2309 =item size
2310
2311 Total file size backed up (as reported by smbclient, tar or rsync).
2312
2313 =item nFilesExist
2314
2315 Number of files that were already in the pool
2316 (as determined by BackupPC_dump and BackupPC_link).
2317
2318 =item sizeExist
2319
2320 Total size of files that were already in the pool
2321 (as determined by BackupPC_dump and BackupPC_link).
2322
2323 =item nFilesNew
2324
2325 Number of files that were not in the pool
2326 (as determined by BackupPC_link).
2327
2328 =item sizeNew
2329
2330 Total size of files that were not in the pool
2331 (as determined by BackupPC_link).
2332
2333 =item xferErrs
2334
2335 Number of errors or warnings from smbclient, tar or rsync.
2336
2337 =item xferBadFile
2338
2339 Number of errors from smbclient that were bad file errors (zero otherwise).
2340
2341 =item xferBadShare
2342
2343 Number of errors from smbclient that were bad share errors (zero otherwise).
2344
2345 =item tarErrs
2346
2347 Number of errors from BackupPC_tarExtract.
2348
2349 =item compress
2350
2351 The compression level used on this backup.  Zero or empty means no
2352 compression.
2353
2354 =item sizeExistComp
2355
2356 Total compressed size of files that were already in the pool
2357 (as determined by BackupPC_dump and BackupPC_link).
2358
2359 =item sizeNewComp
2360
2361 Total compressed size of files that were not in the pool
2362 (as determined by BackupPC_link).
2363
2364 =item noFill
2365
2366 Set if this backup has not been filled in with the most recent
2367 previous filled or full backup.  See $Conf{IncrFill}.
2368
2369 =item fillFromNum
2370
2371 If this backup was filled (ie: noFill is 0) then this is the
2372 number of the backup that it was filled from
2373
2374 =item mangle
2375
2376 Set if this backup has mangled file names and attributes.  Always
2377 true for backups in v1.4.0 and above.  False for all backups prior
2378 to v1.4.0.
2379
2380 =item xferMethod
2381
2382 Set to the value of $Conf{XferMethod} when this dump was done.
2383
2384 =item level
2385
2386 The level of this dump.  A full dump is level 0.  Currently incrementals
2387 are 1.  But when multi-level incrementals are supported this will reflect
2388 each dump's incremental level.
2389
2390 =back
2391
2392 =item restores
2393
2394 A tab-delimited ascii table listing information about each requested
2395 restore, one per row.  The columns are:
2396
2397 =over 4
2398
2399 =item num
2400
2401 Restore number (matches the suffix of the RestoreInfo.nnn and
2402 RestoreLOG.nnn.z file), unrelated to the backup number.
2403
2404 =item startTime
2405
2406 Start time of the restore in unix seconds.
2407
2408 =item endTime
2409
2410 End time of the restore in unix seconds.
2411
2412 =item result
2413
2414 Result (ok or failed).
2415
2416 =item errorMsg
2417
2418 Error message if restore failed.
2419
2420 =item nFiles
2421
2422 Number of files restored.
2423
2424 =item size
2425
2426 Size in bytes of the restored files.
2427
2428 =item tarCreateErrs
2429
2430 Number of errors from BackupPC_tarCreate during restore.
2431
2432 =item xferErrs
2433
2434 Number of errors from smbclient, tar or rsync during restore.
2435
2436 =back
2437
2438 =item archives
2439
2440 A tab-delimited ascii table listing information about each requested
2441 archive, one per row.  The columns are:
2442
2443 =over 4
2444
2445 =item num
2446
2447 Archive number (matches the suffix of the ArchiveInfo.nnn and
2448 ArchiveLOG.nnn.z file), unrelated to the backup or restore number.
2449
2450 =item startTime
2451
2452 Start time of the restore in unix seconds.
2453
2454 =item endTime
2455
2456 End time of the restore in unix seconds.
2457
2458 =item result
2459
2460 Result (ok or failed).
2461
2462 =item errorMsg
2463
2464 Error message if archive failed.
2465
2466 =back
2467
2468 =back
2469
2470 =back
2471
2472 =back
2473
2474 =head2 Compressed file format
2475
2476 The compressed file format is as generated by Compress::Zlib::deflate
2477 with one minor, but important, tweak. Since Compress::Zlib::inflate
2478 fully inflates its argument in memory, it could take large amounts of
2479 memory if it was inflating a highly compressed file. For example, a
2480 200MB file of 0x0 bytes compresses to around 200K bytes. If
2481 Compress::Zlib::inflate was called with this single 200K buffer, it
2482 would need to allocate 200MB of memory to return the result.
2483
2484 BackupPC watches how efficiently a file is compressing. If a big file
2485 has very high compression (meaning it will use too much memory when it
2486 is inflated), BackupPC calls the flush() method, which gracefully
2487 completes the current compression.  BackupPC then starts another
2488 deflate and simply appends the output file.  So the BackupPC compressed
2489 file format is one or more concatenated deflations/flushes.  The specific
2490 ratios that BackupPC uses is that if a 6MB chunk compresses to less
2491 than 64K then a flush will be done.
2492
2493 Back to the example of the 200MB file of 0x0 bytes.  Adding flushes
2494 every 6MB adds only 200 or so bytes to the 200K output.  So the
2495 storage cost of flushing is negligible.
2496
2497 To easily decompress a BackupPC compressed file, the script
2498 BackupPC_zcat can be found in __INSTALLDIR__/bin.  For each
2499 file name argument it inflates the file and writes it to stdout.
2500
2501 =head2 Rsync checksum caching
2502
2503 An incremental backup with rsync compares attributes on the client
2504 with the last full backup.  Any files with identical attributes
2505 are skipped.  A full backup with rsync sets the --ignore-times
2506 option, which causes every file to be examined independent of
2507 attributes.
2508
2509 Each file is examined by generating block checksums (default 2K
2510 blocks) on the receiving side (that's the BackupPC side), sending
2511 those checksums to the client, where the remote rsync matches those
2512 checksums with the corresponding file.  The matching blocks and new
2513 data is sent back, allowing the client file to be reassembled.
2514 A checksum for the entire file is sent to as an extra check the
2515 the reconstructed file is correct.
2516
2517 This results in significant disk IO and computation for BackupPC:
2518 every file in a full backup, or any file with non-matching attributes
2519 in an incremental backup, needs to be uncompressed, block checksums
2520 computed and sent.  Then the receiving side reassembles the file and
2521 has to verify the whole-file checksum.  Even if the file is identical,
2522 prior to 2.1.0, BackupPC had to read and uncompress the file twice,
2523 once to compute the block checksums and later to verify the whole-file
2524 checksum.
2525
2526 Starting in 2.1.0, BackupPC supports optional checksum caching,
2527 which means the block and file checksums only need to be computed
2528 once for each file.  This results in a significant performance
2529 improvement.  This only works for compressed pool files.
2530 It is enabled by adding
2531
2532         '--checksum-seed=32761',
2533
2534 to $Conf{RsyncArgs} and $Conf{RsyncRestoreArgs}.
2535
2536 Rsync versions prior to and including rsync-2.6.2 need a small patch to
2537 add support for the --checksum-seed option.  This patch is available in
2538 the cygwin-rsyncd package at L<http://backuppc.sourceforge.net>.
2539 This patch is already included in rsync CVS, so it will be standard
2540 in future versions of rsync.
2541
2542 When this option is present, BackupPC will add block and file checksums
2543 to the compressed pool file the next time a pool file is used and it
2544 doesn't already have cached checksums.  The first time a new file is
2545 written to the pool, the checksums are not appended.  The next time
2546 checksums are needed for a file, they are computed and added.  So the
2547 full performance benefit of checksum caching won't be noticed until the
2548 third time a pool file is used (eg: the third full backup).
2549
2550 With checksum caching enabled, there is a risk that should a file's contents
2551 in the pool be corrupted due to a disk problem, but the cached checksums
2552 are still correct, the corruption will not be detected by a full backup,
2553 since the file contents are no longer read and compared.  To reduce the
2554 chance that this remains undetected, BackupPC can recheck cached checksums
2555 for a fraction of the files.  This fraction is set with the
2556 $Conf{RsyncCsumCacheVerifyProb} setting.  The default value of 0.01 means
2557 that 1% of the time a file's checksums are read, the checksums are verified.
2558 This reduces performance slightly, but, over time, ensures that files
2559 contents are in sync with the cached checksums.
2560
2561 The format of the cached checksum data can be discovered by looking at
2562 the code.  Basically, the first byte of the compressed file is changed
2563 to denote that checksums are appended.  The block and file checksum
2564 data, plus some other information and magic word, are appended to the
2565 compressed file.  This allows the cache update to be done in-place.
2566
2567 =head2 File name mangling
2568
2569 Backup file names are stored in "mangled" form. Each node of
2570 a path is preceded by "f" (mnemonic: file), and special characters
2571 (\n, \r, % and /) are URI-encoded as "%xx", where xx is the ascii
2572 character's hex value.  So c:/craig/example.txt is now stored as
2573 fc/fcraig/fexample.txt.
2574
2575 This was done mainly so meta-data could be stored alongside the backup
2576 files without name collisions. In particular, the attributes for the
2577 files in a directory are stored in a file called "attrib", and mangling
2578 avoids file name collisions (I discarded the idea of having a duplicate
2579 directory tree for every backup just to store the attributes). Other
2580 meta-data (eg: rsync checksums) could be stored in file names preceded
2581 by, eg, "c". There are two other benefits to mangling: the share name
2582 might contain "/" (eg: "/home/craig" for tar transport), and I wanted
2583 that represented as a single level in the storage tree. Secondly, as
2584 files are written to NewFileList for later processing by BackupPC_link,
2585 embedded newlines in the file's path will cause problems which are
2586 avoided by mangling.
2587
2588 The CGI script undoes the mangling, so it is invisible to the user.
2589 Old (unmangled) backups are still supported by the CGI
2590 interface.
2591
2592 =head2 Special files
2593
2594 Linux/unix file systems support several special file types: symbolic
2595 links, character and block device files, fifos (pipes) and unix-domain
2596 sockets. All except unix-domain sockets are supported by BackupPC
2597 (there's no point in backing up or restoring unix-domain sockets since
2598 they only have meaning after a process creates them). Symbolic links are
2599 stored as a plain file whose contents are the contents of the link (not
2600 the file it points to). This file is compressed and pooled like any
2601 normal file. Character and block device files are also stored as plain
2602 files, whose contents are two integers separated by a comma; the numbers
2603 are the major and minor device number. These files are compressed and
2604 pooled like any normal file. Fifo files are stored as empty plain files
2605 (which are not pooled since they have zero size). In all cases, the
2606 original file type is stored in the attrib file so it can be correctly
2607 restored.
2608
2609 Hardlinks are also supported.  When GNU tar first encounters a file with
2610 more than one link (ie: hardlinks) it dumps it as a regular file.  When
2611 it sees the second and subsequent hardlinks to the same file, it dumps
2612 just the hardlink information.  BackupPC correctly recognizes these
2613 hardlinks and stores them just like symlinks: a regular text file
2614 whose contents is the path of the file linked to.  The CGI script
2615 will download the original file when you click on a hardlink.
2616
2617 Also, BackupPC_tarCreate has enough magic to re-create the hardlinks
2618 dynamically based on whether or not the original file and hardlinks
2619 are both included in the tar file.  For example, imagine a/b/x is a
2620 hardlink to a/c/y.  If you use BackupPC_tarCreate to restore directory
2621 a, then the tar file will include a/b/x as the original file and a/c/y
2622 will be a hardlink to a/b/x.  If, instead you restore a/c, then the
2623 tar file will include a/c/y as the original file, not a hardlink.
2624
2625 =head2 Attribute file format
2626
2627 The unix attributes for the contents of a directory (all the files and
2628 directories in that directory) are stored in a file called attrib.
2629 There is a single attrib file for each directory in a backup.
2630 For example, if c:/craig contains a single file c:/craig/example.txt,
2631 that file would be stored as fc/fcraig/fexample.txt and there would be an
2632 attribute file in fc/fcraig/attrib (and also fc/attrib and ./attrib).
2633 The file fc/fcraig/attrib would contain a single entry containing the
2634 attributes for fc/fcraig/fexample.txt.
2635
2636 The attrib file starts with a magic number, followed by the
2637 concatenation of the following information for each file:
2638
2639 =over 4
2640
2641 =item *
2642
2643 File name length in perl's pack "w" format (variable length base 128).
2644
2645 =item *
2646
2647 File name.
2648
2649 =item *
2650
2651 The unix file type, mode, uid, gid and file size divided by 4GB and
2652 file size modulo 4GB (type mode uid gid sizeDiv4GB sizeMod4GB),
2653 in perl's pack "w" format (variable length base 128).
2654
2655 =item *
2656
2657 The unix mtime (unix seconds) in perl's pack "N" format (32 bit integer).
2658
2659 =back
2660
2661 The attrib file is also compressed if compression is enabled.
2662 See the lib/BackupPC/Attrib.pm module for full details.
2663
2664 Attribute files are pooled just like normal backup files.  This saves
2665 space if all the files in a directory have the same attributes across
2666 multiple backups, which is common.
2667
2668 =head2 Optimizations
2669
2670 BackupPC doesn't care about the access time of files in the pool
2671 since it saves attribute meta-data separate from the files.  Since
2672 BackupPC mostly does reads from disk, maintaining the access time of
2673 files generates a lot of unnecessary disk writes.  So, provided 
2674 BackupPC has a dedicated data disk, you should consider mounting
2675 BackupPC's data directory with the noatime (or, with Linux kernels
2676 >=2.6.20, relatime) attribute (see mount(1)).
2677
2678 =head2 Limitations
2679
2680 BackupPC isn't perfect (but it is getting better). Please see
2681 L<http://backuppc.sourceforge.net/faq/limitations.html> for a
2682 discussion of some of BackupPC's limitations.
2683
2684 =head2 Security issues
2685
2686 Please see L<http://backuppc.sourceforge.net/faq/security.html> for a
2687 discussion of some of various security issues.
2688
2689 =head1 Configuration File
2690
2691 The BackupPC configuration file resides in __CONFDIR__/config.pl.
2692 Optional per-PC configuration files reside in __CONFDIR__/pc/$host.pl
2693 (or __TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC).
2694 This file can be used to override settings just for a particular PC.
2695
2696 =head2 Modifying the main configuration file
2697
2698 The configuration file is a perl script that is executed by BackupPC, so
2699 you should be careful to preserve the file syntax (punctuation, quotes
2700 etc) when you edit it. It is recommended that you use CVS, RCS or some
2701 other method of source control for changing config.pl.
2702
2703 BackupPC reads or re-reads the main configuration file and
2704 the hosts file in three cases:
2705
2706 =over 4
2707
2708 =item *
2709
2710 Upon startup.
2711
2712 =item *
2713
2714 When BackupPC is sent a HUP (-1) signal.  Assuming you installed the 
2715 init.d script, you can also do this with "/etc/init.d/backuppc reload".
2716
2717 =item *
2718
2719 When the modification time of config.pl file changes.  BackupPC
2720 checks the modification time once during each regular wakeup.
2721
2722 =back
2723
2724 Whenever you change the configuration file you can either do
2725 a kill -HUP BackupPC_pid or simply wait until the next regular
2726 wakeup period.
2727
2728 Each time the configuration file is re-read a message is reported in the
2729 LOG file, so you can tail it (or view it via the CGI interface) to make
2730 sure your kill -HUP worked. Errors in parsing the configuration file are
2731 also reported in the LOG file.
2732
2733 The optional per-PC configuration file (__CONFDIR__/pc/$host.pl or
2734 __TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC)
2735 is read whenever it is needed by BackupPC_dump, BackupPC_link and others.
2736
2737 =head1 Configuration Parameters
2738
2739 The configuration parameters are divided into five general groups.
2740 The first group (general server configuration) provides general
2741 configuration for BackupPC.  The next two groups describe what to
2742 backup, when to do it, and how long to keep it.  The fourth group
2743 are settings for email reminders, and the final group contains
2744 settings for the CGI interface.
2745
2746 All configuration settings in the second through fifth groups can
2747 be overridden by the per-PC config.pl file.
2748
2749 __CONFIGPOD__
2750
2751 =head1 Version Numbers
2752
2753 Starting with v1.4.0 BackupPC uses a X.Y.Z version numbering system,
2754 instead of X.0Y. The first digit is for major new releases, the middle
2755 digit is for significant feature releases and improvements (most of
2756 the releases have been in this category), and the last digit is for
2757 bug fixes. You should think of the old 1.00, 1.01, 1.02 and 1.03 as
2758 1.0.0, 1.1.0, 1.2.0 and 1.3.0.
2759
2760 Additionally, patches might be made available.  A patched version
2761 number is of the form X.Y.ZplN (eg: 2.1.0pl2), where N is the
2762 patch level.
2763
2764 =head1 Author
2765
2766 Craig Barratt  <cbarratt@users.sourceforge.net>
2767
2768 See L<http://backuppc.sourceforge.net>.
2769
2770 =head1 Copyright
2771
2772 Copyright (C) 2001-2007 Craig Barratt
2773
2774 =head1 Credits
2775
2776 Ryan Kucera contributed the directory navigation code and images
2777 for v1.5.0.  He contributed the first skeleton of BackupPC_restore.
2778 He also added a significant revision to the CGI interface, including
2779 CSS tags, in v2.1.0, and designed the BackupPC logo.
2780
2781 Xavier Nicollet, with additions from Guillaume Filion, added the
2782 internationalization (i18n) support to the CGI interface for v2.0.0.
2783 Xavier provided the French translation fr.pm, with additions from
2784 Guillaume.
2785
2786 Guillaume Filion wrote BackupPC_zipCreate and added the CGI support
2787 for zip download, in addition to some CGI cleanup, for v1.5.0.
2788 Guillaume continues to support fr.pm updates for each new version.
2789
2790 Josh Marshall implemented the Archive feature in v2.1.0.
2791
2792 Ludovic Drolez supports the BackupPC Debian package.
2793
2794 Javier Gonzalez provided the Spanish translation, es.pm for v2.0.0.
2795
2796 Manfred Herrmann provided the German translation, de.pm for v2.0.0.
2797 Manfred continues to support de.pm updates for each new version,
2798 together with some help from Ralph PaƟgang.
2799
2800 Lorenzo Cappelletti provided the Italian translation, it.pm for v2.1.0.
2801 Giuseppe Iuculano and Vittorio Macchi updated it for 3.0.0.
2802
2803 Lieven Bridts provided the Dutch translation, nl.pm, for v2.1.0,
2804 with some tweaks from Guus Houtzager, and updates for 3.0.0.
2805
2806 Reginaldo Ferreira provided the Portuguese Brazillian translation
2807 pt_br.pm for v2.2.0.
2808
2809 Rich Duzenbury provided the RSS feed option to the CGI interface.
2810
2811 Jono Woodhouse from CapeSoft Software (www.capesoft.com) provided a
2812 new CSS skin for 3.0.0 with several layout improvements.  Sean Cameron
2813 (also from CapeSoft) designed new and more compact file icons for 3.0.0.
2814
2815 Youlin Feng provided the Chinese translation for 3.1.0.
2816
2817 Karol 'Semper' Stelmaczonek provided the Polish translation for 3.1.0.
2818
2819 Jeremy Tietsort provided the host summary table sorting feature for 3.1.0.
2820
2821 Many people have reported bugs, made useful suggestions and helped
2822 with testing; see the ChangeLog and the mailing lists.
2823
2824 Your name could appear here in the next version!
2825
2826 =head1 License
2827
2828 This program is free software; you can redistribute it and/or modify it
2829 under the terms of the GNU General Public License as published by the
2830 Free Software Foundation; either version 2 of the License, or (at your
2831 option) any later version.
2832
2833 This program is distributed in the hope that it will be useful,
2834 but WITHOUT ANY WARRANTY; without even the implied warranty of
2835 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2836 General Public License for more details.
2837
2838 You should have received a copy of the GNU General Public License in the
2839 LICENSE file along with this program; if not, write to the Free Software
2840 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.