summaryrefslogtreecommitdiffstats
path: root/docs/xml/installation.xml
blob: 7e4db1eb6fc1f39b839d0e2b8d705ad798dd0246 (plain)
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
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->

  <chapter id="installation" xreflabel="Bugzilla Installation">
    <title>Installation</title>
    <para>
      These installation instructions are presented assuming you are
      installing on a UNIX or completely POSIX-compliant system.  If
      you are installing on Microsoft Windows or another oddball
      operating system, please consult the appropriate sections in
      this installation guide for notes on how to be successful.
    </para>
    <section id="errata">
      <title>ERRATA</title>
    <para>Here are some miscellaneous notes about possible issues you
      main run into when you begin your Bugzilla installation.
      Reference platforms for Bugzilla installation are Redhat Linux
      7.2, Linux-Mandrake 8.0, and Solaris 8.</para>
  
    <simplelist>
      <member>
	If you are installing Bugzilla on S.u.S.e. Linux, or some
	other distributions with <quote>paranoid</quote> security
	options, it is possible that the checksetup.pl script may fail
	with the error: <errorname>cannot chdir(/var/spool/mqueue):
	  Permission denied</errorname> This is because your
	<filename>/var/spool/mqueue</filename> directory has a mode of
	<quote>drwx------</quote>.  Type <command>chmod 755
	  <filename>/var/spool/mqueue</filename></command> as root to
	fix this problem.
      </member>
      
      <member>
	Bugzilla may be installed on Macintosh OS X (10), which is a
	unix-based (BSD)  operating system. Everything required for
	Bugzilla on OS X will install cleanly, but the optional GD
	perl module which is used for bug charting requires some
	additional setup for installation. Please see the  Mac OS X
	installation section below for details
      </member>
      
      <member>
	Release Notes for Bugzilla &bz-ver; are available at
	<filename>docs/rel_notes.txt</filename> in your Bugzilla
	source distribution.
      </member>
      
      <member>
	  The preferred documentation for Bugzilla is available in
	docs/, with a variety of document types available.  Please
	refer to these documents when  installing, configuring, and
	maintaining your Bugzilla installation.
      </member>

    </simplelist>
    
    <warning>
      <para>
	Bugzilla is not a package where you can just plop it in a directory,
	twiddle a few things, and you're off.  Installing Bugzilla assumes you
	know your variant of UNIX or Microsoft Windows well, are familiar with the
	command line, and are comfortable compiling and installing a plethora
	of third-party utilities.  To install Bugzilla on Win32 requires
	fair Perl proficiency, and if you use a webserver other than Apache you
	should be intimately familiar with the security mechanisms and CGI
	environment thereof.
      </para>
    </warning>
    
    <warning>
      <para>
	Bugzilla has not undergone a complete security review. Security holes
	may exist in the code.  Great care should be taken both in the installation
	and usage of this software.  Carefully consider the implications of
	installing other network services with Bugzilla.
      </para>
    </warning>
  </section>
  
  <section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step">
    <title>Step-by-step Install</title>
    <section>
      <title>Introduction</title>
      <para>
	Installation of bugzilla is pretty straightforward, particularly if your
	machine already has MySQL and the MySQL-related perl packages installed.
	If those aren't installed yet, then that's the first order of business.  The
	other necessary ingredient is a web server set up to run cgi scripts.
	While using Apache for your webserver is not required, it is recommended.
      </para>
      
      <para>
	Bugzilla has been successfully installed under Solaris, Linux,
	and Win32. The peculiarities of installing on Win32 (Microsoft
	Windows) are not included in this section of the Guide; please
	check out the <xref linkend="win32"> for further advice
	on getting Bugzilla to work on Microsoft Windows.
      </para>
      
      <para>
	The Bugzilla Guide is contained in the "docs/" folder in your
	Bugzilla distribution.  It is available in plain text
	(docs/txt), HTML (docs/html), or SGML source (docs/sgml).
      </para>
    </section>
    <section>
      <title>Installing the Prerequisites</title>
      <note>
	<para>If you want to skip these manual installation steps for
	  the CPAN dependencies listed below, and are running the very
	  most recent version of Perl and MySQL (both the executables
	  and development libraries) on your system, check out
	  Bundle::Bugzilla in <xref linkend="bundlebugzilla"></para>
      </note>
      <para>
	The software packages necessary for the proper running of bugzilla are:
	<orderedlist>
	  <listitem>
	    <para>
	      MySQL database server and the mysql client (3.22.5 or greater)
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Perl (5.004 or greater, 5.6.1 is recommended if you wish
	      to use Bundle::Bugzilla)
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      DBI Perl module
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Data::Dumper Perl module
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Bundle::Mysql Perl module collection
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      TimeDate Perl module collection
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      GD perl module (1.8.3) (optional, for bug charting)
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Chart::Base Perl module (0.99c) (optional, for bug charting)
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      DB_File Perl module (optional, for bug charting)
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      The web server of your choice.  Apache is recommended.
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
	    </para>
	  </listitem>
	</orderedlist>

	<warning>
	  <para>
	    It is a good idea, while installing Bugzilla, to ensure it
	    is not <emphasis>accessible</emphasis> by other machines
	    on the Internet. Your machine may be vulnerable to attacks
	    while you are installing. In other words, ensure there is
	    some kind of firewall between you and the rest of the
	    Internet.  Many installation steps require an active
	    Internet connection to complete, but you must take care to
	    ensure that at no point is your machine vulnerable to an
	    attack.
	  </para>
	</warning>
	<note>
	  <para>Linux-Mandrake 8.0, the author's test system, includes
	    every required and optional library for Bugzilla.  The
	    easiest way to install them is by using the
	    <filename>urpmi</filename> utility.  If you follow these
	    commands, you should have everything you need for
	    Bugzilla, and <filename>checksetup.pl</filename> should
	    not complain about any missing libraries.  You may already
	    have some of these installed.</para>
	  <simplelist>
	    <member><prompt>bash#</prompt><command> urpmi
		perl-mysql</command></member>
	    <member><prompt>bash#</prompt><command> urpmi
		perl-chart</command></member>
	    <member><prompt>bash#</prompt><command> urpmi
		perl-gd</command></member>
	    <member><prompt>bash#</prompt><command> urpmi
		perl-MailTools</command> (for Bugzilla email
	      integration)</member>
	    <member><prompt>bash#</prompt><command> urpmi
		apache-modules</command></member>
	  </simplelist>
	</note>
	
      </para>
    </section>
    <section id="install-mysql">
      <title>Installing MySQL Database</title>
      <para>
	Visit MySQL homepage at <ulink
				       url="http://www.mysql.com">www.mysql.com</ulink> and grab the latest stable release of the server.  Many of the binary versions of MySQL store their data files in <filename>/var</filename> which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to <filename>configure</filename>.
      </para>
      <para>
	If you install from source or non-package (RPM, deb, etc.)
	binaries you need to add
	<firstterm>mysqld</firstterm> to your
	init scripts so the server daemon will come back up whenever
	your machine reboots. Further discussion of UNIX init
	sequences are beyond the scope of this guide.
	<note>
	  <para>You should have your init script start
	    <glossterm>mysqld</glossterm> with the ability to accept
	    large packets. By default, <filename>mysqld</filename>
	    only accepts packets up to 64K long. This limits the size
	    of attachments you may put on bugs. If you add <option>-O
	    max_allowed_packet=1M</option> to the command that starts
	    <filename>mysqld</filename> (or
	    <filename>safe_mysqld</filename>), then you will be able
	    to have attachments up to about 1 megabyte.</para>
	</note>

      </para>
      <note>
	<para>
	  If you plan on running Bugzilla and MySQL on the same
	  machine, consider using the <option>--skip-networking</option>
	  option in the init script. This enhances security by
	  preventing network access to MySQL.
	</para>
      </note>
    </section>
    
    <section id="install-perl">
      <title>Perl (5.004 or greater)</title>
      <para>
	Any machine that doesn't have perl on it is a sad machine
	indeed.  Perl for *nix systems can be gotten in source form
	from http://www.perl.com.  Although Bugzilla runs with most
	post-5.004 versions of Perl, it's a good idea to be up to the
	very latest version if you can when running Bugzilla.  As of
	this writing, that is perl version &perl-ver;.
      </para>
      <para>
	Perl is now a far cry from the the single compiler/interpreter
	binary it once was.  It includes a great many required modules
	and quite a few other support files.  If you're not up to or
	not inclined to build perl from source, you'll want to install
	it on your machine using some sort of packaging system (be it
	RPM, deb, or what have you) to ensure a sane install. In the
	subsequent sections you'll be installing quite a few perl
	modules; this can be quite ornery if your perl installation
	isn't up to snuff.
      </para>
      <warning>
	<para>Many people complain that Perl modules will not install
	  for them.  Most times, the error messages complain that they
	  are missing a file in <quote>@INC</quote>.  Virtually every
	  time, this is due to permissions being set too restrictively
	  for you to compile Perl modules or not having the necessary
	  Perl development libraries installed on your system..
	  Consult your local UNIX systems administrator for help
	  solving these permissions issues; if you
	  <emphasis>are</emphasis> the local UNIX sysadmin, please
	  consult the newsgroup/mailing list for further assistance or
	  hire someone to help you out.
	</para>
      </warning>
      <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
	<para>
	  You can skip the following Perl module installation steps by
	  installing <productname>Bundle::Bugzilla</productname> from
	  <glossterm linkend="gloss_cpan">CPAN</glossterm>, which
	  includes them. All Perl module installation steps require
	  you have an active Internet connection.  If you wish to use
	  Bundle::Bugzilla, however, you must be using the latest
	  version of Perl (at this writing, version &perl-ver;)
	</para>
	<para>
	  <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN
	      -e 'install "Bundle::Bugzilla"'</command>
	  </computeroutput>
	</para>
	<para>
	  Bundle::Bugzilla doesn't include GD, Chart::Base, or
	  MIME::Parser, which are not essential to a basic Bugzilla
	  install.  If installing this bundle fails, you should
	  install each module individually to isolate the problem.
	</para>
      </tip>
    </section>
    
    <section>
      <title>DBI Perl Module</title>
      <para>
	The DBI module is a generic Perl module used by other database related
	Perl modules.  For our purposes it's required by the MySQL-related
	modules.  As long as your Perl installation was done correctly the
	DBI module should be a breeze.  It's a mixed Perl/C module, but Perl's
	MakeMaker system simplifies the C compilation greatly.
      </para>
      <para>
	Like almost all Perl modules DBI can be found on the Comprehensive Perl
	Archive Network (CPAN) at http://www.cpan.org.  The CPAN servers have a
	real tendency to bog down, so please use mirrors.  The current location
	at the time of this writing can be found in <xref linkend="downloadlinks">.
      </para>
      <para>
	Quality, general Perl module installation instructions can be found on
	the CPAN website, but the easy thing to do is to just use the CPAN shell
	which does all the hard work for you.
      </para>
      <para>
	To use the CPAN shell to install DBI:
	<informalexample>
	  <para>
	    <computeroutput>
	      <prompt>bash#</prompt>
	      <command>perl -MCPAN -e 'install "DBI"'</command>
	    </computeroutput>
	    <note>
	      <para>Replace "DBI" with the name of whichever module you wish
		to install, such as Data::Dumper, TimeDate, GD, etc.</para>
	    </note>
	  </para>
	</informalexample>
	To do it the hard way:
	<informalexample>
	  <para>
	    Untar the module tarball -- it should create its own directory
	  </para>
	  <para>
	    CD to the directory just created, and enter the following commands:
	    <orderedlist>
	      <listitem>
		<para>
		  <computeroutput>
		    <prompt>bash#</prompt>
		    <command>perl Makefile.PL</command>
		  </computeroutput>
		</para>
	      </listitem>
	      <listitem>
		<para>
		  <computeroutput>
		    <prompt>bash#</prompt>
		    <command>make</command>
		  </computeroutput>
		</para>
	      </listitem>
	      <listitem>
		<para>
		  <computeroutput>
		    <prompt>bash#</prompt>
		    <command>make test</command>
		  </computeroutput>
		</para>
	      </listitem>
	      <listitem>
		<para>
		  <computeroutput>
		    <prompt>bash#</prompt>
		    <command>make install</command>
		  </computeroutput>
		</para>
	      </listitem>
	    </orderedlist>
	    If everything went ok that should be all it takes.  For the vast
	    majority of perl modules this is all that's required.
	  </para>
	</informalexample>
      </para>
    </section>
    <section>
      <title>Data::Dumper Perl Module</title>
      <para>
	The Data::Dumper module provides data structure persistence for Perl
	(similar to Java's serialization).  It comes with later sub-releases of
	Perl 5.004, but a re-installation just to be sure it's available won't
	hurt anything.
      </para>
      <para>
	Data::Dumper is used by the MySQL-related Perl modules.  It
	can be found on CPAN (see <xref linkend="downloadlinks">) and
	can be
	installed by following the same four step make sequence used
	for the DBI module.
      </para>
    </section>
    
    <section>
      <title>MySQL related Perl Module Collection</title>
      <para>
	The Perl/MySQL interface requires a few mutually-dependent perl
	modules.  These modules are grouped together into the the
	Msql-Mysql-modules package.  This package can be found at CPAN.
	After the archive file has been downloaded it should
	be untarred.
      </para>
      <para>
	The MySQL modules are all built using one make file which is generated
	by running:
	<prompt>bash#</prompt>
	<command>perl Makefile.pl</command>
      </para>
      <para>
	The MakeMaker process will ask you a few questions about the desired
	compilation target and your MySQL installation.  For many of the questions
	the provided default will be adequate.
      </para>
      <para>
	When asked if your desired target is the MySQL or mSQL packages,
	select the MySQL related ones.  Later you will be asked if you wish
	to provide backwards compatibility with the older MySQL packages; you
	  should answer YES to this question. The default is NO.
	</para>
	<para>
	  A host of 'localhost' should be fine and a testing user of 'test' and
	  a null password should find itself with sufficient access to run tests
	  on the 'test' database which MySQL created upon installation.  If 'make
	  test' and 'make install' go through without errors you should be ready
	  to go as far as database connectivity is concerned.
	</para>
      </section>

      <section>
	<title>TimeDate Perl Module Collection</title>
	<para>
	  Many of the more common date/time/calendar related Perl
	modules have been grouped into a bundle similar to the MySQL
	modules bundle. This bundle is stored on the CPAN under the
	name TimeDate (see link: <xref linkend="downloadlinks">). The
	component module we're most interested in is the Date::Format
	module, but installing all of them is probably a good idea
	anyway.  The standard Perl module installation instructions
	should work perfectly for this simple package.
	</para>
      </section>
      <section>
	<title>GD Perl Module (1.8.3)</title>
	<para>
	  The GD library was written by Thomas Boutell a long while
	ago to programatically generate images in C.  Since then it's
	become the defacto standard for programatic image
	construction.  The Perl bindings to it found in the GD library
	are used on millions of web pages to generate graphs on the
	fly. That's what bugzilla will be using it for so you must
	install it if you want any of the graphing to work.
	</para>
	<para>
	  Actually bugzilla uses the Graph module which relies on GD
	itself.  Isn't that always the way with object-oriented
	programming?  At any rate, you can find the GD library on CPAN
	in <xref linkend="downloadlinks">.  
	</para>
	<note>
	  <para>
	    The Perl GD library requires some other libraries that may
	  or may not be installed on your system, including
	  <classname>libpng</classname> and
	  <classname>libgd</classname>.  The full requirements are
	  listed in the Perl GD library README.  Just realize that if
	  compiling GD fails, it's probably because you're missing a
	  required library.
	  </para>
	</note>
      </section>

      <section>
	<title>Chart::Base Perl Module (0.99c)</title>
	<para>
	  The Chart module provides bugzilla with on-the-fly charting
	abilities.  It can be installed in the usual fashion after it
	has been fetched from CPAN where it is found as the
	Chart-x.x... tarball, linked in <xref linkend="downloadlinks">. Note that
	as with the GD perl module, only the version listed above, or
	newer, will work. Earlier versions used GIF's, which are no
	longer supported by the latest versions of GD.
	</para>
      </section>

      <section>
	<title>DB_File Perl Module</title>
	<para>
	  DB_File is a module which allows Perl programs to make use
	of the facilities provided by  Berkeley DB version 1.x. This
	module is required by collectstats.pl which is used for  bug
	charting. If you plan to make use of bug charting, you must
	install this module.
	</para>
      </section>

      <section>
	<title>HTTP Server</title>
	<para>
	  You have a freedom of choice here - Apache, Netscape or any
	other server on UNIX would do.  You can easily run the web
	server on a different machine than MySQL, but need to adjust
	the MySQL <quote>bugs</quote> user permissions accordingly.
	<note>
	  <para>I strongly recommend Apache as the web server to use.
	    The Bugzilla Guide installation instructions, in general,
	    assume you are using Apache.  As more users use different
	    webservers and send me information on the peculiarities of
	    installing using their favorite webserver, I will provide
	    notes for them.</para>
	</note>
	</para>
	<para>
	  You'll want to make sure that your web server will run any
	file with the .cgi extension as a cgi and not just display it.
	If you're using apache that means uncommenting the following
	line in the srm.conf file:
	<programlisting>
AddHandler cgi-script .cgi
	</programlisting>
	</para>
	<para>
	  With apache you'll also want to make sure that within the
	access.conf file the line:
 <programlisting>
Options ExecCGI
</programlisting>
	is in the stanza that covers the directories into which
	you intend to put the bugzilla .html and .cgi files.
	</para>
      <note>
	<para>
	  Users of newer versions of Apache will generally find both
	  of the above lines will be in the httpd.conf file, rather
	  than srm.conf or access.conf.
	</para>
      </note>
	<warning>
	  <para>
	    There are important files and directories that should not
	  be a served by the HTTP server. These are most files in the
	  <quote>data</quote> and <quote>shadow</quote>  directories
	  and the <quote>localconfig</quote> file. You should
	  configure your HTTP server to not serve content from these
	  files. Failure to do so will expose critical passwords and
	  other data. Please see <xref linkend="htaccess"> for details
	  on how to do this for Apache.  I appreciate notes on how to
	  get this same functionality using other webservers.
	  </para>
	</warning>
      </section>

      <section>
	<title>Installing the Bugzilla Files</title>
	<para>
	  You should untar the Bugzilla files into a directory that
	you're willing to make writable by the default web server user
	(probably <quote>nobody</quote>).  You may decide to put the
	files off of the main web space for your web server or perhaps
	off of <filename>/usr/local</filename> with a symbolic link in
	the web space that points to the Bugzilla directory.  At any
	rate, just dump all the files in the same place, and make sure
	you can access the files in that directory through your web
	server.
	</para>
	<tip>
	  <para>
	    If you symlink the bugzilla directory into your Apache's
	  HTML heirarchy, you may receive
	  <errorname>Forbidden</errorname> errors unless you add the
	  <quote>FollowSymLinks</quote> directive to the
	  &lt;Directory&gt; entry for the HTML root.
	  </para>
	</tip>
	<para>
	  Once all the files are in a web accessible directory, make
	that directory writable by your webserver's user.  This is a
	temporary step until you run the post-install
	<filename>checksetup.pl</filename> script, which locks down your
	installation.
      </para>
      <para>
	Lastly, you'll need to set up a symbolic link to
	<filename>/usr/bonsaitools/bin/perl</filename> for the correct
	location of your perl executable (probably
	<filename>/usr/bin/perl</filename>). Otherwise you must hack
	all the .cgi files to change where they look for perl, or use
	<xref linkend="setperl">, found in
	<xref linkend="patches">.  I suggest using the symlink
	approach for future release compatability.
	<example>
	  <title>Setting up bonsaitools symlink</title>
	  <para>
	      Here's how you set up the Perl symlink on Linux to make
	    Bugzilla work. Your mileage may vary.  For some UNIX
	    operating systems, you probably need to subsitute
	    <quote>/usr/local/bin/perl</quote> for
	    <quote>/usr/bin/perl</quote>  below; if on certain other
	    UNIX systems, Perl may live in weird places like
	    <quote>/opt/perl</quote>.  As root, run these commands:
	    <programlisting>
bash# mkdir /usr/bonsaitools  
bash# mkdir /usr/bonsaitools/bin 
bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl
	    </programlisting>
	  </para>
	  <para>
	    Alternately, you can simply run this perl one-liner to
	    change your path to perl in all the files in your Bugzilla
	    installation:
	    <programlisting>
perl -pi -e 's@#!/usr/bonsaitools/bin/perl@#!/usr/bin/perl@' *cgi *pl Bug.pm
	    </programlisting>
	    Change the second path to perl to match your installation.
	  </para>
	</example>
	<tip>
	  <para>
	    If you don't have root access to set this symlink up,
	    check out the
	    <xref linkend="setperl">, listed in <xref
						      linkend="patches">. It will change the path to perl in all your Bugzilla files for you.
	  </para>
	  </tip>
	</para>
      </section>

      <section>
	<title>Setting Up the MySQL Database</title>
	<para>
	  After you've gotten all the software installed and working you're ready
	  to start preparing the database for its life as a the back end to a high
	  quality bug tracker.
	</para>
	<para>
	  First, you'll want to fix MySQL permissions to allow access
	from Bugzilla.  For the purpose of this Installation section,
	the Bugzilla username will be <quote>bugs</quote>, and will
	have minimal permissions.
	
	<warning>
	  <para>
	    Bugzilla has not undergone a thorough security audit. It
	    may be possible for a system cracker to somehow trick
	    Bugzilla into executing a command such as <command>DROP
	      DATABASE mysql</command>.
	  </para>
	  <para>That would be bad.</para>
	</warning>
      </para>
      
      <para>
	Give the MySQL root user a password.  MySQL passwords are
	limited to 16 characters.
	<simplelist>
	  <member>
	    <computeroutput> <prompt>bash#</prompt> <command>mysql
		-u root mysql</command> </computeroutput>
	  </member>
	  <member>
	    <computeroutput> <prompt>mysql></prompt> <command>
		UPDATE user SET Password=PASSWORD ('new_password')
		WHERE user='root'; </command> </computeroutput>
	  </member>
	  <member>
	    <computeroutput> <prompt>mysql></prompt> <command>FLUSH
		PRIVILEGES;</command> </computeroutput>
	  </member>
	</simplelist> From this point on, if you need to access
	MySQL as the MySQL root user, you will need to use
	<command>mysql -u root -p</command> and enter your
	new_password.  Remember that MySQL user names have nothing to
	do with Unix user names (login names).	  
      </para>
      <para>
	Next, we create the <quote>bugs</quote> user, and grant
	sufficient permissions for checksetup.pl, which we'll use
	later, to work its magic.  This also restricts the
	<quote>bugs</quote> user to operations within a database
	called <quote>bugs</quote>, and only allows the account to
	connect from <quote>localhost</quote>.  Modify it to reflect
	your setup if you will be connecting from another machine or
	as a different user.
      </para>
      <para>
	Remember to set bugs_password to some unique password.
	<simplelist>
	  <member>
	    <computeroutput>
	      <prompt>mysql></prompt>
	      <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
		ALTER,CREATE,DROP,REFERENCES 
		ON bugs.* TO bugs@localhost
		IDENTIFIED BY 'bugs_password';</command>
	    </computeroutput>
	  </member>
	  <member>
	    <computeroutput>
	      <prompt>
		mysql>
	      </prompt>
	      <command>
		FLUSH PRIVILEGES;
	      </command>
	    </computeroutput>
	  </member>
	</simplelist>
      </para>
      <para>
	Next, run the magic checksetup.pl script.  (Many thanks to
	Holger Schurig &lt;holgerschurig@nikocity.de&gt; for writing
	this script!) It will make sure Bugzilla files and directories
	have reasonable permissions, set up the
	<filename>data</filename> directory, and create all the MySQL
	tables.
	<simplelist>
	  <member>
	    <computeroutput> <prompt>bash#</prompt>
	      <command>./checksetup.pl</command> </computeroutput>
	  </member>
	</simplelist> The first time you run it, it will create a
	file called <filename>localconfig</filename>.
      </para>
    </section>
    
    <section>
      <title>Tweaking <filename>localconfig</filename></title>
      <para>
	This file contains a variety of settings you may need to tweak including
	how Bugzilla should connect to the MySQL database.
      </para>
      <para>
	The connection settings include:
	<orderedlist>
	  <listitem>
	    <para>
	      server's host: just use <quote>localhost</quote> if the
	      MySQL server is local
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      database name: <quote>bugs</quote> if you're following
	      these directions
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      MySQL username: <quote>bugs</quote> if you're following
	      these directions
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Password for the <quote>bugs</quote> MySQL account above
	    </para>
	  </listitem>
	</orderedlist>
      </para>
      <para>
	You should also install .htaccess files that the Apache
	webserver will use  to restrict access to Bugzilla data files.
	See <xref
		  linkend="htaccess">.
      </para>
      <para>
	Once you are happy with the settings, re-run
	<filename>checksetup.pl</filename>. On this second run, it will
	  create the database and an administrator account for which
	  you will be prompted to provide information.
      </para>
      <para>
	When logged into an administrator account once Bugzilla is
	running, if you go to the query page (off of the Bugzilla main
	menu), you'll find an <quote>edit parameters</quote> option
	that is filled with editable treats.
      </para>
      <para>
	Should everything work, you will have a nearly empty Bugzilla
	database and a newly-created <filename>localconfig</filename>
	file in your Bugzilla root directory.
      </para>
      <para>
	<note>
	  <para>
	    The second time you run checksetup.pl, you should become
	    the user your web server runs as, and that you ensure that
	    you set the <quote>webservergroup</quote> parameter in localconfig to
	    match the web  server's group name, if any.  I believe,
	    for the next release of Bugzilla, this will be fixed so
	    that Bugzilla supports a <quote>webserveruser</quote> parameter in
	    localconfig as well.
	    <example>
	      <title>Running checksetup.pl as the web user</title>
	      <para>
		  Assuming your web server runs as user "apache", and
		Bugzilla is installed in "/usr/local/bugzilla", here's
		one way to run checksetup.pl as the web server user.
		As root, for the <emphasis>second run</emphasis> of
		checksetup.pl, do this: 
		<programlisting> 
bash# chown -R apache:apache /usr/local/bugzilla 
bash# su - apache 
bash# cd /usr/local/bugzilla 
bash# ./checksetup.pl 
		</programlisting>
	      </para>
	    </example>
	  </para>
	</note>
      </para>
      <note>
	<para>
	  The checksetup.pl script is designed so that you can run
	  it at any time without causing harm.  You should run it
	  after any upgrade to Bugzilla.
	</para>
      </note>
    </section>
    
    <section>
      <title>Setting Up Maintainers Manually (Optional)</title>
      <para>
	If you want to add someone else to every group by hand, you
	can do it by typing the appropriate MySQL commands.  Run
	<command> mysql -u root -p bugs</command> You
	may need different parameters, depending on your security
	settings. Then:
	  <simplelist>
	    <member>
	      <computeroutput> <prompt>mysql></prompt> <command>update
		profiles set groupset=0x7fffffffffffffff where
		login_name = 'XXX';</command> </computeroutput> (yes, that's <emphasis>fifteen</emphasis><quote>f</quote>'s.
	    </member>
	  </simplelist> replacing XXX with the Bugzilla email address.
	</para>
      </section>

      <section>
	<title>The Whining Cron (Optional)</title>
      <para>
	By now you have a fully functional bugzilla, but what good
	are bugs if they're not annoying?  To help make those bugs
	more annoying you can set up bugzilla's automatic whining
	system.  This can be done by adding the following command as a
	daily crontab entry (for help on that see that crontab man
	page):
	<simplelist>
	  <member>
	    <computeroutput> <command>cd
		&lt;your-bugzilla-directory&gt; ;
		./whineatnews.pl</command> </computeroutput>
	  </member>
	</simplelist>
      </para>
      <tip>
	<para>
	  Depending on your system, crontab may have several manpages.
	  The following command should  lead you to the most useful
	  page for this purpose: 
	  <programlisting>
 man 5 crontab
	  </programlisting>
	</para>
      </tip>
    </section>
    
    <section>
      <title>Bug Graphs (Optional)</title>
      <para>
	As long as you installed the GD and Graph::Base Perl modules
	you might as well turn on the nifty bugzilla bug reporting
	graphs.
      </para>
      <para>
	Add a cron entry like this to run collectstats daily at 5
	after midnight:
	<simplelist>
	  <member>
	    <computeroutput> <prompt>bash#</prompt> <command>crontab
		-e</command> </computeroutput>
	  </member>
	  <member>
	    <computeroutput> 5 0 * * * cd
	      &lt;your-bugzilla-directory&gt; ; ./collectstats.pl
	    </computeroutput>
	  </member>
	</simplelist>
      </para>
      <para>
	After two days have passed you'll be able to view bug graphs
	from the Bug Reports page. 
      </para>
    </section>
    
    <section>
      <title>Securing MySQL</title>
      <para>
	If you followed the installation instructions for setting up
	your "bugs" and "root" user in MySQL, much of this should not
	apply to you.  If you are upgrading an existing installation
	of Bugzilla, you should pay close attention to this section.
      </para>
      <para>
	Most MySQL installs have "interesting" default security parameters:
	<simplelist>
	  <member>mysqld defaults to running as root</member>
	  <member>it defaults to allowing external network connections</member>
	  <member>it has a known port number, and is easy to detect</member>
	  <member>it defaults to no passwords whatsoever</member>
	  <member>it defaults to allowing "File_Priv"</member>
	</simplelist>
      </para>
      <para>
	This means anyone from anywhere on the internet can not only
	drop the database with one SQL command, and they can write as
	root to the system.
      </para>
      <para>
	To see your permissions do:
	<simplelist>
	  <member>
	    <computeroutput>
	      <prompt>bash#</prompt>
	      <command>mysql -u root -p</command>
	    </computeroutput>
	  </member>
	  <member>
	    <computeroutput>
	      <prompt>mysql></prompt>
	      <command>use mysql;</command>
	    </computeroutput>
	  </member>
	  <member>
	    <computeroutput>
	      <prompt>mysql></prompt>
	      <command>show tables;</command>
	    </computeroutput>
	  </member>
	  <member>
	    <computeroutput>
	      <prompt>mysql></prompt>
	      <command>select * from user;</command>
	    </computeroutput>
	  </member>
	  <member>
	    <computeroutput>
	      <prompt>mysql></prompt>
	      <command>select * from db;</command>
	    </computeroutput>
	  </member>
	</simplelist>
      </para>
      <para>
	To fix the gaping holes:
	<simplelist>
	  <member>DELETE FROM user WHERE User='';</member>
	  <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member>
	  <member> FLUSH PRIVILEGES;</member>
	</simplelist>
      </para>
      <para>
	If you're not running "mit-pthreads" you can use:
	<simplelist>
	  <member>GRANT USAGE ON *.* TO bugs@localhost;</member>
	  <member>GRANT ALL ON bugs.* TO bugs@localhost;</member>
	  <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member>
	  <member>FLUSH PRIVILEGES;</member>
	</simplelist>
      </para>
      <para>
	With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
	line to specify a specific host name instead of "localhost", and accept
	external connections:
	<simplelist>
	  <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member>
	  <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member>
	  <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member>
	  <member>FLUSH PRIVILEGES;</member>
	</simplelist>
      </para>
      <para>
	Use .htaccess files with the Apache webserver to secure your
	bugzilla install. See <xref linkend="htaccess">
      </para>
      <para>
	Consider also:
	<orderedlist>
	  <listitem>
	    <para>
	      Turning off external networking with "--skip-networking",
	      unless you have "mit-pthreads", in which case you can't.
	      Without networking, MySQL connects with a Unix domain socket.
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      using the --user= option to mysqld to run it as an unprivileged
	      user.
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      starting MySQL in a chroot jail
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      running the httpd in a "chrooted" jail
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      making sure the MySQL passwords are different from the OS
	      passwords (MySQL "root" has nothing to do with system "root").
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      running MySQL on a separate untrusted machine
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      making backups ;-)
	    </para>
	  </listitem>
	</orderedlist>
      </para>
    </section>
  </section>      
  <section id="osx">
    <title>Mac OS X Installation Notes</title>
    <para>
      There are a lot of common libraries and utilities out there
      that Apple did not include with Mac OS X, but which run
      perfectly well on it.  The GD library, which Bugzilla needs to
      do bug graphs, is one of these.
    </para>
    <para>
      The easiest way to get a lot of these is with a program called
      Fink, which is similar in nature to the CPAN installer, but
      installs common GNU utilities.  Fink is available from
      &lt;http://sourceforge.net/projects/fink/>.
    </para>
    <para>
      Follow the instructions for setting up Fink.  Once it's
      installed, you'll want to run the following as root:
      <command>fink install gd</command>
    </para>
    <para>
      It will prompt you for a number of dependencies, type 'y' and
      hit enter to install all of the dependencies.  Then watch it
      work.
    </para>
    <para>
      To prevent creating conflicts with the software that Apple
      installs by default, Fink creates its own directory tree at
      /sw where it installs most of the software that it installs.
      This means your libraries and headers for libgd will be at
      /sw/lib and /sw/include instead of /usr/lib and
      /usr/local/include.  Because of these changed locations for
      the libraries, the Perl GD module will not install directly
      via CPAN (it looks for the specific paths instead of getting
      them from your environment).  But there's a way around that
      :-)
    </para>
    <para>
      Instead of typing <quote>install GD</quote> at the
      <prompt>cpan&gt;</prompt> prompt, type <command>look
	GD</command>.  This should go through the motions of
      downloading the latest version of the GD module, then it will
      open a shell and drop you into the build directory. Apply the
      following patch to the Makefile.PL file (save the patch into a
      file  and use the command <command>patch &lt;
	patchfile</command>:
    </para>
    <para>
      <programlisting>
<![CDATA[
	
--- GD-1.33/Makefile.PL Fri Aug  4 16:59:22 2000
+++ GD-1.33-darwin/Makefile.PL  Tue Jun 26 01:29:32 2001
@@ -3,8 +3,8 @@
 warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
 
 # =====> PATHS: CHECK AND ADJUST <=====
-my @INC     = qw(-I/usr/local/include -I/usr/local/include/gd); 
-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
+my @INC     = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
 my @LIBS    = qw(-lgd -lpng -lz);
 
 # FEATURE FLAGS
@@ -23,7 +23,7 @@
 
 push @LIBS,'-lttf' if $TTF;
 push @LIBS,'-ljpeg' if $JPEG;
-push @LIBS, '-lm' unless $^O eq 'MSWin32';
+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
 
 # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified 
 if ($^O ne 'freebsd' && $^O ne 'MSWin32') {

]]> 
      </programlisting>
    </para>
    <para>
      Then, run these commands to finish the installation of the perl module:
      <simplelist>
	<member><command>perl Makefile.PL</command></member>
	<member><command>make</command></member>
	<member><command>make test</command></member>
	<member><command>make install</command></member>
	<member>And don't forget to run <command>exit</command> to get back to cpan.</member>
      </simplelist>
    </para>
    <para>
      Happy Hacking!
    </para>
  </section>
  
  <section id="bsdinstall" xreflabel="BSD Installation Notes">
    <title>BSD Installation Notes</title>
    <para>
      For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
      consult <xref linkend="osx">.
    </para>
  </section>
  
  
  <section id="geninstall" xreflabel="Installation General Notes">
    <title>Installation General Notes</title>
    <section>
      <title>Modifying Your Running System</title>
      <para>
	Bugzilla optimizes database lookups by storing all relatively static
	information in the versioncache file, located in the data/ subdirectory
	under your installation directory.
      </para>
      <para>
	If you make a change to the structural data in your database
	(the versions table for example), or to the
	<quote>constants</quote> encoded in defparams.pl, you will
	need to remove the cached content from the data directory
	(by doing a <quote>rm data/versioncache</quote>), or your
	changes won't show up.
      </para>
      <para>
	That file gets automatically regenerated whenever it's more than an
	hour old, so Bugzilla will eventually notice your changes by itself, but
	generally you want it to notice right away, so that you can test things.
      </para>
    </section>
    <section>
      <title>Upgrading From Previous Versions</title>
      <para>
	The developers of Bugzilla are constantly adding new tables, columns and
	fields.  You'll get SQL errors if you just update the code.  The strategy
	to update is to simply always run the checksetup.pl script whenever
	you upgrade your installation of Bugzilla.  If you want to see what has
	changed, you can read the comments in that file, starting from the end.
      </para>
      <para>
	If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
	the latest version, please consult the file, "UPGRADING-pre-2.8" in the
	Bugzilla root directory after untarring the archive.
      </para>
    </section>

    <section id="htaccess" xreflabel=".htaccess files and security">
      <title><filename>.htaccess</filename> files and security</title>
      <para>
	To enhance the security of your Bugzilla installation,
	Bugzilla  will generate
	<glossterm><filename>.htaccess</filename></glossterm> files
	which the Apache webserver can use to restrict  access to
	the bugzilla data files. The checksetup script  will
	generate the <filename>.htaccess</filename> files.
	
	<note>
	  <para>
	    If you are using an alternate provider of
	    <productname>webdot</productname> services for graphing
	    (as described when viewing
	    <filename>editparams.cgi</filename> in your web
	    browser), you will need to change  the ip address in
	    <filename>data/webdot/.htaccess</filename> to the ip
	    address of the webdot server that  you are using. 
	  </para>
	</note>
	
      </para>
      <para>
	If you are using Internet Information Server or other web
	server which does not observe <filename>.htaccess</filename>
	conventions, you can disable their creation by editing
	<filename>localconfig</filename> and setting the
	<varname>$create_htaccess</varname> variable to
	<parameter>0</parameter>.
      </para>
    </section>

    <section id="mod_throttle" xreflabel="Using mod_throttle to prevent Denial of Service attacks">
    	<title><filename>mod_throttle</filename> and Security</title>
      <para>
	It is possible for a user, by mistake or on purpose, to access
	the database many times in a row which can result in very slow
	access speeds for other users.  If your Bugzilla installation
	is experiencing this problem , you may install  the Apache
	module <filename>mod_throttle</filename> which can limit
	connections by ip-address. You may download this module at
	<ulink
	       url="http://www.snert.com/Software/Throttle/">http://www.snert.com/Software/Throttle/</ulink>. Follow the instructions to install into your Apache install.  <emphasis>This module only functions with the Apache web server!</emphasis>. You may use the <command>ThrottleClientIP</command> command provided by this module  to accomplish this goal. See the <ulink url="http://www.snert.com/Software/Throttle/">Module Instructions</ulink> for more  information. </para>
    </section>
    
    <section id="content_type" xreflabel="Preventing untrusted Bugzilla contentfrom executing malicious Javascript code">
      <title>Preventing untrusted Bugzilla content from executing malicious Javascript code</title>
      <para>It is possible for a Bugzilla to execute malicious
	Javascript code.  Due to internationalization concerns, we are
	unable to incorporate the code changes necessary to fulfill
	the CERT advisory requirements mentioned in <ulink
							   url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3">http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>.  Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience.  As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it. </para>
	<para><programlisting>
bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
	  do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
	  mv $i.tmp $i; done
	</programlisting></para>
      <para>
	All this one-liner command does is search for all instances of
	<quote>Content-type: text/html</quote> and replaces it with
	<quote>Content-Type: text/html; charset=ISO-8859-1</quote>.
	This specification prevents possible Javascript attacks on the
	browser, and is suggested for all English-speaking sites.  For
	non-english-speaking Bugzilla sites, I suggest changing
	<quote>ISO-8859-1</quote>, above, to <quote>UTF-8</quote>.
      </para>
    </section>

    
    <section id="unixhistory">
      <title>UNIX Installation Instructions History</title>
      <para>
	This document was originally adapted from the Bonsai
	installation instructions by Terry Weissman
	&lt;terry@mozilla.org&gt;.
      </para>
      <para>
	The February 25, 1999 re-write of this page was done by Ry4an
	Brase &lt;ry4an@ry4an.org&gt;, with some edits by Terry
	Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
	don't send bug reports to them; report them using bugzilla, at <ulink
	url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ).
      </para>
      <para>
	This document was heavily modified again Wednesday, March 07
	2001 to reflect changes for Bugzilla 2.12 release by Matthew
	P. Barnson.  The securing MySQL section should be changed to
	become standard procedure for Bugzilla installations.
      </para>
      <para>
	Finally, the README in its entirety was marked up in SGML and
	included into the Guide on April 24, 2001 by Matt Barnson.
	Since that time, it's undergone extensive modification as
	Bugzilla grew.
      </para>
      <para>
	Comments from people using this Guide for the first time are
	particularly welcome.
      </para>
    </section>
  </section>
  
  <section id="win32" xreflabel="Win32 Installation Notes">
    <title>Win32 Installation Notes</title>
    <para>This section covers installation on Microsoft Windows 95,
      98, ME, NT, and 2000.  Bugzilla works fine on Win32 platforms,
      but please remember that the Bugzilla team and the author of the
      Guide neither endorse nor support installation on Microsoft
      Windows.  Bugzilla installs and runs <emphasis>best</emphasis>
      and <emphasis>easiest</emphasis> on UNIX-like operating systems,
      and that is the way it will stay for the foreseeable future. The
      Bugzilla team is considering supporting Win32 for the 2.16
      release and later.</para>
    <para>The easiest way to install Bugzilla on Intel-archiecture
      machines is to install some variant of GNU/Linux, then follow
      the UNIX installation instructions in this Guide.  If you have
      any influence in the platform choice for running this system,
      please choose GNU/Linux instead of Microsoft Windows.</para>

    <section id="wininstall" xreflabel="Win32 Installation: Step-by-step">
      <title>Win32 Installation: Step-by-step</title>
      <note>
	<para>
	  You should be familiar with, and cross-reference, the rest
	  of the  
	  <xref linkend="installation"> section while performing your
	  Win32 installation.
	</para>
	<para>  Making Bugzilla work on Microsoft Windows is no
	  picnic.  Support for Win32 has improved dramatically in the
	  last few releases, but, if you choose to proceed, you should
	  be a <emphasis>very</emphasis> skilled Windows Systems
	  Administrator with strong troubleshooting abilities, a high
	  tolerance for pain, and moderate perl skills. Bugzilla on NT
	  requires hacking source code and implementing some advanced
	  utilities.  What follows is the recommended installation
	  procedure for Win32; additional suggestions are provided in
	  <xref linkend="faq">.
	</para>
      </note>
      
      <procedure>
	<step>
	  <para>
	    Install <ulink url="http://www.apache.org/">Apache Web
	      Server</ulink> for Windows, and copy the Bugzilla files
	    somewhere Apache can serve them.  Please follow all the
	    instructions referenced in <xref linkend="installation">
	    regarding your Apache configuration, particularly
	    instructions regarding the <quote>AddHandler</quote>
	    parameter and <quote>ExecCGI</quote>.
	  </para>
	  <note>
	    <para>
	      You may also use Internet Information Server or Personal
	      Web Server for this purpose.  However, setup is quite
	      different.  If ActivePerl doesn't seem to handle your
	      file associations correctly (for .cgi and .pl files),
	      please consult <xref linkend="faq">.
	    </para>
	    <para>
	      If you are going to use IIS, if on Windows NT you must
	      be updated to at least Service Pack 4.  Windows 2000
	      ships with a sufficient version of IIS.
	    </para>
	  </note>
	</step>
	<step>
	  <para>
	    Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows.  Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary.
	  </para>
	  <para>
	    Please also check the following links to fully understand the status
	    of ActivePerl on Win32:
	    <ulink url="http://language.perl.com/newdocs/pod/perlport.html">
	      Perl Porting</ulink>, and
	    <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html">
	      Perl on Win32 FAQ</ulink>
	  </para>
	</step>
	<step>
	  <para>
	    Use ppm from your perl\bin directory to install the following packs: DBI,
	    DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD.  You may need
	    to extract them from .zip format using Winzip or other unzip program first.
	    These additional ppm modules can be downloaded from ActiveState.
	  </para>
	  <note>
	    <para>
	      You can find a list of modules at
	      <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only">
		http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink>
	    </para>
	  </note>
	  <para>
	    The syntax for ppm is:
	    <computeroutput>
	      <prompt>C:> </prompt><command>ppm &lt;modulename&gt;</command>
	    </computeroutput>
	  </para>

	  <example>
	    <title>Installing ActivePerl ppd Modules on Microsoft Windows</title>
	    <para><prompt>C:></prompt><command>ppm
		<option>DBD-Mysql</option></command></para>
	    <para>Watch your capitalization!</para>
	  </example>

	  <para>
	    You can find ActiveState ppm modules at
	    <ulink url="http://www.activestate.com/PPMPackages/5.6plus/">
	      http://www.activestate.com/PPMPackages/5.6plus</ulink>
	  </para>
	</step>

	<step>
	  <para>
	    Install MySQL for NT.
	    <note>
	      <para>
		You can download MySQL for Windows NT from <ulink url="http://www.mysql.com/">MySQL.com</ulink>.  Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
	      </para>
	    </note>
	  </para>
	</step>
	<step>
	  <para>
	    Setup MySQL
	  </para>
	  <substeps>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>C:> </prompt>
		  <command>C:\mysql\bin\mysql -u root mysql</command>
		</computeroutput>
	      </para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>DELETE FROM user WHERE Host='localhost' AND User='';</command>
		</computeroutput>
	      </para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>UPDATE user SET Password=PASSWORD ('new_password')
		    WHERE user='root';</command>
		</computeroutput>
	      </para>
	      <para><quote>new_password</quote>, above, indicates
		whatever password you wish to use for your
		<quote>root</quote> user.</para>
	    </step>
	    <step id="ntbugs-password">
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>GRANT SELECT, INSERT, UPDATE, DELETE,
		    INDEX, ALTER, CREATE, DROP, REFERENCES
		    ON bugs.* to bugs@localhost
		    IDENTIFIED BY 'bugs_password';</command>
		</computeroutput>
	      </para>
	      <para><quote>bugs_password</quote>, above, indicates
		whatever password you wish to use for your
		<quote>bugs</quote> user.</para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>FLUSH PRIVILEGES;</command>
		</computeroutput>
	      </para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>create database bugs;</command>
		</computeroutput>
	      </para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>mysql></prompt>
		  <command>exit;</command>
		</computeroutput>
	      </para>
	    </step>
	    <step>
	      <para>
		<computeroutput>
		  <prompt>C:></prompt>
		  <command>C:\mysql\bin\mysqladmin -u root -p reload</command>
		</computeroutput>
	      </para>
	    </step>
	  </substeps>
	</step>

	<step>
	  <para>
	    Edit <filename>checksetup.pl</filename> in your Bugzilla directory.  Change
	    this line:
	  </para>
	  <para>
	    <programlisting>
my $webservergid = getgrnam($my_webservergroup);
	    </programlisting>
	  </para>
	  <para>
	    to
	  </para>
	  <para>
	    <programlisting>
my $webservergid = $my_webservergroup;
	    </programlisting>
or the name of the group you wish to own the files explicitly:
	    <programlisting>
my $webservergid = 'Administrators'
	    </programlisting>
	  </para>
	</step>

	<step>
	  <para>
	    Run <filename>checksetup.pl</filename> from the Bugzilla directory.
	  </para>
	</step>

	<step>
	  <para>Edit <filename>localconfig</filename> to suit your
	    requirements.  Set <varname>$db_pass</varname> to your
	    <quote>bugs_password</quote> from <xref linkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para>
	  <note>
	    <para>Not sure on the <quote>8</quote> for
	      <varname>$webservergroup</varname> above.  If it's
	      wrong, please send corrections.</para>
	  </note>
	</step>

	<step>
	  <para>
	    Edit <filename>defparams.pl</filename> to suit your
	    requirements.  Particularly, set
	    <varname>DefParam("maintainer")</varname> and
	    <varname>DefParam("urlbase") to match your
	      install.</varname>
	  </para>
	  <note>
	    <para>This is yet another step I'm not sure of, since the
	      maintainer of this documentation does not maintain
	      Bugzilla on NT.  If you can confirm or deny that this
	      step is required, please let me know.</para>
	  </note>
	</step>

	<step>
	  <note>
	    <para>
	      There are several alternatives to Sendmail that will work on Win32.
	      The one mentioned here is a <emphasis>suggestion</emphasis>, not
	      a requirement.  Some other mail packages that can work include
	      <ulink url="http://www.blat.net/">BLAT</ulink>,
	      <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>,
	      <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>,
	      and the CPAN Net::SMTP Perl module (available in .ppm).
	      Every option requires some hacking of the Perl scripts for Bugzilla
	      to make it work.  The option here simply requires the least.
	    </para>
	  </note>

	  <procedure>
	    <step>
	      <para>
		Download NTsendmail, available from<ulink url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
	      </para>
	    </step>

	    <step>
	      <para>Put ntsendmail.pm into your .\perl\lib directory.</para>
	    </step>

	    <step>
	      <para>Add to globals.pl:</para>
	      <programlisting>
# these settings configure the NTsendmail process
use NTsendmail;
$ENV{"NTsendmail"}="your.smtpserver.box";
$ENV{"NTsendmail_debug"}=1;
$ENV{"NTsendmail_max_tries"}=5;
	      </programlisting>
	      <note>
		<para>
		  Some mention to also edit
		  <varname>$db_pass</varname> in
		  <filename>globals.pl</filename> to be your
		  <quote>bugs_password</quote>.  Although this may get
		  you around some problem authenticating to your
		  database, since globals.pl is not normally
		  restricted by <filename>.htaccess</filename>, your
		  database password is exposed to whoever uses your
		  web server.
		</para>
	      </note>
	    </step>

	    <step>
	      <para>
		Find and comment out all occurences of
		<quote><command>open(SENDMAIL</command></quote> in
		your Bugzilla directory.  Then replace them with:
		<programlisting>
# new sendmail functionality
my $mail=new NTsendmail;
my $from="bugzilla\@your.machine.name.tld";
my $to=$login;
my $subject=$urlbase;
$mail->send($from,$to,$subject,$msg);
		</programlisting>
	      </para>
	      <note>
		<para>
		  Some have found success using the commercial product, 
		  <productname>Windmail</productname>.
		  You could try replacing your sendmail calls with:
		  <programlisting>
open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
		  </programlisting>
		or something to that effect.
		</para>
	      </note>
	    </step>
	  </procedure>
	</step>
      
	<step>
	  <para>
	    Change all references in all files from
	    <filename>processmail</filename> to
	    <filename>processmail.pl</filename>, and
	    rename <filename>processmail</filename> to
	    <filename>processmail.pl</filename>.
	  </para>
	  <note>
	    <para>
	      Many think this may be a change we want to make for
	      main-tree Bugzilla.  It's painless for the UNIX folks,
	      and will make the Win32 people happier.
	    </para>
	  </note>
	  <note>
	    <para>
	      Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here.  You can change processmail.pl to make this work.
	    <programlisting>
<![CDATA[

my $smtp = Net::SMTP->new('<Name of your SMTP server>');   #connect to SMTP server
$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
$smtp->to($tolist); # recipient's address
$smtp->data();  # Start the mail
$smtp->datasend($msg);
$smtp->dataend();   # Finish sending the mail
$smtp->quit;    # Close the SMTP connection
$logstr = "$logstr; mail sent to $tolist $cclist";
}

]]>
</programlisting>
here is a test mail program for Net::SMTP:
<programlisting>
<![CDATA[

use Net::SMTP;
 my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
=> 1, ); # connect to SMTP server
                 $smtp->auth;
                $smtp->mail('you@yourcompany.com');# use the sender's adress
here
                $smtp->to('someotherAddress@someotherdomain.com'); #
recipient's address
                $smtp->data();  # Start the mail
                $smtp->datasend('test');
                $smtp->dataend();   # Finish sending the mail
                $smtp->quit;    # Close the SMTP connection
exit;

]]>
</programlisting>
	    </para>
	  </note>
	</step>
	<step>
	  <note>
	    <para>
	      This step is optional if you are using IIS or another
	      web server which only decides on an interpreter based
	      upon the file extension (.pl), rather than the
	      <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl)
	    </para>
	  </note>
	  <para>
	    Modify the path to perl on the first line (#!) of all
	    files to point to your Perl installation, and add
	    <quote>perl</quote> to the beginning of all Perl system
	    calls that use a perl script as an argument.  This may
	    take you a while. There is a <quote>setperl.csh</quote>
	    utility to speed part of this procedure, available in the
	    <xref linkend="patches"> section of The Bugzilla Guide.
	    However, it requires the Cygwin GNU-compatible environment
	    for Win32 be set up in order to work.  See <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin.
	  </para>
	</step>

	<step>
	  <para>
	    Modify the invocation of all system() calls in all perl
	    scripts in your Bugzilla directory.  For instance, change
	    this line in processmail: 
	    <programlisting> 
system ("./processmail.pl",@ARGLIST); 
	    </programlisting> to
	    <programlisting> 
system ("perl processmail.pl",@ARGLIST);
	    </programlisting>
	  </para>
	</step>
        <step>
          <para>
            Add <function>binmode()</function> calls so attachments
	    will work (<ulink
			      url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>).
          </para>
          <para>
            Because Microsoft Windows based systems handle binary
	    files different than Unix based systems, you need to add
	    the following lines to
	    <filename>createattachment.cgi</filename>  and
	    <filename>showattachment.cgi</filename> before the
	    <function>require 'CGI.pl';</function> line.
</para>
<para>
<programlisting>
<![CDATA[
binmode(STDIN);
binmode(STDOUT);
]]>
</programlisting>
          </para>
          <note>
            <para>
              According to <ulink
				  url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, the perl documentation says that you should always use <function>binmode()</function> when dealing with binary files, but never when dealing with text files.  That seems to suggest that rather than aribtrarily putting <function>binmode()</function> at the begining of the attachment files, there should be logic to determine if <function>binmode()</function> is needed or not.
            </para>
          </note>
        </step>
      </procedure>

      <tip>
	<para>
	  If you are using IIS or Personal Web Server, you must add cgi
	  relationships to Properties -> Home directory (tab) ->
	  Application Settings (section) -> Configuration (button),
	  such as: 
	</para>
	<para>
	  <programlisting> 
.cgi to: &lt;perl install directory&gt;\perl.exe %s %s
.pl to: &lt;perl install directory&gt;\perl.exe %s %s
GET,HEAD,POST
	  </programlisting> 
	  Change the path to Perl to match your
	  install, of course.
	</para>
      </tip>
    </section>

    <section id="addlwintips">
      <title>Additional Windows Tips</title>
      <tip>
	<para>
	  From Andrew Pearson:
	  <blockquote>
	    <para>
	      You can make Bugzilla work with Personal Web Server for
	      Windows 98 and higher, as well as for IIS 4.0.
	      Microsoft has information available at <ulink url="
							    http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink>
	    </para>
	    <para>
	      Basically you need to add two String Keys in the
	      registry at the following location:
	    </para>
	    <para>
	      <programlisting>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
	      </programlisting>
	    </para>
	    <para>
	      The keys should be called ".pl" and ".cgi", and both
	      should have a value something like:
	      <command>c:/perl/bin/perl.exe "%s" "%s"</command>
	    </para>
	    <para>
	      The KB article only talks about .pl, but it goes into
	      more detail and provides a perl test script.
	    </para>
	  </blockquote>
	</para>
      </tip>
      <tip>
	<para>
	  If attempting to run Bugzilla 2.12 or older, you will need
	  to remove encrypt() calls from the Perl source. This is
	  <emphasis>not necessary</emphasis> for Bugzilla 2.13 and
	  later, which includes the current release, Bugzilla
	  &bz-ver;.
	  <example>
	    <title>Removing encrypt() for Windows NT Bugzilla version
	      2.12 or earlier</title>
	    <para>
	      Replace this:   
	      <programlisting>  
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
	      </programlisting> 
with this:   
	      <programlisting>  
my $enteredcryptpwd = $enteredpwd   
	      </programlisting> 
	      in cgi.pl.
	    </para>
	  </example>
	</para>
      </tip>
    </section>
    
    <section id="bzldap">
      <title>Bugzilla LDAP Integration</title>
      <para>
	What follows is some late-breaking information on using the
	LDAP authentication options with Bugzilla.  The author has not
	tested these (nor even formatted this section!) so please
	contribute feedback to the newsgroup.
      </para>
      <literallayout>
Mozilla::LDAP module

The Mozilla::LDAP module allows you to use LDAP for authentication to
the Bugzilla system.  This module is not required if you are not using
LDAP.

Mozilla::LDAP (aka PerLDAP) is available for download from
http://www.mozilla.org/directory.

NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
Follow the link for "Directory SDK for C" on that same page to
download the SDK first.  After you have installed this SDK, then
install the PerLDAP module.
----------------------------------------------------------------------

Post-Installation Checklist
----------------------------------------------------------------------
Set useLDAP to "On" **only** if you will be using an LDAP directory
for authentication.  Be very careful when setting up this parameter;
if you set LDAP authentication, but do not have a valid LDAP directory
set up, you will not be able to log back in to Bugzilla once you log
out.  (If this happens, you can get back in by manually editing the
data/params file, and setting useLDAP back to 0.)

If using LDAP, you must set the three additional parameters:

Set LDAPserver to the name (and optionally port) of your LDAP server.
If no port is specified, it defaults to the default port of 389.  (e.g
"ldap.mycompany.com" or "ldap.mycompany.com:1234")

Set LDAPBaseDN to the base DN for searching for users in your LDAP
directory.  (e.g. "ou=People,o=MyCompany")  uids must be unique under
the DN specified here.

Set LDAPmailattribute to the name of the attribute in your LDAP
directory which contains the primary email address.  On most directory
servers available, this is "mail", but you may need to change this.
----------------------------------------------------------------------

(Not sure where this bit should go, but it's important that it be in
there somewhere...)
----------------------------------------------------------------------
Using LDAP authentication for Bugzilla:

The existing authentication scheme for Bugzilla uses email addresses
as the primary user ID, and a password to authenticate that user.  All
places within Bugzilla where you need to deal with user ID (e.g
assigning a bug) use the email address.

The LDAP authentication builds on top of this scheme, rather than
replacing it.  The initial log in is done with a username and password
for the LDAP directory.  This then fetches the email address from LDAP
and authenticates seamlessly in the standard Bugzilla authentication
scheme using this email address.  If an account for this address
already exists in your Bugzilla system, it will log in to that
account.  If no account for that email address exists, one is created
at the time of login.  (In this case, Bugzilla will attempt to use the
"displayName" or "cn" attribute to determine the user's full name.)

After authentication, all other user-related tasks are still handled
by email address, not LDAP username.  You still assign bugs by email
address, query on users by email address, etc.
----------------------------------------------------------------------
      </literallayout>
    </section>
  </section>
</chapter>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->