faq.xml 45 KB
Newer Older
1
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
2

3
<appendix id="faq">
4 5
  <title>The Bugzilla FAQ</title>

6 7 8 9
  <para>
    This FAQ includes questions not covered elsewhere in the Guide.
  </para>
  
10 11 12
  <qandaset>


13
    <qandadiv id="faq-general">
14 15 16
      <title>General Questions</title>

      <qandaentry>
17
	<question id="faq-general-license">
18 19 20 21 22 23
	  <para>
	    What license is Bugzilla distributed under?
	  </para>
	</question>
	<answer>
	  <para>
24
	    Bugzilla is covered by the Mozilla Public License.
25
	    See details at <ulink url="http://www.mozilla.org/MPL/"/>.
26 27 28 29 30
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
31
	<question id="faq-general-support">
32 33 34 35 36
	  <para>
	    How do I get commercial support for Bugzilla?
	  </para>
	</question>
	<answer>
37
          <para>
38
            <ulink url="http://bugzilla.org/consulting.html"/>
39 40 41
            is a list of people and companies who have asked us to list them
            as consultants for Bugzilla.
          </para>
42
	  <para>
43 44
	    There are several experienced
	    Bugzilla hackers on the mailing list/newsgroup who are willing
45
	    to make themselves available for generous compensation.
46
	    Try sending a message to the mailing list asking for a volunteer.
47 48 49 50 51
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
52
	<question id="faq-general-companies">
53
	  <para>
54 55
	    What major companies or projects are currently using Bugzilla
	    for bug-tracking?
56 57 58 59
	  </para>
	</question>
	<answer>
	  <para>
60
	    There are <emphasis>dozens</emphasis> of major companies with public
61 62
	    Bugzilla sites to track bugs in their products. We have a fairly
            complete list available on our website at
63
            <ulink url="http://bugzilla.org/installation-list/"/>. If you
64 65
            have an installation of Bugzilla and would like to be added to the
            list, whether it's a public install or not, simply e-mail
66
            Gerv <email>gerv@mozilla.org</email>.
67 68 69 70 71
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
72
	<question id="faq-general-maintainers">
73 74 75 76 77 78
	  <para>
	    Who maintains Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
79 80
	    A 
      <ulink url="http://www.bugzilla.org/who_we_are.html">core team</ulink>,
81
      led by Dave Miller (justdave@bugzilla.org).
82 83 84 85 86
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
87
	<question id="faq-general-compare">
88
	  <para>
89
	    How does Bugzilla stack up against other bug-tracking databases?
90 91 92 93
	  </para>
	</question>
	<answer>
	  <para>
94 95 96
	    We can't find any head-to-head comparisons of Bugzilla against
	    other defect-tracking software. If you know of one, please
      get in touch. However, from the author's personal
97 98 99 100 101 102
	    experience with other bug-trackers, Bugzilla offers
	    superior performance on commodity hardware, better price
	    (free!), more developer- friendly features (such as stored
	    queries, email integration, and platform independence),
	    improved scalability, open source code, greater
	    flexibility, and superior ease-of-use.
103 104
	  </para>
	  <para>
105
	    If you happen to be a commercial bug-tracker vendor, please
106 107 108
	    step forward with a list of advantages your product has over
      Bugzilla. We'd be happy to include it in the "Competitors"
      section.
109 110 111 112 113
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
114
	<question id="faq-general-bzmissing">
115
	  <para>
116
	    Why doesn't Bugzilla offer this or that feature or compatibility
117
	    with this other tracking software?
118 119 120 121
	  </para>
	</question>
	<answer>
	  <para>
122
	    It may be that the support has not been built yet, or that you
123 124
	    have not yet found it. Bugzilla is making tremendous strides in
	    usability, customizability, scalability, and user interface. It
125 126
	    is widely considered the most complete and popular open-source
	    bug-tracking software in existence.
127 128
	  </para>
	  <para>
129 130 131 132
	    That doesn't mean it can't use improvement!
	    You can help the project along by either hacking a patch yourself
	    that supports the functionality you require, or else submitting a
	    "Request for Enhancement" (RFE) using the bug submission interface
133
	    at <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">bugzilla.mozilla.org</ulink>.
134 135 136 137 138
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
139
	<question id="faq-general-mysql">
140 141
	  <para>
	    Why MySQL?  I'm interested in seeing Bugzilla run on
142
	    Oracle/Sybase/Msql/PostgreSQL/MSSQL.
143 144 145
	  </para>
	</question>
	<answer>
146
	  <para>
147 148 149 150 151
            MySQL was originally chosen because it is free, easy to install,
            and was available for the hardware Netscape intended to run it on.
	  </para>
          <para>
            There is currently work in progress to make Bugzilla work on
152 153 154
            PostgreSQL and Sybase in the default distribution. You can track
            the progress of these initiatives in <ulink
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=98304">bug 98304</ulink>
155
            and <ulink
156
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=173130">bug 173130</ulink>
157 158 159 160 161 162
            respectively.
          </para>
          <para>
            Once both of these are done, adding support for additional
            database servers should be trivial.
          </para>
163 164 165 166
	</answer>
      </qandaentry>

      <qandaentry>
167
	<question id="faq-general-bonsaitools">
168
	  <para>
169
	    What is <filename>/usr/bonsaitools/bin/perl</filename>?
170 171 172 173
	  </para>
	</question>
	<answer>
	  <para>
