1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
|
#!/usr/bin/env perl
#============================================================= -*-perl-*-
#
# configure.pl: Configuration and installation program for BackupPC
#
# DESCRIPTION
#
# This script should be run as root:
#
# perl configure.pl
#
# To read about the command-line options for this configure script:
#
# perldoc configure.pl
#
# The installation steps are described as the script runs.
#
# AUTHOR
# Craig Barratt <cbarratt@users.sourceforge.net>
#
# COPYRIGHT
# Copyright (C) 2001-2017 Craig Barratt
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#========================================================================
#
# Version 3.3.2, released 25 Jan 2017.
#
# See http://backuppc.sourceforge.net.
#
#========================================================================
use strict;
no utf8;
use vars qw(%Conf %OrigConf);
use lib "./lib";
use Encode;
my $EncodeVersion = eval($Encode::VERSION);
if ( $EncodeVersion < 1.99 ) {
print("Error: you need to upgrade perl's Encode package.\n"
. "I found $EncodeVersion and BackupPC needs >= 1.99\n"
. "Please go to www.cpan.org or use the cpan command.\n");
exit(1);
}
my @Packages = qw(File::Path File::Spec File::Copy DirHandle Digest::MD5
Data::Dumper Getopt::Std Getopt::Long Pod::Usage
BackupPC::Lib BackupPC::FileZIO);
foreach my $pkg ( @Packages ) {
eval "use $pkg";
next if ( !$@ );
if ( $pkg =~ /BackupPC/ ) {
die <<EOF;
Error loading $pkg: $@
BackupPC cannot load the package $pkg, which is included in the
BackupPC distribution. This probably means you did not cd to the
unpacked BackupPC distribution before running configure.pl, eg:
cd BackupPC-3.3.2
./configure.pl
Please try again.
EOF
}
die <<EOF;
BackupPC needs the package $pkg. Please install $pkg
before installing BackupPC.
EOF
}
my %opts;
$opts{"set-perms"} = 1;
if ( !GetOptions(
\%opts,
"batch",
"backuppc-user=s",
"bin-path=s%",
"cgi-dir=s",
"compress-level=i",
"config-path=s",
"config-override=s%",
"config-dir=s",
"data-dir=s",
"dest-dir=s",
"fhs!",
"help|?",
"hostname=s",
"html-dir=s",
"html-dir-url=s",
"install-dir=s",
"log-dir=s",
"man",
"set-perms!",
"uid-ignore!",
) || @ARGV ) {
pod2usage(2);
}
pod2usage(1) if ( $opts{help} );
pod2usage(-exitstatus => 0, -verbose => 2) if $opts{man};
my $DestDir = $opts{"dest-dir"};
$DestDir = "" if ( $DestDir eq "/" );
if ( !$opts{"uid-ignore"} && $< != 0 ) {
print <<EOF;
This configure script should be run as root, rather than uid $<.
Provided uid $< has sufficient permissions to create the data and
install directories, then it should be ok to proceed. Otherwise,
please quit and restart as root.
EOF
exit(1) if ( prompt("--> Do you want to continue?",
"y") !~ /y/i );
exit(1) if ( $opts{batch} && !$opts{"uid-ignore"} );
}
#
# Whether we use the file system hierarchy conventions or not.
# Older versions did not. BackupPC used to be installed in
# two main directories (in addition to CGI and html pages)
#
# TopDir which includes subdirs conf, log, pc, pool, cpool
#
# InstallDir which includes subdirs bin, lib, doc
#
# With FHS enabled (which is the default for new installations)
# the config files move to /etc/BackupPC and log files to /var/log:
#
# /etc/BackupPC/config.pl main config file (was $TopDir/conf/config.pl)
# /etc/BackupPC/hosts hosts file (was $TopDir/conf/hosts)
# /etc/BackupPC/pc/HOST.pl per-pc config file (was $TopDir/pc/HOST/config.pl)
# /var/log/BackupPC log files (was $TopDir/log)
# /var/log/BackupPC Pid, status and email info (was $TopDir/log)
#
#
# Check if this is an upgrade, in which case read the existing
# config file to get all the defaults.
#
my $ConfigPath = "";
my $ConfigFileOK = 1;
while ( 1 ) {
if ( $ConfigFileOK && -f "/etc/BackupPC/config.pl"
&& (!defined($opts{fhs}) || $opts{fhs}) && !defined($opts{"config-path"}) ) {
$ConfigPath = "/etc/BackupPC/config.pl";
$opts{fhs} = 1 if ( !defined($opts{fhs}) );
print <<EOF;
Found /etc/BackupPC/config.pl, so this is an upgrade of an
existing BackupPC installation. We will verify some existing
information, but you will probably not need to make any
changes - just hit ENTER to each question.
EOF
} else {
print <<EOF;
Is this a new installation or upgrade for BackupPC? If this is
an upgrade please tell me the full path of the existing BackupPC
configuration file (eg: /etc/BackupPC/config.pl). Otherwise, just
hit return.
EOF
$ConfigPath = prompt("--> Full path to existing main config.pl",
$ConfigPath,
"config-path");
}
last if ( $ConfigPath eq ""
|| ($ConfigPath =~ /^\// && -f $ConfigPath && -w $ConfigPath) );
my $problem = "is not an absolute path";
$problem = "is not writable" if ( !-w $ConfigPath );
$problem = "is not readable" if ( !-r $ConfigPath );
$problem = "is not a regular file" if ( !-f $ConfigPath );
$problem = "doesn't exist" if ( !-e $ConfigPath );
print("The file '$ConfigPath' $problem.\n");
if ( $opts{batch} ) {
print("Need to specify a valid --config-path for upgrade\n");
exit(1);
}
$ConfigFileOK = 0;
}
$opts{fhs} = 1 if ( !defined($opts{fhs}) && $ConfigPath eq "" );
$opts{fhs} = 0 if ( !defined($opts{fhs}) );
my $bpc;
if ( $ConfigPath ne "" && -r $ConfigPath ) {
(my $confDir = $ConfigPath) =~ s{/[^/]+$}{};
die("BackupPC::Lib->new failed\n")
if ( !($bpc = BackupPC::Lib->new(".", ".", $confDir, 1)) );
%Conf = $bpc->Conf();
%OrigConf = %Conf;
if ( !$opts{fhs} ) {
($Conf{TopDir} = $ConfigPath) =~ s{/[^/]+/[^/]+$}{}
if ( $Conf{TopDir} eq '' );
$bpc->{LogDir} = $Conf{LogDir} = "$Conf{TopDir}/log"
if ( $Conf{LogDir} eq '' );
}
$bpc->{ConfDir} = $Conf{ConfDir} = $confDir;
my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1);
if ( $err eq "" ) {
print <<EOF;
BackupPC is running on $Conf{ServerHost}. You need to stop BackupPC
before you can upgrade the code. Depending upon your installation,
you could run "/etc/init.d/backuppc stop".
EOF
exit(1);
}
}
#
# Create defaults for FHS setup
#
if ( $opts{fhs} ) {
$Conf{TopDir} ||= $opts{"data-dir"} || "/data/BackupPC";
$Conf{ConfDir} ||= $opts{"config-dir"} || "/etc/BackupPC";
$Conf{InstallDir} ||= $opts{"install-dir"} || "/usr/local/BackupPC";
$Conf{LogDir} ||= $opts{"log-dir"} || "/var/log/BackupPC";
} else {
$Conf{TopDir} ||= $opts{"data-dir"} || "/data/BackupPC";
$Conf{ConfDir} ||= $opts{"config-dir"} || "$Conf{TopDir}/conf";
$Conf{InstallDir} ||= $opts{"install-dir"} || "/usr/local/BackupPC";
$Conf{LogDir} ||= $opts{"log-dir"} || "$Conf{TopDir}/log";
}
$Conf{ConfDir} = "/etc/backuppc";
#
# These are the programs whose paths we need to find
#
my %Programs = (
perl => "PerlPath",
'gtar/tar' => "TarClientPath",
smbclient => "SmbClientPath",
nmblookup => "NmbLookupPath",
rsync => "RsyncClientPath",
ping => "PingPath",
ping6 => "Ping6Path",
df => "DfPath",
'ssh/ssh2' => "SshPath",
sendmail => "SendmailPath",
hostname => "HostnamePath",
split => "SplitPath",
par2 => "ParPath",
cat => "CatPath",
gzip => "GzipPath",
bzip2 => "Bzip2Path",
);
foreach my $prog ( sort(keys(%Programs)) ) {
my $path;
foreach my $subProg ( split(/\//, $prog) ) {
$path = FindProgram("$ENV{PATH}:/usr/bin:/bin:/sbin:/usr/sbin",
$subProg) if ( !length($path) );
}
$Conf{$Programs{$prog}} = $path if ( !length($Conf{$Programs{$prog}}) );
}
while ( 1 ) {
print <<EOF;
I found the following locations for these programs:
EOF
foreach my $prog ( sort(keys(%Programs)) ) {
printf(" %-12s => %s\n", $prog, $Conf{$Programs{$prog}});
}
print "\n";
last if (prompt('--> Are these paths correct?', 'y') =~ /^y/i);
foreach my $prog ( sort(keys(%Programs)) ) {
$Conf{$Programs{$prog}} = prompt("--> $prog path",
$Conf{$Programs{$prog}});
}
}
my $Perl58 = system($Conf{PerlPath}
. q{ -e 'exit($^V && $^V ge v5.8.0 ? 1 : 0);'});
if ( !$Perl58 ) {
print <<EOF;
BackupPC needs perl version 5.8.0 or later. $Conf{PerlPath} appears
to be an older version. Please upgrade to a newer version of perl
and re-run this configure script.
EOF
exit(1);
}
print <<EOF;
Please tell me the hostname of the machine that BackupPC will run on.
EOF
chomp($Conf{ServerHost} = `$Conf{HostnamePath}`)
if ( defined($Conf{HostnamePath}) && !defined($Conf{ServerHost}) );
$Conf{ServerHost} = prompt("--> BackupPC will run on host",
$Conf{ServerHost},
"hostname");
print <<EOF;
BackupPC should run as a dedicated user with limited privileges. You
need to create a user. This user will need read/write permission on
the main data directory and read/execute permission on the install
directory (these directories will be setup shortly).
The primary group for this user should also be chosen carefully.
The data directories and files will have group read permission,
so group members can access backup files.
EOF
my($name, $passwd, $Uid, $Gid);
while ( 1 ) {
$Conf{BackupPCUser} = prompt("--> BackupPC should run as user",
$Conf{BackupPCUser} || "backuppc",
"backuppc-user");
if ( $opts{"set-perms"} ) {
#($name, $passwd, $Uid, $Gid) = getpwnam($Conf{BackupPCUser});
$name = "backuppc";
$Uid = 0;
$Gid = 0;
last if ( $name ne "" );
print <<EOF;
getpwnam() says that user $Conf{BackupPCUser} doesn't exist. Please
check the name and verify that this user is in the passwd file.
EOF
exit(1) if ( $opts{batch} );
} else {
last;
}
}
print <<EOF;
Please specify an install directory for BackupPC. This is where the
BackupPC scripts, library and documentation will be installed.
EOF
while ( 1 ) {
$Conf{InstallDir} = prompt("--> Install directory (full path)",
$Conf{InstallDir},
"install-dir");
last if ( $Conf{InstallDir} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --install-dir for new installation\n");
exit(1);
}
}
print <<EOF;
Please specify a data directory for BackupPC. This is where all the
PC backup data is stored. This file system needs to be big enough to
accommodate all the PCs you expect to backup (eg: at least several GB
per machine).
EOF
while ( 1 ) {
$Conf{TopDir} = prompt("--> Data directory (full path)",
$Conf{TopDir},
"data-dir");
last if ( $Conf{TopDir} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --data-dir for new installation\n");
exit(1);
}
}
$Conf{CompressLevel} = $opts{"compress-level"}
if ( defined($opts{"compress-level"}) );
if ( !defined($Conf{CompressLevel}) ) {
$Conf{CompressLevel} = BackupPC::FileZIO->compOk ? 3 : 0;
if ( $ConfigPath eq "" && $Conf{CompressLevel} ) {
print <<EOF;
BackupPC can compress pool files, providing around a 40% reduction in pool
size (your mileage may vary). Specify the compression level (0 turns
off compression, and 1 to 9 represent good/fastest to best/slowest).
The recommended values are 0 (off) or 3 (reasonable compression and speed).
Increasing the compression level to 5 will use around 20% more cpu time
and give perhaps 2-3% more compression.
EOF
} elsif ( $ConfigPath eq "" ) {
print <<EOF;
BackupPC can compress pool files, but it needs the Compress::Zlib
package installed (see www.cpan.org). Compression will provide around a
40% reduction in pool size, at the expense of cpu time. You can leave
compression off and run BackupPC without compression, in which case you
should leave the compression level at 0 (which means off). Or the better
choice is to quit, install Compress::Zlib, and re-run configure.pl.
EOF
} elsif ( $Conf{CompressLevel} ) {
$Conf{CompressLevel} = 0;
print <<EOF;
BackupPC now supports pool file compression. Since you are upgrading
BackupPC you probably have existing uncompressed backups. You could
turn on compression, so that new backups will be compressed. This
will increase the pool storage requirement, since both uncompressed
and compressed copies of files will be stored. But eventually the old
uncompressed backups will expire, recovering the pool storage. Please
see the documentation for more details.
If you are not sure what to do, leave the Compression Level at 0,
which disables compression. You can always read the documentation
and turn it on later.
EOF
} else {
$Conf{CompressLevel} = 0;
print <<EOF;
BackupPC now supports pool file compression, but it needs the
Compress::Zlib module (see www.cpan.org). For now, leave
the compression level set at 0 to disable compression. If you
want you can install Compress::Zlib and turn compression on.
EOF
}
while ( 1 ) {
$Conf{CompressLevel}
= prompt("--> Compression level", $Conf{CompressLevel});
last if ( $Conf{CompressLevel} =~ /^\d+$/ );
}
}
print <<EOF;
BackupPC has a powerful CGI perl interface that runs under Apache.
A single executable needs to be installed in a cgi-bin directory.
This executable needs to run as set-uid $Conf{BackupPCUser}, or
it can be run under mod_perl with Apache running as user $Conf{BackupPCUser}.
Leave this path empty if you don't want to install the CGI interface.
EOF
while ( 1 ) {
$Conf{CgiDir} = prompt("--> CGI bin directory (full path)",
$Conf{CgiDir},
"cgi-dir");
last if ( $Conf{CgiDir} =~ /^\// || $Conf{CgiDir} eq "" );
if ( $opts{batch} ) {
print("Need to specify --cgi-dir for new installation\n");
exit(1);
}
}
if ( $Conf{CgiDir} ne "" ) {
print <<EOF;
BackupPC's CGI script needs to display various PNG/GIF images that
should be stored where Apache can serve them. They should be placed
somewhere under Apache's DocumentRoot. BackupPC also needs to know
the URL to access these images. Example:
Apache image directory: /var/www/htdocs/BackupPC
URL for image directory: /BackupPC
The URL for the image directory should start with a slash.
EOF
while ( 1 ) {
$Conf{CgiImageDir} = prompt("--> Apache image directory (full path)",
$Conf{CgiImageDir},
"html-dir");
last if ( $Conf{CgiImageDir} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --html-dir for new installation\n");
exit(1);
}
}
while ( 1 ) {
$Conf{CgiImageDirURL} = prompt("--> URL for image directory (omit http://host; starts with '/')",
$Conf{CgiImageDirURL},
"html-dir-url");
last if ( $Conf{CgiImageDirURL} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --html-dir-url for new installation\n");
exit(1);
}
}
}
print <<EOF;
Ok, we're about to:
- install the binaries, lib and docs in $Conf{InstallDir},
- create the data directory $Conf{TopDir},
- create/update the config.pl file $Conf{ConfDir}/config.pl,
- optionally install the cgi-bin interface.
EOF
exit unless prompt("--> Do you want to continue?", "y") =~ /y/i;
#
# Create install directories
#
foreach my $dir ( qw(bin doc
lib/BackupPC/CGI
lib/BackupPC/Config
lib/BackupPC/Lang
lib/BackupPC/Storage
lib/BackupPC/Xfer
lib/BackupPC/Zip
lib/Net/FTP
) ) {
next if ( -d "$DestDir$Conf{InstallDir}/$dir" );
mkpath("$DestDir$Conf{InstallDir}/$dir", 0, 0755);
if ( !-d "$DestDir$Conf{InstallDir}/$dir"
|| !my_chown($Uid, $Gid, "$DestDir$Conf{InstallDir}/$dir") ) {
die("Failed to create or chown $DestDir$Conf{InstallDir}/$dir\n");
} else {
print("Created $DestDir$Conf{InstallDir}/$dir\n");
}
}
#
# Create CGI image directory
#
foreach my $dir ( ($Conf{CgiImageDir}) ) {
next if ( $dir eq "" || -d "$DestDir$dir" );
mkpath("$DestDir$dir", 0, 0755);
if ( !-d "$DestDir$dir" || !my_chown($Uid, $Gid, "$DestDir$dir") ) {
die("Failed to create or chown $DestDir$dir");
} else {
print("Created $DestDir$dir\n");
}
}
#
# Create other directories
#
foreach my $dir ( (
"$Conf{TopDir}",
"$Conf{TopDir}/pool",
"$Conf{TopDir}/cpool",
"$Conf{TopDir}/pc",
"$Conf{TopDir}/trash",
"$Conf{ConfDir}",
"$Conf{LogDir}",
) ) {
mkpath("$DestDir$dir", 0, 0750) if ( !-d "$DestDir$dir" );
if ( !-d "$DestDir$dir"
|| !my_chown($Uid, $Gid, "$DestDir$dir") ) {
die("Failed to create or chown $DestDir$dir\n");
} else {
print("Created $DestDir$dir\n");
}
}
printf("Installing binaries in $DestDir$Conf{InstallDir}/bin\n");
foreach my $prog ( qw(
bin/BackupPC
bin/BackupPC_archive
bin/BackupPC_archiveHost
bin/BackupPC_archiveStart
bin/BackupPC_attribPrint
bin/BackupPC_dump
bin/BackupPC_fixupBackupSummary
bin/BackupPC_link
bin/BackupPC_nightly
bin/BackupPC_restore
bin/BackupPC_sendEmail
bin/BackupPC_serverMesg
bin/BackupPC_trashClean
bin/BackupPC_tarExtract
bin/BackupPC_tarCreate
bin/BackupPC_tarPCCopy
bin/BackupPC_zipCreate
bin/BackupPC_zcat
) ) {
InstallFile($prog, "$DestDir$Conf{InstallDir}/$prog", 0555);
}
printf("Installing library in $DestDir$Conf{InstallDir}/lib\n");
foreach my $lib ( qw(
lib/BackupPC/Attrib.pm
lib/BackupPC/Config.pm
lib/BackupPC/FileZIO.pm
lib/BackupPC/Lib.pm
lib/BackupPC/PoolWrite.pm
lib/BackupPC/Storage.pm
lib/BackupPC/View.pm
lib/BackupPC/CGI/AdminOptions.pm
lib/BackupPC/CGI/Archive.pm
lib/BackupPC/CGI/ArchiveInfo.pm
lib/BackupPC/CGI/Browse.pm
lib/BackupPC/CGI/DirHistory.pm
lib/BackupPC/CGI/EditConfig.pm
lib/BackupPC/CGI/EmailSummary.pm
lib/BackupPC/CGI/GeneralInfo.pm
lib/BackupPC/CGI/HostInfo.pm
lib/BackupPC/CGI/Lib.pm
lib/BackupPC/CGI/LOGlist.pm
lib/BackupPC/CGI/Queue.pm
lib/BackupPC/CGI/ReloadServer.pm
lib/BackupPC/CGI/RestoreFile.pm
lib/BackupPC/CGI/RestoreInfo.pm
lib/BackupPC/CGI/Restore.pm
lib/BackupPC/CGI/RSS.pm
lib/BackupPC/CGI/StartServer.pm
lib/BackupPC/CGI/StartStopBackup.pm
lib/BackupPC/CGI/StopServer.pm
lib/BackupPC/CGI/Summary.pm
lib/BackupPC/CGI/View.pm
lib/BackupPC/Config/Meta.pm
lib/BackupPC/Lang/cz.pm
lib/BackupPC/Lang/de.pm
lib/BackupPC/Lang/en.pm
lib/BackupPC/Lang/es.pm
lib/BackupPC/Lang/fr.pm
lib/BackupPC/Lang/it.pm
lib/BackupPC/Lang/ja.pm
lib/BackupPC/Lang/nl.pm
lib/BackupPC/Lang/pl.pm
lib/BackupPC/Lang/pt_br.pm
lib/BackupPC/Lang/ru.pm
lib/BackupPC/Lang/uk.pm
lib/BackupPC/Lang/zh_CN.pm
lib/BackupPC/Storage/Text.pm
lib/BackupPC/Xfer.pm
lib/BackupPC/Xfer/Archive.pm
lib/BackupPC/Xfer/Ftp.pm
lib/BackupPC/Xfer/Protocol.pm
lib/BackupPC/Xfer/Rsync.pm
lib/BackupPC/Xfer/RsyncDigest.pm
lib/BackupPC/Xfer/RsyncFileIO.pm
lib/BackupPC/Xfer/Smb.pm
lib/BackupPC/Xfer/Tar.pm
lib/BackupPC/Zip/FileMember.pm
lib/Net/FTP/AutoReconnect.pm
lib/Net/FTP/RetrHandle.pm
) ) {
InstallFile($lib, "$DestDir$Conf{InstallDir}/$lib", 0444);
}
if ( $Conf{CgiImageDir} ne "" ) {
printf("Installing images in $DestDir$Conf{CgiImageDir}\n");
foreach my $img ( <images/*> ) {
(my $destImg = $img) =~ s{^images/}{};
InstallFile($img, "$DestDir$Conf{CgiImageDir}/$destImg", 0444, 1);
}
#
# Install new CSS file, making a backup copy if necessary
#
my $cssBackup = "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css.pre-3.3.2";
if ( -f "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css" && !-f $cssBackup ) {
rename("$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", $cssBackup);
}
InstallFile("conf/BackupPC_stnd.css",
"$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", 0444, 0);
InstallFile("conf/BackupPC_stnd_orig.css",
"$DestDir$Conf{CgiImageDir}/BackupPC_stnd_orig.css", 0444, 0);
InstallFile("conf/sorttable.js",
"$DestDir$Conf{CgiImageDir}/sorttable.js", 0444, 0);
}
printf("Making init.d scripts\n");
foreach my $init ( qw(gentoo-backuppc gentoo-backuppc.conf linux-backuppc
solaris-backuppc debian-backuppc freebsd-backuppc
freebsd-backuppc2 suse-backuppc slackware-backuppc ) ) {
InstallFile("init.d/src/$init", "init.d/$init", 0444);
}
printf("Making Apache configuration file for suid-perl\n");
InstallFile("httpd/src/BackupPC.conf", "httpd/BackupPC.conf", 0644);
printf("Installing docs in $DestDir$Conf{InstallDir}/doc\n");
foreach my $doc ( qw(BackupPC.pod BackupPC.html) ) {
InstallFile("doc/$doc", "$DestDir$Conf{InstallDir}/doc/$doc", 0444);
}
printf("Installing config.pl and hosts in $DestDir$Conf{ConfDir}\n");
InstallFile("conf/hosts", "$DestDir$Conf{ConfDir}/hosts", 0644)
if ( !-f "$DestDir$Conf{ConfDir}/hosts" );
#
# Now do the config file. If there is an existing config file we
# merge in the new config file, adding any new configuration
# parameters and deleting ones that are no longer needed.
#
my $dest = "$DestDir$Conf{ConfDir}/config.pl";
my ($distConf, $distVars) = ConfigParse("conf/config.pl");
my ($oldConf, $oldVars);
my ($newConf, $newVars) = ($distConf, $distVars);
if ( -f $dest ) {
($oldConf, $oldVars) = ConfigParse($dest);
($newConf, $newVars) = ConfigMerge($oldConf, $oldVars, $distConf, $distVars);
}
#
# Update various config parameters. The old config is in Conf{}
# and the new config is an array in text form in $newConf->[].
#
$Conf{EMailFromUserName} ||= $Conf{BackupPCUser};
$Conf{EMailAdminUserName} ||= $Conf{BackupPCUser};
#
# Guess $Conf{CgiURL}
#
if ( !defined($Conf{CgiURL}) ) {
if ( $Conf{CgiDir} =~ m{cgi-bin(/.*)} ) {
$Conf{CgiURL} = "'http://$Conf{ServerHost}/cgi-bin$1/BackupPC_Admin'";
} else {
$Conf{CgiURL} = "'http://$Conf{ServerHost}/backuppc/index.cgi'";
}
}
#
# The smbclient commands have moved from hard-coded to the config file.
# $Conf{SmbClientArgs} no longer exists, so merge it into the new
# commands if it still exists.
#
if ( defined($Conf{SmbClientArgs}) ) {
if ( $Conf{SmbClientArgs} ne "" ) {
foreach my $param ( qw(SmbClientRestoreCmd SmbClientFullCmd
SmbClientIncrCmd) ) {
$newConf->[$newVars->{$param}]{text}
=~ s/(-E\s+-N)/$1 $Conf{SmbClientArgs}/;
}
}
delete($Conf{SmbClientArgs});
}
#
# CSS is now stored in a file rather than a big config variable.
#
delete($Conf{CSSstylesheet});
#
# The blackout timing settings are now stored in a list of hashes, rather
# than three scalar parameters.
#
if ( defined($Conf{BlackoutHourBegin}) ) {
$Conf{BlackoutPeriods} = [
{
hourBegin => $Conf{BlackoutHourBegin},
hourEnd => $Conf{BlackoutHourEnd},
weekDays => $Conf{BlackoutWeekDays},
}
];
delete($Conf{BlackoutHourBegin});
delete($Conf{BlackoutHourEnd});
delete($Conf{BlackoutWeekDays});
}
#
# $Conf{RsyncLogLevel} has been replaced by $Conf{XferLogLevel}
#
if ( defined($Conf{RsyncLogLevel}) ) {
$Conf{XferLogLevel} = $Conf{RsyncLogLevel};
delete($Conf{RsyncLogLevel});
}
#
# In 2.1.0 the default for $Conf{CgiNavBarAdminAllHosts} is now 1
#
$Conf{CgiNavBarAdminAllHosts} = 1;
#
# IncrFill should now be off
#
$Conf{IncrFill} = 0;
#
# Empty $Conf{ParPath} if it isn't a valid executable
# (pre-3.0.0 configure.pl incorrectly set it to a
# hardcoded value).
#
$Conf{ParPath} = '' if ( $Conf{ParPath} ne '' && !-x $Conf{ParPath} );
#
# Figure out sensible arguments for the ping command
#
$Conf{PingArgs} = '-c 1 $host';
if ( defined($Conf{PingArgs}) ) {
$Conf{PingCmd} = '$pingPath ' . $Conf{PingArgs};
} elsif ( !defined($Conf{PingCmd}) ) {
if ( $^O eq "solaris" || $^O eq "sunos" ) {
$Conf{PingCmd} = '$pingPath -s $host 56 1';
} elsif ( ($^O eq "linux" || $^O eq "openbsd" || $^O eq "netbsd")
&& !system("$Conf{PingPath} -c 1 -w 3 localhost") ) {
$Conf{PingCmd} = '$pingPath -c 1 -w 3 $host';
} else {
$Conf{PingCmd} = '$pingPath -c 1 $host';
}
delete($Conf{PingArgs});
}
#
# Figure out sensible arguments for the df command
#
if ( !defined($Conf{DfCmd}) ) {
if ( $^O eq "solaris" || $^O eq "sunos" ) {
$Conf{DfCmd} = '$dfPath -k $topDir';
}
}
#
# $Conf{SmbClientTimeout} is now $Conf{ClientTimeout}
#
if ( defined($Conf{SmbClientTimeout}) ) {
$Conf{ClientTimeout} = $Conf{SmbClientTimeout};
delete($Conf{SmbClientTimeout});
}
#
# Replace --devices with -D in RsyncArgs and RsyncRestoreArgs
#
foreach my $param ( qw(RsyncArgs RsyncRestoreArgs) ) {
next if ( !defined($newVars->{$param}) );
$newConf->[$newVars->{$param}]{text} =~ s/--devices/-D/g;
}
#
# Merge any new user-editable parameters into CgiUserConfigEdit
# by copying the old settings forward.
#
if ( defined($Conf{CgiUserConfigEdit}) ) {
#
# This is a real hack. The config file merging is done in text
# form without actually instantiating the new conf structure.
# So we need to extract the new hash of settings, update it,
# and merge the text. Ugh...
#
my $new;
my $str = $distConf->[$distVars->{CgiUserConfigEdit}]{text};
$str =~ s/^\s*\$Conf\{.*?\}\s*=\s*/\$new = /m;
eval($str);
foreach my $p ( keys(%$new) ) {
$new->{$p} = $Conf{CgiUserConfigEdit}{$p}
if ( defined($Conf{CgiUserConfigEdit}{$p}) );
}
$Conf{CgiUserConfigEdit} = $new;
my $d = Data::Dumper->new([$new], [*value]);
$d->Indent(1);
$d->Terse(1);
my $value = $d->Dump;
$value =~ s/(.*)\n/$1;\n/s;
$newConf->[$newVars->{CgiUserConfigEdit}]{text}
=~ s/(\s*\$Conf\{.*?\}\s*=\s*).*/$1$value/s;
}
#
# Apply any command-line configuration parameter settings
#
foreach my $param ( keys(%{$opts{"config-override"}}) ) {
my $val = eval { $opts{"config-override"}{$param} };
if ( @$ ) {
printf("Can't eval --config-override setting %s=%s\n",
$param, $opts{"config-override"}{$param});
exit(1);
}
if ( !defined($newVars->{$param}) ) {
printf("Unkown config parameter %s in --config-override\n", $param);
exit(1);
}
$newConf->[$newVars->{$param}]{text} = $opts{"config-override"}{$param};
}
#
# Now backup and write the config file
#
my $confCopy = "$dest.pre-3.3.2";
if ( -f $dest && !-f $confCopy ) {
#
# Make copy of config file, preserving ownership and modes
#
printf("Making backup copy of $dest -> $confCopy\n");
my @stat = stat($dest);
my $mode = $stat[2];
my $uid = $stat[4];
my $gid = $stat[5];
die("can't copy($dest, $confCopy)\n")
unless copy($dest, $confCopy);
die("can't chown $uid, $gid $confCopy\n")
unless my_chown($uid, $gid, $confCopy);
die("can't chmod $mode $confCopy\n")
unless my_chmod($mode, $confCopy);
}
open(OUT, ">", $dest) || die("can't open $dest for writing\n");
binmode(OUT);
my $blockComment;
foreach my $var ( @$newConf ) {
if ( length($blockComment)
&& substr($var->{text}, 0, length($blockComment)) eq $blockComment ) {
$var->{text} = substr($var->{text}, length($blockComment));
$blockComment = undef;
}
$blockComment = $1 if ( $var->{text} =~ /^([\s\n]*#{70}.*#{70}[\s\n]+)/s );
$var->{text} =~ s/^\s*\$Conf\{(.*?)\}(\s*=\s*['"]?)(.*?)(['"]?\s*;)/
defined($Conf{$1}) && ref($Conf{$1}) eq ""
&& $Conf{$1} ne $OrigConf{$1}
? "\$Conf{$1}$2$Conf{$1}$4"
: "\$Conf{$1}$2$3$4"/emg;
print OUT $var->{text};
}
close(OUT);
if ( !defined($oldConf) ) {
die("can't chmod 0640 mode $dest\n") unless my_chmod(0640, $dest);
die("can't chown $Uid, $Gid $dest\n") unless my_chown($Uid, $Gid, $dest);
}
if ( $Conf{CgiDir} ne "" ) {
printf("Installing cgi script BackupPC_Admin in $DestDir$Conf{CgiDir}\n");
mkpath("$DestDir$Conf{CgiDir}", 0, 0755);
InstallFile("cgi-bin/BackupPC_Admin", "$DestDir$Conf{CgiDir}/BackupPC_Admin",
04554);
}
print <<EOF;
Ok, it looks like we are finished. There are several more things you
will need to do:
- Browse through the config file, $Conf{ConfDir}/config.pl,
and make sure all the settings are correct. In particular,
you will need to set \$Conf{CgiAdminUsers} so you have
administration privileges in the CGI interface.
- Edit the list of hosts to backup in $Conf{ConfDir}/hosts.
- Read the documentation in $Conf{InstallDir}/doc/BackupPC.html.
Please pay special attention to the security section.
- Verify that the CGI script BackupPC_Admin runs correctly. You might
need to change the permissions or group ownership of BackupPC_Admin.
If this is an upgrade and you are using mod_perl, you will need
to restart Apache. Otherwise it will have stale code.
- BackupPC should be ready to start. Don't forget to run it
as user $Conf{BackupPCUser}! The installation also contains an
init.d/backuppc script that can be copied to /etc/init.d
so that BackupPC can auto-start on boot. This will also enable
administrative users to start the server from the CGI interface.
See init.d/README.
Enjoy!
EOF
if ( `$Conf{PerlPath} -V` =~ /uselargefiles=undef/ ) {
print <<EOF;
Warning: your perl, $Conf{PerlPath}, does not support large files.
This means BackupPC won't be able to backup files larger than 2GB.
To solve this problem you should build/install a new version of perl
with large file support enabled. Use
$Conf{PerlPath} -V | egrep uselargefiles
to check if perl has large file support (undef means no support).
EOF
}
eval "use File::RsyncP;";
if ( !$@ && $File::RsyncP::VERSION < 0.68 ) {
print("\nWarning: you need to upgrade File::RsyncP;"
. " I found $File::RsyncP::VERSION and BackupPC needs 0.68\n");
}
exit(0);
###########################################################################
# Subroutines
###########################################################################
sub InstallFile
{
my($prog, $dest, $mode, $binary) = @_;
my $first = 1;
my($uid, $gid) = ($Uid, $Gid);
if ( -f $dest ) {
#
# preserve ownership and modes of files that already exist
#
my @stat = stat($dest);
$mode = $stat[2];
$uid = $stat[4];
$gid = $stat[5];
}
unlink($dest) if ( -f $dest );
if ( $binary ) {
die("can't copy($prog, $dest)\n") unless copy($prog, $dest);
} else {
open(PROG, $prog) || die("can't open $prog for reading\n");
open(OUT, ">", $dest) || die("can't open $dest for writing\n");
binmode(PROG);
binmode(OUT);
while ( <PROG> ) {
s/__INSTALLDIR__/$Conf{InstallDir}/g;
s/__LOGDIR__/$Conf{LogDir}/g;
s/__CONFDIR__/$Conf{ConfDir}/g;
s/__TOPDIR__/$Conf{TopDir}/g;
s/^(\s*my \$useFHS\s*=\s*)\d;/${1}$opts{fhs};/
if ( $prog =~ /Lib.pm/ );
s/__BACKUPPCUSER__/$Conf{BackupPCUser}/g;
s/__CGIDIR__/$Conf{CgiDir}/g;
s/__IMAGEDIR__/$Conf{CgiImageDir}/g;
s/__IMAGEDIRURL__/$Conf{CgiImageDirURL}/g;
if ( $first && /^#.*bin\/perl/ ) {
#
# Fill in correct path to perl (no taint for >= 2.0.1).
#
print OUT "#!$Conf{PerlPath}\n";
} else {
print OUT;
}
$first = 0;
}
close(PROG);
close(OUT);
}
die("can't chown $uid, $gid $dest") unless my_chown($uid, $gid, $dest);
die("can't chmod $mode $dest") unless my_chmod($mode, $dest);
}
sub FindProgram
{
my($path, $prog) = @_;
if ( defined($opts{"bin-path"}{$prog}) ) {
return $opts{"bin-path"}{$prog};
}
foreach my $dir ( split(/:/, $path) ) {
my $file = File::Spec->catfile($dir, $prog);
return $file if ( -x $file );
}
return;
}
sub ConfigParse
{
my($file) = @_;
open(C, $file) || die("can't open $file");
binmode(C);
my($out, @conf, $var);
my $comment = 1;
my $allVars = {};
my $endLine = undef;
while ( <C> ) {
if ( /^#/ && !defined($endLine) ) {
if ( $comment ) {
$out .= $_;
} else {
if ( $out ne "" ) {
$allVars->{$var} = @conf if ( defined($var) );
push(@conf, {
text => $out,
var => $var,
});
}
$var = undef;
$comment = 1;
$out = $_;
}
} elsif ( /^\s*\$Conf\{([^}]*)/ ) {
$comment = 0;
if ( defined($var) ) {
$allVars->{$var} = @conf if ( defined($var) );
push(@conf, {
text => $out,
var => $var,
});
$out = $_;
} else {
$out .= $_;
}
$var = $1;
$endLine = $1 if ( /^\s*\$Conf\{[^}]*} *= *<<(.*);/ );
$endLine = $1 if ( /^\s*\$Conf\{[^}]*} *= *<<'(.*)';/ );
} else {
$endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
$out .= $_;
}
}
if ( $out ne "" ) {
$allVars->{$var} = @conf if ( defined($var) );
push(@conf, {
text => $out,
var => $var,
});
}
close(C);
return (\@conf, $allVars);
}
sub ConfigMerge
{
my($old, $oldVars, $new, $newVars) = @_;
my $posn = 0;
my($res, $resVars);
#
# Find which config parameters are not needed any longer
#
foreach my $var ( @$old ) {
next if ( !defined($var->{var}) || defined($newVars->{$var->{var}}) );
#print(STDERR "Deleting old config parameter $var->{var}\n");
$var->{delete} = 1;
}
#
# Find which config parameters are new
#
foreach my $var ( @$new ) {
next if ( !defined($var->{var}) );
if ( defined($oldVars->{$var->{var}}) ) {
$posn = $oldVars->{$var->{var}};
} else {
#print(STDERR "New config parameter $var->{var}: $var->{text}\n");
push(@{$old->[$posn]{new}}, $var);
}
}
#
# Create merged config file
#
foreach my $var ( @$old ) {
next if ( $var->{delete} );
push(@$res, $var);
foreach my $new ( @{$var->{new}} ) {
push(@$res, $new);
}
}
for ( my $i = 0 ; $i < @$res ; $i++ ) {
$resVars->{$res->[$i]{var}} = $i;
}
return ($res, $resVars);
}
sub my_chown
{
my($uid, $gid, $file) = @_;
return 1 if ( !$opts{"set-perms"} );
return chown($uid, $gid, $file);
}
sub my_chmod
{
my ($mode, $file) = @_;
return 1 if ( !$opts{"set-perms"} );
return chmod($mode, $file);
}
sub prompt
{
my($question, $default, $option) = @_;
$default = $opts{$option} if ( defined($opts{$option}) );
if ( $opts{batch} ) {
print("$question [$default]\n");
return $default;
}
print("$question [$default]? ");
my $reply = <STDIN>;
$reply =~ s/[\n\r]*//g;
return $reply if ( $reply !~ /^$/ );
return $default;
}
__END__
=head1 SYNOPSIS
configure.pl [options]
=head1 DESCRIPTION
configure.pl is a script that is used to install or upgrade a BackupPC
installation. It is usually run interactively without arguments. It
also supports a batch mode where all the options can be specified
via the command-line.
For upgrading BackupPC you need to make sure that BackupPC is not
running prior to running BackupPC.
Typically configure.pl needs to run as the super user (root).
=head1 OPTIONS
=over 8
=item B<--batch>
Run configure.pl in batch mode. configure.pl will run without
prompting the user. The other command-line options are used
to specify the settings that the user is usually prompted for.
=item B<--backuppc-user=USER>
Specify the BackupPC user name that owns all the BackupPC
files and runs the BackupPC programs. Default is backuppc.
=item B<--bin-path PROG=PATH>
Specify the path for various external programs that BackupPC
uses. Several --bin-path options may be specified. configure.pl
usually finds sensible defaults based on searching the PATH.
The format is:
--bin-path PROG=PATH
where PROG is one of perl, tar, smbclient, nmblookup, rsync, ping,
df, ssh, sendmail, hostname, split, par2, cat, gzip, bzip2 and
PATH is that full path to that program.
Examples
--bin-path cat=/bin/cat --bin-path bzip2=/home/user/bzip2
=item B<--compress-level=N>
Set the configuration compression level to N. Default is 3
if Compress::Zlib is installed.
=item B<--config-dir CONFIG_DIR>
Configuration directory for new installations. Defaults
to /etc/BackupPC with FHS. Automatically extracted
from --config-path for existing installations.
=item B<--config-path CONFIG_PATH>
Path to the existing config.pl configuration file for BackupPC.
This option should be specified for batch upgrades to an
existing installation. The option should be omitted when
doing a batch new install.
=item B<--cgi-dir CGI_DIR>
Path to Apache's cgi-bin directory where the BackupPC_Admin
script will be installed. This option only needs to be
specified for a batch new install.
=item B<--data-dir DATA_DIR>
Path to the BackupPC data directory. This is where all the backup
data is stored, and it should be on a large file system. This option
only needs to be specified for a batch new install.
Example:
--data-dir /data/BackupPC
=item B<--dest-dir DEST_DIR>
An optional prefix to apply to all installation directories.
Usually this is not needed, but certain auto-installers like
to stage an install in a temporary directory, and then copy
the files to their real destination. This option can be used
to specify the temporary directory prefix. Note that if you
specify this option, BackupPC won't run correctly if you try
to run it from below the --dest-dir directory, since all the
paths are set assuming BackupPC is installed in the intended
final locations.
=item B<--fhs>
Use locations specified by the Filesystem Hierarchy Standard
for installing BackupPC. This is enabled by default for new
installations. To use the pre-3.0 installation locations,
specify --no-fhs.
=item B<--help|?>
Print a brief help message and exits.
=item B<--hostname HOSTNAME>
Host name (this machine's name) on which BackupPC is being installed.
This option only needs to be specified for a batch new install.
=item B<--html-dir HTML_DIR>
Path to an Apache html directory where various BackupPC image files
and the CSS files will be installed. This is typically a directory
below Apache's DocumentRoot directory. This option only needs to be
specified for a batch new install.
Example:
--html-dir /var/www/htdocs/BackupPC
=item B<--html-dir-url URL>
The URL (without http://hostname) required to access the BackupPC html
directory specified with the --html-dir option. This option only needs
to be specified for a batch new install.
Example:
--html-dir-url /BackupPC
=item B<--install-dir INSTALL_DIR>
Installation directory for BackupPC scripts, libraries, and
documentation. This option only needs to be specified for a
batch new install.
Example:
--install-dir /usr/local/BackupPC
=item B<--log-dir LOG_DIR>
Log directory. Defaults to /var/log/BackupPC with FHS.
=item B<--man>
Prints the manual page and exits.
=item B<--set-perms>
When installing files and creating directories, chown them to
the BackupPC user and chmod them too. This is enabled by default.
To disable (for example, if staging a destination directory)
then specify --no-set-perms.
=item B<--uid-ignore>
configure.pl verifies that the script is being run as the super user
(root). Without the --uid-ignore option, in batch mode the script will
exit with an error if not run as the super user, and in interactive mode
the user will be prompted. Specifying this option will cause the script
to continue even if the user id is not root.
=head1 EXAMPLES
For a standard interactive install, run without arguments:
configure.pl
For a batch new install you need to specify answers to all the
questions that are normally prompted:
configure.pl \
--batch \
--cgi-dir /var/www/cgi-bin/BackupPC \
--data-dir /data/BackupPC \
--hostname myHost \
--html-dir /var/www/html/BackupPC \
--html-dir-url /BackupPC \
--install-dir /usr/local/BackupPC
For a batch upgrade, you only need to specify the path to the
configuration file:
configure.pl --batch --config-path /data/BackupPC/conf/config.pl
=head1 AUTHOR
Craig Barratt <cbarratt@users.sourceforge.net>
=head1 COPYRIGHT
Copyright (C) 2001-2010 Craig Barratt.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
=cut
|