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