174 175 176 177
            Bugzilla used to have the path to perl on the shebang line set to
            <filename>/usr/bonsaitools/bin/perl</filename> because when
            Terry first started writing the code for mozilla.org he needed a
            version of Perl and other tools that were completely under his
178 179
            control. This location was abandoned for the 2.18 release in favor
            of the more sensible <filename>/usr/bin/perl</filename>. If you
180 181 182 183 184
            installed an older verion of Bugzilla and created the symlink we
            suggested, you can remove it now (provided that you don't have
            anything else, such as Bonsai, using it and you don't intend to
            reinstall an older version of Bugzilla).
          </para>
185 186 187
	</answer>
      </qandaentry>

188 189 190 191 192 193 194 195 196 197
      <qandaentry>
        <question id="faq-general-perlpath">
          <para>
            My perl is not located at <filename>/usr/bin/perl</filename>, is
            there an easy way to change it everywhere it needs to be changed?
          </para>
        </question>
        <answer>
          <para>
            Yes, the following bit of perl magic will change all the shebang
198
            lines. Be sure to change <filename>/usr/local/bin/perl</filename>
199 200 201 202 203 204 205
            to your path to the perl binary.
          </para>
          <programlisting>
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
          </programlisting>
        </answer>
      </qandaentry>
206 207

      <qandaentry>
208
	<question id="faq-general-cookie">
209 210 211 212 213 214 215 216 217 218 219
	  <para>
	    Is there an easy way to change the Bugzilla cookie name?
	  </para>
	</question>
	<answer>
	  <para>
	    At present, no.
	  </para>
	</answer>
      </qandaentry>
      
220 221 222 223 224 225 226 227 228 229 230 231 232
      <qandaentry>
	<question id="faq-mod-perl">
	  <para>
	    Does bugzilla run under <filename>mod_perl</filename>?
	  </para>
	</question>
	<answer>
	  <para>
	    At present, no. This is being worked on.
	  </para>
	</answer>
      </qandaentry>
      
233 234
    </qandadiv>

235
    <qandadiv id="faq-phb">
236
      <title>Managerial Questions</title>
237 238

      <qandaentry>
239
	<question id="faq-phb-client">
240
	  <para>
241 242
	    Is Bugzilla web-based, or do you have to have specific software or
	    a specific operating system on your machine?
243 244 245 246
	  </para>
	</question>
	<answer>
	  <para>
247
	    It is web and e-mail based.
248 249 250 251 252
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
253
	<question id="faq-phb-priorities">
254
	  <para>
255 256 257
	    Does Bugzilla allow us to define our own priorities and levels? Do we
	    have complete freedom to change the labels of fields and format of them, and
	    the choice of acceptable values?
258 259 260 261
	  </para>
	</question>
	<answer>
	  <para>
262
	    Yes. However, modifying some fields, notably those related to bug
263 264
	    progression states, also require adjusting the program logic to
	    compensate for the change.
265
	  </para>
266 267
	  <para>
	    There is no GUI for adding fields to Bugzilla at this
268 269
	    time. You can follow development of this feature in 
	    <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">bug 91037</ulink>
270
	  </para>
271 272 273 274
	</answer>
      </qandaentry>

      <qandaentry>
275
	<question id="faq-phb-reporting">
276
	  <para>
277 278
	    Does Bugzilla provide any reporting features, metrics, graphs, etc? You
	    know, the type of stuff that management likes to see. :)
279 280 281 282
	  </para>
	</question>
	<answer>
	  <para>
283 284
	    Yes. Look at <ulink url="http://bugzilla.mozilla.org/report.cgi"/>
            for samples of what Bugzilla can do in reporting and graphing.
285 286
	  </para>
	  <para>
287 288 289 290 291 292
            If you can not get the reports you want from the included reporting
            scripts, it is possible to hook up a professional reporting package
            such as Crystal Reports using ODBC. If you choose to do this,
            beware that giving direct access to the database does contain some
            security implications. Even if you give read-only access to the
            bugs database it will bypass the secure bugs features of Bugzilla.
293 294 295 296 297
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
298
	<question id="faq-phb-email">
299
	  <para>
300
	    Is there email notification and if so, what do you see when you get an
301
	    email?
302 303 304 305
	  </para>
	</question>
	<answer>
	  <para>
306
	    Email notification is user-configurable. By default, the bug id and 
307
      summary of the bug report accompany each email notification, along with
308
	    a list of the changes made.
309 310 311 312 313
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
314
	<question id="faq-phb-emailapp">
315
	  <para>
316
	    Do users have to have any particular
317
	    type of email application?
318 319 320 321
	  </para>
	</question>
	<answer>
	  <para>
322 323
	    Bugzilla email is sent in plain text, the most compatible mail format
	    on the planet.
324 325
	    <note>
	      <para>
326 327 328
		If you decide to use the bugzilla_email integration features
		to allow Bugzilla to record responses to mail with the associated bug,
		you may need to caution your users to set their mailer to "respond
329
		to messages in the format in which they were sent". For security reasons
330 331
		Bugzilla ignores HTML tags in comments, and if a user sends HTML-based
		email into Bugzilla the resulting comment looks downright awful.
332 333 334 335 336 337 338
	      </para>
	    </note>
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
339
	<question id="faq-phb-data">
340
	  <para>
341 342 343 344
	    Does Bugzilla allow data to be imported and exported? If I had outsiders
	    write up a bug report using a MS Word bug template, could that template be
	    imported into "matching" fields? If I wanted to take the results of a query
	    and export that data to MS Excel, could I do that?
