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
|
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<chapter id="administration">
<title>Administering Bugzilla</title>
<section id="parameters">
<title>Bugzilla Configuration</title>
<para>
Bugzilla is configured by changing various parameters, accessed
from the "Edit parameters" link in the page footer. Here are
some of the key parameters on that page. You should run down this
list and set them appropriately after installing Bugzilla.
</para>
<indexterm>
<primary>checklist</primary>
</indexterm>
<variablelist>
<varlistentry>
<term>
maintainer
</term>
<listitem>
<para>
The maintainer parameter is the email address of the person
responsible for maintaining this Bugzilla installation.
The address need not be that of a valid Bugzilla account.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
urlbase
</term>
<listitem>
<para>
This parameter defines the fully qualified domain name and web
server path to your Bugzilla installation.
</para>
<para>
For example, if your Bugzilla query page is
<filename>http://www.foo.com/bugzilla/query.cgi</filename>,
set your <quote>urlbase</quote>
to <filename>http://www.foo.com/bugzilla/</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
makeproductgroups
</term>
<listitem>
<para>
This dictates whether or not to automatically create groups
when new products are created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
useentrygroupdefault
</term>
<listitem>
<para>
Bugzilla products can have a group associated with them, so that
certain users can only see bugs in certain products. When this
parameter is set to <quote>on</quote>, this
causes the initial group controls on newly created products
to place all newly-created bugs in the group
having the same name as the product immediately.
After a product is initially created, the group controls
can be further adjusted without interference by
this mechanism.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
shadowdb
</term>
<listitem>
<para>
You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only table-level
write locking. What this means is that if someone needs to make a
change to a bug, they will lock the entire table until the operation
is complete. Locking for write also blocks reads until the write is
complete. Note that more recent versions of mysql support row level
locking using different table types. These types are slower than the
standard type, and Bugzilla does not yet take advantage of features
such as transactions which would justify this speed decrease. The
Bugzilla team are, however, happy to hear about any experiences with
row level locking and Bugzilla.
</para>
<para>
The <quote>shadowdb</quote> parameter was designed to get around
this limitation. While only a single user is allowed to write to
a table at a time, reads can continue unimpeded on a read-only
shadow copy of the database. Although your database size will
double, a shadow database can cause an enormous performance
improvement when implemented on extremely high-traffic Bugzilla
databases.
</para>
<para>
As a guide, on reasonably old hardware, mozilla.org began needing
<quote>shadowdb</quote> when they reached around 40,000 Bugzilla
users with several hundred Bugzilla bug changes and comments per day.
</para>
<para>
The value of the parameter defines the name of the shadow bug
database. You will need to set the host and port settings from
the params page, and set up replication in your database server
so that updates reach this readonly mirror. Consult your database
documentation for more detail.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
shutdownhtml
</term>
<listitem>
<para>
If you need to shut down Bugzilla to perform administration, enter
some descriptive text (with embedded HTML codes, if you'd like)
into this box. Anyone who tries to use Bugzilla (including admins)
will receive a page displaying this text. Users can neither log in
nor log out while shutdownhtml is enabled.
</para>
<note>
<para>
Although regular log-in capability is disabled while 'shutdownhtml'
is enabled, safeguards are in place to protect the unfortunate
admin who loses connection to Bugzilla. Should this happen to you,
go directly to the <filename>editparams.cgi</filename> (by typing
the URL in manually, if necessary). Doing this will prompt you to
log in, and your name/password will be accepted here (but nowhere
else).
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
passwordmail
</term>
<listitem>
<para>
Every time a user creates an account, the text of this parameter
(with substitutions) is sent to the new user along with their
password message.
</para>
<para>
Add any text you wish to the "passwordmail" parameter box. For
instance, many people choose to use this box to give a quick
training blurb about how to use Bugzilla at your site.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
movebugs
</term>
<listitem>
<para>
This option is an undocumented feature to allow moving bugs
between separate Bugzilla installations. You will need to understand
the source code in order to use this feature. Please consult
<filename>movebugs.pl</filename> in your Bugzilla source tree for
further documentation, such as it is.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
useqacontact
</term>
<listitem>
<para>
This allows you to define an email address for each component,
in addition to that of the default owner, who will be sent
carbon copies of incoming bugs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
usestatuswhiteboard
</term>
<listitem>
<para>
This defines whether you wish to have a free-form, overwritable field
associated with each bug. The advantage of the Status Whiteboard is
that it can be deleted or modified with ease, and provides an
easily-searchable field for indexing some bugs that have some trait
in common.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
whinedays
</term>
<listitem>
<para>
Set this to the number of days you want to let bugs go
in the NEW or REOPENED state before notifying people they have
untouched new bugs. If you do not plan to use this feature, simply
do not set up the whining cron job described in the installation
instructions, or set this value to "0" (never whine).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
commenton*
</term>
<listitem>
<para>
All these fields allow you to dictate what changes can pass
without comment, and which must have a comment from the
person who changed them. Often, administrators will allow
users to add themselves to the CC list, accept bugs, or
change the Status Whiteboard without adding a comment as to
their reasons for the change, yet require that most other
changes come with an explanation.
</para>
<para>
Set the "commenton" options according to your site policy. It
is a wise idea to require comments when users resolve, reassign, or
reopen bugs at the very least.
</para>
<note>
<para>
It is generally far better to require a developer comment
when resolving bugs than not. Few things are more annoying to bug
database users than having a developer mark a bug "fixed" without
any comment as to what the fix was (or even that it was truly
fixed!)
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
supportwatchers
</term>
<listitem>
<para>
Turning on this option allows users to ask to receive copies
of bug mail sent to another user. Watching a user with
different group permissions is not a way to 'get around' the
system; copied emails are still subject to the normal groupset
permissions of a bug, and <quote>watchers</quote> will only be
copied on emails from bugs they would normally be allowed to view.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
noresolveonopenblockers
</term>
<listitem>
<para>
This option will prevent users from resolving bugs as FIXED if
they have unresolved dependencies. Only the FIXED resolution
is affected. Users will be still able to resolve bugs to
resolutions other than FIXED if they have unresolved dependent
bugs.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="useradmin">
<title>User Administration</title>
<section id="defaultuser">
<title>Creating the Default User</title>
<para>When you first run checksetup.pl after installing Bugzilla, it
will prompt you for the administrative username (email address) and
password for this "super user". If for some reason you delete
the "super user" account, re-running checksetup.pl will again prompt
you for this username and password.</para>
<tip>
<para>If you wish to add more administrative users, add them to
the "admin" group and, optionally, add edit the tweakparams, editusers,
creategroups, editcomponents, and editkeywords groups to add the
entire admin group to those groups.
</para>
</tip>
</section>
<section id="manageusers">
<title>Managing Other Users</title>
<section id="createnewusers">
<title>Creating new users</title>
<para>Your users can create their own user accounts by clicking the
"New Account" link at the bottom of each page (assuming they
aren't logged in as someone else already.) However, should you
desire to create user accounts ahead of time, here is how you do
it.</para>
<orderedlist>
<listitem>
<para>After logging in, click the "Users" link at the footer of
the query page, and then click "Add a new user".</para>
</listitem>
<listitem>
<para>Fill out the form presented. This page is self-explanatory.
When done, click "Submit".</para>
<note>
<para>Adding a user this way will
<emphasis>not</emphasis>
send an email informing them of their username and password.
While useful for creating dummy accounts (watchers which
shuttle mail to another system, for instance, or email
addresses which are a mailing list), in general it is
preferable to log out and use the
<quote>New Account</quote>
button to create users, as it will pre-populate all the
required fields and also notify the user of her account name
and password.</para>
</note>
</listitem>
</orderedlist>
</section>
<section id="modifyusers">
<title>Modifying Users</title>
<para>To see a specific user, search for their login name
in the box provided on the "Edit Users" page. To see all users,
leave the box blank.</para>
<para>You can search in different ways the listbox to the right
of the text entry box. You can match by
case-insensitive substring (the default),
regular expression, or a
<emphasis>reverse</emphasis>
regular expression match, which finds every user name which does NOT
match the regular expression. (Please see
the <command>man regexp</command>
manual page for details on regular expression syntax.)
</para>
<para>Once you have found your user, you can change the following
fields:</para>
<itemizedlist>
<listitem>
<para>
<emphasis>Login Name</emphasis>:
This is generally the user's full email address. However, if you
have are using the emailsuffix Param, this may just be the user's
login name. Note that users can now change their login names
themselves (to any valid email address.)
</para>
</listitem>
<listitem>
<para>
<emphasis>Real Name</emphasis>: The user's real name. Note that
Bugzilla does not require this to create an account.</para>
</listitem>
<listitem>
<para>
<emphasis>Password</emphasis>:
You can change the user's password here. Users can automatically
request a new password, so you shouldn't need to do this often.
If you want to disable an account, see Disable Text below.
</para>
</listitem>
<listitem>
<para>
<emphasis>Disable Text</emphasis>:
If you type anything in this box, including just a space, the
user is prevented from logging in, or making any changes to
bugs via the web interface.
The HTML you type in this box is presented to the user when
they attempt to perform these actions, and should explain
why the account was disabled.
</para>
<para>
Users with disabled accounts will continue to receive
mail from Bugzilla; furthermore, they will not be able
to log in themselves to change their own preferences and
stop it. If you want an account (disabled or active) to
stop receiving mail, add the account name (one account
per line) to the file <filename>data/nomail</filename>.
</para>
<note>
<para>
Even users whose accounts have been disabled can still
submit bugs via the e-mail gateway, if one exists.
The e-mail gateway should <emphasis>not</emphasis> be
enabled for secure installations of Bugzilla.
</para>
</note>
<warning>
<para>
Don't disable all the administrator accounts!
</para>
</warning>
</listitem>
<listitem>
<para>
<emphasis><groupname></emphasis>:
If you have created some groups, e.g. "securitysensitive", then
checkboxes will appear here to allow you to add users to, or
remove them from, these groups.
</para>
</listitem>
<listitem>
<para>
<emphasis>canconfirm</emphasis>:
This field is only used if you have enabled the "unconfirmed"
status. If you enable this for a user,
that user can then move bugs from "Unconfirmed" to a "Confirmed"
status (e.g.: "New" status).</para>
</listitem>
<listitem>
<para>
<emphasis>creategroups</emphasis>:
This option will allow a user to create and destroy groups in
Bugzilla.</para>
</listitem>
<listitem>
<para>
<emphasis>editbugs</emphasis>:
Unless a user has this bit set, they can only edit those bugs
for which they are the assignee or the reporter. Even if this
option is unchecked, users can still add comments to bugs.
</para>
</listitem>
<listitem>
<para>
<emphasis>editcomponents</emphasis>:
This flag allows a user to create new products and components,
as well as modify and destroy those that have no bugs associated
with them. If a product or component has bugs associated with it,
those bugs must be moved to a different product or component
before Bugzilla will allow them to be destroyed.
</para>
</listitem>
<listitem>
<para>
<emphasis>editkeywords</emphasis>:
If you use Bugzilla's keyword functionality, enabling this
feature allows a user to create and destroy keywords. As always,
the keywords for existing bugs containing the keyword the user
wishes to destroy must be changed before Bugzilla will allow it
to die.</para>
</listitem>
<listitem>
<para>
<emphasis>editusers</emphasis>:
This flag allows a user to do what you're doing right now: edit
other users. This will allow those with the right to do so to
remove administrator privileges from other users or grant them to
themselves. Enable with care.</para>
</listitem>
<listitem>
<para>
<emphasis>tweakparams</emphasis>:
This flag allows a user to change Bugzilla's Params
(using <filename>editparams.cgi</filename>.)</para>
</listitem>
<listitem>
<para>
<emphasis><productname></emphasis>:
This allows an administrator to specify the products in which
a user can see bugs. The user must still have the
"editbugs" privilege to edit bugs in these products.</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="products">
<title>Products</title>
<para>
<glossterm linkend="gloss-product" baseform="product">
Products</glossterm>
are the broadest category in Bugzilla, and tend to represent real-world
shipping products. E.g. if your company makes computer games,
you should have one product per game, perhaps a "Common" product for
units of technology used in multiple games, and maybe a few special
products (Website, Administration...)</para>
<para>Many of Bugzilla's settings are configurable on a per-product
basis. The number of "votes" available to users is set per-product,
as is the number of votes
required to move a bug automatically from the UNCONFIRMED status to the
NEW status.</para>
<para>To create a new product:</para>
<orderedlist>
<listitem>
<para>Select "products" from the footer</para>
</listitem>
<listitem>
<para>Select the "Add" link in the bottom right</para>
</listitem>
<listitem>
<para>Enter the name of the product and a description. The
Description field may contain HTML.</para>
</listitem>
</orderedlist>
<para>Don't worry about the "Closed for bug entry", "Maximum Votes
per person", "Maximum votes a person can put on a single bug",
"Number of votes a bug in this Product needs to automatically get out
of the UNCOMFIRMED state", and "Version" options yet. We'll cover
those in a few moments.
</para>
</section>
<section id="components">
<title>Components</title>
<para>Components are subsections of a Product. E.g. the computer game
you are designing may have a "UI"
component, an "API" component, a "Sound System" component, and a
"Plugins" component, each overseen by a different programmer. It
often makes sense to divide Components in Bugzilla according to the
natural divisions of responsibility within your Product or
company.</para>
<para>
Each component has a owner and (if you turned it on in the parameters),
a QA Contact. The owner should be the primary person who fixes bugs in
that component. The QA Contact should be the person who will ensure
these bugs are completely fixed. The Owner, QA Contact, and Reporter
will get email when new bugs are created in this Component and when
these bugs change. Default Owner and Default QA Contact fields only
dictate the
<emphasis>default assignments</emphasis>;
these can be changed on bug submission, or at any later point in
a bug's life.</para>
<para>To create a new Component:</para>
<orderedlist>
<listitem>
<para>Select the "Edit components" link from the "Edit product"
page</para>
</listitem>
<listitem>
<para>Select the "Add" link in the bottom right.</para>
</listitem>
<listitem>
<para>Fill out the "Component" field, a short "Description",
the "Initial Owner" and "Initial QA Contact" (if enabled.)
The Component and Description fields may contain HTML;
the "Initial Owner" field must be a login name
already existing in the database.
</para>
</listitem>
</orderedlist>
</section>
<section id="versions">
<title>Versions</title>
<para>Versions are the revisions of the product, such as "Flinders
3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select
field; the usual practice is to select the earliest version known to have
the bug.
</para>
<para>To create and edit Versions:</para>
<orderedlist>
<listitem>
<para>From the "Edit product" screen, select "Edit Versions"</para>
</listitem>
<listitem>
<para>You will notice that the product already has the default
version "undefined". Click the "Add" link in the bottom right.</para>
</listitem>
<listitem>
<para>Enter the name of the Version. This field takes text only.
Then click the "Add" button.</para>
</listitem>
</orderedlist>
</section>
<section id="milestones">
<title>Milestones</title>
<para>Milestones are "targets" that you plan to get a bug fixed by. For
example, you have a bug that you plan to fix for your 3.0 release, it
would be assigned the milestone of 3.0.</para>
<note>
<para>Milestone options will only appear for a Product if you turned
on the "usetargetmilestone" Param in the "Edit Parameters" screen.
</para>
</note>
<para>To create new Milestones, set Default Milestones, and set
Milestone URL:</para>
<orderedlist>
<listitem>
<para>Select "Edit milestones" from the "Edit product" page.</para>
</listitem>
<listitem>
<para>Select "Add" in the bottom right corner.
text</para>
</listitem>
<listitem>
<para>Enter the name of the Milestone in the "Milestone" field. You
can optionally set the "sortkey", which is a positive or negative
number (-255 to 255) that defines where in the list this particular
milestone appears. This is because milestones often do not
occur in alphanumeric order For example, "Future" might be
after "Release 1.2". Select "Add".</para>
</listitem>
<listitem>
<para>From the Edit product screen, you can enter the URL of a
page which gives information about your milestones and what
they mean. </para>
</listitem>
</orderedlist>
</section>
<section id="flags-overview">
<title>Flags</title>
<para>
Flags are a way to attach a specific status to a bug or attachment,
either <quote>+</quote> or <quote>-</quote>. The meaning of these symbols depends on the text
the flag itself, but contextually they could mean pass/fail,
accept/reject, approved/denied, or even a simple yes/no. If your site
allows requestable flags, then users may set a flag to <quote>?</quote> as a
request to another user that they look at the bug/attachment, and set
the flag to its correct status.
</para>
<section id="flags-simpleexample">
<title>A Simple Example</title>
<para>
A developer might want to ask their manager,
<quote>Should we fix this bug before we release version 2.0?</quote>
They might want to do this for a <emphasis>lot</emphasis> of bugs,
so it would be nice to streamline the process...
</para>
<para>
In Bugzilla, it would work this way:
<orderedlist>
<listitem>
<para>
The Bugzilla administrator creates a flag type called
<quote>blocking2.0</quote> that shows up on all bugs in
your product.
</para>
<para>
It shows up on the <quote>Show Bug</quote> screen
as the text <quote>blocking2.0</quote> with a drop-down box next
to it. The drop-down box contains four values: an empty space,
<quote>?</quote>, <quote>-</quote>, and <quote>+</quote>.
</para>
</listitem>
<listitem>
<para>The developer sets the flag to <quote>?</quote>.</para>
</listitem>
<listitem>
<para>
The manager sees the <computeroutput>blocking2.0</computeroutput>
flag with a <quote>?</quote> value.
</para>
</listitem>
<listitem>
<para>
If the manager thinks the feature should go into the product
before version 2.0 can be released, he sets the flag to
<quote>+</quote>. Otherwise, he sets it to <quote>-</quote>.
</para>
</listitem>
<listitem>
<para>
Now, every Bugzilla user who looks at the bug knows whether or
not the bug needs to be fixed before release of version 2.0.
</para>
</listitem>
</orderedlist>
</para>
</section>
<section id="flags-about">
<title>About Flags</title>
<section id="flag-values">
<title>Values</title>
<para>
Flags can have three values:
<variablelist>
<varlistentry>
<term><computeroutput>?</computeroutput></term>
<listitem><simpara>
A user is requesting that a status be set. (Think of it as 'A question is being asked'.)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>-</computeroutput></term>
<listitem><simpara>
The status has been set negatively. (The question has been answered <quote>no</quote>.)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>+</computeroutput></term>
<listitem><simpara>
The status has been set positively.
(The question has been answered <quote>yes</quote>.)
</simpara></listitem>
</varlistentry>
</variablelist>
</para>
<para>
Actually, there's a fourth value a flag can have --
<quote>unset</quote> -- which shows up as a blank space. This
just means that nobody has expressed an opinion (or asked
someone else to express an opinion) about this bug or attachment.
</para>
</section>
</section>
<section id="flag-askto">
<title>Using flag requests</title>
<para>
If a flag has been defined as 'requestable',
users are allowed to set the flag's status to <quote>?</quote>.
This status indicates that someone (aka <quote>the requester</quote> is asking
for someone else to set the flag to either <quote>+</quote> or <quote>-</quote>.
</para>
<para>
If a flag has been defined as 'specifically requestable',
a text box will appear next to the flag into which the requester may
enter a Bugzilla username. That named person (aka <quote>the requestee</quote>)
will receive an email notifying them of the request, and pointing them
to the bug/attachment in question.
</para>
<para>
If a flag has <emphasis>not</emphasis> been defined as 'specifically requestable',
then no such text-box will appear. A request to set this flag cannot be made of
any specific individual, but must be asked <quote>to the wind</quote>.
A requester may <quote>ask the wind</quote> on any flag simply by leaving the text-box blank.
</para>
</section>
<section id="flag-types">
<title>Two Types of Flags</title>
<para>
Flags can go in two places: on an attachment, or on a bug.
</para>
<section id="flag-type-attachment">
<title>Attachment Flags</title>
<para>
Attachment flags are used to ask a question about a specific
attachment on a bug.
</para>
<para>
Many Bugzilla installations use this to
request that one developer <quote>review</quote> another
developer's code before they check it in. They attach the code to
a bug report, and then set a flag on that attachment called
<quote>review</quote> to
<computeroutput>review?boss@domain.com</computeroutput>.
boss@domain.com is then notified by email that
he has to check out that attachment and approve it or deny it.
</para>
<para>
For a Bugzilla user, attachment flags show up in two
places:
<orderedlist>
<listitem>
<para>
On the list of attachments in the <quote>Show Bug</quote>
screen, you can see the current state of any flags that
have been set to ?, +, or -. You can see who asked about
the flag (the requester), and who is being asked (the
requestee).
</para>
</listitem>
<listitem>
<para>
When you <quote>Edit</quote> an attachment, you can
see any settable flag, along with any flags that have
already been set. This <quote>Edit Attachment</quote>
screen is where you set flags to ?, -, +, or unset them.
</para>
</listitem>
</orderedlist>
</para>
</section>
<section id="flag-type-bug">
<title>Bug Flags</title>
<para>
Bug flags are used to set a status on the bug itself. You can
see Bug Flags in the <quote>Show Bug</quote> screen
(<filename>editbug.cgi</filename>).
</para>
<para>
Only users with the ability to edit the bug may
set flags on bugs. This includes the owner, reporter, and
any user with the <computeroutput>editbugs</computeroutput>
permission.
</para>
</section>
</section>
<section id="flags-admin">
<title>Administering Flags</title>
<para>
If you have the <quote>editcomponents</quote> permission, you will
have <quote>Edit: ... | Flags | ...</quote> in your page footer.
Clicking on that link will bring you to the <quote>Administer
Flag Types</quote> page. Here, you can select whether you want
to create (or edit) a Bug flag, or an Attachment flag.
</para>
<para>
No matter which you choose, the interface is the same, so we'll
just go over it once.
</para>
<section id="flags-create">
<title>Creating a Flag</title>
<para>
When you click on the <quote>Create a Flag Type for...</quote>
link, you will be presented with a form. Here is what the felds in
the form mean:
</para>
<section id="flags-create-field-name">
<title>Name</title>
<para>
This is the name of the flag. This will be displayed
to Bugzilla users who are looking at or setting the flag.
The name may consist of any valid Unicode character.
</para>
</section>
<section id="flags-create-field-description">
<title>Description</title>
<para>
This describes the flag in more detail. At present, this doesn't
whos up anywhere helpful; ideally, it would be nice to have
it show up as a tooltip. This field
can be as long as you like, and can contain any character you want.
</para>
</section>
<section id="flags-create-field-category">
<title>Category</title>
<para>
Default behaviour for a newly-created flag is to appear on
products and all components, which is why <quote>__Any__:__Any__</quote>
is already entered in the <quote>Inclusions</quote> box.
If this is not your desired behaviour, you must either set some
exclusions (for products on which you don't want the flag to appear),
or you must remove <quote>__Any__:__Any__</quote> from the Inclusions box
and define products/components specifically for this flag.
</para>
<para>
To create an Inclusion, select a Product from the top drop-down box.
You may also select a specific component from the bottom drop-down box.
(Setting <quote>__Any__</quote> for Product translates to,
<quote>all the products in this Bugzilla</quote>.
Selecting <quote>__Any__</quote> in the Component field means
<quote>all components in the selected product.</quote>)
Selections made, press <quote>Include</quote>, and your
Product/Component pairing will show up in the <quote>Inclusions</quote> box on the right.
</para>
<para>
To create an Exclusion, the process is the same; select a Product from the
top drop-down box, select a specific component if you want one, and press
<quote>Exclude</quote>. The Product/Component pairing will show up in the
<quote>Exclusions</quote> box on the right.
</para>
<para>
This flag <emphasis>will</emphasis> and <emphasis>can</emphasis> be set for any
products/components that appearing in the <quote>Inclusions</quote> box
(or which fall under the appropriate <quote>__Any__</quote>).
This flag <emphasis>will not</emphasis> appear (and therefore cannot be set) on
any products appearing in the <quote>Exclusions</quote> box.
<emphasis> IMPORTANT: Exclusions override inclusions.</emphasis>
</para>
<para>
You may select a Product without selecting a specific Component,
but it is illegal to select a Component without a Product, or to select a
Component that does not belong to the named Product. Doing so as of
this writing (2.18rc3) will raise an error... even if all your products
have a component by that name.
</para>
<para><emphasis>Example:</emphasis> Let's say you have a product called
<quote>Jet Plane</quote> that has thousands of components. You want
to be able to ask if a problem should be fixed in the next model of
plane you release. We'll call the flag <quote>fixInNext</quote>.
But, there's one component in <quote>Jet Plane,</quote>
called <quote>Pilot.</quote> It doesn't make sense to release a
new pilot, so you don't want to have the flag show up in that component.
So, you include <quote>Jet Plane:__Any__</quote> and you exclude
<quote>Jet Plane:Pilot</quote>.
</para>
</section>
<section id="flags-create-field-sortkey">
<title>Sort Key</title>
<para>
Flags normally show up in alphabetical order. If you want them to
show up in a different order, you can use this key set the order on each flag.
Flags with a lower sort key will appear before flags with a higher
sort key. Flags that have the same sort key will be sorted alphabetically,
but they will still be after flags with a lower sort key, and before flags
with a higher sort key.
</para>
<para>
<emphasis>Example:</emphasis> I have AFlag (Sort Key 100), BFlag (Sort Key 10),
CFlag (Sort Key 10), and DFlag (Sort Key 1). These show up in
the order: DFlag, BFlag, CFlag, AFlag.
</para>
</section>
<section id="flags-create-field-active">
<title>Active</title>
<para>
Sometimes, you might want to keep old flag information in the
Bugzilla database, but stop users from setting any new flags of this type.
To do this, uncheck <quote>active</quote>. Deactivated
flags will still show up in the UI if they are ?, +, or -, but they
may only be cleared (unset), and cannot be changed to a new value.
Once a deactivated flag is cleared, it will completely disappear from a
bug/attachment, and cannot be set again.
</para>
</section>
<section id="flags-create-field-requestable">
<title>Requestable</title>
<para>
New flags are, by default, <quote>requestable</quote>, meaning that they
offer users the <quote>?</quote> option, as well as <quote>+</quote>
and <quote>-</quote>.
To remove the ? option, uncheck <quote>requestable</quote>.
</para>
</section>
<section id="flags-create-field-cclist">
<title>CC List</title>
<para>
If you want certain users to be notified every time this flag is
set to ?, -, +, or unset, add them here. This is a comma-separated
list of email addresses that need not be restricted to Bugzilla usernames..
</para>
</section>
<section id="flags-create-field-specific">
<title>Specifically Requestable</title>
<para>
By default this box is checked for new flags, meaning that users may make
flag requests of specific individuals. Unchecking this box will remove the
text box next to a flag; if it is still requestable, then requests may
only be made <quote>to the wind.</quote> Removing this after specific
requests have been made will not remove those requests; that data will
stay in the database (though it will no longer appear to the user).
</para>
</section>
<section id="flags-create-field-multiplicable">
<title>Multiplicable</title>
<para>
Any flag with <quote>Multiplicable</quote> set (default for new flags is 'on')
may be set more than once. After being set once, an unset flag
of the same type will appear below it with <quote>addl.</quote> (short for
<quote>additional</quote>) before the name. There is no limit to the number of
times a Multiplicable flags may be set on the same bug/attachment.
</para>
</section>
</section> <!-- flags-create -->
<section id="flags-delete">
<title>Deleting a Flag</title>
<para>
When you are at the <quote>Administer Flag Types</quote> screen,
you will be presented with a list of Bug flags and a list of Attachment
Flags.
</para>
<para>
To delete a flag, click on the <quote>Delete</quote> link next to
the flag description.
</para>
<warning>
<para>
Once you delete a flag, it is <emphasis>gone</emphasis> from
your Bugzilla. All the data for that flag will be deleted.
Everywhere that flag was set, it will disappear,
and you cannot get that data back. If you want to keep flag data,
but don't want anybody to set any new flags or change current flags,
unset <quote>active</quote> in the flag Edit form.
</para>
</warning>
</section>
<section id="flags-edit">
<title>Editing a Flag</title>
<para>
To edit a flag's properties, just click on the <quote>Edit</quote>
link next to the flag's description. That will take you to the same
form described in the <quote>Creating a Flag</quote> section.
</para>
</section>
</section> <!-- flags-admin -->
<!-- XXX We should add a "Uses of Flags" section, here, with examples. -->
</section> <!-- flags -->
<section id="voting">
<title>Voting</title>
<para>Voting allows users to be given a pot of votes which they can allocate
to bugs, to indicate that they'd like them fixed.
This allows developers to gauge
user need for a particular enhancement or bugfix. By allowing bugs with
a certain number of votes to automatically move from "UNCONFIRMED" to
"NEW", users of the bug system can help high-priority bugs garner
attention so they don't sit for a long time awaiting triage.</para>
<para>To modify Voting settings:</para>
<orderedlist>
<listitem>
<para>Navigate to the "Edit product" screen for the Product you
wish to modify</para>
</listitem>
<listitem>
<para><emphasis>Maximum Votes per person</emphasis>:
Setting this field to "0" disables voting.</para>
</listitem>
<listitem>
<para><emphasis>Maximum Votes a person can put on a single
bug</emphasis>:
It should probably be some number lower than the
"Maximum votes per person". Don't set this field to "0" if
"Maximum votes per person" is non-zero; that doesn't make
any sense.</para>
</listitem>
<listitem>
<para><emphasis>Number of votes a bug in this product needs to
automatically get out of the UNCONFIRMED state</emphasis>:
Setting this field to "0" disables the automatic move of
bugs from UNCONFIRMED to NEW.
</para>
</listitem>
<listitem>
<para>Once you have adjusted the values to your preference, click
"Update".</para>
</listitem>
</orderedlist>
</section>
<section id="quips">
<title>Quips</title>
<para>
Quips are small text messages that can be configured to appear
next to search results. A Bugzilla installation can have its own specific
quips. Whenever a quip needs to be displayed, a random selection
is made from the pool of already existing quips.
</para>
<para>
Quips are controlled by the <emphasis>enablequips</emphasis> parameter.
It has several possible values: on, approved, frozen or off.
In order to enable quips approval you need to set this parameter
to "approved". In this way, users are free to submit quips for
addition but an administrator must explicitly approve them before
they are actually used.
</para>
<para>
In order to see the user interface for the quips, it is enough to click
on a quip when it is displayed together with the search results. Or
it can be seen directly in the browser by visiting the quips.cgi URL
(prefixed with the usual web location of the Bugzilla installation).
Once the quip interface is displayed, it is enough to click the
"view and edit the whole quip list" in order to see the administration
page. A page with all the quips available in the database will
be displayed.
</para>
<para>
Next to each tip there is a checkbox, under the
"Approved" column. Quips who have this checkbox checked are
already approved and will appear next to the search results.
The ones that have it unchecked are still preserved in the
database but they will not appear on search results pages.
User submitted quips have initially the checkbox unchecked.
</para>
<para>
Also, there is a delete link next to each quip,
which can be used in order to permanently delete a quip.
</para>
</section>
<section id="groups">
<title>Groups and Group Security</title>
<para>Groups allow the administrator
to isolate bugs or products that should only be seen by certain people.
The association between products and groups is controlled from
the product edit page under <quote>Edit Group Controls.</quote>
</para>
<para>
If the makeproductgroups param is on, a new group will be automatically
created for every new product. It is primarily available for backward
compatibility with older sites.
</para>
<para>
Note that group permissions are such that you need to be a member
of <emphasis>all</emphasis> the groups a bug is in, for whatever
reason, to see that bug. Similarly, you must be a member
of <emphasis>all</emphasis> of the entry groups for a product
to add bugs to a product and you must be a member
of <emphasis>all</emphasis> of the canedit groups for a product
in order to make <emphasis>any</emphasis> change to bugs in that
product.
</para>
<note>
<para>
By default, bugs can also be seen by the Assignee, the Reporter, and
by everyone on the CC List, regardless of whether or not the bug would
typically be viewable by them. Visibility to the Reporter and CC List can
be overridden (on a per-bug basis) by bringing up the bug, finding the
section that starts with <quote>Users in the roles selected below...</quote>
and un-checking the box next to either 'Reporter' or 'CC List' (or both).
</para>
</note>
<section>
<title>Creating Groups</title>
<para>To create Groups:</para>
<orderedlist>
<listitem>
<para>Select the <quote>groups</quote>
link in the footer.</para>
</listitem>
<listitem>
<para>Take a moment to understand the instructions on the <quote>Edit
Groups</quote> screen, then select the <quote>Add Group</quote> link.</para>
</listitem>
<listitem>
<para>Fill out the <quote>Group</quote>, <quote>Description</quote>,
and <quote>User RegExp</quote> fields.
<quote>User RegExp</quote> allows you to automatically
place all users who fulfill the Regular Expression into the new group.
When you have finished, click <quote>Add</quote>.</para>
<para>Users whose email addresses match the regular expression
will automatically be members of the group as long as their
email addresses continue to match the regular expression.</para>
<note>
<para>This is a change from 2.16 where the regular expression
resulted in a user acquiring permanent membership in a group.
To remove a user from a group the user was in due to a regular
expression in version 2.16 or earlier, the user must be explicitly
removed from the group.</para>
</note>
<warning>
<para>If specifying a domain in the regexp, make sure you end
the regexp with a $. Otherwise, when granting access to
"@mycompany\.com", you will allow access to
'badperson@mycompany.com.cracker.net'. You need to use
'@mycompany\.com$' as the regexp.</para>
</warning>
</listitem>
<listitem>
<para>If you plan to use this group to directly control
access to bugs, check the "use for bugs" box. Groups
not used for bugs are still useful because other groups
can include the group as a whole.</para>
</listitem>
<listitem>
<para>After you add your new group, edit the new group. On the
edit page, you can specify other groups that should be included
in this group and which groups should be permitted to add and delete
users from this group.</para>
</listitem>
</orderedlist>
</section>
<section>
<title>Assigning Users to Groups</title>
<para>Users can become a member of a group in several ways.</para>
<orderedlist>
<listitem>
<para>The user can be explicitly placed in the group by editing
the user's own profile</para>
</listitem>
<listitem>
<para>The group can include another group of which the user is
a member.</para>
</listitem>
<listitem>
<para>The user's email address can match a regular expression
that the group specifies to automatically grant membership to
the group.</para>
</listitem>
</orderedlist>
</section>
<section>
<title>Assigning Group Controls to Products</title>
<para>
On the product edit page, there is a page to edit the
<quote>Group Controls</quote>
for a product. This allows you to
configure how a group relates to the product.
Groups may be applicable, default,
and mandatory as well as used to control entry
or used to make bugs in the product
totally read-only unless the group restrictions are met.
</para>
<para>
For each group, it is possible to specify if membership in that
group is...
</para>
<orderedlist>
<listitem>
<para>
required for bug entry,
</para>
</listitem>
<listitem>
<para>
Not applicable to this product(NA),
a possible restriction for a member of the
group to place on a bug in this product(Shown),
a default restriction for a member of the
group to place on a bug in this product(Default),
or a mandatory restriction to be placed on bugs
in this product(Mandatory).
</para>
</listitem>
<listitem>
<para>
Not applicable by non-members to this product(NA),
a possible restriction for a non-member of the
group to place on a bug in this product(Shown),
a default restriction for a non-member of the
group to place on a bug in this product(Default),
or a mandatory restriction to be placed on bugs
in this product when entered by a non-member(Mandatory).
</para>
</listitem>
<listitem>
<para>
required in order to make <emphasis>any</emphasis> change
to bugs in this product <emphasis>including comments.</emphasis>
</para>
</listitem>
</orderedlist>
<para>These controls are often described in this order, so a
product that requires a user to be a member of group "foo"
to enter a bug and then requires that the bug stay resticted
to group "foo" at all times and that only members of group "foo"
can edit the bug even if they otherwise could see the bug would
have its controls summarized by...</para>
<programlisting>
foo: ENTRY, MANDATORY/MANDATORY, CANEDIT
</programlisting>
</section>
<section>
<title>Common Applications of Group Controls</title>
<section>
<title>General User Access With Security Group</title>
<para>To permit any user to file bugs in each product (A, B, C...)
and to permit any user to submit those bugs into a security
group....</para>
<programlisting>
Product A...
security: SHOWN/SHOWN
Product B...
security: SHOWN/SHOWN
Product C...
security: SHOWN/SHOWN
</programlisting>
</section>
<section>
<title>General User Access With A Security Product</title>
<para>To permit any user to file bugs in a Security product
while keeping those bugs from becoming visible to anyone
outside the securityworkers group unless a member of the
securityworkers group removes that restriction....</para>
<programlisting>
Product Security...
securityworkers: DEFAULT/MANDATORY
</programlisting>
</section>
<section>
<title>Product Isolation With Common Group</title>
<para>To permit users of product A to access the bugs for
product A, users of product B to access product B, and support
staff to access both, 3 groups are needed</para>
<orderedlist>
<listitem>
<para>Support: Contains members of the support staff.</para>
</listitem>
<listitem>
<para>AccessA: Contains users of product A and the Support group.</para>
</listitem>
<listitem>
<para>AccessB: Contains users of product B and the Support group.</para>
</listitem>
</orderedlist>
<para>Once these 3 groups are defined, the products group controls
can be set to..</para>
<programlisting>
Product A...
AccessA: ENTRY, MANDATORY/MANDATORY
Product B...
AccessB: ENTRY, MANDATORY/MANDATORY
</programlisting>
<para>Optionally, the support group could be permitted to make
bugs inaccessible to the users and could be permitted to publish
bugs relevant to all users in a common product that is read-only
to anyone outside the support group. That configuration could
be...</para>
<programlisting>
Product A...
AccessA: ENTRY, MANDATORY/MANDATORY
Support: SHOWN/NA
Product B...
AccessB: ENTRY, MANDATORY/MANDATORY
Support: SHOWN/NA
Product Common...
Support: ENTRY, DEFAULT/MANDATORY, CANEDIT
</programlisting>
</section>
</section>
</section>
<section id="upgrading">
<title>Upgrading to New Releases</title>
<warning>
<para>Upgrading is a one-way process. You should backup your database
and current Bugzilla directory before attempting the upgrade. If you wish
to revert to the old Bugzilla version for any reason, you will have to
restore from these backups.
</para>
</warning>
<para>Upgrading Bugzilla is something we all want to do from time to time,
be it to get new features or pick up the latest security fix. How easy
it is to update depends on a few factors.
</para>
<itemizedlist>
<listitem>
<para>If the new version is a revision or a new point release</para>
</listitem>
<listitem>
<para>How many, if any, local changes have been made</para>
</listitem>
</itemizedlist>
<para>There are also three different methods to upgrade your installation.
</para>
<orderedlist>
<listitem>
<para>Using CVS (<xref linkend="upgrade-cvs"/>)</para>
</listitem>
<listitem>
<para>Downloading a new tarball (<xref linkend="upgrade-tarball"/>)</para>
</listitem>
<listitem>
<para>Applying the relevant patches (<xref linkend="upgrade-patches"/>)</para>
</listitem>
</orderedlist>
<para>Which options are available to you may depend on how large a jump
you are making and/or your network configuration.
</para>
<para>Revisions are normally released to fix security vulnerabilities
and are distinguished by an increase in the third number. For example,
when 2.16.6 was released, it was a revision to 2.16.5.
</para>
<para>Point releases are normally released when the Bugzilla team feels
that there has been a significant amount of progress made between the
last point release and the current time. These are often proceeded by a
stabilization period and release candidates, however the use of
development versions or release candidates is beyond the scope of this
document. Point releases can be distinguished by an increase in the
second number, or minor version. For example, 2.18.0 is a newer point
release than 2.16.5.
</para>
<para>The examples in this section are written as if you were updating
to version 2.18.1. The procedures are the same regardless if you are
updating to a new point release or a new revision. However, the chance
of running into trouble increases when upgrading to a new point release,
escpecially if you've made local changes.
</para>
<para>These examples also assume that your Bugzilla installation is at
<filename>/var/www/html/bugzilla</filename>. If that is not the case,
simply substitute the proper paths where appropriate.
</para>
<example id="upgrade-cvs">
<title>Upgrading using CVS</title>
<para>Every release of Bugzilla, whether it is a revision or a point
release, is tagged in CVS. Also, every tarball we have distributed
since version 2.12 has been primed for using CVS. This does, however,
require that you are able to access cvs-mirror.mozilla.org on port
2401.
<tip>
<para>If you can do this, updating using CVS is probably the most
painless method, especially if you have a lot of local changes.
</para>
</tip>
</para>
<programlisting>
bash$ <command>cd /var/www/html/bugzilla</command>
bash$ <command>cvs login</command>
Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot
CVS password: <command>anonymous</command>
bash$ <command>cvs -q update -r BUGZILLA-2_18_1 -dP</command>
P checksetup.pl
P collectstats.pl
P globals.pl
P docs/rel_notes.txt
P template/en/default/list/quips.html.tmpl
</programlisting>
<para>
<caution>
<para>If a line in the output from <command>cvs update</command>
begins with a <computeroutput>C</computeroutput> that represents a
file with local changes that CVS was unable to properly merge. You
need to resolve these conflicts manually before Bugzilla (or at
least the portion using that file) will be usable.
</para>
</caution>
<note>
<para>You also need to run <command>./checksetup.pl</command>
before your Bugzilla upgrade will be complete.
</para>
</note>
</para>
</example>
<example id="upgrade-tarball">
<title>Upgrading using the tarball</title>
<para>If you are unable or unwilling to use CVS, another option that's
always available is to download the latest tarball. This is the most
difficult option to use, especially if you have local changes.
</para>
<programlisting>
bash$ <command>cd /var/www/html</command>
bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.1.tar.gz</command>
<emphasis>Output omitted</emphasis>
bash$ <command>tar xzvf bugzilla-2.18.1.tar.gz</command>
bugzilla-2.18.1/
bugzilla-2.18.1/.cvsignore
bugzilla-2.18.1/1x1.gif
<emphasis>Output truncated</emphasis>
bash$ <command>cd bugzilla-2.18.1</command>
bash$ <command>cp ../bugzilla/localconfig* .</command>
bash$ <command>cp -r ../bugzilla/data .</command>
bash$ <command>cd ..</command>
bash$ <command>mv bugzilla bugzilla.old</command>
bash$ <command>mv bugzilla-2.18.1 bugzilla</command>
bash$ <command>cd bugzilla</command>
bash$ <command>./checksetup.pl</command>
<emphasis>Output omitted</emphasis>
</programlisting>
<para>
<warning>
<para>The <command>cp</command> commands both end with periods which
is a very important detail, it tells the shell that the destination
directory is the current working directory. Also, the period at the
beginning of the <command>./checksetup.pl</command> is important and
can not be omitted.
</para>
</warning>
<note>
<para>You will now have to reapply any changes you have made to your
local installation manually.
</para>
</note>
</para>
</example>
<example id="upgrade-patches">
<title>Upgrading using patches</title>
<para>The Bugzilla team will normally make a patch file available for
revisions to go from the most recent revision to the new one. You could
also read the release notes and grab the patches attached to the
mentioned bug, but it is safer to use the released patch file as
sometimes patches get changed before they get checked in.
It is also theoretically possible to
scour the fixed bug list and pick and choose which patches to apply
from a point release, but this is not recommended either as what you'll
end up with is a hodge podge Bugzilla that isn't really any version.
This would also make it more difficult to upgrade in the future.
</para>
<programlisting>
bash$ <command>cd /var/www/html/bugzilla</command>
bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.0-to-2.18.1.diff.gz</command>
<emphasis>Output omitted</emphasis>
bash$ <command>gunzip bugzilla-2.18.0-to-2.18.1.diff.gz</command>
bash$ <command>patch -p1 < bugzilla-2.18.0-to-2.18.1.diff</command>
patching file checksetup.pl
patching file collectstats.pl
patching file globals.pl
</programlisting>
<para>
<caution>
<para>If you do this, beware that this doesn't change the entires in
your <filename id="dir">CVS</filename> directory so it may make
updates using CVS (<xref linkend="upgrade-cvs"/>) more difficult in the
future.
</para>
</caution>
</para>
</example>
</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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
|