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