345 346 347
	  </para>
	</question>
	<answer>
348 349 350
          <para>
            Bugzilla can output buglists as HTML (the default), CSV or RDF.
            The link for CSV can be found at the bottom of the buglist in HTML
351
            format. This CSV format can easily be imported into MS Excel or
352
            other spreadsheet applications.
353 354 355
          </para>
          <para>
            To use the RDF format of the buglist it is necessary to append a
356
            <computeroutput>&amp;ctype=rdf</computeroutput> to the URL. RDF
357
            is meant to be machine readable and thus it is assumed that the
358
            URL would be generated programatically so there is no user visible
359 360 361 362 363
            link to this format.
          </para>
          <para>
            Currently the only script included with Bugzilla that can import
            data is <filename>importxml.pl</filename> which is intended to be
364 365 366
            used for importing the data generated by the XML ctype of
            <filename>show_bug.cgi</filename> in association with bug moving.
            Any other use is left as an exercise for the user.
367 368 369 370 371 372 373
          </para>
          <para>
            There are also scripts included in the <filename>contrib/</filename>
            directory for using e-mail to import information into Bugzilla,
            but these scripts are not currently supported and included for
            educational purposes.
          </para>
374 375 376 377
	</answer>
      </qandaentry>

      <qandaentry>
378
	<question id="faq-phb-l10n">
379
	  <para>
380 381
	    Has anyone converted Bugzilla to another language to be used in other
	    countries? Is it localizable?
382 383 384 385
	  </para>
	</question>
	<answer>
	  <para>
386
            Yes. For more information including available translated templates,
387
            see <ulink
388
            url="http://www.bugzilla.org/download.html#localizations"/>.
389
            The admin interfaces are still not included in these translated
390 391
            templates and is therefore still English only. Also, there may be
            issues with the charset not being declared. See <ulink
392 393
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=126266">bug 126226</ulink>
            for more information.
394 395 396 397 398
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
399
	<question id="faq-phb-reports">
400
	  <para>
401 402
	    Can a user create and save reports? Can they do this in Word format?
	    Excel format?
403 404 405 406
	  </para>
	</question>
	<answer>
	  <para>
407
	    Yes. No. Yes (using the CSV format).
408 409 410 411 412
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
413
	<question id="faq-phb-midair">
414
	  <para>
415 416 417
	     Does Bugzilla provide record locking when there is simultaneous access
	    to the same bug? Does the second person get a notice that the bug is in use
	    or how are they notified?
418 419 420 421
	  </para>
	</question>
	<answer>
	  <para>
422
	    Bugzilla does not lock records. It provides mid-air collision detection,
423
	    and offers the offending user a choice of options to deal with the conflict.
424 425 426 427 428
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
429
	<question id="faq-phb-backup">
430 431 432 433 434 435
	  <para>
	    Are there any backup features provided?
	  </para>
	</question>
	<answer>
	  <para>
436 437
	    MySQL, the database back-end for Bugzilla, allows hot-backup of data.
	    You can find strategies for dealing with backup considerations
438
	    at <ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>.
439 440 441 442 443
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
444
	<question id="faq-phb-livebackup">
445 446 447 448 449 450
	  <para>
	    Can users be on the system while a backup is in progress?
	  </para>
	</question>
	<answer>
	  <para>
451 452
	    Yes. However, commits to the database must wait
	    until the tables are unlocked. Bugzilla databases are typically
453 454 455 456 457
	    very small, and backups routinely take less than a minute.
	  </para>
	</answer>
      </qandaentry>

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
      <qandaentry>
        <question id="faq-phb-cvsupdate">
          <para>
            How can I update the code and the database using CVS?
          </para>
        </question>
        <answer>
          <para>
            <orderedlist>
              <listitem>
                <para>
                  Make a backup of both your Bugzilla directory and the
                  database. For the Bugzilla directory this is as easy as
                  doing <command>cp -rp bugzilla bugzilla.bak</command>.
                  For the database, there's a number of options - see the
                  MySQL docs and pick the one that fits you best (the easiest
                  is to just make a physical copy of the database on the disk,
                  but you have to have the database server shut down to do
                  that without risking dataloss).
                </para>
              </listitem>

              <listitem>
                <para>
                  Make the Bugzilla directory your current directory.
                </para>
              </listitem>

              <listitem>
                <para>
                  Use <command>cvs -q update -AdP</command> if you want to
                  update to the tip or
                  <command>cvs -q update -dP -rTAGNAME</command>
                  if you want a specific version (in that case you'll have to
                  replace TAGNAME with a CVS tag name such as BUGZILLA-2_16_5).
                </para>

                <para>
                  If you've made no local changes, this should be very clean.
                  If you have made local changes, then watch the cvs output
                  for C results. If you get any lines that start with a C
                  it means there  were conflicts between your local changes
                  and what's in CVS. You'll need to fix those manually before
                  continuing.
                </para>
              </listitem>

              <listitem>
                <para>
                  After resolving any conflicts that the cvs update operation
                  generated, running <command>./checksetup.pl</command> will
                  take care of updating the database for you as well as any
                  other changes required for the new version to operate.
                </para>

                <warning>
                  <para>
                    Once you run checksetup.pl, the only way to go back is
                    to restore the database backups. You can't "downgrade"
                    the system cleanly under most circumstances.
                  </para>
                </warning>
              </listitem>
            </orderedlist>
          </para>
        </answer>
      </qandaentry>

