~ubuntu-branches/debian/sid/bugzilla/sid

« back to all changes in this revision

Viewing changes to docs/xml/faq.xml

  • Committer: Bazaar Package Importer
  • Author(s): Raphael Bossek
  • Date: 2008-06-27 22:34:34 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20080627223434-0ib57vstn43bb4a3
Tags: 3.0.4.1-1
* Update of French, Russian and German translations. (closes: #488251)
* Added Bulgarian and Belarusian translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
2
 
 
3
 
<appendix id="faq">
4
 
  <title>The Bugzilla FAQ</title>
5
 
 
6
 
  <para>
7
 
    This FAQ includes questions not covered elsewhere in the Guide.
8
 
  </para>
9
 
  
10
 
  <qandaset>
11
 
 
12
 
 
13
 
    <qandadiv id="faq-general">
14
 
      <title>General Questions</title>
15
 
 
16
 
      <qandaentry>
17
 
        <question id="faq-general-tryout">
18
 
          <para>
19
 
            Can I try out Bugzilla somewhere?
20
 
          </para>
21
 
        </question>
22
 
        <answer>
23
 
          <para>
24
 
            If you want to take a test ride, there are test installations
25
 
            at <ulink url="http://landfill.bugzilla.org/"/>,
26
 
            ready to play with directly from your browser.
27
 
          </para>
28
 
        </answer>
29
 
      </qandaentry>
30
 
 
31
 
      <qandaentry>
32
 
        <question id="faq-general-license">
33
 
          <para>
34
 
            What license is Bugzilla distributed under?
35
 
          </para>
36
 
        </question>
37
 
        <answer>
38
 
          <para>
39
 
            Bugzilla is covered by the Mozilla Public License.
40
 
            See details at <ulink url="http://www.mozilla.org/MPL/"/>.
41
 
          </para>
42
 
        </answer>
43
 
      </qandaentry>
44
 
 
45
 
      <qandaentry>
46
 
        <question id="faq-general-support">
47
 
          <para>
48
 
            How do I get commercial support for Bugzilla?
49
 
          </para>
50
 
        </question>
51
 
        <answer>
52
 
          <para>
53
 
            <ulink url="http://www.bugzilla.org/support/consulting.html"/>
54
 
            is a list of companies and individuals who have asked us to
55
 
            list them as consultants for Bugzilla.
56
 
          </para>
57
 
          <para>
58
 
            There are several experienced
59
 
            Bugzilla hackers on the mailing list/newsgroup who are willing
60
 
            to make themselves available for generous compensation.
61
 
            Try sending a message to the mailing list asking for a volunteer.
62
 
          </para>
63
 
        </answer>
64
 
      </qandaentry>
65
 
 
66
 
      <qandaentry>
67
 
        <question id="faq-general-companies">
68
 
          <para>
69
 
            What major companies or projects are currently using Bugzilla
70
 
            for bug-tracking?
71
 
          </para>
72
 
        </question>
73
 
        <answer>
74
 
          <para>
75
 
            There are <emphasis>dozens</emphasis> of major companies with public
76
 
            Bugzilla sites to track bugs in their products. We have a fairly
77
 
            complete list available on our website at
78
 
            <ulink url="http://bugzilla.org/installation-list/"/>. If you
79
 
            have an installation of Bugzilla and would like to be added to the
80
 
            list, whether it's a public install or not, simply e-mail
81
 
            Gerv <email>gerv@mozilla.org</email>.
82
 
          </para>
83
 
        </answer>
84
 
      </qandaentry>
85
 
 
86
 
      <qandaentry>
87
 
        <question id="faq-general-maintainers">
88
 
          <para>
89
 
            Who maintains Bugzilla?
90
 
          </para>
91
 
        </question>
92
 
        <answer>
93
 
          <para>
94
 
            A <ulink url="http://www.bugzilla.org/developers/profiles.html">core
95
 
            team</ulink>, led by Dave Miller (justdave@bugzilla.org).
96
 
          </para>
97
 
        </answer>
98
 
      </qandaentry>
99
 
 
100
 
      <qandaentry>
101
 
        <question id="faq-general-compare">
102
 
          <para>
103
 
            How does Bugzilla stack up against other bug-tracking databases?
104
 
          </para>
105
 
        </question>
106
 
        <answer>
107
 
          <para>
108
 
            We can't find any head-to-head comparisons of Bugzilla against
109
 
            other defect-tracking software. If you know of one, please get
110
 
            in touch. In the experience of Matthew Barnson (the original
111
 
            author of this FAQ), though, Bugzilla offers superior
112
 
            performance on commodity hardware, better price (free!), more
113
 
            developer-friendly features (such as stored queries, email
114
 
            integration, and platform independence), improved scalability,
115
 
            greater flexibility, and superior ease-of-use when compared
116
 
            to commercial bug-tracking software.
117
 
          </para>
118
 
          <para>
119
 
            If you happen to be a vendor for commercial bug-tracking
120
 
            software, and would like to submit a list of advantages your
121
 
            product has over Bugzilla, simply send it to 
122
 
            <email>documentation@bugzilla.org</email> and we'd be happy to
123
 
            include the comparison in our documentation.
124
 
          </para>
125
 
        </answer>
126
 
      </qandaentry>
127
 
 
128
 
      <qandaentry>
129
 
        <question id="faq-general-bzmissing">
130
 
          <para>
131
 
            Why doesn't Bugzilla offer this or that feature or compatibility
132
 
            with this other tracking software?
133
 
          </para>
134
 
        </question>
135
 
        <answer>
136
 
          <para>
137
 
            It may be that the support has not been built yet, or that you
138
 
            have not yet found it. While Bugzilla makes strides in usability,
139
 
            customizability, scalability, and user interface with each release,
140
 
            that doesn't mean it can't still use improvement!
141
 
          </para>
142
 
          <para>
143
 
            The best way to make an enhancement request is to <ulink 
144
 
            url="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">file
145
 
            a bug at bugzilla.mozilla.org</ulink> and set the Severity
146
 
            to 'enhancement'. Your 'request for enhancement' (RFE) will
147
 
            start out in the UNCONFIRMED state, and will stay there until
148
 
            someone with the ability to CONFIRM the bug reviews it.
149
 
            If that person feels it to be a good request that fits in with
150
 
            Bugzilla's overall direction, the status will be changed to
151
 
            NEW; if not, they will probably explain why and set the bug
152
 
            to RESOLVED/WONTFIX. If someone else has made the same (or
153
 
            almost the same) request before, your request will be marked
154
 
            RESOLVED/DUPLICATE, and a pointer to the previous RFE will be
155
 
            added.
156
 
          </para>
157
 
          <para>
158
 
            Even if your RFE gets approved, that doesn't mean it's going
159
 
            to make it right into the next release; there are a limited
160
 
            number of developers, and a whole lot of RFEs... some of
161
 
            which are <emphasis>quite</emphasis> complex. If you're a
162
 
            code-hacking sort of person, you can help the project along
163
 
            by making a patch yourself that supports the functionality
164
 
            you require. If you have never contributed anything to
165
 
            Bugzilla before, please be sure to read the 
166
 
            <ulink url="http://www.bugzilla.org/docs/developer.html">Developers' Guide</ulink>
167
 
            and
168
 
            <ulink url="http://www.bugzilla.org/docs/contributor.html">Contributors' Guide</ulink>
169
 
            before going ahead.
170
 
          </para>
171
 
        </answer>
172
 
      </qandaentry>
173
 
 
174
 
      <qandaentry>
175
 
        <question id="faq-general-db">
176
 
          <para>
177
 
            What databases does Bugzilla run on?
178
 
          </para>
179
 
        </question>
180
 
        <answer>
181
 
          <para>
182
 
            MySQL is the default database for Bugzilla. It was originally chosen 
183
 
            because it is free, easy to install, and was available for the hardware 
184
 
            Netscape intended to run it on.
185
 
          </para>
186
 
          <para>
187
 
            As of Bugzilla 2.22, complete support for PostgreSQL 
188
 
            is included. With this release using PostgreSQL with Bugzilla 
189
 
            should be as stable as using MySQL. If you experience any problems
190
 
            with PostgreSQL compatibility, they will be taken as
191
 
            seriously as if you were running MySQL.
192
 
          </para>
193
 
          <para>
194
 
            There are plans to include an Oracle driver for Bugzilla 3.1.2. 
195
 
            Track progress at
196
 
            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=189947">
197
 
            Bug 189947</ulink>.
198
 
          </para>
199
 
          <para>
200
 
            Sybase support was worked on for a time. However, several 
201
 
            complicating factors have prevented Sybase support from 
202
 
            being realized. There are currently no plans to revive it.
203
 
          </para>
204
 
          <para>
205
 
            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=237862">
206
 
            Bug 237862</ulink> is a good bug to read through if you'd
207
 
            like to see what progress is being made on general database
208
 
            compatibility.
209
 
          </para>
210
 
        </answer>
211
 
      </qandaentry>
212
 
 
213
 
      <qandaentry>
214
 
        <question id="faq-general-perlpath">
215
 
          <para>
216
 
            My perl is located at <filename>/usr/local/bin/perl</filename>
217
 
            and not <filename>/usr/bin/perl</filename>. Is there an easy
218
 
            to change that in all the files that have this hard-coded?
219
 
          </para>
220
 
        </question>
221
 
        <answer>
222
 
          <para>
223
 
            The easiest way to get around this is to create a link from
224
 
            one to the other:
225
 
            <command>ln -s /usr/local/bin/perl /usr/bin/perl</command>.
226
 
            If that's not an option for you, the following bit of perl
227
 
            magic will change all the shebang lines (that is to say,
228
 
            the line at the top of each file that starts with '#!' 
229
 
            and contains the path) to something else:
230
 
          </para>
231
 
          <programlisting>
232
 
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
233
 
          </programlisting>
234
 
          <para>
235
 
            Sadly, this command-line won't work on Windows unless you
236
 
            also have Cygwin. However, MySQL comes with a binary called
237
 
            <command>replace</command> which can do the job:
238
 
          </para>
239
 
          <programlisting>
240
 
C:\mysql\bin\replace "#!/usr/bin/perl" "#!C:\perl\bin\perl" -- *.cgi *.pl
241
 
          </programlisting>
242
 
          <note>
243
 
            <para>
244
 
              If your perl path is something else again, just follow the
245
 
              above examples and replace
246
 
              <filename>/usr/local/bin/perl</filename> with your own perl path.
247
 
            </para>            
248
 
          </note>
249
 
          <para>
250
 
            Once you've modified all your files, you'll also need to modify the
251
 
            <filename>t/002goodperl.t</filename> test, as it tests that all
252
 
            shebang lines are equal to <filename>/usr/bin/perl</filename>.
253
 
            (For more information on the test suite, please check out the 
254
 
            appropriate section in the <ulink
255
 
            url="http://www.bugzilla.org/docs/developer.html#testsuite">Developers'
256
 
            Guide</ulink>.) Having done this, run the test itself:
257
 
            <programlisting>
258
 
            perl runtests.pl 2 --verbose
259
 
            </programlisting>
260
 
            to ensure that you've modified all the relevant files.
261
 
          </para>
262
 
          <para>
263
 
            If using Apache on Windows, you can avoid the whole problem
264
 
            by setting the <ulink
265
 
            url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">
266
 
            ScriptInterpreterSource</ulink> directive to 'Registry'.
267
 
            (If using Apache 2 or higher, set it to 'Registry-Strict'.)
268
 
            ScriptInterperterSource requires a registry entry
269
 
            <quote>HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command</quote> to
270
 
            associate .cgi files with your perl executable. If one does
271
 
            not already exist, create it with a default value of
272
 
           <quote>&lt;full path to perl&gt; -T</quote>, e.g.
273
 
           <quote>C:\Perl\bin\perl.exe -T</quote>.
274
 
          </para>
275
 
        </answer>
276
 
      </qandaentry>
277
 
 
278
 
      <qandaentry>
279
 
        <question id="faq-general-cookie">
280
 
          <para>
281
 
            Is there an easy way to change the Bugzilla cookie name?
282
 
          </para>
283
 
        </question>
284
 
        <answer>
285
 
          <para>
286
 
            At present, no.
287
 
          </para>
288
 
        </answer>
289
 
      </qandaentry>
290
 
 
291
 
      <qandaentry>
292
 
        <question id="faq-general-selinux">
293
 
          <para>
294
 
            How can Bugzilla be made to work under SELinux?
295
 
          </para>
296
 
        </question>
297
 
        <answer>
298
 
          <para>
299
 
            As a web application, Bugzilla simply requires its root
300
 
            directory to have the httpd context applied for it to work
301
 
            properly under SELinux. This should happen automatically
302
 
            on distributions that use SELinux and that package Bugzilla
303
 
            (if it is installed with the native package management tools).
304
 
            Information on how to view and change SELinux file contexts
305
 
            can be found at the 
306
 
            <ulink url="http://docs.fedoraproject.org/selinux-faq-fc5/">
307
 
            SELinux FAQ</ulink>.
308
 
 
309
 
          </para>
310
 
        </answer>
311
 
      </qandaentry>
312
 
 
313
 
    </qandadiv>
314
 
 
315
 
    <qandadiv id="faq-phb">
316
 
      <title>Managerial Questions</title>
317
 
 
318
 
      <qandaentry>
319
 
        <question id="faq-phb-deletebugs">
320
 
          <para>
321
 
            Is it possible to delete bug reports?
322
 
          </para>
323
 
        </question>
324
 
        <answer>
325
 
          <para>
326
 
            Yes. You have to turn on the 'allowbugdeletion' parameter, which is
327
 
            off by default. Note that you cannot delete bug reports one by one.
328
 
            You have to move them in a product or component, e.g. named "Trash",
329
 
            and then delete this product or component. The reason we make it
330
 
            hard is that you generally don't want to do that. 
331
 
          </para>
332
 
        </answer>
333
 
      </qandaentry>
334
 
 
335
 
      <qandaentry>
336
 
        <question id="faq-phb-client">
337
 
          <para>
338
 
            Is Bugzilla web-based, or do you have to have specific software or
339
 
            a specific operating system on your machine?
340
 
          </para>
341
 
        </question>
342
 
        <answer>
343
 
          <para>
344
 
            It is web and e-mail based.
345
 
          </para>
346
 
        </answer>
347
 
      </qandaentry>
348
 
 
349
 
      <qandaentry>
350
 
        <question id="faq-phb-priorities">
351
 
          <para>
352
 
            Does Bugzilla allow us to define our own priorities and levels?
353
 
            Do we have complete freedom to change the labels of fields and
354
 
            format of them, and the choice of acceptable values?
355
 
          </para>
356
 
        </question>
357
 
        <answer>
358
 
          <para>
359
 
            Yes. However, modifying some fields, notably those related to bug
360
 
            progression states, also require adjusting the program logic to
361
 
            compensate for the change.
362
 
          </para>
363
 
          <para>
364
 
            As of Bugzilla 3.0 custom fields can be created via the
365
 
            "Custom Fields" admin page.
366
 
          </para>
367
 
        </answer>
368
 
      </qandaentry>
369
 
 
370
 
      <qandaentry>
371
 
        <question id="faq-phb-reporting">
372
 
          <para>
373
 
            Does Bugzilla provide any reporting features, metrics, graphs,
374
 
            etc? You know, the type of stuff that management likes to see. :)
