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