526
      <qandaentry>
527
	<question id="faq-phb-maintenance">
528
	  <para>
529 530 531 532
	    What type of human resources are needed to be on staff to install and
	    maintain Bugzilla? Specifically, what type of skills does the person need to
	    have? I need to find out if we were to go with Bugzilla, what types of
	    individuals would we need to hire and how much would that cost vs buying an
533
	    "out-of-the-box" solution?
534 535 536 537
	  </para>
	</question>
	<answer>
	  <para>
538 539
	    If Bugzilla is set up correctly from the start, continuing maintenance
      needs are minimal and can be done easily using the web interface.
540 541
	  </para>
	  <para>
542
	    Commercial Bug-tracking software typically costs somewhere upwards
543
	    of $20,000 or more for 5-10 floating licenses. Bugzilla consultation
544 545
	    is available from skilled members of the newsgroup. Simple questions
      are answered there and then.
546 547 548 549 550
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
551
	<question id="faq-phb-installtime">
552
	  <para>
553 554 555 556 557
	    What time frame are we looking at if we decide to hire people to install
	    and maintain the Bugzilla? Is this something that takes hours or weeks to
	    install and a couple of hours per week to maintain and customize or is this
	    a multi-week install process, plus a full time job for 1 person, 2 people,
	    etc?
558 559 560 561
	  </para>
	</question>
	<answer>
	  <para>
562
	    It all depends on your level of commitment. Someone with much Bugzilla
563
	    experience can get you up and running in less than a day, and
564
	    your Bugzilla install can run untended for years. If your
565 566
	    Bugzilla strategy is critical to your business workflow, hire somebody
	    with reasonable UNIX or Perl skills to handle your process management and
567
	    bug-tracking maintenance &amp; customization.
568 569 570 571 572
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
573
	<question id="faq-phb-cost">
574
	  <para>
575 576
	    Is there any licensing fee or other fees for using Bugzilla? Any
	    out-of-pocket cost other than the bodies needed as identified above?
577 578 579 580
	  </para>
	</question>
	<answer>
	  <para>
581
	    No. MySQL asks, if you find their product valuable, that you purchase
582
	    a support contract from them that suits your needs.
583 584 585
	  </para>
	</answer>
      </qandaentry>
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

      <qandaentry>
        <question id="faq-phb-reloginEveryone">
          <para>
            Why do users have to log in every time they access a page? This
            affects everyone who accesses my Bugzilla. (If this only affects
            some of your users, see the next FAQ item.)
          </para>
        </question>
        <answer>
          <para>
            The most-likely cause is that the "cookiepath" parameter is not set
            correctly in the Bugzilla configuration.  You can change this (if
            you're a Bugzilla administrator) from the editparams.cgi page
            via the web.
          </para>
          <para>
            The value of the cookiepath parameter should be the actual directory
            containing your Bugzilla installation, <emphasis>as seen by the
            end-user's web browser</emphasis>. Leading and trailing slashes are
            mandatory. You can also set the cookiepath to any directory which
            is a parent of the Bugzilla directory (such as '/', the root
            directory). But you can't put something that isn't at least
            a partial match or it won't work. What you're actually doing
            is restricting the end-user's browser to sending the cookies
            back only to that directory.
          </para>
          <para>
            How do you know if you want your specific Bugzilla directory or the
            whole site?
          </para>

          <para>
            If you have only one Bugzilla running on the server, and you
            don't mind having other applications on the same server with it
            being able to see the cookies (you might be doing this on purpose
            if you have other things on your site that share authentication with
            Bugzilla), then you'll want to have the cookiepath set to "/", or to
            a sufficiently-high enough directory that all of the involved apps
            can see the cookies.
          </para>
          <para>
            Examples:

            <blockquote>
              <literallayout>
        urlbase is <ulink url="http://bugzilla.mozilla.org/"/>
        cookiepath is /

        urlbase is <ulink url="http://tools.mysite.tld/bugzilla/"/>
                but you have http://tools.mysite.tld/someotherapp/ which shares
                authentication with your Bugzilla
        cookiepath is /
              </literallayout>
            </blockquote>
          </para>
          
         <para>
            On the other hand, if you have more than one Bugzilla
            running on the server (some people do - we do on landfill)
            then you need to have the cookiepath restricted enough
            so that the different Bugzillas don't
            confuse their cookies with one another.
          </para>
          <para>
            Examples:

            <blockquote>
              <literallayout>
        urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"/>
        cookiepath is /bugzilla-tip/

        urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-2.16-branch/"/>
        cookiepath is /bugzilla-2.16-branch/
              </literallayout>
            </blockquote>
          </para>

          <para>
            If you had cookiepath set to / at any point in the past and
            need to set it to something more restrictive (i.e. /bugzilla/),
            you can safely do this without requiring users to delete
            their Bugzilla-related cookies in their browser (this is
            true starting with Bugzilla 2.17.7 and Bugzilla 2.16.5).
          </para>
        </answer>
      </qandaentry>

      <qandaentry>
        <question id="faq-phb-reloginSome">
          <para>
            Why do users have to log in every time they access a page? This
            only seems to affect some of my Bugzilla's users, others stay
            logged in.
          </para>
        </question>
        <answer>
          <para>
            First, make sure cookies are enabled in the user's browser.
          </para>
          <para>
687 688 689
            If that doesn't fix the problem, it may be that
            the user's ISP implements a rotating proxy server. This causes
            the user's effective IP address (the address which the Bugzilla server
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
            perceives him coming from) to change periodically. Since
            Bugzilla cookies are tied to a specific IP address, each time
            the effective address changes, the user will have to log in again.
          </para>
          <para>
            In newer versions of Bugzilla (2.17.1 and later) there is a
            parameter called "loginnetmask", which you can use to set the
            number of bits of the user's IP address to require to be matched
            when authenticating the cookies. If you set this to something less
            than 32, then the user will be given a checkbox for "Restrict this
            login to my IP address" on the login screen, which defaults to
            checked. If they leave the box checked, Bugzilla will behave the
            same as it did before, requiring an exact match on their IP address
            to remain logged in. If they uncheck the box, then only the left
            side of their IP address (up to the number of bits you specified in
            the parameter) has to match to remain logged in.
          </para>
        </answer>  
      </qandaentry>