375
 
          </para>
376
 
        </question>
377
 
        <answer>
378
 
          <para>
379
 
            Yes. Look at <ulink url="https://bugzilla.mozilla.org/report.cgi"/>
380
 
            for samples of what Bugzilla can do in reporting and graphing.
381
 
            Fuller documentation is provided in <xref linkend="reporting"/>.
382
 
          </para>
383
 
          <para>
384
 
            If you can not get the reports you want from the included reporting
385
 
            scripts, it is possible to hook up a professional reporting package
386
 
            such as Crystal Reports using ODBC. If you choose to do this,
387
 
            beware that giving direct access to the database does contain some
388
 
            security implications. Even if you give read-only access to the
389
 
            bugs database it will bypass the secure bugs features of Bugzilla.
390
 
          </para>
391
 
        </answer>
392
 
      </qandaentry>
393
 
 
394
 
      <qandaentry>
395
 
        <question id="faq-phb-email">
396
 
          <para>
397
 
            Is there email notification? If so, what do you see
398
 
            when you get an email?
399
 
          </para>
400
 
        </question>
401
 
        <answer>
402
 
          <para>
403
 
            Email notification is user-configurable. By default, the bug id
404
 
            and summary of the bug report accompany each email notification,
405
 
            along with a list of the changes made.
406
 
          </para>
407
 
        </answer>
408
 
      </qandaentry>
409
 
 
410
 
      <qandaentry>
411
 
        <question id="faq-phb-emailapp">
412
 
          <para>
413
 
            Do users have to have any particular type of email application?
414
 
          </para>
415
 
        </question>
416
 
        <answer>
417
 
          <para>
418
 
            Bugzilla email is sent in plain text, the most compatible
419
 
            mail format on the planet.
