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