710 711
    </qandadiv>

712
    <qandadiv id="faq-security">
713 714 715
      <title>Bugzilla Security</title>

      <qandaentry>
716
	<question id="faq-security-mysql">
717
	  <para>
718
	    How do I completely disable MySQL security if it's giving me problems
719
	    (I've followed the instructions in the installation section of this guide)?
720 721 722 723
	  </para>
	</question>
	<answer>
	  <para>
724
	    Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this
725
	    makes MySQL as secure as taping a $100 to the floor of a football stadium
726
	    bathroom for safekeeping.</emphasis> 
727 728 729 730 731
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
732
	<question id="faq-security-knownproblems">
733 734 735 736 737 738
	  <para>
	    Are there any security problems with Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
739 740 741
	    The Bugzilla code has undergone a reasonably complete security audit,
      and user-facing CGIs run under Perl's taint mode. However, 
	    it is recommended that you closely examine permissions on your Bugzilla
742 743
	    installation, and follow the recommended security guidelines found
	    in The Bugzilla Guide.
744 745 746 747 748
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

749
    <qandadiv id="faq-email">
750 751 752
      <title>Bugzilla Email</title>

      <qandaentry>
753
	<question id="faq-email-nomail">
754
	  <para>
755 756
	    I have a user who doesn't want to receive any more email from Bugzilla.
	    How do I stop it entirely for this user?
757 758 759 760
	  </para>
	</question>
	<answer>
	  <para>
761
	    The user should be able to set
762 763
	    this in user email preferences (uncheck all boxes) or you can add
            their email address to the <filename>data/nomail</filename> file.
764 765 766 767 768
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
769
	<question id="faq-email-testing">
770
	  <para>
771 772
	    I'm evaluating/testing Bugzilla, and don't want it to send email to
	    anyone but me. How do I do it?
773 774 775 776
	  </para>
	</question>
	<answer>
	  <para>
777
	    Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:",
778
	    replace "Cc:" with "X-Real-CC:", and add a "To: &lt;youremailaddress&gt;".
779 780 781 782 783
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
784
	<question id="faq-email-whine">
785
	  <para>
786 787
	    I want whineatnews.pl to whine at something other than new and
	    reopened bugs. How do I do it?
788 789 790 791
	  </para>
	</question>
	<answer>
	  <para>
792 793 794
	    Try Klaas Freitag's excellent patch for "whineatassigned"
            functionality. You can find it in <ulink
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=6679">bug 6679</ulink>. This
795 796
	    patch is against an older version of Bugzilla, so you must apply
	    the diffs manually.
797
            <!-- TODO: Mention Joel's "Fine Whine" patch. -->
798 799 800 801 802
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
803
	<question id="faq-email-mailif">
804
	  <para>
805
	    How do I set up the email interface to submit/change bugs via email?
806 807 808 809
	  </para>
	</question>
	<answer>
	  <para>
810 811
	    You can find an updated README.mailif file in the contrib/ directory
	    of your Bugzilla distribution that walks you through the setup.
812 813 814 815 816
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
817
	<question id="faq-email-sendmailnow">
818
	  <para>
819
	    Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
820
	    What gives?
821 822 823
	  </para>
	</question>
	<answer>
824 825 826 827 828
	  <para>
	    If you are using <application>sendmail</application>, try enabling
            <option>sendmailnow</option> in <filename>editparams.cgi</filename>.
            <!-- TODO provide more info about this, possibly a link to admin -->
	  </para>
829
	  <para>
830 831 832 833 834
	    If you are using an alternate <glossterm linkend="gloss-mta">MTA</glossterm>,
            make sure the options given in <filename>Bugzilla/BugMail.pm</filename>
            and any other place where <application>sendmail</application> is called from
	    are correct for your MTA. You should also ensure that the
            <option>sendmailnow</option> param is set to <literal>on</literal>.
835 836 837 838 839
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
840
	<question id="faq-email-nonreceived">
841
	  <para>
842
	     How come email from Bugzilla changes never reaches me?
843 844 845 846
	  </para>
	</question>
	<answer>
	  <para>
847 848 849 850
	    Double-check that you have not turned off email in your user preferences.
	    Confirm that Bugzilla is able to send email by visiting the "Log In"
	    link of your Bugzilla installation and clicking the "Email me a password"
	    button after entering your email address.
851 852
	  </para>
	  <para>
853
	    If you never receive mail from Bugzilla, chances are you do not have
854
	    sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
855
	    to, "/usr/lib/sendmail".
856 857 858 859 860
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

861
    <qandadiv id="faq-db">
862 863 864
      <title>Bugzilla Database</title>

      <qandaentry>
865
	<question id="faq-db-oracle">
866 867 868 869 870 871
	  <para>
	    I've heard Bugzilla can be used with Oracle?
	  </para>
	</question>
	<answer>
	  <para>
872 873
            Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle,
            but it is now so old as to be obsolete, and is totally unsupported.
874
            Red Hat's newer version (based on 2.17.1 and soon to be merged into
875
            the main distribution) runs on PostgreSQL. At this time we know of