420
 
            <note>
421
 
              <para>
422
 
                If you decide to use the bugzilla_email integration features
423
 
                to allow Bugzilla to record responses to mail with the
424
 
                associated bug, you may need to caution your users to set
425
 
                their mailer to <quote>respond to messages in the format in
426
 
                which they were sent</quote>. For security reasons Bugzilla
427
 
                ignores HTML tags in comments, and if a user sends HTML-based
428
 
                email into Bugzilla the resulting comment looks downright awful.
429
 
              </para>
430
 
            </note>
431
 
          </para>
432
 
        </answer>
433
 
      </qandaentry>
434
 
 
435
 
      <qandaentry>
436
 
        <question id="faq-phb-data">
437
 
          <para>
438
 
            Does Bugzilla allow data to be imported and exported? If I had
439
 
            outsiders write up a bug report using a MS Word bug template,
440
 
            could that template be imported into <quote>matching</quote>
441
 
            fields? If I wanted to take the results of a query and export
442
 
            that data to MS Excel, could I do that?
443
 
          </para>
444
 
        </question>
445
 
        <answer>
446
 
          <para>
447
 
            Bugzilla can output buglists as HTML (the default), CSV or RDF.
448
 
            The link for CSV can be found at the bottom of the buglist in HTML
449
 
            format. This CSV format can easily be imported into MS Excel or
450
 
            other spreadsheet applications.
451
 
          </para>
452
 
          <para>
453
 
            To use the RDF format of the buglist it is necessary to append a
454
 
            <computeroutput>&amp;ctype=rdf</computeroutput> to the URL. RDF
455
 
            is meant to be machine readable and thus it is assumed that the
456
 
            URL would be generated programmatically so there is no user visible
457
 
            link to this format.
458
 
          </para>
459
 
          <para>
460
 
            Currently the only script included with Bugzilla that can import
461
 
            data is <filename>importxml.pl</filename> which is intended to be
462
 
            used for importing the data generated by the XML ctype of
463
 
            <filename>show_bug.cgi</filename> in association with bug moving.
464
 
            Any other use is left as an exercise for the user.
465
 
          </para>
466
 
          <para>
467
 
            There are also scripts included in the <filename>contrib/</filename>
468
 
            directory for using e-mail to import information into Bugzilla,
469
 
            but these scripts are not currently supported and included for
470
 
            educational purposes.
471
 
          </para>
472
 
        </answer>
473
 
      </qandaentry>
474
 
 
475
 
      <qandaentry>
476
 
        <question id="faq-phb-l10n">
477
 
          <para>
478
 
            Has anyone converted Bugzilla to another language to be
479
 
            used in other countries? Is it localizable?
480
 
          </para>
481
 
        </question>
482
 
        <answer>
483
 
          <para>
484
 
            Yes. For more information including available translated templates,
485
 
            see <ulink
486
 
            url="http://www.bugzilla.org/download.html#localizations"/>.
487
 
            Some admin interfaces have been templatized (for easy localization)
488
 
            but many of them are still available in English only. Also, there
489
 
            may be issues with the charset not being declared. See <ulink
490
 
            url="https://bugzilla.mozilla.org/show_bug.cgi?id=126266">bug 126226</ulink>
491
 
            for more information.
492
 
          </para>
493
 
        </answer>
494
 
      </qandaentry>
495
 
 
496
 
      <qandaentry>
497
 
        <question id="faq-phb-reports">
498
 
          <para>
499
 
            Can a user create and save reports?
500
 
            Can they do this in Word format? Excel format?
501
 
          </para>
502
 
        </question>
503
 
        <answer>
504
 
          <para>
505
 
            Yes. No. Yes (using the CSV format).
506
 
          </para>
507
 
        </answer>
508
 
      </qandaentry>
509
 
 
510
 
      <qandaentry>
511
 
        <question id="faq-phb-backup">
512
 
          <para>
513
 
            Are there any backup features provided?
514
 
          </para>
515
 
        </question>
516
 
        <answer>
517
 
          <para>
518
 
            You should use the backup options supplied by your database platform.  
519
 
            Vendor documentation for backing up a MySQL database can be found at 
520
 
            <ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>. 
521
 
            PostgreSQL backup documentation can be found at
522
 
            <ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
523
 
          </para>
524
 
        </answer>
525
 
      </qandaentry>
526
 
 
527
 
      <qandaentry>
528
 
        <question id="faq-phb-maintenance">
529
 
          <para>
530
 
            What type of human resources are needed to be on staff to install
531
 
            and maintain Bugzilla? Specifically, what type of skills does the
532
 
            person need to have? I need to find out what types of individuals
533
 
            would we need to hire and how much would that cost if we were to
534
 
            go with Bugzilla vs. buying an <quote>out-of-the-box</quote>
535
 
            solution.
536
 
          </para>
537
 
        </question>
538
 
        <answer>
539
 
          <para>
540
 
            If Bugzilla is set up correctly from the start, continuing
541
 
            maintenance needs are minimal and can be done easily using
542
 
            the web interface.
543
 
          </para>
544
 
          <para>
545
 
            Commercial Bug-tracking software typically costs somewhere
546
 
            upwards of $20,000 or more for 5-10 floating licenses. Bugzilla
547
 
            consultation is available from skilled members of the newsgroup.
548
 
            Simple questions are answered there and then.
549
 
          </para>
550
 
        </answer>
551
 
      </qandaentry>
552
 
 
553
 
      <qandaentry>
554
 
        <question id="faq-phb-installtime">
555
 
          <para>
556
 
            What time frame are we looking at if we decide to hire people
557
 
            to install and maintain the Bugzilla? Is this something that
558
 
            takes hours or days to install and a couple of hours per week
559
 
            to maintain and customize, or is this a multi-week install process,
560
 
            plus a full time job for 1 person, 2 people, etc?
561
 
          </para>
562
 
        </question>
563
 
        <answer>
564
 
          <para>
565
 
            It all depends on your level of commitment. Someone with much
566
 
            Bugzilla experience can get you up and running in less than a day,
567
 
            and your Bugzilla install can run untended for years. If your
568
 
            Bugzilla strategy is critical to your business workflow, hire
569
 
            somebody to who has reasonable Perl skills, and a familiarity
570
 
            with the operating system on which Bugzilla will be running,
571
 
            and have them handle your process management, bug-tracking
572
 
            maintenance, and local customization.
573
 
          </para>
574
 
        </answer>
575
 
      </qandaentry>
576
 
 
577
 
      <qandaentry>
578
 
        <question id="faq-phb-cost">
579
 
          <para>
580
 
            Is there any licensing fee or other fees for using Bugzilla? Any
581
 
            out-of-pocket cost other than the bodies needed as identified above?
582
 
          </para>
583
 
        </question>
584
 
        <answer>
585
 
          <para>
586
 
            No. Bugzilla, Perl, the Template Toolkit, and all other support
587
 
            software needed to make Bugzilla work can be downloaded for free.
588
 
            MySQL and PostgreSQL -- the databases supported by Bugzilla -- 
589
 
            are also open-source. MySQL asks that if you find their product 
590
 
            valuable, you purchase a support contract from them that suits your needs.
591
 
          </para>
592
 
        </answer>
593
 
      </qandaentry>
594
 
 
595
 
      <qandaentry>
596
 
        <question id="faq-phb-renameBugs">
597
 
          <para>
598
 
            We don't like referring to problems as 'bugs'. Can we change that?
599
 
          </para>
600
 
        </question>
601
 
        <answer>
602
 
          <para>
603
 
            Yes! As of Bugzilla 2.18, it is a simple matter to change the
604
 
            word 'bug' into whatever word/phrase is used by your organization.
605
 
            See the documentation on Customization for more details,
606
 
            specifically <xref linkend="template-specific"/>.
607
 
          </para>
608
 
        </answer>
609
 
      </qandaentry>
610
 
 
611
 
    </qandadiv>
612
 
 
613
 
    <qandadiv id="faq-admin">
614
 
      <title>Administrative Questions</title>
615
 
 
616
 
      <qandaentry>
617
 
        <question id="faq-admin-midair">
618
 
          <para>
619
 
            Does Bugzilla provide record locking when there is simultaneous
620
 
            access to the same bug? Does the second person get a notice
621
 
            that the bug is in use or how are they notified?
622
 
          </para>
623
 
        </question>
624
 
        <answer>
625
 
          <para>
626
 
            Bugzilla does not lock records. It provides mid-air collision
627
 
            detection -- which means that it warns a user when a commit is
628
 
            about to conflict with commits recently made by another user,
629
 
            and offers the second user a choice of options to deal with
630
 
            the conflict.
