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