876 877
            no recent ports of Bugzilla to Oracle; to be honest, Bugzilla
            doesn't need what Oracle offers.
878 879 880 881 882
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
883
	<question id="faq-db-corrupted">
884
	  <para>
885 886
	    I think my database might be corrupted, or contain invalid entries. What
	    do I do?
887 888 889 890
	  </para>
	</question>
	<answer>
	  <para>
891
	    Run the <quote>sanity check</quote> utility
892 893
	    (<filename>sanitycheck.cgi</filename>) from your web browser to see! 
      If it finishes without errors, you're
894
	    <emphasis>probably</emphasis> OK. If it doesn't come back
895
	    OK (i.e. any red letters), there are certain things
896
	    Bugzilla can recover from and certain things it can't. If
897 898
	    it can't auto-recover, I hope you're familiar with
	    mysqladmin commands or have installed another way to
899
	    manage your database. Sanity Check, although it is a good
900 901
	    basic check on your database integrity, by no means is a
	    substitute for competent database administration and
902
	    avoiding deletion of data. It is not exhaustive, and was
903 904
	    created to do a basic check for the most common problems
	    in Bugzilla databases.
905 906 907 908 909
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
910
	<question id="faq-db-manualedit">
911 912 913 914 915 916
	  <para>
	    I want to manually edit some entries in my database. How?
	  </para>
	</question>
	<answer>
	  <para>
917 918
	     There is no facility in Bugzilla itself to do this. It's also generally
	    not a smart thing to do if you don't know exactly what you're doing.
919 920
	    However, if you understand SQL you can use the <command>mysql</command>
            command line utility to manually insert, delete and modify table
921
            information. There are also more intuitive GUI clients available.
922 923 924 925
            Personal favorites of the Bugzilla team are <ulink
            url="http://www.phpmyadmin.net/">phpMyAdmin</ulink> and <ulink
            url="http://www.mysql.com/downloads/gui-mycc.html">MySQL Control
            Center</ulink>.
926 927 928 929 930
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
931
	<question id="faq-db-permissions">
932
	  <para>
933
	    I think I've set up MySQL permissions correctly, but Bugzilla still can't
934
	    connect.
935 936 937 938
	  </para>
	</question>
	<answer>
	  <para>
939 940
	    Try running MySQL from its binary: "mysqld --skip-grant-tables". This
	    will allow you to completely rule out grant tables as the cause of your
941 942 943 944 945 946 947 948 949 950 951
            frustration. If this Bugzilla is able to connect at this point then
            you need to check that you have granted proper permission to the user
            password combo defined in <filename>localconfig</filename>.
          </para>
          <warning>
            <para>
              Running MySQL with this command line option is very insecure and
              should only be done when not connected to the external network
              as a troubleshooting step.
            </para>
          </warning>
952 953 954 955
	</answer>
      </qandaentry>

      <qandaentry>
956
	<question id="faq-db-synchronize">
957
	  <para>
958 959
	    How do I synchronize bug information among multiple different Bugzilla
	    databases?
960 961 962 963
	  </para>
	</question>
	<answer>
	  <para>
964
	    Well, you can synchronize or you can move bugs. Synchronization will
965 966 967
	    only work one way -- you can create a read-only copy of the database
	    at one site, and have it regularly updated at intervals from the main
	    database.
968 969
	  </para>
	  <para>
970 971 972 973
	    MySQL has some synchronization features builtin to the latest releases.
	    It would be great if someone looked into the possibilities there
	    and provided a report to the newsgroup on how to effectively
	    synchronize two Bugzilla installations.
974 975
	  </para>
	  <para>
976 977
	    If you simply need to transfer bugs from one Bugzilla to another,
	    checkout the "move.pl" script in the Bugzilla distribution.
978 979 980 981 982
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

983
    <qandadiv id="faq-nt">
984 985 986
      <title>Bugzilla and Win32</title>

      <qandaentry>
987
	<question id="faq-nt-easiest">
988
	  <para>
989
	    What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
990 991 992 993
	  </para>
	</question>
	<answer>
	  <para>
994 995
	    Remove Windows. Install Linux. Install Bugzilla.
	    The boss will never know the difference.
996 997 998 999 1000
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1001
	<question id="faq-nt-bundle">
1002 1003 1004 1005 1006 1007
	  <para>
	    Is there a "Bundle::Bugzilla" equivalent for Win32?
	  </para>
	</question>
	<answer>
	  <para>
1008 1009
	    Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
	    installation on UNIX systems. If someone can volunteer to
1010
	    create a suitable PPM bundle for Win32, it would be appreciated.
1011 1012 1013 1014 1015
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1016
	<question id="faq-nt-mappings">
1017
	  <para>
1018 1019
	    CGI's are failing with a "something.cgi is not a valid Windows NT
	    application" error. Why?