631
 
          </para>
632
 
        </answer>
633
 
      </qandaentry>
634
 
 
635
 
      <qandaentry>
636
 
        <question id="faq-admin-livebackup">
637
 
          <para>
638
 
            Can users be on the system while a backup is in progress?
639
 
          </para>
640
 
        </question>
641
 
        <answer>
642
 
          <para>
643
 
            Refer to your database platform documentation for details on how to do hot
644
 
            backups.  
645
 
            Vendor documentation for backing up a MySQL database can be found at 
646
 
            <ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>. 
647
 
            PostgreSQL backup documentation can be found at
648
 
            <ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
649
 
          </para>
650
 
        </answer>
651
 
      </qandaentry>
652
 
 
653
 
      <qandaentry>
654
 
        <question id="faq-admin-cvsupdate">
655
 
          <para>
656
 
            How can I update the code and the database using CVS?
657
 
          </para>
658
 
        </question>
659
 
        <answer>
660
 
          <para>
661
 
            <orderedlist>
662
 
              <listitem>
663
 
                <para>
664
 
                  Make a backup of both your Bugzilla directory and the
665
 
                  database. For the Bugzilla directory this is as easy as
666
 
                  doing <command>cp -rp bugzilla bugzilla.bak</command>.
667
 
                  For the database, there's a number of options - see the
668
 
                  MySQL docs and pick the one that fits you best (the easiest
669
 
                  is to just make a physical copy of the database on the disk,
670
 
                  but you have to have the database server shut down to do
671
 
                  that without risking dataloss).
672
 
                </para>
673
 
              </listitem>
674
 
 
675
 
              <listitem>
676
 
                <para>
677
 
                  Make the Bugzilla directory your current directory.
678
 
                </para>
679
 
              </listitem>
680
 
 
681
 
              <listitem>
682
 
                <para>
683
 
                  Use <command>cvs -q update -AdP</command> if you want to
684
 
                  update to the tip or
685
 
                  <command>cvs -q update -dP -rTAGNAME</command>
686
 
                  if you want a specific version (in that case you'll have to
687
 
                  replace TAGNAME with a CVS tag name such as BUGZILLA-2_16_5).
688
 
                </para>
689
 
 
690
 
                <para>
691
 
                  If you've made no local changes, this should be very clean.
692
 
                  If you have made local changes, then watch the cvs output
693
 
                  for C results. If you get any lines that start with a C
694
 
                  it means there  were conflicts between your local changes
695
 
                  and what's in CVS. You'll need to fix those manually before
696
 
                  continuing.
697
 
                </para>
698
 
              </listitem>
699
 
 
700
 
              <listitem>
701
 
                <para>
702
 
                  After resolving any conflicts that the cvs update operation
703
 
                  generated, running <command>./checksetup.pl</command> will
704
 
                  take care of updating the database for you as well as any
705
 
                  other changes required for the new version to operate.
706
 
                </para>
707
 
 
708
 
                <warning>
709
 
                  <para>
710
 
                    Once you run checksetup.pl, the only way to go back is
711
 
                    to restore the database backups. You can't
712
 
                    <quote>downgrade</quote> the system cleanly under most
713
 
                    circumstances.
714
 
                  </para>
715
 
                </warning>
716
 
              </listitem>
717
 
            </orderedlist>
718
 
          </para>
719
 
          <para>
720
 
            See also the instructions in <xref linkend="upgrade-cvs"/>.
721
 
          </para>
722
 
        </answer>
723
 
      </qandaentry>
724
 
 
725
 
      <qandaentry>
726
 
        <question id="faq-admin-enable-unconfirmed">
727
 
          <para>
728
 
            How do I make it so that bugs can have an UNCONFIRMED status?
729
 
          </para>
730
 
        </question>
731
 
        <answer>
732
 
          <para>
733
 
            To use the UNCONFIRMED status, you must have the 'usevotes'
734
 
            parameter set to <quote>On</quote>. You must then visit the
735
 
            <filename>editproducts.cgi</filename> page and set the <quote>
736
 
            Number of votes a bug in this product needs to automatically
737
 
            get out of the UNCONFIRMED state</quote> to be a non-zero number.
738
 
            (You will have to do this for each product that wants to use
739
 
            the UNCONFIRMED state.) If you do not actually want users to be
740
 
            able to vote for bugs entered against this product, leave the
741
 
            <quote>Maximum votes per person</quote> value at '0'.
742
 
          </para>            
743
 
          <para>
744
 
            There is work being done to decouple the UNCONFIRMED state from
745
 
            the 'usevotes' parameter for future versions of Bugzilla.
746
 
            Follow the discussion and progress at <ulink 
747
 
            url="https://bugzilla.mozilla.org/show_bug.cgi?id=162060">bug
748
 
            162060</ulink>.
749
 
          </para>
750
 
        </answer>
751
 
      </qandaentry>
752
 
 
753
 
      <qandaentry>
754
 
        <question id="faq-admin-moving">
755
 
          <para>
756
 
            How do I move a Bugzilla installation from one machine to another?
757
 
          </para>
758
 
        </question>
759
 
 
760
 
        <answer>
761
 
          <para>
762
 
            Reference your database vendor's documentation for information on 
763
 
            backing up and restoring your Bugzilla database on to a different server.
764
 
            Vendor documentation for backing up a MySQL database can be found at 
765
 
            <ulink url="http://dev.mysql.com/doc/mysql/en/mysqldump.html"/>.
766
 
            PostgreSQL backup documentation can be found at
767
 
            <ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
768
 
          </para>
769
 
 
770
 
          <para>
771
 
            On your new machine, follow the instructions found in <xref 
772
 
            linkend="installing-bugzilla"/> as far as setting up the physical
773
 
            environment of the new machine with perl, webserver, modules, etc. 
774
 
            Having done that, you can either: copy your entire Bugzilla
775
 
            directory from the old machine to a new one (if you want to keep
776
 
            your existing code and modifications), or download a newer version
777
 
            (if you are planning to upgrade at the same time). Even if you are
778
 
            upgrading to clean code, you will still want to bring over the 
779
 
            <filename>localconfig</filename> file, and the 
780
 
            <filename class="directory">data</filename> directory from the
781
 
            old machine, as they contain configuration information that you 
782
 
            probably won't want to re-create.
783
 
          </para>
784
 
 
785
 
          <note>
786
 
            <para>
787
 
              If the hostname or port number of your database server changed
788
 
              as part of the move, you'll need to update the appropriate
789
 
              variables in localconfig before taking the next step.
790
 
            </para>
791
 
          </note>
792
 
 
793
 
          <para>
794
 
            Once you have your code in place, and your database has
795
 
            been restored from the backup you made in step 1, run
796
 
            <command>checksetup.pl</command>. This will upgrade your
797
 
            database (if necessary), rebuild your templates, etc.
798
 
          </para>
799
 
        </answer>
800
 
      </qandaentry>
801
 
 
802
 
      <qandaentry>
803
 
        <question id="faq-admin-makeadmin">
804
 
          <para>
805
 
            How do I make a new Bugzilla administrator?
806
 
            The previous administrator is gone...
807
 
          </para>
808
 
        </question>
809
 
        <answer>
810
 
          <para>
811
 
            Run <command>checksetup.pl</command> with
812
 
            <option>--make-admin</option> option.
813
 
            Its usage is <option>--make-admin=user@example.org</option>.
814
 
            The user account must be exist in the Bugzilla database.
815
 
          </para>
816
 
        </answer>
817
 
      </qandaentry>
818
 
 
819
 
    </qandadiv>
820
 
 
821
 
    <qandadiv id="faq-security">
822
 
      <title>Bugzilla Security</title>
823
 
      <qandaentry>
824
 
        <question id="faq-security-mysql">
825
 
          <para>
826
 
            How do I completely disable MySQL security if it's giving
827
 
            me problems? (I've followed the instructions in the installation
828
 
            section of this guide...)
829
 
          </para>
830
 
        </question>
831
 
 
832
 
        <answer>
833
 
          <para>
834
 
            You can run MySQL like this: <command>mysqld --skip-grant-tables</command>.
835
 
            However, doing so disables all MySQL security. This is a bad idea.
836
 
            Please consult <xref linkend="security-mysql"/> of this guide
837
 
            and the MySQL documentation for better solutions.
838
 
            </para>
839
 
        </answer>
840
 
      </qandaentry>
841
 
      
842
 
      <qandaentry>
843
 
        <question id="faq-security-knownproblems">
844
 
          <para>
845
 
            Are there any security problems with Bugzilla?
846
 
          </para>
847
 
        </question>
848
 
        <answer>
849
 
          <para>
