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