1020 1021 1022 1023
	  </para>
	</question>
	<answer>
	  <para>
1024 1025 1026
	    Depending on what Web server you are using, you will have to configure
	    the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by
	    adding *.cgi to the App Mappings with the &lt;path&gt;\perl.exe %s %s as the
1027 1028 1029 1030 1031 1032
	    executable.
	  </para>
	  <para>
	    Microsoft has some advice on this matter, as well:
	    <blockquote>
	      <para>
1033 1034 1035 1036 1037 1038 1039 1040
		"Set application mappings. In the ISM, map the extension for the script
		file(s) to the executable for the script interpreter. For example, you might
		map the extension .py to Python.exe, the executable for the Python script
		interpreter. Note For the ActiveState Perl script interpreter, the extension
		.pl is associated with PerlIS.dll by default. If you want to change the
		association of .pl to perl.exe, you need to change the application mapping.
		In the mapping, you must add two percent (%) characters to the end of the
		pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s"
1041 1042 1043 1044 1045 1046
	      </para>
	    </blockquote>
	  </para>
	</answer>
      </qandaentry>

1047
      <qandaentry>
1048
	<question id="faq-nt-dbi">
1049 1050 1051
	  <para>
	    I'm having trouble with the perl modules for NT not being able to talk to
	    to the database.
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
	  </para>
	</question>
	<answer>
	  <para>
	    Your modules may be outdated or inaccurate. Try:
	    <orderedlist>
	      <listitem>
		<para>
		  Hitting http://www.activestate.com/ActivePerl
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Download ActivePerl
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Go to your prompt
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Type 'ppm'
		</para>
	      </listitem>
	      <listitem>
		<para>
1080
		  <prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command>
1081 1082
		</para>
	      </listitem>
1083 1084 1085
	    </orderedlist>
	    I reckon TimeDate and Data::Dumper come with the activeperl. You can check
	    the ActiveState site for packages for installation through PPM.
1086
	    <ulink url="http://www.activestate.com/Packages/"/>.
1087 1088 1089 1090 1091 1092
	  </para>
	</answer>
      </qandaentry>

    </qandadiv>

1093
    <qandadiv id="faq-use">
1094 1095
      <title>Bugzilla Usage</title>

1096
      <qandaentry>
1097
	<question id="faq-use-changeaddress">
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
	  <para>
	    How do I change my user name (email address) in Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
	    New in 2.16 - go to the Account section of the Preferences. You will
      be emailed at both addresses for confirmation.
	  </para>
	</answer>
      </qandaentry>

1110
      <qandaentry>
1111
	<question id="faq-use-query">
1112
	  <para>
1113
	    The query page is very confusing. Isn't there a simpler way to query?
1114 1115 1116 1117
	  </para>
	</question>
	<answer>
	  <para>
1118 1119 1120
	    The interface was simplified by a UI designer for 2.16. Further
      suggestions for improvement are welcome, but we won't sacrifice power for
      simplicity.
1121 1122 1123 1124 1125
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1126
	<question id="faq-use-accept">
1127
	  <para>
1128 1129
	    I'm confused by the behavior of the "accept" button in the Show Bug form.
	    Why doesn't it assign the bug to me when I accept it?
1130 1131 1132 1133
	  </para>
	</question>
	<answer>
	  <para>
1134
	    The current behavior is acceptable to bugzilla.mozilla.org and most
1135
	    users. You have your choice of patches to change this behavior, however.
1136
	    <simplelist>
1137 1138 1139 1140 1141
	      <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">
		Add a "and accept bug" radio button</ulink></member>
	      <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153">
		"Accept" button automatically assigns to you</ulink></member>
	    </simplelist>
1142 1143
	    Note that these patches are somewhat dated. You will need to apply
      them manually.
1144 1145 1146 1147 1148
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1149
	<question id="faq-use-attachment">
1150
	  <para>
1151
	    I can't upload anything into the database via the "Create Attachment"
1152
	    link. What am I doing wrong?
1153 1154 1155 1156
	  </para>
	</question>
	<answer>
	  <para>
1157
	    The most likely cause is a very old browser or a browser that is
1158
	    incompatible with file upload via POST. Download the latest Netscape,
1159
	    Microsoft, or Mozilla browser to handle uploads correctly.
1160 1161 1162 1163 1164
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1165
	<question id="faq-use-keyword">
1166
	  <para>
1167
	    How do I change a keyword in Bugzilla, once some bugs are using it?
1168 1169 1170 1171
	  </para>
	</question>
	<answer>
	  <para>
1172
	    In the Bugzilla administrator UI, edit the keyword and it will let you
1173 1174
	    replace the old keyword name with a new one. This will cause a problem
	    with the keyword cache. Run sanitycheck.cgi to fix it.
1175 1176 1177 1178
	  </para>
	</answer>
      </qandaentry>

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
      <qandaentry>
    <question id="faq-use-close">
      <para>
        Why can't I close bugs from the "Change Several Bugs at Once" page?
      </para>
    </question>
    <answer>
      <para>
        The logic flow currently used is RESOLVED, then VERIFIED, then CLOSED.
        You <emphasis>can</emphasis> mass-CLOSE bugs from the change several
        bugs at once page. <emphasis>but</emphasis>, every bug listed on the
        page has to be in VERIFIED state before the control to do it will show
        up on the form. You can also mass-VERIFY, but every bug listed has to be
        RESOLVED in order for the control to show up on the form. The logic
        behind this is that if you pick one of the bugs that's not VERIFIED and
        try to CLOSE it, the bug change will fail miserably (thus killing any
        changes in the list after it while doing the bulk change) so it doesn't
        even give you the choice.
      </para>
    </answer>
      </qandaentry>