850
 
            The Bugzilla code has undergone a reasonably complete security
851
 
            audit, and user-facing CGIs run under Perl's taint mode. However, 
852
 
            it is recommended that you closely examine permissions on your
853
 
            Bugzilla installation, and follow the recommended security
854
 
            guidelines found in The Bugzilla Guide.
855
 
          </para>
856
 
        </answer>
857
 
      </qandaentry>
858
 
    </qandadiv>
859
 
 
860
 
    <qandadiv id="faq-email">
861
 
      <title>Bugzilla Email</title>
862
 
 
863
 
      <qandaentry>
864
 
        <question id="faq-email-nomail">
865
 
          <para>
866
 
            I have a user who doesn't want to receive any more email
867
 
            from Bugzilla. How do I stop it entirely for this user?
868
 
          </para>
869
 
        </question>
870
 
        <answer>
871
 
          <para>
872
 
            The user can stop Bugzilla from sending any mail by unchecking
873
 
            all boxes on the 'Edit prefs' -> 'Email settings' page.
874
 
            (As of 2.18,this is made easier by the addition of a 'Disable
875
 
            All Mail' button.) Alternately, you can add their email address
876
 
            to the <filename>data/nomail</filename> file (one email address
877
 
            per line). This will override their personal preferences, and
878
 
            they will never be sent mail again.
879
 
          </para>
880
 
        </answer>
881
 
      </qandaentry>
882
 
 
883
 
      <qandaentry>
884
 
        <question id="faq-email-testing">
885
 
          <para>
886
 
            I'm evaluating/testing Bugzilla, and don't want it to send email
887
 
            to anyone but me. How do I do it?
888
 
          </para>
889
 
        </question>
890
 
        <answer>
891
 
          <para>
892
 
            To disable email, set the
893
 
            <option>mail_delivery_method</option> parameter to
894
 
            <literal>none</literal> (2.20 and later), or
895
 
            <programlisting>$enableSendMail</programlisting> parameter to '0'
896
 
            in either <filename>BugMail.pm</filename> (2.18 and later) or 
897
 
            <filename>processmail</filename> (up to 2.16.x).
898
 
          </para>
899
 
          <note>
900
 
            <para>
901
 
              Up to 2.16.x, changing
902
 
              <programlisting>$enableSendMail</programlisting>
903
 
              will only affect bugmail; email related to password changes,
904
 
              email address changes, bug imports, flag changes, etc. will
905
 
              still be sent out. As of the final release of 2.18, however,
906
 
              the above step will disable <emphasis>all</emphasis> mail
907
 
              sent from Bugzilla for any purpose.
908
 
            </para>
909
 
          </note>
910
 
          <para>
911
 
            To have bugmail (and only bugmail) redirected to you instead of
912
 
            its intended recipients, leave
913
 
            <programlisting>$enableSendMail</programlisting> alone;
914
 
            instead, edit the <quote>newchangedmail</quote> parameter
915
 
            as follows:
916
 
          </para>
917
 
          <itemizedlist>
918
 
            <listitem>
919
 
              <para>
920
 
                Replace <quote>To:</quote> with <quote>X-Real-To:</quote>
921
 
              </para>
922
 
            </listitem>
923
 
            <listitem>
924
 
              <para>
925
 
                Replace <quote>Cc:</quote> with <quote>X-Real-CC:</quote>
926
 
              </para>
927
 
            </listitem>
928
 
            <listitem>
929
 
              <para>
930
 
                Add a <quote>To: %lt;your_email_address&gt;</quote>
931
 
              </para>
932
 
            </listitem>
933
 
          </itemizedlist>
934
 
        </answer>
935
 
      </qandaentry>
936
 
 
937
 
      <qandaentry>
938
 
        <question id="faq-email-whine">
939
 
          <para>
940
 
            I want whineatnews.pl to whine at something other than new and
941
 
            reopened bugs. How do I do it?
942
 
          </para>
943
 
        </question>
944
 
        <answer>
945
 
          <para>
946
 
            For older versions of Bugzilla, you may be able to apply 
947
 
            Klaas Freitag's patch for <quote>whineatassigned</quote>,
948
 
            which can be found in
949
 
            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=6679">bug
950
 
            6679</ulink>. Note that this patch was made in 2000, so it may take
951
 
            some work to apply cleanly to any releases of Bugzilla newer than
952
 
            that, but you can use it as a starting point.
953
 
          </para>
954
 
 
955
 
          <para>
956
 
            An updated (and much-expanded) version of this functionality is
957
 
            due to be released as part of Bugzilla 2.20; see 
958
 
            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=185090">bug
959
 
            185090</ulink> for the discussion, and for more up-to-date patches
960
 
            if you just can't wait.
961
 
          </para>
962
 
        </answer>
963
 
      </qandaentry>
964
 
 
965
 
      <qandaentry>
966
 
        <question id="faq-email-in">
967
 
          <para>
968
 
            How do I set up the email interface to submit or change bugs via email?
969
 
          </para>
970
 
        </question>
971
 
        <answer>
972
 
          <para>
973
 
            Bugzilla 3.0 and later offers the ability submit or change
974
 
            bugs via email, using the <filename>email_in.pl</filename>
975
 
            script within the root directory of the Bugzilla installation.
976
 
            More information on the script can be found in
977
 
            <ulink url="api/email_in.html">docs/html/api/email_in.html</ulink>.
978
 
          </para>
979
 
        </answer>
980
 
      </qandaentry>
981
 
 
982
 
      <qandaentry>
983
 
        <question id="faq-email-sendmailnow">
984
 
          <para>
985
 
            Email takes FOREVER to reach me from Bugzilla -- it's
986
 
            extremely slow. What gives?
987
 
          </para>
988
 
        </question>
989
 
        <answer>
990
 
          <para>
991
 
            If you are using <application>sendmail</application>, try
992
 
            enabling <option>sendmailnow</option> in
993
 
            <filename>editparams.cgi</filename>. For earlier versions of
994
 
            <application>sendmail</application>, one could achieve
995
 
            significant performance improvement in the UI (at the cost of
996
 
            delaying the sending of mail) by setting this parameter to
997
 
            <literal>off</literal>. Sites with
998
 
            <application>sendmail</application> version 8.12 (or higher)
999
 
            should leave this <literal>on</literal>, as they will not see
1000
 
            any performance benefit.
1001
 
          </para>
1002
 
          <para>
1003
 
            If you are using an alternate
1004
 
            <glossterm linkend="gloss-mta">MTA</glossterm>, make sure the
1005
 
            options given in <filename>Bugzilla/BugMail.pm</filename>
1006
 
            and any other place where <application>sendmail</application>
1007
 
            is called are correct for your MTA.
1008
 
          </para>
1009
 
        </answer>
1010
 
      </qandaentry>
1011
 
 
1012
 
      <qandaentry>
1013
 
        <question id="faq-email-nonreceived">
1014
 
          <para>
1015
 
             How come email from Bugzilla changes never reaches me?
1016
 
          </para>
1017
 
        </question>
1018
 
        <answer>
1019
 
          <para>
1020
 
            Double-check that you have not turned off email in your user
1021
 
            preferences. Confirm that Bugzilla is able to send email by
1022
 
            visiting the <quote>Log In</quote> link of your Bugzilla
1023
 
            installation and clicking the <quote>Submit Request</quote>
1024
 
            button after entering your email address.
1025
 
          </para>
1026
 
          <para>
1027
 
            If you never receive mail from Bugzilla, chances are you do
1028
 
            not have sendmail in "/usr/lib/sendmail". Ensure sendmail
1029
 
            lives in, or is symlinked to, "/usr/lib/sendmail".
1030
 
          </para>
1031
 
          <para>
1032
 
            If you are using an MTA other than
1033
 
            <application>sendmail</application> the
1034
 
            <option>sendmailnow</option> param must be set to
1035
 
            <literal>on</literal> or no mail will be sent.
1036
 
          </para>
1037
 
        </answer>
1038
 
      </qandaentry>
1039
 
    </qandadiv>
1040
 
 
1041
 
    <qandadiv id="faq-db">
1042
 
      <title>Bugzilla Database</title>
1043
 
 
1044
 
      <qandaentry>
1045
 
        <question id="faq-db-corrupted">
1046
 
          <para>
1047
 
            I think my database might be corrupted, or contain
1048
 
            invalid entries. What do I do?
1049
 
          </para>
1050
 
        </question>
1051
 
        <answer>
1052
 
          <para>
1053
 
            Run the <quote>sanity check</quote> utility
1054
 
            (<filename>sanitycheck.cgi</filename>) from your web browser
1055
 
            to see! If it finishes without errors, you're
1056
 
            <emphasis>probably</emphasis> OK. If it doesn't come back
1057
 
            OK (i.e. any red letters), there are certain things
1058
 
            Bugzilla can recover from and certain things it can't. If
1059
 
            it can't auto-recover, I hope you're familiar with
1060
 
            mysqladmin commands or have installed another way to
1061
 
            manage your database. Sanity Check, although it is a good
1062
 
            basic check on your database integrity, by no means is a
1063
 
            substitute for competent database administration and
1064
 
            avoiding deletion of data. It is not exhaustive, and was
1065
 
            created to do a basic check for the most common problems
1066
 
            in Bugzilla databases.
1067
 
          </para>
1068
 
        </answer>
1069
 
      </qandaentry>
1070
 
 
1071
 
      <qandaentry>
1072
 
        <question id="faq-db-manualedit">
1073
 
          <para>
1074
 
            I want to manually edit some entries in my database. How?
1075
 
          </para>
1076
 
        </question>
1077
 
        <answer>
1078
 
          <para>
1079
 
            There is no facility in Bugzilla itself to do this. It's also
1080
 
            generally not a smart thing to do if you don't know exactly what
1081
 
            you're doing. If you understand SQL, though, you can use the
1082
 
            <command>mysql</command> or <command>psql</command> command line 
1083
 
            utilities to manually insert, delete and modify table information. 
1084
 
            There are also more intuitive GUI clients available for both MySQL 
1085
 
            and PostgreSQL. For MySQL, we recommend
1086
 
            <ulink url="http://www.phpmyadmin.net/">phpMyAdmin</ulink>.
1087
 
          </para>
1088
 
 
1089
 
          <para>
1090
 
            Remember, backups are your friend. Everyone makes mistakes, and
1091
 
            it's nice to have a safety net in case you mess something up.
1092
 
          </para>
1093
 
 
1094
 
        </answer>
1095
 
      </qandaentry>
1096
 
 
1097
 
      <qandaentry>
1098
 
        <question id="faq-db-permissions">
1099
 
          <para>
1100
 
            I think I've set up MySQL permissions correctly, but Bugzilla still
1101
 
            can't connect.
1102
 
          </para>
1103
 
        </question>
1104
 
        <answer>
1105
 
          <para>
1106
 
            Try running MySQL from its binary:
1107
 
            <command>mysqld --skip-grant-tables</command>.
1108
 
            This will allow you to completely rule out grant tables as the
1109
 
            cause of your frustration. If this Bugzilla is able to connect
1110
 
            at this point then you need to check that you have granted proper
1111
 
            permission to the user password combo defined in
1112
 
            <filename>localconfig</filename>.
1113
 
          </para>
1114
 
          <warning>
1115
 
            <para>
1116
 
              Running MySQL with this command line option is very insecure and
1117
 
              should only be done when not connected to the external network
1118
 
              as a troubleshooting step.  Please do not run your production
1119
 
              database in this mode.
1120
 
            </para>
1121
 
          </warning>
1122
 
          <para>
1123
 
            You may also be suffering from a client version mismatch:
1124
 
          </para>
1125
 
          <para>
1126
 
            MySQL 4.1 and up uses an authentication protocol based on
1127
 
            a password hashing algorithm that is incompatible with that
1128
 
            used by older clients. If you upgrade the server to 4.1,
1129
 
            attempts to connect to it with an older client may fail
1130
 
            with the following message:
1131
 
          </para>
1132
 
          <para>
1133
 
            <screen><prompt>shell&gt;</prompt> mysql
1134
 
            Client does not support authentication protocol requested
1135
 
            by server; consider upgrading MySQL client
1136
 
            </screen>
1137
 
          </para>
1138
 
          <para>
1139
 
            To solve this problem, you should use one of the following
1140
 
            approaches:
1141
 
          </para>
1142
 
          <para>
1143
 
            <itemizedlist>
1144
 
              <listitem>
1145
 
                <para>
1146
 
                  Upgrade all client programs to use a 4.1.1 or newer
1147
 
                  client library.
1148
 
                </para>
1149
 
              </listitem>
1150
 
              <listitem>
1151
 
                <para>
1152
 
                  When connecting to the server with a pre-4.1 client
1153
 
                  program, use an account that still has a
1154
 
                  pre-4.1-style password.
1155
 
                </para>
1156
 
              </listitem>
1157
 
              <listitem>
1158
 
                <para>
1159
 
                  Reset the password to pre-4.1 style for each user
1160
 
                  that needs to use a pre-4.1 client program.
1161
 
                  This can be done using the SET PASSWORD statement
1162
 
                  and the OLD_PASSWORD() function:
1163
 
                  <screen>
1164
 
                    <prompt>mysql&gt;</prompt> SET PASSWORD FOR
1165
 
                    <prompt>    -&gt;</prompt> ' some_user '@' some_host ' = OLD_PASSWORD(' newpwd ');
1166
 
                  </screen>
1167
 
                </para>
1168
 
              </listitem>
1169
 
            </itemizedlist>
1170
 
            
1171
 
          </para>
1172
 
 
1173
 
 
1174
 
          <para>
1175
 
          </para>
1176
 
 
1177
 
        </answer>
1178
 
      </qandaentry>
1179
 
 
1180
 
      <qandaentry>
1181
 
        <question id="faq-db-synchronize">
1182
 
          <para>
1183
 
            How do I synchronize bug information among multiple
1184
 
            different Bugzilla databases?
1185
 
          </para>
1186
 
        </question>
1187
 
        <answer>
1188
 
          <para>
1189
 
            Well, you can synchronize or you can move bugs.
1190
 
            Synchronization will only work one way -- you can create
1191
 
            a read-only copy of the database at one site, and have it
1192
 
            regularly updated at intervals from the main database.
1193
 
          </para>
1194
 
          <para>
1195
 
            MySQL has some synchronization features built-in to the
1196
 
            latest releases. It would be great if someone looked into
1197
 
            the possibilities there and provided a report to the
1198
 
            newsgroup on how to effectively synchronize two Bugzilla
1199
 
            installations.
1200
 
          </para>
1201
 
          <para>
1202
 
            If you simply need to transfer bugs from one Bugzilla to another,
1203
 
            checkout the <quote>move.pl</quote> script in the Bugzilla
1204
 
            distribution.
1205
 
          </para>
1206
 
        </answer>
1207
 
      </qandaentry>
1208
 
    </qandadiv>
1209
 
 
1210
 
    <qandadiv id="faq-nt">
1211
 
      <title>Can Bugzilla run on a Windows server?</title>
1212
 
 
1213
 
      <qandaentry>
1214
 
        <question id="faq-nt-easiest">
1215
 
          <para>
1216
 
            What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
1217
 
          </para>
1218
 
        </question>
1219
 
        <answer>
1220
 
          <para>
1221
 
            Making Bugzilla work easily with Windows
1222
 
            was one of the major goals of the 2.18 milestone. If the
1223
 
            necessary components are in place (perl, a webserver, an MTA, etc.)
1224
 
            then installation of Bugzilla on a Windows box should be no more
1225
 
            difficult than on any other platform. As with any installation,
1226
 
            we recommend that you carefully and completely follow the
1227
 
            installation instructions in <xref linkend="os-win32"/>.
1228
 
          </para>
1229
 
          <para>
1230
 
            While doing so, don't forget to check out the very excellent guide
1231
 
            to <ulink url="http://www.bugzilla.org/docs/win32install.html">
1232
 
            Installing Bugzilla on Microsoft Windows</ulink> written by
1233
 
            Byron Jones. Thanks, Byron!
1234
 
          </para>
1235
 
        </answer>
1236
 
      </qandaentry>
1237
 
 
1238
 
      <qandaentry>
1239
 
        <question id="faq-nt-bundle">
1240
 
          <para>
1241
 
            Is there a "Bundle::Bugzilla" equivalent for Win32?
1242
 
          </para>
1243
 
        </question>
1244
 
        <answer>
1245
 
          <para>
1246
 
            Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
1247
 
            installation on UNIX systems. If someone can volunteer to
1248
 
            create a suitable PPM bundle for Win32, it would be appreciated.
1249
 
          </para>
1250
 
        </answer>
1251
 
      </qandaentry>
1252
 
 
1253
 
      <qandaentry>
1254
 
        <question id="faq-nt-mappings">
1255
 
          <para>
1256
 
            CGI's are failing with a <quote>something.cgi is not a valid
1257
 
            Windows NT application</quote> error. Why?
1258
 
          </para>
1259
 
        </question>
1260
 
        <answer>
1261
 
          <para>
1262
 
            Depending on what Web server you are using, you will have to
1263
 
            configure the Web server to treat *.cgi files as CGI scripts.
1264
 
            In IIS, you do this by adding *.cgi to the App Mappings with
1265
 
            the &lt;path&gt;\perl.exe %s %s as the executable.
1266
 
          </para>
1267
 
          <para>
1268
 
            Microsoft has some advice on this matter, as well:
1269
 
            <blockquote>
1270
 
              <para>
1271
 
                <quote>Set application mappings. In the ISM, map the extension
1272
 
                for the script file(s) to the executable for the script
1273
 
                interpreter. For example, you might map the extension .py to
1274
 
                Python.exe, the executable for the Python script interpreter.
1275
 
                Note For the ActiveState Perl script interpreter, the extension
1276
 
                '.pl' is associated with PerlIS.dll by default. If you want
1277
 
                to change the association of .pl to perl.exe, you need to
1278
 
                change the application mapping. In the mapping, you must add
1279
 
                two percent (%) characters to the end of the pathname for
1280
 
                perl.exe, as shown in this example: 
1281
 
                <command>c:\perl\bin\perl.exe %s %s</command></quote>
1282
 
              </para>
1283
 
            </blockquote>
1284
 
          </para>
1285
 
        </answer>
1286
 
      </qandaentry>
1287
 
 
1288
 
      <qandaentry>
1289
 
        <question id="faq-nt-dbi">
1290
 
          <para>
1291
 
            I'm having trouble with the perl modules for NT not being
1292
 
            able to talk to the database.
1293
 
          </para>
1294
 
        </question>
1295
 
        <answer>
1296
 
          <para>
1297
 
            Your modules may be outdated or inaccurate. Try:
1298
 
            <orderedlist>
1299
 
              <listitem>
1300
 
                <para>
1301
 
                  Hitting <ulink url="http://www.activestate.com/ActivePerl"/>
1302
 
                </para>
1303
 
              </listitem>
1304
 
              <listitem>
1305
 
                <para>
1306
 
                  Download ActivePerl
1307
 
                </para>
1308
 
              </listitem>
1309
 
              <listitem>
1310
 
                <para>
1311
 
                  Go to your prompt
1312
 
                </para>
1313
 
              </listitem>
1314
 
              <listitem>
1315
 
                <para>
1316
 
                  Type 'ppm'
1317
 
                </para>
1318
 
              </listitem>
1319
 
              <listitem>
1320
 
                <para>
1321
 
                  <prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command>
1322
 
                </para>
1323
 
              </listitem>
1324
 
            </orderedlist>
1325
 
            I reckon TimeDate comes with the activeperl.
1326
 
            You can check the ActiveState site for packages for installation
1327
 
            through PPM. <ulink url="http://www.activestate.com/Packages/"/>.
1328
 
          </para>
1329
 
        </answer>
1330
 
      </qandaentry>
1331
 
 
1332
 
    </qandadiv>
1333
 
 
1334
 
    <qandadiv id="faq-use">
1335
 
      <title>Bugzilla Usage</title>
1336
 
 
1337
 
      <qandaentry>
1338
 
        <question id="faq-use-changeaddress">
1339
 
          <para>
1340
 
            How do I change my user name (email address) in Bugzilla?
1341
 
          </para>
1342
 
        </question>
1343
 
        <answer>
1344
 
          <para>
1345
 
            You can change your email address from the Name and Password
1346
 
            section in Preferences. You will be emailed at both the old 
1347
 
            and new addresses for confirmation. 'Administrative Policies' 
1348
 
            must have the 'allowemailchange' parameter set to <quote>On</quote>.
1349
 
          </para>
1350
 
        </answer>
1351
 
      </qandaentry>
1352
 
 
1353
 
      <qandaentry>
1354
 
        <question id="faq-use-query">
1355
 
          <para>
1356
 
            The query page is very confusing.
1357
 
            Isn't there a simpler way to query?
1358
 
          </para>
1359
 
        </question>
1360
 
        <answer>
1361
 
          <para>
1362
 
            The interface was simplified by a UI designer for 2.16. Further
1363
 
            suggestions for improvement are welcome, but we won't sacrifice
1364
 
            power for simplicity.
1365
 
          </para>
1366
 
          <para>
1367
 
            As of 2.18, there is also a 'simpler' search available. At the top
1368
 
            of the search page are two links; <quote>Advanced Search</quote>
1369
 
            will take you to the familiar full-power/full-complexity search
1370
 
            page. The <quote>Find a Specific Bug</quote> link will take you
1371
 
            to a much-simplified page where you can pick a product and
1372
 
            status (open,closed, or both), then enter words that appear in
1373
 
            the bug you want to find. This search will scour the 'Summary'
1374
 
            and 'Comment' fields, and return a list of bugs sorted so that
1375
 
            the bugs with the most hits/matches are nearer to the top.
1376
 
          </para>
1377
 
          <note>
1378
 
            <para>
1379
 
              Matches in the Summary will 'trump' matches in comments,
1380
 
              and bugs with summary-matches will be placed higher in
1381
 
              the buglist --  even if a lower-ranked bug has more matches
1382
 
              in the comments section.
1383
 
            </para>
1384
 
          </note>
1385
 
          <para>
1386
 
            Bugzilla uses a cookie to remember which version of the page
1387
 
            you visited last, and brings that page up when you next do a
1388
 
            search. The default page for new users (or after an upgrade)
1389
 
            is the 'simple' search.
1390
 
          </para>
1391
 
        </answer>
1392
 
      </qandaentry>
1393
 
 
1394
 
      <qandaentry>
1395
 
        <question id="faq-use-accept">
1396
 
          <para>
1397
 
            I'm confused by the behavior of the <quote>Accept</quote>
1398
 
            button in the Show Bug form. Why doesn't it assign the bug
1399
 
            to me when I accept it?
1400
 
          </para>
1401
 
        </question>
1402
 
        <answer>
1403
 
          <para>
1404
 
            The current behavior is acceptable to bugzilla.mozilla.org and
1405
 
            most users. If you want to change this behavior, though, you
1406
 
            have your choice of patches: 
1407
 
            <simplelist>
1408
 
              <member>
1409
 
                <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=35195">Bug 35195</ulink>
1410
 
                seeks to add an <quote>...and accept the bug</quote> checkbox
1411
 
                to the UI. It has two patches attached to it: 
1412
 
                <ulink url="https://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">attachment 8029</ulink>
1413
 
                was originally created for Bugzilla 2.12, while 
1414
 
                <ulink url="https://bugzilla.mozilla.org/showattachment.cgi?attach_id=91372">attachment 91372</ulink>
1415
 
                is an updated version for Bugzilla 2.16
1416
 
              </member>
1417
 
              <member>
1418
 
                <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=37613">Bug
1419
 
                37613</ulink> also provides two patches (against Bugzilla
1420
 
                2.12): one to add a 'Take Bug' option, and the other to
1421
 
                automatically reassign the bug on 'Accept'. 
1422
 
              </member>
1423
 
            </simplelist>
1424
 
            These patches are all somewhat dated now, and cannot be applied
1425
 
            directly, but they are simple enough to provide a guide on how
1426
 
            Bugzilla can be customized and updated to suit your needs.
1427
 
          </para>
1428
 
        </answer>
1429
 
      </qandaentry>
1430
 
 
1431
 
      <qandaentry>
1432
 
        <question id="faq-use-attachment">
1433
 
          <para>
1434
 
            I can't upload anything into the database via the
1435
 
            <quote>Create Attachment</quote> link. What am I doing wrong?
1436
 
          </para>
1437
 
        </question>
1438
 
        <answer>
1439
 
          <para>
1440
 
            The most likely cause is a very old browser or a browser that is
1441
 
            incompatible with file upload via POST. Download the latest version
1442
 
            of your favourite browser to handle uploads correctly.
1443
 
          </para>
1444
 
        </answer>
1445
 
      </qandaentry>
1446
 
 
1447
 
      <qandaentry>
1448
 
        <question id="faq-use-keyword">
1449
 
          <para>
1450
 
            How do I change a keyword in Bugzilla, once some bugs are using it?
1451
 
          </para>
1452
 
        </question>
1453
 
        <answer>
1454
 
          <para>
1455
 
            In the Bugzilla administrator UI, edit the keyword and
1456
 
            it will let you replace the old keyword name with a new one.
1457
 
            This will cause a problem with the keyword cache; run
1458
 
            <command>sanitycheck.cgi</command> to fix it.
1459
 
          </para>
1460
 
        </answer>
1461
 
      </qandaentry>
1462
 
 
1463
 
      <qandaentry>
1464
 
        <question id="faq-use-close">
1465
 
          <para>
1466
 
            Why can't I close bugs from the <quote>Change Several Bugs
1467
 
            at Once</quote> page?
1468
 
          </para>
1469
 
        </question>
1470
 
        <answer>
1471
 
          <para>
1472
 
            Simple answer; you can.
1473
 
          </para>
1474
 
 
1475
 
          <para>
1476
 
            The logic behind the page checks every bug in the list to
1477
 
            determine legal state changes, and then only shows you controls
1478
 
            to do things that could apply to <emphasis>every</emphasis> bug
1479
 
            on the list. The reason for this is that if you try to do something
1480
 
            illegal to a bug, the whole process will grind to a halt, and all
1481
 
            changes after the failed one will <emphasis>also</emphasis> fail.
1482
 
            Since that isn't a good outcome, the page doesn't even present
1483
 
            you with the option.
1484
 
          </para>
1485
 
 
1486
 
          <para>
1487
 
            In practical terms, that means that in order to mark
1488
 
            multiple bugs as CLOSED, then every bug on the page has to be
1489
 
            either RESOLVED or VERIFIED already; if this is not the case,
1490
 
            then the option to close the bugs will not appear on the page.
1491
 
          </para>
1492
 
 
1493
 
          <para>
1494
 
            The rationale is that if you pick one of the bugs that's not
1495
 
            VERIFIED and try to CLOSE it, the bug change will fail
1496
 
            miserably (thus killing any changes in the list after it
1497
 
            while doing the bulk change) so it doesn't even give you the
1498
 
            choice.
1499
 
          </para>
1500
 
        </answer>
1501
 
      </qandaentry>
1502
 
 
1503
 
 
1504
 
    </qandadiv>
1505
 
 
1506
 
    <qandadiv id="faq-hacking">
1507
 
      <title>Bugzilla Hacking</title>
1508
 
 
1509
 
      <qandaentry>
1510
 
        <question id="faq-hacking-templatestyle">
1511
 
          <para>
1512
 
            What kind of style should I use for templatization?
1513
 
          </para>
1514
 
        </question>
1515
 
        <answer>
1516
 
          <para>
1517
 
            Gerv and Myk suggest a 2-space indent, with embedded code sections on
1518
 
            their own line, in line with outer tags. Like this:</para>
1519
 
            <programlisting><![CDATA[
1520
 
<fred>
1521
 
[% IF foo %]
1522
 
  <bar>
1523
 
  [% FOREACH x = barney %]
1524
 
    <tr>
1525
 
      <td>
1526
 
        [% x %]
1527
 
      </td>
1528
 
    <tr>
1529
 
  [% END %]
1530
 
[% END %]
1531
 
</fred>
1532
 
]]></programlisting>
1533
 
 
1534
 
        <para> Myk also recommends you turn on PRE_CHOMP in the template
1535
 
        initialization to prevent bloating of HTML with unnecessary whitespace.
1536
 
        </para>
1537
 
 
1538
 
        <para>Please note that many have differing opinions on this subject,
1539
 
        and the existing templates in Bugzilla espouse both this and a 4-space
1540
 
        style. Either is acceptable; the above is preferred.</para>
1541
 
        </answer>
1542
 
      </qandaentry>
1543
 
 
1544
 
      <qandaentry>
1545
 
        <question id="faq-hacking-bugzillabugs">
1546
 
          <para>
1547
 
            What bugs are in Bugzilla right now?
1548
 
          </para>
1549
 
        </question>
1550
 
        <answer>
1551
 
          <para>
1552
 
            Try <ulink url="https://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
1553
 
            this link</ulink> to view current bugs or requests for
1554
 
            enhancement for Bugzilla.
1555
 
          </para>
1556
 
          <para>
1557
 
            You can view bugs marked for &bz-nextver; release
1558
 
            <ulink url="https://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+&amp;bz-nextver;">here</ulink>.
1559
 
            This list includes bugs for the &bz-nextver; release that have already
1560
 
            been fixed and checked into CVS. Please consult the
1561
 
            <ulink url="http://www.bugzilla.org/">
1562
 
            Bugzilla Project Page</ulink> for details on how to
1563
 
            check current sources out of CVS so you can have these
1564
 
            bug fixes early!
1565
 
          </para>
1566
 
        </answer>
1567
 
      </qandaentry>
1568
 
 
1569
 
      <qandaentry>
1570
 
        <question id="faq-hacking-priority">
1571
 
          <para>
1572
 
            How can I change the default priority to a null value?
1573
 
            For instance, have the default priority be <quote>---</quote>
1574
 
            instead of <quote>P2</quote>?
1575
 
          </para>
1576
 
        </question>
1577
 
        <answer>
1578
 
          <para>
1579
 
            This is well-documented in <ulink
1580
 
            url="https://bugzilla.mozilla.org/show_bug.cgi?id=49862">bug
1581
 
            49862</ulink>. Ultimately, it's as easy as adding the
1582
 
            <quote>---</quote> priority field to your localconfig file
1583
 
            in the appropriate area, re-running checksetup.pl, and then
1584
 
            changing the default priority in your browser using
1585
 
            <command>editparams.cgi</command>. 
1586
 
          </para>
1587
 
        </answer>
1588
 
      </qandaentry>
1589
 
 
1590
 
      <qandaentry>
1591
 
        <question id="faq-hacking-patches">
1592
 
          <para>
1593
 
            What's the best way to submit patches?  What guidelines
1594
 
            should I follow?
1595
 
          </para>
1596
 
        </question>
1597
 
        <answer>
1598
 
          <blockquote>
1599
 
            <orderedlist>
1600
 
              <listitem>
1601
 
                <para>
1602
 
                  Enter a bug into bugzilla.mozilla.org for the <quote><ulink
1603
 
                  url="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
1604
 
                  product.
1605
 
                </para>
1606
 
              </listitem>
1607
 
              <listitem>
1608
 
                <para>
1609
 
                  Upload your patch as a unified diff (having used <quote>diff
1610
 
                  -u</quote> against the <emphasis>current sources</emphasis>
1611
 
                  checked out of CVS), or new source file by clicking
1612
 
                  <quote>Create a new attachment</quote> link on the bug
1613
 
                  page you've just created, and include any descriptions of
1614
 
                  database changes you may make, into the bug ID you submitted
1615
 
                  in step #1. Be sure and click the <quote>Patch</quote> checkbox
1616
 
                  to indicate the text you are sending is a patch!
1617
 
                </para>
1618
 
              </listitem>
1619
 
              <listitem>
1620
 
                <para>
1621
 
                  Announce your patch and the associated URL
1622
 
                  (https://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX)
1623
 
                  for discussion in the newsgroup
1624
 
                  (mozilla.support.bugzilla). You'll get a
1625
 
                  really good, fairly immediate reaction to the
1626
 
                  implications of your patch, which will also give us
1627
 
                  an idea how well-received the change would be.
1628
 
                </para>
1629
 
              </listitem>
1630
 
              <listitem>
1631
 
                <para>
1632
 
                  If it passes muster with minimal modification, the
1633
 
                  person to whom the bug is assigned in Bugzilla is
1634
 
                  responsible for seeing the patch is checked into CVS.
1635
 
                </para>
1636
 
              </listitem>
1637
 
              <listitem>
1638
 
                <para>
1639
 
                  Bask in the glory of the fact that you helped write
1640
 
                  the most successful open-source bug-tracking software
1641
 
                  on the planet :)
1642
 
                </para>
1643
 
              </listitem>
1644
 
            </orderedlist>
1645
 
          </blockquote>
1646
 
        </answer>
1647
 
      </qandaentry>
1648
 
 
1649
 
 
1650
 
    </qandadiv>
1651
 
 
1652
 
  </qandaset>
1653
 
 
1654
 
</appendix>
1655
 
 
1656
 
 
1657
 
<!-- Keep this comment at the end of the file
1658
 
Local variables:
1659
 
mode: sgml
1660
 
sgml-always-quote-attributes:t
1661
 
sgml-auto-insert-required-elements:t
1662
 
sgml-balanced-tag-edit:t
1663
 
sgml-exposed-tags:nil
1664
 
sgml-general-insert-case:lower
1665
 
sgml-indent-data:t
1666
 
sgml-indent-step:2
1667
 
sgml-local-catalogs:nil
1668
 
sgml-local-ecat-files:nil
1669
 
sgml-minimize-attributes:nil
1670
 
sgml-namecase-general:t
1671
 
sgml-omittag:t
1672
 
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
1673
 
sgml-shorttag:t
1674
 
sgml-tag-region-if-active:t
1675
 
End:
1676
 
-->