1202 1203
    </qandadiv>

1204
    <qandadiv id="faq-hacking">
1205 1206
      <title>Bugzilla Hacking</title>

1207
      <qandaentry>
1208
        <question id="faq-hacking-templatestyle">
1209 1210 1211 1212 1213 1214
	  <para>
	    What kind of style should I use for templatization?
	  </para>
	</question>
	<answer>
	  <para>
1215
	    Gerv and Myk suggest a 2-space indent, with embedded code sections on
1216
	    their own line, in line with outer tags. Like this:</para>
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
	    <programlisting><![CDATA[
<fred>
[% IF foo %]
  <bar>
  [% FOREACH x = barney %]
    <tr>
      <td>
        [% x %]
      </td>
    <tr>
  [% END %]
[% END %]
</fred>
]]></programlisting>

	<para> Myk also recommends you turn on PRE_CHOMP in the template
	initialization to prevent bloating of HTML with unnecessary whitespace.
	</para>

	<para>Please note that many have differing opinions on this subject,
	and the existing templates in Bugzilla espouse both this and a 4-space
1238
	style. Either is acceptable; the above is preferred.</para>
1239 1240 1241
	</answer>
      </qandaentry>

1242
      <qandaentry>
1243
	<question id="faq-hacking-bugzillabugs">
1244 1245 1246 1247 1248 1249
	  <para>
	    What bugs are in Bugzilla right now?
	  </para>
	</question>
	<answer>
	  <para>
1250
	    Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
1251 1252
	    this link</ulink> to view current bugs or requests for
	    enhancement for Bugzilla.
1253 1254
	  </para>
	  <para>
1255 1256 1257
	    You can view bugs marked for &bz-nextver; release
	    <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+&bz-nextver;">here</ulink>.
	    This list includes bugs for the &bz-nextver; release that have already
1258
	    been fixed and checked into CVS. Please consult the
1259
	    <ulink url="http://www.bugzilla.org/">
1260 1261 1262
	      Bugzilla Project Page</ulink> for details on how to
	    check current sources out of CVS so you can have these
	    bug fixes early!
1263 1264 1265 1266
	  </para>
	</answer>
      </qandaentry>

1267
      <qandaentry>
1268
	<question id="faq-hacking-priority">
1269
	  <para>
1270 1271
	    How can I change the default priority to a null value?  For instance, have the default
	    priority be "---" instead of "P2"?
1272 1273 1274 1275
	  </para>
	</question>
	<answer>
	  <para>
1276 1277 1278 1279
	    This is well-documented in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862">
	    bug 49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your
            localconfig file in the appropriate area, re-running checksetup.pl, and then changing the
            default priority in your browser using "editparams.cgi". 
1280 1281 1282 1283
	  </para>
	</answer>
      </qandaentry>

1284
      <qandaentry>
1285
	<question id="faq-hacking-patches">
1286
	  <para>
1287
	    What's the best way to submit patches?  What guidelines should I follow?
1288 1289 1290 1291 1292 1293 1294
	  </para>
	</question>
	<answer>
	  <blockquote>
	    <orderedlist>
	      <listitem>
		<para>
1295 1296 1297
		  Enter a bug into bugzilla.mozilla.org for the <quote><ulink
                  url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
                  product.
1298 1299 1300 1301
		</para>
	      </listitem>
	      <listitem>
		<para>
1302
		  Upload your patch as a unified diff (having used "diff -u" against
1303 1304 1305 1306
		  the <emphasis>current sources</emphasis> checked out of CVS),
		  or new source file by clicking
		  "Create a new attachment" link on the bug page you've just created, and
		  include any descriptions of database changes you may make, into the bug
1307
		  ID you submitted in step #1. Be sure and click the "Patch" checkbox
1308
		  to indicate the text you are sending is a patch!
1309 1310 1311 1312 1313
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Announce your patch and the associated URL
1314
		  (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for discussion in
1315
		  the newsgroup (netscape.public.mozilla.webtools). You'll get a really
1316 1317 1318
		  good, fairly immediate reaction to the implications of your patch,
		  which will also give us an idea how well-received the change would
		  be.
1319 1320 1321 1322
		</para>
	      </listitem>
	      <listitem>
		<para>
1323 1324 1325
		  If it passes muster with minimal modification, the person to whom
		  the bug is assigned in Bugzilla is responsible for seeing the patch
		  is checked into CVS.
1326 1327 1328 1329
		</para>
	      </listitem>
	      <listitem>
		<para>
1330 1331
		  Bask in the glory of the fact that you helped write the most successful
		  open-source bug-tracking software on the planet :)
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
		</para>
	      </listitem>
	    </orderedlist>
	  </blockquote>
	</answer>
      </qandaentry>


    </qandadiv>

  </qandaset>

1344
</appendix>
1345 1346 1347 1348 1349 1350


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
1351 1352
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
1353
sgml-exposed-tags:nil
1354 1355 1356
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
1357 1358
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
1359 1360 1361
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
1362
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
1363 1364
sgml-shorttag:t
sgml-tag-region-if-active:t
1365 1366
End:
-->