<HTML
><HEAD
><TITLE
>The Bugzilla Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"><META
NAME="KEYWORD"
CONTENT="Bugzilla"><META
NAME="KEYWORD"
CONTENT="Guide"><META
NAME="KEYWORD"
CONTENT="installation"><META
NAME="KEYWORD"
CONTENT="FAQ"><META
NAME="KEYWORD"
CONTENT="administration"><META
NAME="KEYWORD"
CONTENT="integration"><META
NAME="KEYWORD"
CONTENT="MySQL"><META
NAME="KEYWORD"
CONTENT="Mozilla"><META
NAME="KEYWORD"
CONTENT="webtools"></HEAD
><BODY
CLASS="BOOK"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="BOOK"
><A
NAME="INDEX"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="AEN2"
>The Bugzilla Guide</A
></H1
><H3
CLASS="AUTHOR"
><A
NAME="AEN5"
>Matthew P. Barnson</A
></H3
><DIV
CLASS="AFFILIATION"
><DIV
CLASS="ADDRESS"
><P
CLASS="ADDRESS"
>barnboy@trilobyte.net</P
></DIV
></DIV
><DIV
CLASS="REVHISTORY"
><TABLE
WIDTH="100%"
BORDER="0"
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
COLSPAN="3"
><B
>Revision History</B
></TH
></TR
><TR
><TD
ALIGN="LEFT"
>Revision v2.11</TD
><TD
ALIGN="LEFT"
>20 December 2000</TD
><TD
ALIGN="LEFT"
>Revised by: MPB</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Converted the README, FAQ, and DATABASE information into SGML
docbook format.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 2.11.1</TD
><TD
ALIGN="LEFT"
>06 March 2001</TD
><TD
ALIGN="LEFT"
>Revised by: MPB</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Took way too long to revise this for 2.12 release.
Updated FAQ to use qandaset tags instead of literallayout,
cleaned up administration section, added User Guide section,
miscellaneous FAQ updates and third-party integration information.
From this point on all new tags are lowercase in preparation for the
2.13 release of the Guide in XML format instead of SGML.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 2.12.0</TD
><TD
ALIGN="LEFT"
>24 April 2001</TD
><TD
ALIGN="LEFT"
>Revised by: MPB</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Things fixed this release: Elaborated on queryhelp interface, added FAQ regarding
moving bugs from one keyword to another, clarified possible problems with the Landfill
tutorial, fixed a boatload of typos and unclear sentence structures. Incorporated the
README into the UNIX installation section, and changed the README to indicate the deprecated
status. Things I know need work: Used "simplelist" a lot, where I should have used
"procedure" to tag things. Need to lowercase all tags to be XML compliant.</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="ABSTRACT"
><A
NAME="AEN12"
></A
><P
></P
><P
>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</P
><P
></P
></DIV
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="#ABOUT"
>About This Guide</A
></DT
><DD
><DL
><DT
>1.1. <A
HREF="#ABOUTTHISGUIDE"
>Purpose and Scope of this Guide</A
></DT
><DT
>1.2. <A
HREF="#COPYRIGHT"
>Copyright Information</A
></DT
><DT
>1.3. <A
HREF="#DISCLAIMER"
>Disclaimer</A
></DT
><DT
>1.4. <A
HREF="#NEWVERSIONS"
>New Versions</A
></DT
><DT
>1.5. <A
HREF="#CREDITS"
>Credits</A
></DT
><DT
>1.6. <A
HREF="#CONTRIBUTORS"
>Contributors</A
></DT
><DT
>1.7. <A
HREF="#FEEDBACK"
>Feedback</A
></DT
><DT
>1.8. <A
HREF="#TRANSLATIONS"
>Translations</A
></DT
><DT
>1.9. <A
HREF="#CONVENTIONS"
>Document Conventions</A
></DT
></DL
></DD
><DT
>2. <A
HREF="#INSTALLATION"
>Installing Bugzilla</A
></DT
><DD
><DL
><DT
>2.1. <A
HREF="#README.UNIX"
>UNIX Installation</A
></DT
><DD
><DL
><DT
>2.1.1. <A
HREF="#AEN190"
>ERRATA</A
></DT
><DT
>2.1.2. <A
HREF="#AEN204"
>Step-by-step Install</A
></DT
><DD
><DL
><DT
>2.1.2.1. <A
HREF="#AEN206"
>Introduction</A
></DT
><DT
>2.1.2.2. <A
HREF="#AEN211"
>Installing the Prerequisites</A
></DT
><DT
>2.1.2.3. <A
HREF="#AEN242"
>Installing MySQL Database</A
></DT
><DT
>2.1.2.4. <A
HREF="#AEN248"
>Perl (5.004 or greater)</A
></DT
><DT
>2.1.2.5. <A
HREF="#AEN259"
>DBI Perl Module</A
></DT
><DT
>2.1.2.6. <A
HREF="#AEN296"
>Data::Dumper Perl Module</A
></DT
><DT
>2.1.2.7. <A
HREF="#AEN300"
>MySQL related Perl Module Collection</A
></DT
><DT
>2.1.2.8. <A
HREF="#AEN309"
>TimeDate Perl Module Collection</A
></DT
><DT
>2.1.2.9. <A
HREF="#AEN312"
>GD Perl Module (1.8.3)</A
></DT
><DT
>2.1.2.10. <A
HREF="#AEN318"
>Chart::Base Perl Module (0.99c)</A
></DT
><DT
>2.1.2.11. <A
HREF="#AEN321"
>DB_File Perl Module</A
></DT
><DT
>2.1.2.12. <A
HREF="#AEN324"
>HTTP Server</A
></DT
><DT
>2.1.2.13. <A
HREF="#AEN334"
>Installing the Bugzilla Files</A
></DT
><DT
>2.1.2.14. <A
HREF="#AEN347"
>Setting Up the MySQL Database</A
></DT
><DT
>2.1.2.15. <A
HREF="#AEN383"
>Tweaking "localconfig"</A
></DT
><DT
>2.1.2.16. <A
HREF="#AEN410"
>Setting Up Maintainers Manually (Optional)</A
></DT
><DT
>2.1.2.17. <A
HREF="#AEN419"
>The Whining Cron (Optional)</A
></DT
><DT
>2.1.2.18. <A
HREF="#AEN426"
>Bug Graphs (Optional)</A
></DT
><DT
>2.1.2.19. <A
HREF="#AEN438"
>Securing MySQL</A
></DT
><DT
>2.1.2.20. <A
HREF="#AEN504"
>Installation General Notes</A
></DT
></DL
></DD
></DL
></DD
><DT
>2.2. <A
HREF="#README.WINDOWS"
>Win32 (Win98+/NT/2K) Installation</A
></DT
><DD
><DL
><DT
>2.2.1. <A
HREF="#NTVERIFIED"
>Win32 Installation: Step-by-step</A
></DT
><DT
>2.2.2. <A
HREF="#ADDLWINTIPS"
>Additional Windows Tips</A
></DT
></DL
></DD
></DL
></DD
><DT
>3. <A
HREF="#ADMINISTRATION"
>Administering Bugzilla</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="#POSTINSTALL-CHECK"
>Post-Installation Checklist</A
></DT
><DT
>3.2. <A
HREF="#USERADMIN"
>User Administration</A
></DT
><DD
><DL
><DT
>3.2.1. <A
HREF="#DEFAULTUSER"
>Creating the Default User</A
></DT
><DT
>3.2.2. <A
HREF="#MANAGEUSERS"
>Managing Other Users</A
></DT
><DD
><DL
><DT
>3.2.2.1. <A
HREF="#LOGIN"
>Logging In</A
></DT
><DT
>3.2.2.2. <A
HREF="#CREATENEWUSERS"
>Creating new users</A
></DT
><DT
>3.2.2.3. <A
HREF="#DISABLEUSERS"
>Disabling Users</A
></DT
><DT
>3.2.2.4. <A
HREF="#MODIFYUSERS"
>Modifying Users</A
></DT
></DL
></DD
></DL
></DD
><DT
>3.3. <A
HREF="#PROGRAMADMIN"
>Product, Component, Milestone, and Version Administration</A
></DT
><DD
><DL
><DT
>3.3.1. <A
HREF="#PRODUCTS"
>Products</A
></DT
><DT
>3.3.2. <A
HREF="#COMPONENTS"
>Components</A
></DT
><DT
>3.3.3. <A
HREF="#VERSIONS"
>Versions</A
></DT
><DT
>3.3.4. <A
HREF="#MILESTONES"
>Milestones</A
></DT
><DT
>3.3.5. <A
HREF="#VOTING"
>Voting</A
></DT
><DT
>3.3.6. <A
HREF="#GROUPS"
>Groups and Group Security</A
></DT
></DL
></DD
><DT
>3.4. <A
HREF="#SECURITY"
>Bugzilla Security</A
></DT
></DL
></DD
><DT
>4. <A
HREF="#USING"
>Using Bugzilla</A
></DT
><DD
><DL
><DT
>4.1. <A
HREF="#WHATIS"
>What is Bugzilla?</A
></DT
><DT
>4.2. <A
HREF="#WHY"
>Why Should We Use Bugzilla?</A
></DT
><DT
>4.3. <A
HREF="#HOW"
>How do I use Bugzilla?</A
></DT
><DD
><DL
><DT
>4.3.1. <A
HREF="#MYACCOUNT"
>Create a Bugzilla Account</A
></DT
><DT
>4.3.2. <A
HREF="#QUERY"
>The Bugzilla Query Page</A
></DT
><DT
>4.3.3. <A
HREF="#BUGREPORTS"
>Creating and Managing Bug Reports</A
></DT
><DD
><DL
><DT
>4.3.3.1. <A
HREF="#BUG_WRITING"
>Writing a Great Bug Report</A
></DT
><DT
>4.3.3.2. <A
HREF="#BUG_MANAGE"
>Managing your Bug Reports</A
></DT
></DL
></DD
></DL
></DD
><DT
>4.4. <A
HREF="#INIT4ME"
>What's in it for me?</A
></DT
><DD
><DL
><DT
>4.4.1. <A
HREF="#ACCOUNTSETTINGS"
>Account Settings</A
></DT
><DT
>4.4.2. <A
HREF="#EMAILSETTINGS"
>Email Settings</A
></DT
><DD
><DL
><DT
>4.4.2.1. <A
HREF="#NOTIFICATION"
>Email Notification</A
></DT
><DT
>4.4.2.2. <A
HREF="#NEWEMAILTECH"
>New Email Technology</A
></DT
><DT
>4.4.2.3. <A
HREF="#WATCHSETTINGS"
>"Watching" Users</A
></DT
></DL
></DD
><DT
>4.4.3. <A
HREF="#FOOTERSETTINGS"
>Page Footer</A
></DT
><DT
>4.4.4. <A
HREF="#PERMISSIONSETTINGS"
>Permissions</A
></DT
></DL
></DD
><DT
>4.5. <A
HREF="#USINGBZ-CONC"
>Using Bugzilla-Conclusion</A
></DT
></DL
></DD
><DT
>5. <A
HREF="#INTEGRATION"
>Integrating Bugzilla with Third-Party Tools</A
></DT
><DD
><DL
><DT
>5.1. <A
HREF="#BONSAI"
>Bonsai</A
></DT
><DT
>5.2. <A
HREF="#CVS"
>CVS</A
></DT
><DT
>5.3. <A
HREF="#SCM"
>Perforce SCM</A
></DT
><DT
>5.4. <A
HREF="#TINDERBOX"
>Tinderbox</A
></DT
></DL
></DD
><DT
>6. <A
HREF="#FUTURE"
>The Future of Bugzilla</A
></DT
><DD
><DL
><DT
>6.1. <A
HREF="#SPAMLITE"
>Reducing Spam</A
></DT
><DT
>6.2. <A
HREF="#SEARCHING"
>Better Searching</A
></DT
><DT
>6.3. <A
HREF="#TRACKINGBUGS"
>Description Flags and Tracking Bugs</A
></DT
><DT
>6.4. <A
HREF="#BUGPROBS"
>Bug Issues</A
></DT
><DT
>6.5. <A
HREF="#DBASEINTEGRITY"
>Database Integrity</A
></DT
><DT
>6.6. <A
HREF="#BZ30"
>Bugzilla 3.0</A
></DT
></DL
></DD
><DT
>A. <A
HREF="#FAQ"
>The Bugzilla FAQ</A
></DT
><DT
>B. <A
HREF="#DOWNLOADLINKS"
>Software Download Links</A
></DT
><DT
>C. <A
HREF="#DATABASE"
>The Bugzilla Database</A
></DT
><DD
><DL
><DT
>C.1. <A
HREF="#DBSCHEMA"
>Database Schema Chart</A
></DT
><DT
>C.2. <A
HREF="#DBDOC"
>MySQL Bugzilla Database Introduction</A
></DT
><DT
>C.3. <A
HREF="#GRANTTABLES"
>MySQL Permissions & Grant Tables</A
></DT
><DT
>C.4. <A
HREF="#CLEANUPWORK"
>Cleaning up after mucking with Bugzilla</A
></DT
></DL
></DD
><DT
>7. <A
HREF="#VARIANTS"
>Bugzilla Variants</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="#RHBUGZILLA"
>Red Hat Bugzilla</A
></DT
></DL
></DD
><DT
>D. <A
HREF="#PATCHES"
>Useful Patches and Utilities for Bugzilla</A
></DT
><DD
><DL
><DT
>D.1. <A
HREF="#SETPERL"
>The setperl.csh Utility</A
></DT
><DT
>D.2. <A
HREF="#CMDLINE"
>Command-line Bugzilla Queries</A
></DT
><DT
>D.3. <A
HREF="#QUICKSEARCH"
>The Quicksearch Utility</A
></DT
></DL
></DD
><DT
>E. <A
HREF="#GFDL"
>GNU Free Documentation License</A
></DT
><DD
><DL
><DT
>0. <A
HREF="#GFDL_0"
>PREAMBLE</A
></DT
><DT
>1. <A
HREF="#GFDL_1"
>APPLICABILITY AND DEFINITIONS</A
></DT
><DT
>2. <A
HREF="#GFDL_2"
>VERBATIM COPYING</A
></DT
><DT
>3. <A
HREF="#GFDL_3"
>COPYING IN QUANTITY</A
></DT
><DT
>4. <A
HREF="#GFDL_4"
>MODIFICATIONS</A
></DT
><DT
>5. <A
HREF="#GFDL_5"
>COMBINING DOCUMENTS</A
></DT
><DT
>6. <A
HREF="#GFDL_6"
>COLLECTIONS OF DOCUMENTS</A
></DT
><DT
>7. <A
HREF="#GFDL_7"
>AGGREGATION WITH INDEPENDENT WORKS</A
></DT
><DT
>8. <A
HREF="#GFDL_8"
>TRANSLATION</A
></DT
><DT
>9. <A
HREF="#GFDL_9"
>TERMINATION</A
></DT
><DT
>10. <A
HREF="#GFDL_10"
>FUTURE REVISIONS OF THIS LICENSE</A
></DT
><DT
><A
HREF="#GFDL_HOWTO"
>How to use this License for your documents</A
></DT
></DL
></DD
><DT
><A
HREF="#GLOSSARY"
>Glossary</A
></DT
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Examples</B
></DT
><DT
>2-1. <A
HREF="#AEN341"
>Setting up bonsaitools symlink</A
></DT
><DT
>2-2. <A
HREF="#AEN403"
>Running checksetup.pl as the web user</A
></DT
><DT
>2-3. <A
HREF="#AEN655"
>Removing encrypt() for Windows NT installations</A
></DT
><DT
>3-1. <A
HREF="#AEN850"
>Creating some Components</A
></DT
><DT
>3-2. <A
HREF="#AEN879"
>Common Use of Versions</A
></DT
><DT
>3-3. <A
HREF="#AEN883"
>A Different Use of Versions</A
></DT
><DT
>3-4. <A
HREF="#AEN911"
>Using SortKey with Target Milestone</A
></DT
><DT
>3-5. <A
HREF="#AEN949"
>When to Use Group Security</A
></DT
><DT
>3-6. <A
HREF="#AEN966"
>Creating a New Group</A
></DT
><DT
>4-1. <A
HREF="#AEN1112"
>Some Famous Software Versions</A
></DT
><DT
>4-2. <A
HREF="#AEN1122"
>Mozilla Webtools Components</A
></DT
><DT
>D-1. <A
HREF="#AEN1986"
>Using Setperl to set your perl path</A
></DT
><DT
>1. <A
HREF="#AEN2168"
>A Sample Product</A
></DT
></DL
></DIV
>] >
<DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="ABOUT"
>Chapter 1. About This Guide</A
></H1
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="ABOUTTHISGUIDE"
>1.1. Purpose and Scope of this Guide</A
></H1
><P
> This document was started on September 17, 2000
by Matthew P. Barnson after a great deal of procrastination updating the Bugzilla FAQ,
which I left untouched for nearly half a year.
After numerous complete rewrites and reformatting, it is the document you see today.
</P
><P
> Despite the lack of updates, Bugzilla is simply the best piece of bug-tracking software
the world has ever seen. This document is intended to be the comprehensive guide to
the installation, administration, maintenance, and use of the Bugzilla bug-tracking system.
</P
><P
> This release of the Bugzilla Guide is the <EM
>2.11</EM
> release.
It is so named that it may match the current version of Bugzilla.
The numbering tradition stems from that used for many free software projects,
in which <EM
>even-numbered</EM
> point releases (1.2, 1.14, etc.)
are considered "stable releases", intended for public consumption; on the other
hand, <EM
>odd-numbered</EM
> point releases (1.3, 2.09, etc.)
are considered unstable <EM
>development</EM
> releases intended
for advanced users, systems administrators, developers, and those who enjoy
a lot of pain.
</P
><P
> Newer revisions of the Bugzilla Guide will follow the numbering conventions of
the main-tree Bugzilla releases, available at
<A
HREF="http://www.mozilla.org/bugs/source.html"
TARGET="_top"
>Mozilla.org</A
>, with
the exception that intermediate releases will have a minor revision number
following a period. For instance, if the current version of Bugzilla is 4.2,
the current "stable" version of the Bugzilla guide, in, say, it's fifth revision,
would be numbered "4.2.5". Got it? Good.
</P
><P
> I wrote this in response to the enormous demand for decent Bugzilla documentation.
I have incorporated instructions from the Bugzilla README, Frequently Asked Questions,
Database Schema Document, and various mailing lists to create it.
Chances are, there are glaring errors in this documentation; please contact
<TT
CLASS="EMAIL"
><<A
HREF="mailto:barnboy@trilobyte.net"
>barnboy@trilobyte.net</A
>></TT
> to correct them.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="COPYRIGHT"
>1.2. Copyright Information</A
></H1
><A
NAME="AEN57"
></A
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="BLOCKQUOTE"
><TR
><TD
WIDTH="10%"
VALIGN="TOP"
> </TD
><TD
WIDTH="80%"
VALIGN="TOP"
><P
> Permission is granted to copy, distribute and/or modify this document under thei
terms of the GNU Free Documentation License, Version 1.1 or any later version published
by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and
with no Back-Cover Texts. A copy of the license is included in the section entitled
"GNU Free Documentation LIcense".
</P
></TD
><TD
WIDTH="10%"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="RIGHT"
VALIGN="TOP"
>--<SPAN
CLASS="ATTRIBUTION"
>Copyright (c) 2000-2001 Matthew P. Barnson</SPAN
></TD
><TD
WIDTH="10%"
> </TD
></TR
></TABLE
><P
> If you have any questions regarding this document, its' copyright, or publishing this
document in non-electronic form, please contact <TT
CLASS="EMAIL"
><<A
HREF="mailto:barnboy@trilobyte.net"
>barnboy@trilobyte.net</A
>></TT
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="DISCLAIMER"
>1.3. Disclaimer</A
></H1
><P
> No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
As this is a new edition of this document, there may be errors
and inaccuracies that may damage your system. Use of this document
may cause your girlfriend to leave you, your cats to pee on your
furniture and clothing, your computer to cease functioning, your
boss to fire you, and global thermonuclear war. Proceed with caution.
</P
><P
> All copyrights are held by their respective owners, unless specifically
noted otherwise. Use of a term in this document should not be regarded
as affecting the validity of any trademark or service mark.
In particular, I like to put down Microsoft(tm). Live with it.
</P
><P
> Naming of particular products or brands should not be seen as endorsements,
with the exception of the term "GNU/Linux".
Use GNU/Linux. Love it. Bathe with it. It is life and happiness.
I endorse it wholeheartedly and encourage you to do the same.
</P
><P
> You are strongly recommended to make a backup of your system before
installing Bugzilla and at regular intervals thereafter. Heaven knows
it's saved my bacon time after time; if you implement any suggestion in
this Guide, implement this one!
</P
><P
> Bugzilla has not undergone a complete security review.
Security holes probably exist in the code.
Great care should be taken both in the installation and usage of this software.
Carefully consider the implications of installing other network services with Bugzilla.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="NEWVERSIONS"
>1.4. New Versions</A
></H1
><P
> This is the initial release of the Bugzilla Guide.
</P
><P
> This document can be found in the following places:
</P
><P
> <P
></P
><UL
><LI
><P
> <A
HREF="http://www.trilobyte.net/barnsons/"
TARGET="_top"
>TriloBYTE</A
>
</P
></LI
><LI
><P
> <A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
>Mozilla.org</A
>
</P
></LI
><LI
><P
> <A
HREF="http://www.linuxdoc.org/"
TARGET="_top"
>The Linux Documentation Project</A
>
</P
></LI
></UL
>
</P
><P
> The latest version of this document can be checked out via CVS.
Please follow the instructions available at
<A
HREF="http://www.mozilla.org/cvs.html"
TARGET="_top"
>the Mozilla CVS page</A
>,
and check out the mozilla/webtools/bugzilla/docs/ branch.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CREDITS"
>1.5. Credits</A
></H1
><P
> The people listed below have made enormous contributions to the creation
of this Guide, through their dedicated hacking efforts,
numerous e-mail and IRC support sessions,
and overall excellent contribution to the Bugzilla community:
</P
><P
> <A
HREF="mailto://terry@mozilla.org"
TARGET="_top"
>Terry Weissman</A
>
for initially converting Bugzilla from BugSplat!
and writing the README upon which this documentation is largely based.
</P
><P
> <A
HREF="mailto://tara@tequilarista.org"
TARGET="_top"
>Tara Hernandez</A
>
for keeping Bugzilla development going strong after Terry left Mozilla.org
</P
><P
> <A
HREF="mailto://dkl@redhat.com"
TARGET="_top"
>Dave Lawrence</A
>
for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the
"Red Hat Bugzilla" appendix
</P
><P
> <A
HREF="mailto://endico@mozilla.org"
TARGET="_top"
>Dawn Endico</A
>
for being a hacker extraordinaire and putting up with my incessant
questions and arguments on irc.mozilla.org in #mozwebtools
</P
><P
> Last but not least, all the members of the
<A
HREF="news://news.mozilla.org/netscape/public/mozilla/webtools"
TARGET="_top"
> netscape.public.mozilla.webtools</A
> newsgroup. Without your
discussions, insight, suggestions, and patches, this could never have happened.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CONTRIBUTORS"
>1.6. Contributors</A
></H1
><P
> Thanks go to these people for significant contributions
to this documentation (in no particular order):
</P
><P
> Zach Lipton (significant textual contributions),
Andrew Pearson,
Spencer Smith,
Eric Hanson,
Kevin Brannen,
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="FEEDBACK"
>1.7. Feedback</A
></H1
><P
> I welcome feedback on this document. Without your submissions and input,
this Guide cannot continue to exist. Please mail additions, comments, criticisms, etc.
to <TT
CLASS="EMAIL"
><<A
HREF="mailto:barnboy@trilobyte.net"
>barnboy@trilobyte.net</A
>></TT
>. Please send flames to
<TT
CLASS="EMAIL"
><<A
HREF="mailto:devnull@localhost"
>devnull@localhost</A
>></TT
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="TRANSLATIONS"
>1.8. Translations</A
></H1
><P
> The Bugzilla Guide needs translators!
Please volunteer your translation into the language of your choice.
If you will translate this Guide, please notify the members of the mozilla-webtools mailing list at
<TT
CLASS="EMAIL"
><<A
HREF="mailto:mozilla-webtools@mozilla.org"
>mozilla-webtools@mozilla.org</A
>></TT
>. Since The Bugzilla Guide is also hosted on the
Linux Documentation Project, you would also do well to notify
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CONVENTIONS"
>1.9. Document Conventions</A
></H1
><P
> This document uses the following conventions
</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN117"
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
>Descriptions</TH
><TH
ALIGN="LEFT"
VALIGN="TOP"
>Appearance</TH
></TR
></THEAD
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Warnings</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Caution</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>Warnings.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Hint</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
>Hint.</P
></BLOCKQUOTE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Notes</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Note.</P
></BLOCKQUOTE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Information requiring special attention</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>Warning.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>File Names</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>file.extension</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Directory Names</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>directory</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Commands to be typed</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><B
CLASS="COMMAND"
>command</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Applications Names</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><SPAN
CLASS="APPLICATION"
>application</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><I
CLASS="FOREIGNPHRASE"
>Prompt</I
> of users command under bash shell</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>bash$</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><I
CLASS="FOREIGNPHRASE"
>Prompt</I
> of root users command under bash shell</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>bash#</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><I
CLASS="FOREIGNPHRASE"
>Prompt</I
> of user command under tcsh shell</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>tcsh$</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Environment Variables</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="ENVAR"
>VARIABLE</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Emphasized word</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><EM
>word</EM
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Code Example</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><TT
CLASS="SGMLTAG"
><para></TT
>Beginning and end of paragraph<TT
CLASS="SGMLTAG"
></para></TT
></PRE
></TD
></TR
></TABLE
></TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="INSTALLATION"
>Chapter 2. Installing Bugzilla</A
></H1
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="README.UNIX"
>2.1. UNIX Installation</A
></H1
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN190"
>2.1.1. ERRATA</A
></H2
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> If you are installing Bugzilla on S.u.S.e. Linux, or some other
distributions with "paranoid" security options, it is possible
that the checksetup.pl script may fail with the error:
<SPAN
CLASS="ERRORNAME"
>cannot chdir(/var/spool/mqueue): Permission denied</SPAN
>
This is because your
/var/spool/mqueue directory has a mode of "drwx------". Type
<B
CLASS="COMMAND"
>chmod 755 /var/spool/mqueue</B
> as root to fix this problem.
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Release Notes for Bugzilla 2.12 are available at docs/rel_notes.txt
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The preferred documentation for Bugzilla is available in docs/, with
a variety of document types available. Please refer to these documents when
installing, configuring, and maintaining your Bugzilla installation.
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> Bugzilla is not a package where you can just plop it in a directory,
twiddle a few things, and you're off. Installing Bugzilla assumes you
know your variant of UNIX or Microsoft Windows well, are familiar with the
command line, and are comfortable compiling and installing a plethora
of third-party utilities. To install Bugzilla on Win32 requires
fair Perl proficiency, and if you use a webserver other than Apache you
should be intimately familiar with the security mechanisms and CGI
environment thereof.
</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> Bugzilla has not undergone a complete security review. Security holes
may exist in the code. Great care should be taken both in the installation
and usage of this software. Carefully consider the implications of
installing other network services with Bugzilla.
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="AEN204"
>2.1.2. Step-by-step Install</A
></H2
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN206"
>2.1.2.1. Introduction</A
></H3
><P
> Installation of bugzilla is pretty straightforward, particularly if your
machine already has MySQL and the MySQL-related perl packages installed.
If those aren't installed yet, then that's the first order of business. The
other necessary ingredient is a web server set up to run cgi scripts.
While using Apache for your webserver is not required, it is recommended.
</P
><P
> Bugzilla has been successfully installed under Solaris, Linux, and
Win32. The peculiarities of installing on Win32 (Win98+/NT/2K) are not
included in this section of the Guide; please check out the "Win32 Installation Instructions"
for further advice on getting Bugzilla to work on Microsoft Windows.
</P
><P
> The Bugzilla Guide is contained in the "docs/" folder. It is available
in plain text (docs/txt), HTML (docs/html), or SGML source (docs/sgml).
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN211"
>2.1.2.2. Installing the Prerequisites</A
></H3
><P
> The software packages necessary for the proper running of bugzilla are:
<P
></P
><OL
TYPE="1"
><LI
><P
> MySQL database server and the mysql client (3.22.5 or greater)
</P
></LI
><LI
><P
> Perl (5.004 or greater)
</P
></LI
><LI
><P
> DBI Perl module
</P
></LI
><LI
><P
> Data::Dumper Perl module
</P
></LI
><LI
><P
> DBD::mySQL
</P
></LI
><LI
><P
> TimeDate Perl module collection
</P
></LI
><LI
><P
> GD perl module (1.8.3) (optional, for bug charting)
</P
></LI
><LI
><P
> Chart::Base Perl module (0.99c) (optional, for bug charting)
</P
></LI
><LI
><P
> DB_File Perl module (optional, for bug charting)
</P
></LI
><LI
><P
> The web server of your choice. Apache is recommended.
</P
></LI
><LI
><P
> MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
</P
></LI
></OL
>
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> You must run Bugzilla on a filesystem that supports file locking via
flock(). This is necessary for Bugzilla to operate safely with multiple
instances.
</P
></BLOCKQUOTE
></DIV
>
<DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> It is a good idea, while installing Bugzilla, to ensure it is not
<EM
>accessible</EM
> by other machines on the Internet.
Your machine may be vulnerable to attacks
while you are installing. In other words, ensure there is some kind of firewall between you
and the rest of the Internet. Many installation steps require an active Internet connection
to complete, but you must take care to ensure that at no point is your machine vulnerable
to an attack.
</P
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN242"
>2.1.2.3. Installing MySQL Database</A
></H3
><P
> Visit MySQL homepage at http://www.mysql.org/ and grab the latest stable
release of the server. Both binaries and source are available and which
you get shouldn't matter. Be aware that many of the binary versions
of MySQL store their data files in /var which on many installations
(particularly common with linux installations) is part of a smaller
root partition. If you decide to build from sources you can easily set
the dataDir as an option to configure.
</P
><P
> If you've installed from source or non-package (RPM, deb, etc.) binaries
you'll want to make sure to add mysqld to your init scripts so the server
daemon will come back up whenever your machine reboots.
You also may want to edit those init scripts, to make sure that
mysqld will accept large packets. By default, mysqld is set up to only
accept packets up to 64K long. This limits the size of attachments you
may put on bugs. If you add something like "-O max_allowed_packet=1M"
to the command that starts mysqld (or safe_mysqld), then you will be
able to have attachments up to about 1 megabyte.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> If you plan on running Bugzilla and MySQL on the same machine,
consider using the "--skip-networking" option in the init script.
This enhances security by preventing network access to MySQL.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN248"
>2.1.2.4. Perl (5.004 or greater)</A
></H3
><P
> Any machine that doesn't have perl on it is a sad machine indeed. Perl
for *nix systems can be gotten in source form from http://www.perl.com.
</P
><P
> Perl is now a far cry from the the single compiler/interpreter binary it
once was. It now includes a great many required modules and quite a
few other support files. If you're not up to or not inclined to build
perl from source, you'll want to install it on your machine using some
sort of packaging system (be it RPM, deb, or what have you) to ensure
a sane install. In the subsequent sections you'll be installing quite
a few perl modules; this can be quite ornery if your perl installation
isn't up to snuff.
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> You can skip the following Perl module installation
steps by installing "Bundle::Bugzilla" from CPAN, which includes them.
All Perl module installation steps require you have an active Internet
connection.
</P
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>perl -MCPAN -e 'install "Bundle::Bugzilla"'</B
>
</TT
>
</P
><P
> Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser,
which are not essential to a basic Bugzilla install. If installing
this bundle fails, you should install each module individually to
isolate the problem.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN259"
>2.1.2.5. DBI Perl Module</A
></H3
><P
> The DBI module is a generic Perl module used by other database related
Perl modules. For our purposes it's required by the MySQL-related
modules. As long as your Perl installation was done correctly the
DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
MakeMaker system simplifies the C compilation greatly.
</P
><P
> Like almost all Perl modules DBI can be found on the Comprehensive Perl
Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
real tendency to bog down, so please use mirrors. The current location
at the time of this writing (02/17/99) can be found in Appendix A.
</P
><P
> Quality, general Perl module installation instructions can be found on
the CPAN website, but the easy thing to do is to just use the CPAN shell
which does all the hard work for you.
</P
><P
> To use the CPAN shell to install DBI:
<DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN265"
></A
><P
></P
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>perl -MCPAN -e 'install "DBI"'</B
>
</TT
>
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Replace "DBI" with the name of whichever module you wish
to install, such as Data::Dumper, TimeDate, GD, etc.</P
></BLOCKQUOTE
></DIV
>
</P
><P
></P
></DIV
>
To do it the hard way:
<DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN272"
></A
><P
></P
><P
> Untar the module tarball -- it should create its own directory
</P
><P
> CD to the directory just created, and enter the following commands:
<P
></P
><OL
TYPE="1"
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>perl Makefile.PL</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>make</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>make test</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>make install</B
>
</TT
>
</P
></LI
></OL
>
If everything went ok that should be all it takes. For the vast
majority of perl modules this is all that's required.
</P
><P
></P
></DIV
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN296"
>2.1.2.6. Data::Dumper Perl Module</A
></H3
><P
> The Data::Dumper module provides data structure persistence for Perl
(similar to Java's serialization). It comes with later sub-releases of
Perl 5.004, but a re-installation just to be sure it's available won't
hurt anything.
</P
><P
> Data::Dumper is used by the MySQL related Perl modules. It can be
found on CPAN (link in Appendix A) and can be installed by following
the same four step make sequence used for the DBI module.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN300"
>2.1.2.7. MySQL related Perl Module Collection</A
></H3
><P
> The Perl/MySQL interface requires a few mutually-dependent perl
modules. These modules are grouped together into the the
Msql-Mysql-modules package. This package can be found at CPAN.
After the archive file has been downloaded it should
be untarred.
</P
><P
> The MySQL modules are all built using one make file which is generated
by running:
<TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>perl Makefile.pl</B
>
</P
><P
> The MakeMaker process will ask you a few questions about the desired
compilation target and your MySQL installation. For many of the questions
the provided default will be adequate.
</P
><P
> When asked if your desired target is the MySQL or mSQL packages
selected the MySQL related ones. Later you will be asked if you wish
to provide backwards compatibility with the older MySQL packages; you
must answer YES to this question. The default will be no, and if you
select it things won't work later.
</P
><P
> A host of 'localhost' should be fine and a testing user of 'test' and
a null password should find itself with sufficient access to run tests
on the 'test' database which MySQL created upon installation. If 'make
test' and 'make install' go through without errors you should be ready
to go as far as database connectivity is concerned.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN309"
>2.1.2.8. TimeDate Perl Module Collection</A
></H3
><P
> Many of the more common date/time/calendar related Perl modules have
been grouped into a bundle similar to the MySQL modules bundle. This
bundle is stored on the CPAN under the name TimeDate. A (hopefully
current) link can be found in Appendix A. The component module we're
most interested in is the Date::Format module, but installing all of them
is probably a good idea anyway. The standard Perl module installation
instructions should work perfectly for this simple package.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN312"
>2.1.2.9. GD Perl Module (1.8.3)</A
></H3
><P
> The GD library was written by Thomas Boutell a long while ago to
programatically generate images in C. Since then it's become almost a
defacto standard for programatic image construction. The Perl bindings
to it found in the GD library are used on a million web pages to generate
graphs on the fly. That's what bugzilla will be using it for so you'd
better install it if you want any of the graphing to work.
</P
><P
> Actually bugzilla uses the Graph module which relies on GD itself,
but isn't that always the way with OOP. At any rate, you can find the
GD library on CPAN (link in Appendix "Required Software").
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The Perl GD library requires some other libraries that may or may not be
installed on your system, including "libpng" and "libgd". The full requirements
are listed in the Perl GD library README. Just realize that if compiling GD fails,
it's probably because you're missing a required library.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN318"
>2.1.2.10. Chart::Base Perl Module (0.99c)</A
></H3
><P
> The Chart module provides bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been
fetched from CPAN where it is found as the Chart-x.x... tarball in a
directory to be listed in Appendix "Required Software". Note that as with the GD perl
module, only the specific versions listed above (or newer) will work. Earlier
versions used GIF's, which are no longer supported by the latest
versions of GD.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN321"
>2.1.2.11. DB_File Perl Module</A
></H3
><P
> DB_File is a module which allows Perl programs to make use of the facilities provided by
Berkeley DB version 1.x. This module is required by collectstats.pl which is used for
bug charting. If you plan to make use of bug charting, you must install this module.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN324"
>2.1.2.12. HTTP Server</A
></H3
><P
> You have a freedom of choice here - Apache, Netscape or any other
server on UNIX would do. You can easily run the web server on a different
machine than MySQL, but need to adjust the MySQL "bugs" user permissions
accordingly.
</P
><P
> You'll want to make sure that your web server will run any file
with the .cgi extension as a cgi and not just display it. If you're using
apache that means uncommenting the following line in the srm.conf file:
<TT
CLASS="COMPUTEROUTPUT"
>AddHandler cgi-script .cgi</TT
>
</P
><P
> With apache you'll also want to make sure that within the access.conf
file the line:
<TT
CLASS="COMPUTEROUTPUT"
> Options ExecCGI
</TT
>
is in the stanza that covers the directories you intend to put the bugzilla
.html and .cgi files into.
</P
><P
> If you are using a newer version of Apache, both of the above lines will be
(or will need to be) in the httpd.conf file, rather than srm.conf or
access.conf.
</P
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> There are two critical directories and a file that should not be a served by
the HTTP server. These are the 'data' and 'shadow' directories and the
'localconfig' file. You should configure your HTTP server to not serve
content from these files. Failure to do so will expose critical passwords
and other data. Please see your HTTP server configuration manual on how
to do this. If you use quips (at the top of the buglist pages) you will want
the 'data/comments' file to still be served. This file contains those quips.
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN334"
>2.1.2.13. Installing the Bugzilla Files</A
></H3
><P
> You should untar the Bugzilla files into a directory that you're
willing to make writable by the default web server user (probably
'nobody'). You may decide to put the files off of the main web space
for your web server or perhaps off of /usr/local with a symbolic link
in the web space that points to the bugzilla directory. At any rate,
just dump all the files in the same place (optionally omitting the CVS
directories if they were accidentally tarred up with the rest of Bugzilla)
and make sure you can access the files in that directory through your
web server.
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> If you symlink the bugzilla directory into your Apache's
HTML heirarchy, you may receive "Forbidden" errors unless you
add the "FollowSymLinks" directive to the <Directory> entry
for the HTML root.
</P
></BLOCKQUOTE
></DIV
><P
> Once all the files are in a web accessible directory, make that
directory writable by your webserver's user (which may require just
making it world writable). This is a temporary step until you run
the post-install "checksetup.pl" script, which locks down your
installation.
</P
><P
> Lastly, you'll need to set up a symbolic link to /usr/bonsaitools/bin/perl
for the correct location of your perl executable (probably /usr/bin/perl).
Otherwise you must hack all the .cgi files to change where they look
for perl. To make future upgrades easier, you should use the symlink
approach.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN341"
></A
><P
><B
>Example 2-1. Setting up bonsaitools symlink</B
></P
><P
> Here's how you set up the Perl symlink on Linux to make Bugzilla work.
Your mileage may vary; if you are running on Solaris, you probably need to subsitute
"/usr/local/bin/perl" for "/usr/bin/perl" below; if on certain other UNIX systems,
Perl may live in weird places like "/opt/perl". As root, run these commands:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>bash# mkdir /usr/bonsaitools
bash# mkdir /usr/bonsaitools/bin
bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
>
<DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> If you don't have root access to set this symlink up, check out the
"setperl.csh" utility, listed in the Patches section of this
Guide. It will change the path to perl in all your Bugzilla files for
you.
</P
></BLOCKQUOTE
></DIV
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN347"
>2.1.2.14. Setting Up the MySQL Database</A
></H3
><P
> After you've gotten all the software installed and working you're ready
to start preparing the database for its life as a the back end to a high
quality bug tracker.
</P
><P
> First, you'll want to fix MySQL permissions to allow access from
Bugzilla. For the purpose of this Installation section, the Bugzilla username
will be "bugs", and will have minimal permissions. Bugzilla has
not undergone a thorough security audit. It may be possible for
a system cracker to somehow trick Bugzilla into executing a command
such as "; DROP DATABASE mysql".
</P
><P
> That would be bad.
</P
><P
> Give the MySQL root user a password. MySQL passwords are
limited to 16 characters.
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>mysql -u root mysql</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
> UPDATE user SET Password=PASSWORD ('new_password')
WHERE user='root';
</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>FLUSH PRIVILEGES;</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
From this point on, if you need to access MySQL as the
MySQL root user, you will need to use "mysql -u root -p" and
enter your new_password. Remember that MySQL user names have
nothing to do with Unix user names (login names).
</P
><P
> Next, we create the "bugs" user, and grant sufficient
permissions for checksetup.pl, which we'll use later, to work
its magic. This also restricts the "bugs" user to operations
within a database called "bugs", and only allows the account
to connect from "localhost". Modify it to reflect your setup
if you will be connecting from another machine or as a different
user.
</P
><P
> Remember to set bugs_password to some unique password.
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
ALTER,CREATE,DROP,REFERENCES
ON bugs.* TO bugs@localhost
IDENTIFIED BY 'bugs_password';</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
> mysql>
</TT
>
<B
CLASS="COMMAND"
> FLUSH PRIVILEGES;
</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> Next, run the magic checksetup.pl script. (Many thanks to Holger
Schurig <holgerschurig@nikocity.de> for writing this script!)
It will make sure Bugzilla files and directories have reasonable
permissions, set up the "data" directory, and create all the MySQL
tables.
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>./checksetup.pl</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
The first time you run it, it will create a file called "localconfig".
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN383"
>2.1.2.15. Tweaking "localconfig"</A
></H3
><P
> This file contains a variety of settings you may need to tweak including
how Bugzilla should connect to the MySQL database.
</P
><P
> The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
> server's host: just use "localhost" if the MySQL server is
local
</P
></LI
><LI
><P
> database name: "bugs" if you're following these directions
</P
></LI
><LI
><P
> MySQL username: "bugs" if you're following these directions
</P
></LI
><LI
><P
> Password for the "bugs" MySQL account above
</P
></LI
></OL
>
</P
><P
> Once you are happy with the settings, re-run checksetup.pl. On this
second run, it will create the database and an administrator account
for which you will be prompted to provide information.
</P
><P
> When logged into an administrator account once Bugzilla is running,
if you go to the query page (off of the bugzilla main menu), you'll
find an 'edit parameters' option that is filled with editable treats.
</P
><P
> Should everything work, you should have a nearly empty copy of the bug
tracking setup.
</P
><P
> The second time around, checksetup.pl will stall if it is on a
filesystem that does not fully support file locking via flock(), such as
NFS mounts. This support is required for Bugzilla to operate safely with
multiple instances. If flock() is not fully supported, it will stall at:
<SPAN
CLASS="ERRORCODE"
>Now regenerating the shadow database for all bugs.</SPAN
>
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The second time you run checksetup.pl, you should become the
user your web server runs as, and that you ensure you have set the
"webservergroup" parameter in localconfig to match the web server's group
name, if any. I believe, for the next release of Bugzilla, this will
be fixed so that Bugzilla supports a "webserveruser" parameter in localconfig
as well.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN403"
></A
><P
><B
>Example 2-2. Running checksetup.pl as the web user</B
></P
><P
> Assuming your web server runs as user "apache", and Bugzilla is installed in
"/usr/local/bugzilla", here's one way to run checksetup.pl as the web server user.
As root, for the <EM
>second run</EM
> of checksetup.pl, do this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>bash# chown -R apache:apache /usr/local/bugzilla
bash# su - apache
bash# cd /usr/local/bugzilla
bash# ./checksetup.pl
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
>
</P
></BLOCKQUOTE
></DIV
>
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The checksetup.pl script is designed so that you can run it at any time
without causing harm. You should run it after any upgrade to Bugzilla.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN410"
>2.1.2.16. Setting Up Maintainers Manually (Optional)</A
></H3
><P
> If you want to add someone else to every group by hand, you can do it
by typing the appropriate MySQL commands. Run '<TT
CLASS="COMPUTEROUTPUT"
> mysql -u root -p bugs</TT
>'
(you may need different parameters, depending on your security settings
according to section 3, above). Then:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>update profiles set groupset=0x7fffffffffffffff
where login_name = 'XXX';</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
replacing XXX with the Bugzilla email address.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN419"
>2.1.2.17. The Whining Cron (Optional)</A
></H3
><P
> By now you've got a fully functional bugzilla, but what good are bugs
if they're not annoying? To help make those bugs more annoying you can
set up bugzilla's automatic whining system. This can be done by adding
the following command as a daily crontab entry (for help on that see that
crontab man page):
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <B
CLASS="COMMAND"
>cd <your-bugzilla-directory> ; ./whineatnews.pl</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN426"
>2.1.2.18. Bug Graphs (Optional)</A
></H3
><P
> As long as you installed the GD and Graph::Base Perl modules you might
as well turn on the nifty bugzilla bug reporting graphs.
</P
><P
> Add a cron entry like this to run collectstats daily at 5 after midnight:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>crontab -e</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> 5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> After two days have passed you'll be able to view bug graphs from the
Bug Reports page.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN438"
>2.1.2.19. Securing MySQL</A
></H3
><P
> If you followed the README for setting up your "bugs" and "root" user in
MySQL, much of this should not apply to you. If you are upgrading
an existing installation of Bugzilla, you should pay close attention
to this section.
</P
><P
> Most MySQL installs have "interesting" default security parameters:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>mysqld defaults to running as root</TD
></TR
><TR
><TD
>it defaults to allowing external network connections</TD
></TR
><TR
><TD
>it has a known port number, and is easy to detect</TD
></TR
><TR
><TD
>it defaults to no passwords whatsoever</TD
></TR
><TR
><TD
>it defaults to allowing "File_Priv"</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> This means anyone from anywhere on the internet can not only drop the
database with one SQL command, and they can write as root to the system.
</P
><P
> To see your permissions do:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>mysql -u root -p</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>use mysql;</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>show tables;</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>select * from user;</B
>
</TT
>
</TD
></TR
><TR
><TD
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>select * from db;</B
>
</TT
>
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> To fix the gaping holes:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>DELETE FROM user WHERE User='';</TD
></TR
><TR
><TD
>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</TD
></TR
><TR
><TD
> FLUSH PRIVILEGES;</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> If you're not running "mit-pthreads" you can use:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>GRANT USAGE ON *.* TO bugs@localhost;</TD
></TR
><TR
><TD
>GRANT ALL ON bugs.* TO bugs@localhost;</TD
></TR
><TR
><TD
>REVOKE DROP ON bugs.* FROM bugs@localhost;</TD
></TR
><TR
><TD
>FLUSH PRIVILEGES;</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
line to specify a specific host name instead of "localhost", and accept
external connections:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</TD
></TR
><TR
><TD
>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</TD
></TR
><TR
><TD
>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</TD
></TR
><TR
><TD
>FLUSH PRIVILEGES;</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> Consider also:
<P
></P
><OL
TYPE="1"
><LI
><P
> Turning off external networking with "--skip-networking",
unless you have "mit-pthreads", in which case you can't.
Without networking, MySQL connects with a Unix domain socket.
</P
></LI
><LI
><P
> using the --user= option to mysqld to run it as an unprivileged
user.
</P
></LI
><LI
><P
> starting MySQL in a chroot jail
</P
></LI
><LI
><P
> running the httpd in a "chrooted" jail
</P
></LI
><LI
><P
> making sure the MySQL passwords are different from the OS
passwords (MySQL "root" has nothing to do with system "root").
</P
></LI
><LI
><P
> running MySQL on a separate untrusted machine
</P
></LI
><LI
><P
> making backups ;-)
</P
></LI
></OL
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="AEN504"
>2.1.2.20. Installation General Notes</A
></H3
><DIV
CLASS="SECTION"
><H4
CLASS="SECTION"
><A
NAME="AEN506"
>2.1.2.20.1. Modifying Your Running System</A
></H4
><P
> Bugzilla optimizes database lookups by storing all relatively static
information in the versioncache file, located in the data/ subdirectory
under your installation directory (we said before it needs to be writable,
right?!)
</P
><P
> If you make a change to the structural data in your database (the
versions table for example), or to the "constants" encoded in
defparams.pl, you will need to remove the cached content from the data
directory (by doing a "rm data/versioncache"), or your changes won't show
up!
</P
><P
> That file gets automatically regenerated whenever it's more than an
hour old, so Bugzilla will eventually notice your changes by itself, but
generally you want it to notice right away, so that you can test things.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H4
CLASS="SECTION"
><A
NAME="AEN511"
>2.1.2.20.2. Upgrading From Previous Versions</A
></H4
><P
> The developers of Bugzilla are constantly adding new tables, columns and
fields. You'll get SQL errors if you just update the code. The strategy
to update is to simply always run the checksetup.pl script whenever
you upgrade your installation of Bugzilla. If you want to see what has
changed, you can read the comments in that file, starting from the end.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H4
CLASS="SECTION"
><A
NAME="AEN514"
>2.1.2.20.3. UNIX Installation Instructions History</A
></H4
><P
> This document was originally adapted from the Bonsai installation
instructions by Terry Weissman <terry@mozilla.org>.
</P
><P
> The February 25, 1999 re-write of this page was done by Ry4an Brase
<ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt,
Martin Pool, & Dan Mosedale (But don't send bug reports to them!
Report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi ,
project Webtools, component Bugzilla).
</P
><P
> This document was heavily modified again Wednesday, March 07 2001 to
reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The
securing MySQL section should be changed to become standard procedure
for Bugzilla installations.
</P
><P
> Finally, the README in its entirety was marked up in SGML and included into
the Guide on April 24, 2001.
</P
><P
> Comments from people using this Guide for the first time are particularly welcome.
</P
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="README.WINDOWS"
>2.2. Win32 (Win98+/NT/2K) Installation</A
></H1
><P
> These directions have <EM
>not</EM
> been extensively tested.
We need testers! Please try these out and post any changes to the
newsgroup.
</P
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="NTVERIFIED"
>2.2.1. Win32 Installation: Step-by-step</A
></H2
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> You should be familiar with, and cross-reference, the UNIX README
while performing your Win32 installation. Unfortunately, Win32
directions are not yet as detailed as those for UNIX.
</P
><P
> The <EM
>most critical</EM
> difference for Win32 users is
the lack of support for a crypt() function in MySQL for Windows. It does not
have it! All ENCRYPT statements must be modified.
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
> Install <A
HREF="http://www.apache.org/"
TARGET="_top"
>Apache Web Server</A
>
for Windows.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> You may also use Internet Information Server or Personal Web
Server for this purpose. However, setup is slightly more
difficult. If ActivePerl doesn't seem to handle your file
associations correctly (for .cgi and .pl files), please
consult the FAQ, in the "Win32" section.
</P
><P
> If you are going to use IIS, if on Windows NT you must be updated
to at least Service Pack 4.
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Install <A
HREF="http://www.activestate.com/"
TARGET="_top"
>ActivePerl</A
>
</P
><P
> Please also check the following links to fully understand the status
of ActivePerl on Win32:
<A
HREF="http://language.perl.com/newdocs/pod/perlport.html"
TARGET="_top"
> Perl Porting</A
>, and
<A
HREF="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"
TARGET="_top"
> Hixie Click Here</A
>
</P
></LI
><LI
><P
> Use ppm from your perl\bin directory to install the following packs: DBI,
DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need
to extract them from .zip format using Winzip or other unzip program first.
These additional ppm modules can be downloaded from ActiveState.
</P
><P
> The syntax for ppm is:
<TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>C:> </TT
><B
CLASS="COMMAND"
>ppm install <module>.ppd</B
>
</TT
>
</P
><P
> You can find ActiveState ppm modules at
<A
HREF="http://www.activestate.com/PPMPackages/5.6plus/"
TARGET="_top"
> http://www.activestate.com/PPMPackages/5.6plus</A
>
</P
></LI
><LI
><P
> Download and install the Windows GNU tools from
<A
HREF="http://www.cygwin.com/"
TARGET="_top"
>www.cygwin.com</A
>.
Make sure the GNU utilities are in your $PATH.
</P
></LI
><LI
><P
> Install MySQL for NT.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Your configuration file for MySQL <EM
>must</EM
> be named C:\MY.CNF.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> Setup MySQL
</P
><OL
CLASS="SUBSTEPS"
TYPE="a"
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>C:> </TT
>
<B
CLASS="COMMAND"
>C:\mysql\bin\mysql -u root mysql</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>DELETE FROM user WHERE Host='localhost' AND User='';</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>UPDATE user SET Password=PASSWORD ('new_password')
WHERE user='root';</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>GRANT SELECT, INSERT, UPDATE, DELETE,
INDEX, ALTER, CREATE, DROP, REFERENCES
ON bugs.* to bugs@localhost
IDENTIFIED BY 'bugs_password';</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>FLUSH PRIVILEGES;</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>create database bugs;</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>mysql></TT
>
<B
CLASS="COMMAND"
>exit</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>C:></TT
>
<B
CLASS="COMMAND"
>C:\mysql\bin\mysqladmin -u root -p reload</B
>
</TT
>
</P
></LI
></OL
></LI
><LI
><P
> Configure Bugzilla. For Win32, this involves editing "defparams.pl"
and "localconfig" to taste. Running "checksetup.pl" should create
localconfig for you. Note that getgrnam() doesn't work, and should be
deleted. Change this line:
"my $webservergid = getgrnam($my_webservergroup); "
to
"my $webservergid = $my_webservergroup; "
</P
></LI
><LI
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> There are several alternatives to Sendmail that will work on Win32.
The one mentioned here is a <EM
>suggestion</EM
>, not
a requirement. Some other mail packages that can work include
<A
HREF="http://www.blat.net/"
TARGET="_top"
>BLAT</A
>,
<A
HREF="http://www.geocel.com/windmail/"
TARGET="_top"
>Windmail</A
>,
<A
HREF="http://www.dynamicstate.com/"
TARGET="_top"
>Mercury Sendmail</A
>,
and the CPAN Net::SMTP Perl module (available in .ppm).
Every option requires some hacking of the Perl scripts for Bugzilla
to make it work. The option here simply requires the least.
</P
></BLOCKQUOTE
></DIV
><P
> Download NTsendmail, available from<A
HREF="http://www.ntsendmail.com/"
TARGET="_top"
> www.ntsendmail.com</A
>. In order for it to work, you must set up some
new environment variables (detailed on the ntsendmail home page). Figuring
out where to put those variables is left as an exercise for the reader.
You must have a "real" mail server which allows you to relay off it
in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
</P
><P
> Once downloaded and installed, modify all open(SENDMAIL) calls to open
"| c:\ntsendmail\ntsendmail -t" instead of "|/usr/lib/sendmail -t".
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> We need someone to test this and make sure this works as advertised.
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Modify globals.pl and CGI.pl to remove the word "encrypt".
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> I'm not sure this is all that is involved to remove crypt. Any
NT Bugzilla hackers want to pipe up?
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Change all references to "processmail" to "processmail.pl" in
all files, and rename "processmail" to "processmail.pl"
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> I really think this may be a change we want to make for
main-tree Bugzilla. It's painless for the UNIX folks,
and will make the Win32 people happier.
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Modify the path to perl on the first line (#!) of all files
to point to your Perl installation, and
add "perl" to the beginning of all Perl system calls that
use a perl script as an argument. This may take you a while.
There is a "setperl.pl" utility to speed part of this procedure,
available in the "Patches and Utilities" section of The Bugzilla Guide.
</P
></LI
><LI
><P
> In processmail.pl, add "binmode(HANDLE)" before all read() calls.
This may not be necessary, but in some cases the read() under
Win32 doesn't count the EOL's without using a binary read().
</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="ADDLWINTIPS"
>2.2.2. Additional Windows Tips</A
></H2
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> From Andrew Pearson:
<A
NAME="AEN633"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> "You can make Bugzilla work with Personal Web Server for
Windows 98 and higher, as well as for IIS 4.0. Microsoft has
information available at
<A
HREF=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"
TARGET="_top"
> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</A
>
</P
><P
> Basically you need to add two String Keys in the
registry at the following location:
</P
><P
> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
</P
><P
> The keys should be called ".pl" and ".cgi", and both
should have a value something like:
<B
CLASS="COMMAND"
>c:/perl/bin/perl.exe "%s" "%s"</B
>
</P
><P
> The KB article only talks about .pl, but it goes into
more detail and provides a perl test script.
</P
></BLOCKQUOTE
>
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</P
><A
NAME="AEN643"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I
deleted the current dir and copied the files in).
</P
><P
> In checksetup.pl, I did the following...
</P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>my $webservergid = getgrnam($my_webservergroup);
</PRE
></TD
></TR
></TABLE
><P
>to</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>my $webservergid = 'Administrators'
</PRE
></TD
></TR
></TABLE
></LI
><LI
><P
> I then ran checksetup.pl
</P
></LI
><LI
><P
> I removed all the encrypt()
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN655"
></A
><P
><B
>Example 2-3. Removing encrypt() for Windows NT installations</B
></P
><P
> Replace this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " .
SqlQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</PRE
></TD
></TR
></TABLE
>
with this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>my $enteredcryptpwd = $enteredpwd
</PRE
></TD
></TR
></TABLE
>
in cgi.pl.
</P
></DIV
>
</P
></LI
><LI
><P
> I renamed processmail to processmail.pl
</P
></LI
><LI
><P
> I altered the sendmail statements to windmail:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>
open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
</PRE
></TD
></TR
></TABLE
>
</P
><P
> The quotes around the dir is for the spaces. mail.log is for the output
</P
></LI
></OL
></DIV
></BLOCKQUOTE
></BLOCKQUOTE
></DIV
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> This was some late breaking information from Jan Evert. Sorry for the lack of formatting.
</P
><P
CLASS="LITERALLAYOUT"
>I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you<br>
at this moment of the commments I have to section 2.2.1 of the bugzilla<br>
guide (at http://www.trilobyte.net/barnsons/html/).<br>
<br>
Step 1:<br>
I've used apache, installation is really straightforward.<br>
After reading the Unix installation instructions, I found that it is<br>
necessary to add the ExecCGI option to the bugzilla directory. Also the<br>
'AddHandler' line for .cgi is by default commented out.<br>
<br>
Step 3: although just a detail, 'ppm install <module%gt;' will also work<br>
(wihtout .ppd). And, it can also download these automatically from<br>
ActiveState.<br>
<br>
Step 4: although I have cygwin installed, it seems that it is not necessary.<br>
On my machine cygwin is not in the PATH and everything seems to work as<br>
expected.<br>
However, I've not used everything yet.<br>
<br>
Step 6: the 'bugs_password' given in SQL command d needs to be edited into<br>
localconfig later on (Step 7) if the password is not empty. I've also edited<br>
it into globals.pl, but I'm not sure that is needed. In both places, the<br>
variable is named db_pass.<br>
<br>
Step 8: all the sendmail replacements mentioned are not as simple as<br>
described there. Since I am not familiar (yet) with perl, I don't have any<br>
mail working yet.<br>
<br>
Step 9: in globals.pl the encrypt() call can be replaced by just the<br>
unencrypted password. In CGI.pl, the complete SQL command can be removed.<br>
<br>
Step 11: I've only changed the #! lines in *.cgi. I haven't noticed problems<br>
with the system() call yet.<br>
There seem to be only four system() called programs: processmail.pl (handled<br>
by step 10), syncshadowdb (which should probably get the same treatment as<br>
processmail.pl), diff and mysqldump. The last one is only needed with the<br>
shadowdb feature (which I don't use).<br>
<br>
There seems to be one step missing: copying the bugzilla files somehwere<br>
that apache can serve them.<br>
<br>
Just noticed the updated guide... Brian's comment is new. His first comment<br>
will work, but opens up a huge security hole.<br>
</P
></BLOCKQUOTE
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="ADMINISTRATION"
>Chapter 3. Administering Bugzilla</A
></H1
><FONT
COLOR="RED"
>Or, I just got this cool thing installed. Now what the heck do I do with it?</FONT
><P
>So you followed the README isntructions to the letter, and
just logged into bugzilla with your super-duper god account and you are sitting at the query
screen. Yet, you have nothing to query. Your first act of business needs to be to setup the
operating parameters for bugzilla.</P
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="POSTINSTALL-CHECK"
>3.1. Post-Installation Checklist</A
></H1
><P
> After installation, follow the checklist below to ensure that
you have a successful installation.
If you do not see a recommended setting for a parameter,
consider leaving it at the default
while you perform your initial tests on your Bugzilla setup.
</P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
> Bring up "editparams.cgi" in your web browser. For instance, to edit parameters
at mozilla.org, the URL would be <A
HREF="http://bugzilla.mozilla.org/editparams.cgi"
TARGET="_top"
> http://bugzilla.mozilla.org/editparams.cgi</A
>, also available under the "edit parameters"
link on your query page.
</P
></LI
><LI
><P
> Set "maintainer" to <EM
>your</EM
> email address.
This allows Bugzilla's error messages
to display your email
address and allow people to contact you for help.
</P
></LI
><LI
><P
> Set "urlbase" to the URL reference for your Bugzilla installation.
If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi,
your url base is http://www.foo.com/bugzilla/
</P
></LI
><LI
><P
> Set "usebuggroups" to "1" <EM
>only</EM
>
if you need to restrict access to products.
I suggest leaving this parameter <EM
>off</EM
>
while initially testing your Bugzilla.
</P
></LI
><LI
><P
> Set "usebuggroupsentry" to "1" if you want to restrict access to products.
Once again, if you are simply testing your installation, I suggest against
turning this parameter on; the strict security checking may stop you from
being able to modify your new entries.
</P
></LI
><LI
><P
> Set "shadowdb" to "bug_shadowdb" if you will be
running a *very* large installation of Bugzilla.
The shadow database enables many simultaneous users
to read and write to the database
without interfering with one another.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Enabling "shadowdb" can adversely affect the stability
of your installation of Bugzilla.
You may frequently need to manually synchronize your databases,
or schedule nightly syncs
via "cron"
</P
></BLOCKQUOTE
></DIV
>
Once again, in testing you should
avoid this option -- use it if or when you <EM
>need</EM
> to use it, and have
repeatedly run into the problem it was designed to solve -- very long wait times while
attempting to commit a change to the database.
</P
><P
> If you use the "shadowdb" option,
it is only natural that you should turn the "queryagainstshadowdb"
option "On" as well. Otherwise you are replicating data into a shadow database for no reason!
</P
></LI
><LI
><P
> If you have custom logos or HTML you must put in place to fit within your site design guidelines,
place the code in the "headerhtml", "footerhtml", "errorhtml",
"bannerhtml", or "blurbhtml" text boxes.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The "headerhtml" text box is the HTML printed out
<EM
>before</EM
> any other code on the page.
If you have a special banner, put the code for it in "bannerhtml".
You may want to leave these
settings at the defaults initially.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> Add any text you wish to the "passwordmail" parameter box. For instance,
many people choose to use this box to give a quick training blurb about how to
use Bugzilla at your site.
</P
></LI
><LI
><P
> Ensure "newemailtech" is "on".
Your users will thank you. This is the default in the post-2.12 world, and is
only an issue if you are upgrading.
</P
></LI
><LI
><P
> Do you want to use the qa contact ("useqacontact")
and status whiteboard ("usestatuswhiteboard") fields?
These fields are useful because they allow for more flexibility,
particularly when you have an existing
Quality Assurance and/or Release Engineering team,
but they may not be needed for smaller installations.
</P
></LI
><LI
><P
> Set "whinedays" to the amount of days you want to let bugs go
in the "New" or "Reopened" state before
notifying people they have untouched new bugs. If you do not plan to use this feature, simply do
not set up the whining cron job described in the README, or set this value to "0".
</P
></LI
><LI
><P
> Set the "commenton" options according to your site policy.
It is a wise idea to require comments when users
resolve, reassign, or reopen bugs.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> It is generally far better to require a developer comment when resolving bugs than not.
Few things are more annoying to bug database users than having a developer
mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!)
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their
respective areas, and can offer many other benefits, such as allowing a developer to pick up a
former engineer's bugs without requiring her to change all the information in the bug.
</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="USERADMIN"
>3.2. User Administration</A
></H1
><P
> User administration is one of the easiest parts of Bugzilla.
Keeping it from getting out of hand, however, can become a challenge.
</P
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="DEFAULTUSER"
>3.2.1. Creating the Default User</A
></H2
><P
> When you first run checksetup.pl after installing Bugzilla, it will prompt you
for the administrative username (email address) and password for this "super user".
If for some reason you were to delete the "super user" account, re-running
checksetup.pl will again prompt you for this username and password.
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> If you wish to add more administrative users, you must use the MySQL interface.
Run "mysql" from the command line, and use these commands ("mysql>" denotes the
mysql prompt, not something you should type in):
<B
CLASS="COMMAND"
><TT
CLASS="PROMPT"
>mysql></TT
> use bugs;</B
>
<B
CLASS="COMMAND"
><TT
CLASS="PROMPT"
>mysql></TT
> update profiles set groupset=0x7ffffffffffffff
where login_name = "(user's login name)"; </B
>
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="MANAGEUSERS"
>3.2.2. Managing Other Users</A
></H2
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="LOGIN"
>3.2.2.1. Logging In</A
></H3
><P
></P
><OL
TYPE="1"
><LI
><P
> Open the index.html page for your Bugzilla installation in your browser window.
</P
></LI
><LI
><P
> Click the "Query Existing Bug Reports" link.
</P
></LI
><LI
><P
> Click the "Log In" link at the foot of the page.
</P
></LI
><LI
><P
> Type your email address, and the password which was emailed to you when you
created your Bugzilla account, into the spaces provided.
</P
></LI
></OL
><P
>Congratulations, you are logged in!</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="CREATENEWUSERS"
>3.2.2.2. Creating new users</A
></H3
><P
> Your users can create their own user accounts by clicking the "New Account"
link at the bottom of each page.
However, should you desire to create user accounts ahead of time, here is how you do it.
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> After logging in, click the "Users" link at the footer of the query page.
</P
></LI
><LI
><P
> To see a specific user, type a portion of their login name
in the box provided and click "submit".
To see all users, simply click the "submit" button.
You must click "submit" here to be able to add a new user.
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> More functionality is available via the list on the right-hand side
of the text entry box.
You can match what you type as a case-insensitive substring (the default)
of all users on your system, a case-sensitive regular expression
(please see the "man regexp" manual page for details on regular expression syntax),
or a <EM
>reverse</EM
> regular expression match,
where every user name which does NOT match the regular expression
is selected.
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Click the "Add New User" link at the bottom of the user list
</P
></LI
><LI
><P
> Fill out the form presented. This page is self-explanatory. When done, click "submit".
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Adding a user this way will <EM
>not</EM
> send an email
informing them of their username and password.
In general, it is preferable to log out and use the "New Account"
button to create users, as it will pre-populate all the required fields and also notify
the user of her account name and password.
</P
></BLOCKQUOTE
></DIV
></LI
></OL
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="DISABLEUSERS"
>3.2.2.3. Disabling Users</A
></H3
><P
> I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen,
when you edit an account?
By entering any text in this box and selecting "submit",
you have prevented the user from using Bugzilla via the web interface.
Your explanation, written in this text box, will be presented to the user
the next time she attempts to use the system.
<DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> Don't disable your own administrative account, or you will hate life!
</P
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="MODIFYUSERS"
>3.2.2.4. Modifying Users</A
></H3
><P
> Here I will attempt to describe the function of each option on the user edit screen.
</P
><P
></P
><UL
><LI
><P
> <EM
>Login Name</EM
>: This is generally the user's email address.
However, if you have edited your system parameters,
this may just be the user's login name or some other identifier.
<DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> For compatability reasons, you should probably
stick with email addresses as user login names. It will make your life easier.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> <EM
>Real Name</EM
>: Duh!
</P
></LI
><LI
><P
> <EM
>Password</EM
>: You will only see asterisks in versions
of Bugzilla newer than 2.10 or early 2.11. You can change the user password here.
</P
></LI
><LI
><P
> <EM
>Email Notification</EM
>: You may choose from one of three options:
<P
></P
><OL
TYPE="1"
><LI
><P
> All qualifying bugs except those which I change:
The user will be notified of any change to any bug
for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher".
</P
></LI
><LI
><P
> Only those bugs which I am listed on the CC line:
The user will not be notified of changes to bugs where she is the assignee,
reporter, or Q/A contact, but will receive them if she is on the CC list.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> She will still receive whining cron emails if you set up the "whinemail" feature.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> <EM
>All Qualifying Bugs</EM
>: This user is a glutton for punishment.
If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher",
she will get email updates regarding the bug.
</P
></LI
></OL
></P
><P
> <EM
>Disable Text</EM
>: If you type anything in this box,
including just a space, the user account is disabled from making any changes
to bugs via the web interface, and what you type in this box is presented as the reason.
<DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="90%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>Don't disable the administrator account!</P
></TD
></TR
></TABLE
></DIV
>
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> As of this writing, the user can still submit bugs via the e-mail gateway,
if you set it up, despite the disabled text field. The e-mail gateway should
<EM
>not</EM
> be enabled for secure installations of Bugzilla.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> <EM
>CanConfirm</EM
>: This field is only used if you have enabled
"unconfirmed" status in your parameters screen. If you enable this for a user,
that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status).
Be judicious about allowing users to turn this bit on for other users.
</P
></LI
><LI
><P
> <EM
>Creategroups</EM
>: This option will allow a user to create and
destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security
option "usebuggroupsentry" in your parameters, this setting has no effect.
</P
></LI
><LI
><P
> <EM
>Editbugs</EM
>: Unless a user has this bit set, they can only edit
those bugs for which they are the assignee or the reporter.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Leaving this option unchecked does not prevent users from adding
comments to a bug! They simply cannot change a bug priority, severity,
etc. unless they are the assignee or reporter.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> <EM
>Editcomponents</EM
>: This flag allows a user to create new
products and components, as well as modify and destroy those that have no bugs
associated with them. If a product or component has bugs associated with it,
those bugs must be moved to a different product or component before Bugzilla
will allow them to be destroyed. The name of a product or component can be
changed without affecting the associated bugs, but it tends to annoy
the hell out of your users when these change a lot.
</P
></LI
><LI
><P
> <EM
>Editkeywords</EM
>: If you use Bugzilla's keyword functionality,
enabling this feature allows a user can create and destroy keywords.
As always, the keywords for existing bugs containing the keyword
the user wishes to destroy must be changed before Bugzilla will allow it to die.
You must be very careful about creating too many new keywords
if you run a very large Bugzilla installation; keywords are global variables
across products, and you can often run into a phenomenon called "keyword bloat".
This confuses users, and then the feature goes unused.
</P
></LI
><LI
><P
> <EM
>Editusers</EM
>: This flag allows a user do what you're doing
right now: edit other users.
This will allow those with the right to do so to remove administrator
priveleges from other users or grant them to themselves. Enable with care.
</P
></LI
><LI
><P
> <EM
>PRODUCT</EM
>: PRODUCT bugs access. This allows an administrator,
with product-level granularity, to specify in which products a user can edit bugs.
The user must still have the "editbugs" privelege to edit bugs in this area;
this simply restricts them from even seeing bugs outside these boundaries if the administrator
has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups,
this option has no effect.
</P
></LI
></UL
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="PROGRAMADMIN"
>3.3. Product, Component, Milestone, and Version Administration</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>Dear Lord, we have to get our users to do WHAT?</I
></P
></I
></TD
></TR
></TABLE
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="PRODUCTS"
>3.3.1. Products</A
></H2
><FONT
COLOR="RED"
>Formerly, and in some spots still, called "Programs"</FONT
><P
> <A
HREF="#GLOSS_PRODUCT"
><I
CLASS="GLOSSTERM"
>Products</I
></A
> are the
broadest category in Bugzilla, and you should have the least of these.
If your company makes computer games, you should have one product per game,
and possibly a few special products
(website, meetings...)
</P
><P
> A Product (formerly called "Program", and still referred to that way
in some portions of the source code) controls some very important functions.
The number of "votes" available for users to vote for the most important bugs
is set per-product, as is the number of votes required to move a bug automatically
from the UNCONFIRMED status to the NEW status. One can close a Product for further
bug entry and define various Versions available from the Edit Product screen.
</P
><P
>To create a new product:</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Select "components" from the yellow footer
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> It may seem counterintuitive to click "components" when you want
to edit the properties associated with Products. This is one of a long
list of things we want in Bugzilla 3.0...
</P
></BLOCKQUOTE
></DIV
></LI
><LI
><P
> Select the "Add" link to the right of "Add a new product".
</P
></LI
><LI
><P
> Enter the name of the product and a description.
The Description field is free-form.
</P
></LI
></OL
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> Don't worry about the "Closed for bug entry", "Maximum Votes per person",
"Maximum votes a person can put on a single bug", "Number of votes a bug in
this Product needs to automatically get out of the UNCOMFIRMED state",
and "Version" options yet.
We'll cover those in a few moments.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="COMPONENTS"
>3.3.2. Components</A
></H2
><P
> Components are subsections of a Product.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN850"
></A
><P
><B
>Example 3-1. Creating some Components</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN852"
></A
><P
></P
><P
> The computer game you are designing may a "UI" component, an "API" component,
a "Sound System" component, and a "Plugins" component, each overseen by a different
programmer. It often makes sense to divide Components in Bugzilla according to the
natural divisions of responsibility within your Product or company.
</P
><P
></P
></DIV
></DIV
>
Each component has a owner and (if you turned it on in the parameters), a qa
contact. The owner should be the primary person who fixes bugs in that component. The QA
Contact should be the person who will ensure these bugs are completely fixed. The Owner,
QA Contact, and Reporter will get email when new bugs are created in this Component and
when these bugs change. Default Owner and Default QA Contact fields only dictate the
<EM
>default assignments</EM
>; the Owner and Q/A Contact fields in a bug
are otherwise unrelated to the Component.
</P
><P
> To create a new Component:
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Select the "Edit components" link from the "Edit Product" page
</P
></LI
><LI
><P
> Select the "Add" link to the right of the "Add a new component" text
on the "Select Component" page.
</P
></LI
><LI
><P
> Fill out the "Component" field, a short "Description", and the "Initial Owner".
The "Component" field should not contain a space. The "Description" field is
free-form. The "Initial Owner" field must be that of a valid user already
existing in the database. If the initial owner does not exist, Bugzilla
will refuse to create the component.
<DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> Is your "Default Owner" a user who is not yet in the database?
No problem.
<P
></P
><OL
TYPE="a"
><LI
><P
> Select the "Log out" link on the footer of the page.
</P
></LI
><LI
><P
> Select the "New Account" link on the footer of the "Relogin" page
</P
></LI
><LI
><P
> Type in the email address of the default owner you want to create
in the "E-mail address" field, and her full name in the "Real name"
field, then select the "Submit Query" button.
</P
></LI
><LI
><P
> Now select "Log in" again, type in your login information, and you
can modify the product to use the Default Owner information
you require.
</P
></LI
></OL
>
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> Either "edit" more components or return to the "query" page on the ensuing
"Addming new component" page. To return to the Product you were editing, you
must select the "components" link as before.
</P
></LI
></OL
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="VERSIONS"
>3.3.3. Versions</A
></H2
><P
> Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95",
and "Flinders 2000". Using Versions helps you isolate code changes and are an aid
in reporting.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN879"
></A
><P
><B
>Example 3-2. Common Use of Versions</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN881"
></A
><P
></P
><P
> A user reports a bug
against Version "Beta 2.0" of your product. The current Version of your software
is "Release Candidate 1", and no longer has the bug. This will
help you triage and classify bugs according to their relevance. It is also
possible people may report bugs against bleeding-edge beta versions that are
not evident in older versions of the software. This can help isolate code
changes that caused the bug
</P
><P
></P
></DIV
></DIV
>
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN883"
></A
><P
><B
>Example 3-3. A Different Use of Versions</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN885"
></A
><P
></P
><P
> This field has been used to good effect by an online service provider in a slightly
different way. They had three versions of the product: "Production", "QA",
and "Dev". Although it may be the same product, a bug in the development
environment is not normally as critical as a Production bug, nor does it
need to be reported publicly. When used in conjunction with Target Milestones,
one can easily specify the environment where a bug can be reproduced, and
the Milestone by which it will be fixed.
</P
><P
></P
></DIV
></DIV
>
</P
><P
> To create and edit Versions:
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> From the "Edit Product" screen, select "Edit Versions"
</P
></LI
><LI
><P
> You will notice that the product already has the default version "undefined".
If your product doesn't use version numbers, you may want to leave this as it is
or edit it so that it is "---". You can then go back to the edit versions page
and add new versions to your product.
</P
><P
> Otherwise, click the "Add" button to the right of the "Add a new version" text.
</P
></LI
><LI
><P
> Enter the name of the Version. This can be free-form characters up to the limit of the
text box. Then select the "Add" button.
</P
></LI
><LI
><P
> At this point you can select "Edit" to edit more Versions, or return to the "Query"
page, from which you can navigate back to the product through the "components" link
at the foot of the Query page.
</P
></LI
></OL
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="MILESTONES"
>3.3.4. Milestones</A
></H2
><P
> Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that
you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a
bug that you plan to fix for 2.8, this would have a milestone of 2.8.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Milestone options will only appear for a Product if you turned the "usetargetmilestone" field
in the "Edit Parameters" screen "On".
</P
></BLOCKQUOTE
></DIV
><P
> To create new Milestones, set Default Milestones, and set Milestone URL:
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Select "edit milestones"
</P
></LI
><LI
><P
> Select "Add" to the right of the "Add a new milestone" text
</P
></LI
><LI
><P
> Enter the name of the Milestone in the "Milestone" field.
You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255)
that defines where in the list this particular milestone appears.
Select "Add".
</P
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN911"
></A
><P
><B
>Example 3-4. Using SortKey with Target Milestone</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN913"
></A
><P
></P
><P
> Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0".
Later, you realize that you will have a public beta, called "Beta1".
You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure
people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0"
</P
><P
></P
></DIV
></DIV
></LI
><LI
><P
> If you want to add more milestones, select the "Edit" link.
If you don't, well shoot, you have to go back to the "query" page and select "components"
again, and make your way back to the Product you were editing.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> This is another in the list of unusual user interface decisions that
we'd like to get cleaned up. Shouldn't there be a link to the effect of
"edit the Product I was editing when I ended up here"? In any case,
clicking "components" in the footer takes you back to the "Select product"
screen, from which you can begin editing your product again.
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> From the Edit Product screen again (once you've made your way back), enter the URL
for a description of what your milestones are for this product in the "Milestone URL" field.
It should be of the format "http://www.foo.com/bugzilla/product_milestones.html"
</P
><P
> Some common uses of this field include product descriptions, product roadmaps,
and of course a simple description of the meaning of each milestone.
</P
></LI
><LI
><P
> If you're using Target Milestones, the "Default Milestone" field must have some
kind of entry. If you really don't care if people set coherent Target Milestones,
simply leave this at the default, "---". However, controlling and regularly updating the Default
Milestone field is a powerful tool when reporting the status of projects.
</P
><P
>Select the "Update" button when you are done.</P
></LI
><LI
><P
>
</P
></LI
></OL
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="VOTING"
>3.3.5. Voting</A
></H2
><P
> The concept of "voting" is a poorly understood, yet powerful feature for the management
of open-source projects. Each user is assigned so many Votes per product, which they can
freely reassign (or assign multiple votes to a single bug).
This allows developers to gauge user need for a particular enhancement
or bugfix. By allowing bugs with a certain number of votes to automatically move from
"UNCONFIRMED" to "NEW", users of the bug system can help high-priority bugs garner
attention so they don't sit for a long time awaiting triage.
</P
><P
> The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you
only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED
to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be
re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved,
and perhaps forego implementation until you have a critical mass of users who demand it.
</P
><P
>To modify Voting settings:</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Navigate to the "Edit Product" screen for the Product you wish to modify
</P
></LI
><LI
><P
> Set "Maximum Votes per person" to your calculated value. Setting this field
to "0" disables voting.
</P
></LI
><LI
><P
> Set "Maximum Votes a person can put on a single bug" to your calculated value. It
should probably be some number lower than the "Maximum votes per person".
Setting this field to "0" disables voting, but leaves the voting options open
to the user. This is confusing.
</P
></LI
><LI
><P
> Set "Number of votes a bug in this product needs to automatically get out of the
UNCONFIRMED state" to your calculated number. Setting this field to "0"
disables the automatic move of bugs from UNCONFIRMED to NEW. Some people
advocate leaving this at "0", but of what use are Votes if your Bugzilla
user base is unable to affect which bugs appear on Development radar?
<DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
> You should probably set this number to higher than a small coalition of
Bugzilla users can influence it. Most sites use this as a "referendum"
mechanism -- if users are able to vote a bug out of UNCONFIRMED, it
is a <EM
>really</EM
> bad bug!
</P
></BLOCKQUOTE
></DIV
>
</P
></LI
><LI
><P
> Once you have adjusted the values to your preference, select the "Update" button.
</P
></LI
></OL
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="GROUPS"
>3.3.6. Groups and Group Security</A
></H2
><P
> Groups can be very useful in bugzilla, because they allow users to isolate
bugs or products that should only be seen by certain people. Groups can also
be a complicated minefield of interdependencies and weirdness if mismanaged.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN949"
></A
><P
><B
>Example 3-5. When to Use Group Security</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN951"
></A
><P
></P
><P
> Many Bugzilla sites isolate "Security-related" bugs from all other bugs.
This way, they can have a fix ready before the security vulnerability
is announced to the world. You can create a "Security" product which, by
default, has no members, and only add members to the group (in their individual
User page, as described under User Administration) who should have
priveleged access to "Security" bugs. Alternately, you may create a Group
independently of any Product, and change the Group mask on individual bugs
to restrict access to members only of certain Groups.
</P
><P
></P
></DIV
></DIV
>
Groups only work if you enable the "usebuggroups" paramater.
In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access
to products by groups, so that only members of a product group are able to view
bugs within that product.
Group security in Bugzilla can be divided into two categories:
Generic and Product-Based.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Groups in Bugzilla are a complicated beast that evolved out of very simple user
permission bitmasks, apparently itself derived from common concepts in UNIX access
controls. A "bitmask" is a fixed-length number whose value can describe one, and
only one, set of states. For instance, UNIX file permissions are assigned bitmask
values: "execute" has a value of 1, "write" has a value of 2,
and "read" has a value of 4. Add them together,
and a file can be read, written to, and executed if it has a bitmask of "7". (This
is a simplified example -- anybody who knows UNIX security knows there is much
more to it than this. Please bear with me for the purpose of this note.) The only
way a bitmask scheme can work is by doubling the bit count for each value. Thus
if UNIX wanted to offer another file permission, the next would have to be a value of
8, then the next 16, the next 32, etc.
</P
><P
> Similarly, Bugzilla offers a bitmask to define group permissions, with an internal
limit of 64. Several are already occupied
by built-in permissions. The way around this limitation is
to avoid assigning groups to products if you have many products, avoid bloating
of group lists, and religiously prune irrelevant groups. In reality, most installations
of Bugzilla support far fewer than 64 groups, so this limitation has not hit
for most sites, but it is on the table to be revised for Bugzilla 3.0
because it interferes with the security schemes of some administrators.
</P
></BLOCKQUOTE
></DIV
><P
> To enable Generic Group Security ("usebuggroups"):
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Turn "On" "usebuggroups" in the "Edit Parameters" screen.
</P
></LI
><LI
><P
> You will generally have no groups set up. Select the "groups" link
in the footer.
</P
></LI
><LI
><P
> Take a moment to understand the instructions on the "Edit Groups" screen.
Once you feel confident you understand what is expected of you, select the
"Add Group" link.
</P
></LI
><LI
><P
> Fill out the "New Name" (remember, no spaces!), "New Description", and "New
User RegExp" fields. "New User RegExp" allows you to automatically place
all users who fulfill the Regular Expression into the new group.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN966"
></A
><P
><B
>Example 3-6. Creating a New Group</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN968"
></A
><P
></P
><P
> I created a group called "DefaultGroup" with a description of "This is simply
a group to play with", and a "New User RegExp" of "*@velio.com". This
new group automatically includes all Bugzilla users with "@velio.com" at the
end of their user id. When I finished, my new group was assigned bit #128.
</P
><P
></P
></DIV
></DIV
>
When you have finished, select the "Add" button.
</P
></LI
></OL
><P
> To enable Product-Based Group Security ("usebuggroupsentry"):
</P
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> Don't forget that you only have 64 groups masks available, total, for
your installation of Bugzilla! If you plan on having more than 50
products in your individual Bugzilla installation, and require group
security for your products, you should
consider either running multiple Bugzillas or using Generic Group Security
instead of Product-Based ("usebuggroupsentry") Group Security.
</P
></TD
></TR
></TABLE
></DIV
><P
></P
><OL
TYPE="1"
><LI
><P
> Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen.
</P
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="90%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> "usebuggroupsentry" has the capacity to prevent the administrative user
from directly altering bugs because of conflicting group permissions.
If you plan on using "usebuggroupsentry", you should plan on restricting administrative
account usage to administrative duties only.
In other words, manage bugs with an unpriveleged user account, and
manage users, groups, Products, etc. with the administrative account.
</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><P
> You will generally have no Groups set up, unless you enabled "usebuggroupsentry"
prior to creating any Products. To create "Generic Group Security" groups,
follow the instructions given above. To create Product-Based Group security,
simply follow the instructions for creating a new Product. If you need to
add users to these new groups as you create them, you will find the option
to add them to the group available under the "Edit User" screens.
</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="SECURITY"
>3.4. Bugzilla Security</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>Putting your money in a wall safe is better protection than depending on the fact that
no one knows that you hide your money in a mayonnaise jar in your fridge.</I
></P
></I
></TD
></TR
></TABLE
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Poorly-configured MySQL, Bugzilla, and FTP installations have given attackers full
access to systems in the past. Please take these guidelines seriously, even
for Bugzilla machines hidden away behind your firewall. 80% of all computer
trespassers are insiders, not anonymous crackers.
</P
></BLOCKQUOTE
></DIV
><P
> First thing's first: Secure your installation.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different
platforms. If you have refinements of these directions for specific platforms, please
submit them to <A
HREF="mailto://mozilla-webtools@mozilla.org"
TARGET="_top"
>mozilla-webtools@mozilla.org</A
>
</P
></BLOCKQUOTE
></DIV
>
<P
></P
><OL
TYPE="1"
><LI
><P
> Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had
notable security holes and poorly secured default configuration choices.
</P
></LI
><LI
><P
><EM
>There is no substitute for understanding the tools on your system!</EM
>
Read <A
HREF="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"
TARGET="_top"
> The MySQL Privelege System</A
> until you can recite it from memory!</P
><P
> At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant
table rights (consult the Keystone guide in Appendix C: The Bugzilla Database for some easy-to-use details)
that do not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone
advice back when I knew far less about security than I do now : )
</P
></LI
><LI
><P
> Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to
port 25 for Sendmail
and port 80 for Apache.
</P
></LI
><LI
><P
>Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories.
Run it, instead, as a user with a name, set via your httpd.conf file.</P
></LI
><LI
><P
> Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and
$BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig and
$BUGZILLA_HOME/globals.pl files.
The localconfig file stores your "bugs" user password,
which would be terrible to have in the hands
of a criminal, while the "globals.pl" stores some default information regarding your
installation which could aid a system cracker.
In addition, some files under $BUGZILLA_HOME/data/ store sensitive information, and
$BUGZILLA_HOME/shadow/ stores bug information for faster retrieval. If you fail to secure
these directories and this file, you will expose bug information to those who may not
be allowed to see it.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Bugzilla provides default .htaccess files to protect the most common Apache
installations. However, you should verify these are adequate according to the site-wide
security policy of your web server, and ensure that the .htaccess files are
allowed to "override" default permissions set in your Apache configuration files.
Covering Apache security is beyond the scope of this Guide; please consult the Apache
documentation for details.
</P
><P
> If you are using a web server that does not support the .htaccess control method,
<EM
>you are at risk!</EM
> After installing, check to see if you can
view the file "localconfig" in your web browser (ergo:
<A
HREF="http://bugzilla.mozilla.org/localconfig"
TARGET="_top"
> http://bugzilla.mozilla.org/localconfig</A
>. If you can read the contents of this
file, your web server has not secured your bugzilla directory properly and you
must fix this problem before deploying Bugzilla. If, however, it gives you a
"Forbidden" error, then it probably respects the .htaccess conventions and you
are good to go.
</P
></BLOCKQUOTE
></DIV
><P
> On Apache, you can use .htaccess files to protect access to these directories, as outlined
in <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=57161"
TARGET="_top"
>Bug 57161</A
> for the
localconfig file, and <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"
TARGET="_top"
> Bug 65572</A
> for adequate protection in your data/ and shadow/ directories.
</P
><P
> Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other
non-Apache web servers, please consult your system documentation for how to secure these
files from being transmitted to curious users.
</P
><P
> Place the following text into a file named ".htaccess", readable by your web server,
in your $BUGZILLA_HOME/data directory.
<P
CLASS="LITERALLAYOUT"
> <Files comments><br>
allow from all<br>
</Files><br>
deny from all<br>
</P
>
</P
><P
> Place the following text into a file named ".htaccess", readable by your web server,
in your $BUGZILLA_HOME/ directory.
<P
CLASS="LITERALLAYOUT"
> <Files localconfig><br>
deny from all<br>
</Files><br>
allow from all<br>
</P
>
</P
><P
> Place the following text into a file named ".htaccess", readable by your web server,
in your $BUGZILLA_HOME/shadow directory.
<P
CLASS="LITERALLAYOUT"
> deny from all<br>
</P
>
</P
></LI
></OL
>
</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="USING"
>Chapter 4. Using Bugzilla</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>What, Why, How, & What's in it for me?</I
></P
></I
></TD
></TR
></TABLE
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="WHATIS"
>4.1. What is Bugzilla?</A
></H1
><P
> Bugzilla is one example of a class of programs called "Defect Tracking Systems",
or, more commonly, "Bug-Tracking Systems". Defect Tracking Systems allow individual or
groups of developers to keep track of outstanding bugs in their product effectively.
Bugzilla was originally written by Terry Weissman in a programming language called
"TCL", to replace a crappy
bug-tracking database used internally for Netscape Communications. Terry later ported
Bugzilla to
Perl from TCL, and in Perl it remains to this day.
Most commercial defect-tracking software vendors at the
time charged enormous licensing fees, and Bugzilla quickly became a favorite of the
open-source crowd (with its genesis in the open-source browser project, Mozilla). It
is now the de-facto standard defect-tracking system against which all others are
measured.
</P
><P
> Bugzilla has matured immensely, and now boasts many advanced features. These include:
<P
></P
><UL
><LI
><P
> integrated, product-based granular security schema
</P
></LI
><LI
><P
> inter-bug dependencies and dependency graphing
</P
></LI
><LI
><P
> advanced reporting capabilities
</P
></LI
><LI
><P
> a robust, stable RDBMS back-end
</P
></LI
><LI
><P
> extensive configurability
</P
></LI
><LI
><P
> a very well-understood and well-thought-out natural bug resolution protocol
</P
></LI
><LI
><P
> email, XML, and HTTP APIs
</P
></LI
><LI
><P
> available integration with automated software configuration management systems, including
Perforce and CVS.
</P
></LI
><LI
><P
> too many more features to list
</P
></LI
></UL
>
</P
><P
> Despite its current robustness and popularity, however, Bugzilla
faces some near-term challenges, such as reliance on a single database, a lack of
abstraction of the user interface and program logic, verbose email bug
notifications, a powerful but daunting query interface, little reporting configurability,
problems with extremely large queries, some unsupportable bug resolution options,
no internationalization, and dependence on some nonstandard libraries.
</P
><P
> Some recent headway has been made on the query front, however. If you are using the latest
version of Bugzilla, you should see a "simple search" form on the default front page of
your Bugzilla install. Type in two or three search terms and you should pull up some
relevant information. This is also available as "queryhelp.cgi".
</P
><P
> Despite these small problems, Bugzilla is very hard to beat. It is under <EM
>very</EM
>
active development to address the current issues, and a long-awaited overhaul in the form
of Bugzilla 3.0 is expected sometime later this year.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="WHY"
>4.2. Why Should We Use Bugzilla?</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>No, Who's on first...</I
></P
></I
></TD
></TR
></TABLE
><P
> For many years, defect-tracking software has remained principally the domain
of large software development houses. Even then, most shops never bothered
with bug-tracking software, and instead simply relied on shared lists and
email to monitor the status of defects. This procedure is error-prone and
tends to cause those bugs judged least significant by developers to be
dropped or ignored
</P
><P
> These days, many companies are finding that integrated defect-tracking
systems reduce downtime, increase productivity, and raise customer
satisfaction with their systems. Along with full disclosure, an open
bug-tracker allows manufacturers to keep in touch with their clients
and resellers, to communicate about problems effectively throughout
the data management chain. Many corporations have also discovered that
defect-tracking helps reduce costs by providing IT support accountability,
telephone support knowledge bases, and a common, well-understood system
for accounting for unusual system or software issues.
</P
><P
> But why should <EM
>you</EM
> use Bugzilla?
</P
><P
> Bugzilla is very adaptable to various situations. Known uses currently
include IT support queues, Systems Administration deployment management,
chip design and development problem tracking (both pre-and-post fabrication),
and software and hardware bug tracking for luminaries such as Redhat, Loki software,
Linux-Mandrake, and VA Systems. Combined with systems such as CVS, Bonsai,
or Perforce SCM, Bugzilla provides a powerful, easy-to-use solution to
configuration management and replication problems
</P
><P
> Bugzilla can dramatically increase the productivity and accountability
of individual employees by providing a documented workflow and positive
feedback for good performance. How many times do you wake up in the
morning, remembering that you were supposed to do *something* today,
but you just can't quite remember? Put it in Bugzilla, and you have a record
of it from which you can extrapolate milestones, predict product versions
for integration, and by using Bugzilla's e-mail integration features
be able to follow the discussion trail that led to critical decisions.
</P
><P
> Ultimately, Bugzilla puts the power in your hands to improve your value
to your employer or business while providing a usable framework for your natural
attention to detail and knowledge store to flourish.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="HOW"
>4.3. How do I use Bugzilla?</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>Hey! I'm Woody! Howdy, Howdy, Howdy!</I
></P
></I
></TD
></TR
></TABLE
><P
> Bugzilla is a large, complex system. Describing how to use it
requires some time. If you are only interested in installing or administering
a Bugzilla installation, please consult the Installing and Administering
Bugzilla portions of this Guide. This section is principally aimed towards
developing end-user mastery of Bugzilla, so you may fully enjoy the benefits
afforded by using this reliable open-source bug-tracking software.
</P
><P
> Throughout this portion of the Guide, we will refer to user account
options available at the Bugzilla test installation,
<A
HREF="http://landfill.tequilarista.org/"
TARGET="_top"
> landfill.tequilarista.org</A
>.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Some people have run into difficulties completing this tutorial. If
you run into problems, please check the updated, online documentation available
at <A
HREF="http://www.trilobyte.net/barnsons/"
TARGET="_top"
>http://www.trilobyte.net/barnsons</A
>.
If you're still stumped, please subscribe to the newsgroup and provide details of exactly
what's stumping you! If enough people complain, I'll have to fix it in the next
version of this Guide. You can subscribe to the newsgroup at
<A
HREF="news://news.mozilla.org/netscape.public.mozilla.webtools"
TARGET="_top"
> news://news.mozilla.org/netscape.public.mozilla.webtools</A
>
</P
></BLOCKQUOTE
></DIV
>
Although Landfill serves as a great introduction to Bugzilla, it does not offer
all the options you would have as a user on your own installation of Bugzilla,
nor can it do more than serve as a general introduction to Bugzilla. Additionally,
Landfill often runs cutting-edge versions of Bugzilla for testing, so some things
may work slightly differently than mentioned here.
</P
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="MYACCOUNT"
>4.3.1. Create a Bugzilla Account</A
></H2
><P
> First thing's first! If you want to use Bugzilla, first you need to create
an account. Consult with the administrator responsible for your installation
of Bugzilla for the URL you should use to access it.
If you're test-driving the end-user Bugzilla experience, use this URL:
<A
HREF="http://landfill.tequilarista.org/mozilla/bugzilla/"
TARGET="_top"
> http://landfill.tequilarista.org/mozilla/bugzilla/</A
>
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Click the "Open a new Bugzilla account" link.
</P
></LI
><LI
><P
> Enter your "E-mail address" and "Real Name" (or whatever name you want to call yourself)
in the spaces provided, then select the "Create Account" button.
</P
></LI
><LI
><P
> Within 5-10 minutes, you should receive an email to the address you provided above,
which contains your login name (generally the same as the email address), and
a password you can use to access your account. This password is randomly generated,
and should be changed at your nearest opportunity (we'll go into how to do it later).
</P
></LI
><LI
><P
> Click the "Log In" link in the yellow area at the bottom of the page in your browser,
then enter your "E-mail address" and "Password" you just received into the spaces provided,
and select "Login".
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> If you ever forget your password, you can come back to this page, enter your
"E-mail address", then select the "E-mail me a password" button to have your password
mailed to you again so that you can login.
</P
></BLOCKQUOTE
></DIV
>
<DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
BORDER="1"
WIDTH="90%"
><TR
><TD
ALIGN="CENTER"
><B
>Caution</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
> Many modern browsers include an "Auto-Complete" or "Form Fill" feature to
remember the user names and passwords you type in at many sites. Unfortunately,
sometimes they attempt to "guess" what you will put in as your password, and guess
wrong. If you notice a text box is already filled out, please overwrite the contents
of the text box so you can be sure to input the correct information.
</P
></TD
></TR
></TABLE
></DIV
>
</P
></LI
></OL
><P
> Congratulations! If you followed these directions, you now are the
proud owner of a user account on landfill.tequilarista.org (Landfill) or
your local Bugzilla install. You should now see in your browser a
page called the "Bugzilla Query Page". It may look daunting, but
with this Guide to walk you through it, you will master it in no time.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="QUERY"
>4.3.2. The Bugzilla Query Page</A
></H2
><P
> The Bugzilla Query Page is the heart and soul of Bugzilla. It is the master
interface where you can find any bug report, comment, or patch currently in the Bugzilla
system. We'll go into how to create your own bug report later on.
</P
><P
> There are efforts underway to simplify query usage. If you have a local installation
of Bugzilla 2.12 or higher, you should have "quicksearch.html" available
to use and simplify your searches. There is also, or shortly will be, a helper
for the query interface, called "queryhelp.cgi". Landfill tends to run the latest code,
so these two utilities should be available there for your perusal.
</P
><P
> At this point, please visit the main Bugzilla site,
<A
HREF="http://bugzilla.mozilla.org/query.cgi"
TARGET="_top"
> bugzilla.mozilla.org</A
>, to see a more fleshed-out query page.
</P
><P
> The first thing you need to notice about the Bugzilla Query Page is that
nearly every box you see on your screen has a hyperlink nearby, explaining what
it is or what it does. Near the upper-left-hand corner of your browser window
you should see the word "Status" underlined. Select it.
</P
><P
> Notice the page that popped up? Every underlined word you see on your screen
is a hyperlink that will take you to context-sensitive help.
Click around for a while, and learn what everything here does. To return
to the query interface after pulling up a help page, use the "Back" button in
your browser.
</P
><P
> I'm sure that after checking out the online help, you are now an Expert
on the Bugzilla Query Page. If, however, you feel you haven't mastered it yet,
let me walk you through making a few successful queries to find out what there
are in the Bugzilla bug-tracking system itself.
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Ensure you are back on the "Bugzilla Query Page"
Do nothing in the boxes marked "Status", "Resolution", "Platform", "OpSys",
"Priority", or "Severity". The default query for "Status" is to find all bugs that
are NEW, ASSIGNED, or REOPENED, which is what we want. If you don't select anything
in the other 5 scrollboxes there, then you are saying that "any of these are OK";
we're not locking ourselves into only finding bugs on the "DEC" Platform, or "Windows 95"
OpSys (Operating System). You're smart, I think you have it figured out.
</P
><P
> Basically, selecting <EM
>anything</EM
> on the query page narrows your search
down. Leaving stuff unselected, or text boxes unfilled, broadens your search!
</P
></LI
><LI
><P
> You see the box immediately below the top six boxes that contains an "Email" text box,
with the words "matching as", a drop-down selection box, then some checkboxes with
"Assigned To" checked by default? This allows you to filter your search down based upon
email address. Let's put my email address in there, and see what happens.
</P
><P
> Type "barnboy@trilobyte.net" in the top Email text box.
</P
></LI
><LI
><P
> Let's narrow the search some more. Scroll down until you find the box with the word
"Program" over the top of it. This is where we can narrow our search down to only
specific products (software programs or product lines) in our Bugzilla database.
Please notice the box is a <EM
>scrollbox</EM
>. Using the down arrow on the
scrollbox, scroll down until you can see an entry called "Webtools". Select this entry.
</P
></LI
><LI
><P
> Did you notice that some of the boxes to the right changed when you selected "Webtools"?
Every Program (or Product) has different Versions, Components, and Target Milestones associated
with it. A "Version" is the number of a software program.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1112"
></A
><P
><B
>Example 4-1. Some Famous Software Versions</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1114"
></A
><P
></P
><P
> Do you remember the hype in 1995 when Microsoft Windows 95(r) was released?
It may have been several years
ago, but Microsoft(tm) spent over $300 Million advertising this new Version of their
software. Three years later, they released Microsoft Windows 98(r),
another new version, to great fanfare, and then in 2000 quietly
released Microsoft Windows ME(Millenium Edition)(r).
</P
><P
> Software "Versions" help a manufacturer differentiate
their current product from their
previous products. Most do not identify their products
by the year they were released.
Instead, the "original" version of their software will
often be numbered "1.0", with
small bug-fix releases on subsequent tenths of a digit. In most cases, it's not
a decimal number; for instance, often 1.9 is an <EM
>older</EM
> version
of the software than 1.11,
but is a <EM
>newer</EM
> version than 1.1.1.
</P
><P
> In general, a "Version" in Bugzilla should refer to
<EM
>released</EM
>
products, not products that have not yet been released
to the public. Forthcoming products
are what the Target Milestone field is for.
</P
><P
></P
></DIV
></DIV
>
</P
><P
> A "Component" is a piece of a Product.
It may be a standalone program, or some other logical
division of a Product or Program.
Normally, a Component has a single Owner, who is responsible
for overseeing efforts to improve that Component.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1122"
></A
><P
><B
>Example 4-2. Mozilla Webtools Components</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1124"
></A
><P
></P
><P
> Mozilla's "Webtools" Product is composed of several pieces (Components):
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><EM
>Bonsai</EM
>,
a tool to show recent changes to Mozilla</TD
></TR
><TR
><TD
><EM
>Bugzilla</EM
>,
a defect-tracking tool</TD
></TR
><TR
><TD
><EM
>Build</EM
>,
a tool to automatically compile source code
into machine-readable form</TD
></TR
><TR
><TD
><EM
>Despot</EM
>,
a program that controls access to the other Webtools</TD
></TR
><TR
><TD
><EM
>LXR</EM
>,
a utility that automatically marks up text files
to make them more readable</TD
></TR
><TR
><TD
><EM
>MozBot</EM
>,
a "robot" that announces changes to Mozilla in Chat</TD
></TR
><TR
><TD
><EM
>TestManager</EM
>,
a tool to help find bugs in Mozilla</TD
></TR
><TR
><TD
><EM
>Tinderbox</EM
>,
which displays reports from Build</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> A different person is responsible for each of these Components.
Tara Hernandez keeps
the "Bugzilla" component up-to-date.
</P
><P
></P
></DIV
></DIV
>
</P
><P
> A "Milestone", or "Target Milestone" is a often a planned future "Version" of a
product. In many cases, though, Milestones simply represent significant dates for
a developer. Having certain features in your Product is frequently
tied to revenue (money)
the developer will receive if the features work by the time she
reaches the Target Milestone.
Target Milestones are a great tool to organize your time.
If someone will pay you $100,000 for
incorporating certain features by a certain date,
those features by that Milestone date become
a very high priority. Milestones tend to be highly malleable creatures,
though, that appear
to be in reach but are out of reach by the time the important day arrives.
</P
><P
> The Bugzilla Project has set up Milestones for future
Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However,
a Target Milestone can just as easily be a specific date,
code name, or weird alphanumeric
combination, like "M19".
</P
></LI
><LI
><P
> OK, now let's select the "Bugzilla" component from its scrollbox.
</P
></LI
><LI
><P
> Skip down the page a bit -- do you see the "submit query" button?
Select it, and let's run
this query!
</P
></LI
><LI
><P
> Congratulations! You've completed your first Query, and have before you the Bug List
of the author of this Guide, Matthew P. Barnson (barnboy@trilobyte.net). If I'm
doing well,
you'll have a cryptic "Zarro Boogs Found" message on your screen. It is just
a happy hacker's way of saying "Zero Bugs Found". However, I am fairly certain I will
always have some bugs assigned to me that aren't done yet,
so you won't often see that message!
</P
></LI
></OL
><P
> I encourage you to click the bug numbers in the left-hand column and examine
my bugs. Also notice that if you click the underlined
links near the top of this page, they do
not take you to context-sensitive help here,
but instead sort the columns of bugs on the screen!
When you need to sort your bugs by priority, severity,
or the people they are assigned to, this
is a tremendous timesaver.
</P
><P
> A couple more interesting things about the Bug List page:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><EM
>Change Columns</EM
>:
by selecting this link, you can show all kinds
of information in the Bug List</TD
></TR
><TR
><TD
><EM
>Change several bugs at once</EM
>:
If you have sufficient rights to change all
the bugs shown in the Bug List, you can mass-modify them.
This is a big time-saver.</TD
></TR
><TR
><TD
><EM
>Send mail to bug owners</EM
>:
If you have many related bugs, you can request
an update from every person who owns the bugs in
the Bug List asking them the status.</TD
></TR
><TR
><TD
><EM
>Edit this query</EM
>:
If you didn't get exactly the results you were looking for,
you can return to the Query page through this link and make
small revisions to the query you just made so
you get more accurate results.</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> There are many more options to the Bugzilla Query Page
and the Bug List than I have shown you.
But this should be enough for you to learn to get around.
I encourage you to check out the
<A
HREF="http://www.mozilla.org/bugs/"
TARGET="_top"
>Bugzilla Home Page</A
>
to learn about the Anatomy
and Life Cycle of a Bug before continuing.
</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="BUGREPORTS"
>4.3.3. Creating and Managing Bug Reports</A
></H2
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>And all this time, I thought we were taking bugs <EM
>out</EM
>...</I
></P
></I
></TD
></TR
></TABLE
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="BUG_WRITING"
>4.3.3.1. Writing a Great Bug Report</A
></H3
><P
> Before we plunge into writing your first bug report, I encourage you to read
<A
HREF="http://www.mozilla.org/quality/bug-writing-guidelines.html"
TARGET="_top"
>Mozilla.org's Bug
Writing Guidelines</A
>. While some of the advice is Mozilla-specific, the basic
principles of reporting Reproducible, Specific bugs, isolating the Product you are
using, the Version of the Product, the Component which failed, the Hardware Platform, and
Operating System you were using at the time of the failure go a long way toward ensuring accurate,
responsible fixes for the bug that bit you.
</P
><P
> While you are at it, why not learn how to find previously reported bugs? Mozilla.org
has published a great tutorial on finding duplicate bugs, available at
<A
HREF="http://www.mozilla.org/quality/help/beginning-duplicate-finding.html"
TARGET="_top"
> http://www.mozilla.org/quality/help/beginning-duplicate-finding.html</A
>.
</P
><P
> I realize this was a lot to read. However, understanding the mentality of writing
great bug reports will help us on the next part!
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Go back to <A
HREF="http://landfill.tequilarista.org/mozilla/bugzilla/"
TARGET="_top"
> http://landfill.tequilarista.org/mozilla/bugzilla/</A
>
in your browser.
</P
></LI
><LI
><P
> Select the
<A
HREF="http://landfill.tequilarista.org/mozilla/bugzilla/enter_bug.cgi"
TARGET="_top"
> Enter a new bug report</A
> link.
</P
></LI
><LI
><P
> Select a product.
</P
></LI
><LI
><P
> Now you should be at the "Enter Bug" form.
The "reporter" should have been automatically filled out
for you (or else Bugzilla prompted you to Log In again
-- you did keep the email with your username
and password, didn't you?).
</P
></LI
><LI
><P
> Select a Component in the scrollbox.
</P
></LI
><LI
><P
> Bugzilla should have made reasonable guesses, based upon your browser,
for the "Platform" and "OS" drop-down
boxes. If those are wrong, change them -- if you're on an SGI box
running IRIX, we want to know!
</P
></LI
><LI
><P
> Fill in the "Assigned To" box with the email address you provided earlier.
This way you don't end up sending copies of your bug to lots of other people,
since it's just a test bug.
</P
></LI
><LI
><P
> Leave the "CC" text box blank.
Fill in the "URL" box with "http://www.mozilla.org".
</P
></LI
><LI
><P
> Enter "The Bugzilla Guide" in the Summary text box,
and place any comments you have on this
tutorial, or the Guide in general, into the Description box.
</P
></LI
></OL
><P
> Voila! Select "Commit" and send in your bug report!
Next we'll look at resolving bugs.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="BUG_MANAGE"
>4.3.3.2. Managing your Bug Reports</A
></H3
><P
> OK, you should have a link to the bug you just created near the top of your page.
It should say
"Bug XXXX posted", with a link to the right saying "Back to BUG# XXXX".
Select this link.
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Scroll down a bit on the subsequent page,
until you see the "Resolve bug, changing resolution to (dropdown box).
Normally, you would
"Accept bug (change status to ASSIGNED)", fix it, and then resolve.
But in this case, we're
going to short-circuit the process because this wasn't a real bug.
Change the dropdown next to
"Resolve Bug" to "INVALID", make sure the radio button is
marked next to "Resolve Bug", then
click "Commit".
</P
></LI
><LI
><P
> Hey! It said it couldn't take the change in a big red box!
That's right, you must specify
a Comment in order to make this change. Select the "Back"
button in your browser, add a
Comment, then try Resolving the bug with INVALID status again.
This time it should work.
</P
></LI
></OL
><P
> You have now learned the basics of Bugzilla navigation,
entering a bug, and bug maintenance.
I encourage you to explore these features, and see what you can do with them!
We'll spend no more time on individual Bugs or Queries from this point on, so you are
on your own there.
</P
><P
> But I'll give a few last hints!
</P
><P
> There is a <A
HREF="http://bugzilla.mozilla.org/help.html"
TARGET="_top"
>CLUE</A
>
on the Query page
that will teach you more how to use the form.
</P
><P
> If you click the hyperlink on the
<A
HREF="http://bugzilla.mozilla.org/describecomponents.cgi"
TARGET="_top"
>Component</A
>
box of the Query page, you will be presented a form that will describe what all
the components are.
</P
><P
> Possibly the most powerful feature of the Query page is the
<A
HREF="http://bugzilla.mozilla.org/booleanchart.html"
TARGET="_top"
>Boolean Chart</A
> section.
It's a bit confusing to use the first time, but can provide unparalleled
flexibility in your queries,
allowing you to build extremely powerful requests.
</P
><P
> Finally, you can build some nifty
<A
HREF="http://bugzilla.mozilla.org/reports.cgi"
TARGET="_top"
>Reports</A
>
using the "Bug Reports" link near the bottom of the query page, and also
available via the "Reports" link
at the footer of each page.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="INIT4ME"
>4.4. What's in it for me?</A
></H1
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="EPIGRAPH"
><TR
><TD
WIDTH="45%"
> </TD
><TD
WIDTH="45%"
ALIGN="LEFT"
VALIGN="TOP"
><I
><P
><I
>Indiana, it feels like we walking on fortune cookies!</I
></P
><P
><I
>These ain't fortune cookies, kid...</I
></P
></I
></TD
></TR
></TABLE
><P
> Customized User Preferences offer tremendous versatility to
your individual Bugzilla experience.
Let's plunge into what you can do! The first step is to click
the "Edit prefs" link at the footer of each page once you
have logged in to
<A
HREF="http://landfill.tequilarista.org/mozilla/bugzilla/query.cgi?GoAheadAndLogIn=1"
TARGET="_top"
> Landfill</A
>.
</P
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="ACCOUNTSETTINGS"
>4.4.1. Account Settings</A
></H2
><P
> On this page, you can change your basic Account Settings,
including your password and full name.
For security reasons, in order to change anything on this page you
must type your <EM
>current</EM
>
password into the "Old Password" field.
If you wish to change your password, type the new password you
want into the "New Password" field and again into the "Re-enter
new password" field to ensure
you typed your new password correctly. Select the "Submit" button and you're done!
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="EMAILSETTINGS"
>4.4.2. Email Settings</A
></H2
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="NOTIFICATION"
>4.4.2.1. Email Notification</A
></H3
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The email notification settings described below have been obsoleted in Bugzilla 2.12, and
this section will be replaced with a comprehensive description of the amazing array of
new options at your disposal. However, in the meantime, throw this chunk out the window
and go crazy with goofing around with different notification options.
</P
></BLOCKQUOTE
></DIV
><P
> Ahh, here you can reduce or increase the amount of email sent you from Bugzilla!
In the drop-down "Notify me of changes to", select one of
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><EM
>All qualifying bugs</EM
>: sends you every change to every bug
where your name is somewhere on it, regardless of who changed it.</TD
></TR
><TR
><TD
><EM
>Only those bugs which I am listed in the CC line</EM
>: prevents
you from receiving mail for which you are the reporter,'
owner, or QA contact. If you are on the CC
list, presumably someone had a <EM
>good</EM
>
reason for you to get the email.</TD
></TR
><TR
><TD
><EM
>All qulifying bugs except those which I change</EM
>:
This is the default, and
a sensible setting. If someone else changes your bugs, you will get emailed,
but if you change bugs
yourself you will receive no notification of the change.</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="NEWEMAILTECH"
>4.4.2.2. New Email Technology</A
></H3
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> This option may not be available in all Bugzilla installations, depending upon
the preferences of the systems administrator responsible for the setup of your Bugzilla.
However, if you really want this functionality, ask her to "enable newemailtech
in Params"
and "make it the default for all new users", referring her to the Administration section
of this Guide.
</P
></BLOCKQUOTE
></DIV
><P
> Disregard the warnings about "experimental and bleeding edge"; the code to handle email
in a cleaner manner than that historically used for Bugzilla is
quite robust and well-tested now.
</P
><P
> I recommend you enable the option, "Click here to sign up (and risk any bugs)".
Your email-box
will thank you for it. The fundamental shift in "newemailtech" is away from standard UNIX
"diff" output, which is quite ugly, to a prettier, better laid-out email.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H3
CLASS="SECTION"
><A
NAME="WATCHSETTINGS"
>4.4.2.3. "Watching" Users</A
></H3
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> This option may not be available in all Bugzilla installations, depending upon
the preferences of the systems administrator responsible for the setup of your Bugzilla.
However, if you really want this functionality, ask her to "enable watchers in Params".
</P
></BLOCKQUOTE
></DIV
><P
> By entering user email names into the "Users to watch" text entry box, delineated by commas,
you can watch bugs of other users. This powerful functionality enables seamless transitions
as developers change projects, managers wish to get in touch with the issues faced by their
direct reports, or users go on vacation. If any of these three situations apply
to you, you will undoubtedly find this feature quite convenient.
</P
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="FOOTERSETTINGS"
>4.4.3. Page Footer</A
></H2
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> By default, this page is quite barren. However, go explore the Query Page some more; you will
find that you can store numerous queries on the server, so if you regularly run a particular query
it is just a drop-down menu away. On this page of Preferences, if you have many stored
queries you can elect to have them always one-click away!
</P
></BLOCKQUOTE
></DIV
><P
> If you have many stored queries on the server, here you will find individual drop-downs for each
stored query. Each drop-down gives you the option of that query appearing on the footer of every
page in Bugzilla! This gives you powerful one-click access to any complex searches you may set up,
and is an excellent way to impress your boss...
</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
>By default, the "My Bugs" link appears at the bottom of each page. However, this query
gives you both the bugs you have reported, as well as those you are assigned. One of the most
common uses for this page is to remove the "My Bugs" link, replacing it with two other queries,
commonly called "My Bug Reports" and "My Bugs" (but only referencing bugs assigned to you). This
allows you to distinguish those bugs you have reported from those you are assigned. I commonly
set up complex Boolean queries in the Query page and link them to my footer in this page. When
they are significantly complex, a one-click reference can save hours of work.</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H2
CLASS="SECTION"
><A
NAME="PERMISSIONSETTINGS"
>4.4.4. Permissions</A
></H2
><P
> This is a purely informative page which outlines your current permissions on
this installation of Bugzilla. If you have permissions to grant certain permissions to
other users, the "other users" link appears on this page as well as the footer.
For more information regarding user administration, please consult the Administration
section of this Guide.
</P
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="USINGBZ-CONC"
>4.5. Using Bugzilla-Conclusion</A
></H1
><P
> Thank you for reading through this portion of the Bugzilla Guide. I anticipate
it may not yet meet the needs of all readers. If you have additional comments or
corrections to make, please submit your contributions to the
<A
HREF="mailto://mozilla-webtools@mozilla.org"
TARGET="_top"
>mozilla-webtools</A
>
mailing list/newsgroup. The mailing list is mirrored to the netscape.public.mozilla.webtools
newsgroup, and the newsgroup is mirrored to mozilla-webtools@mozilla.org
</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="INTEGRATION"
>Chapter 5. Integrating Bugzilla with Third-Party Tools</A
></H1
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="BONSAI"
>5.1. Bonsai</A
></H1
><P
>We need Bonsai integration information.</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CVS"
>5.2. CVS</A
></H1
><P
>We need CVS integration information</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="SCM"
>5.3. Perforce SCM</A
></H1
><P
> Richard Brooksby created a Perforce integration tool for Bugzilla and TeamTrack.
You can find the main project page at
<A
HREF="http://www.ravenbrook.com/project/p4dti/"
TARGET="_top"
> http://www.ravenbrook.com/project/p4dti</A
>. "p4dti" is now an officially
supported product from Perforce, and you can find the "Perforce Public Depot"
p4dti page at <A
HREF="http://public.perforce.com/public/perforce/p4dti/index.html"
TARGET="_top"
> http://public.perforce.com/public/perforce/p4dti/index.html</A
>.
</P
><P
> Integration of Perforce with Bugzilla, once patches are applied, is fairly seamless. However,
p4dti is a patch against the Bugzilla 2.10 release, not the current 2.12 release. I anticipate
patches for 2.12 will be out shortly. Check the project page regularly for updates, or
take the given patches and patch it manually. p4dti is designed to support multiple defect
trackers, and maintains its own documentation for it. Please consult the pages linked
above for further information.
</P
><P
> Right now, there is no way to synchronize the Bug ID and the Perforce Transaction Number, or
to change the Bug ID to read (PRODUCT).bugID unless you hack it in. Additionally, if you
have synchronization problems, the easiest way to avoid them is to only put the bug
information, comments, etc. into Bugzilla, and not into the Perforce change records.
They will link anyway; merely reference the bug ID fixed in your change description,
and put a comment into Bugzilla
giving the change ID that fixed the Bugzilla bug. It's a process issue, not a technology
question.
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="TINDERBOX"
>5.4. Tinderbox</A
></H1
><P
>We need Tinderbox integration information</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="FUTURE"
>Chapter 6. The Future of Bugzilla</A
></H1
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>Bugzilla's Future. Much of this is the present, now.</PRE
></TD
></TR
></TABLE
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="SPAMLITE"
>6.1. Reducing Spam</A
></H1
><P
><P
CLASS="LITERALLAYOUT"
>Those who use Bugzilla frequently are probably used to notification spam<br>
- unwanted or unnecessary notifications. A number of proposals have<br>
been put forward to attempt to reduce this.<br>
<br>
1. Reduce CC Spam<br>
<br>
Some of you probably know me as that guy who CCs on heaps and heaps of<br>
bugs. Just as you get a lot of CC changes from me, so do I get a lot<br>
from others. Why should CC changes send out email notifications?<br>
<br>
It's not necessarily the best idea to just remove the CC spam, there are<br>
other issues too, like the difficulty of adding to large CC fields.<br>
<br>
For these reasons and more, an RFE for a per user "BCC" facility exists<br>
that people could use to silently and privately track bugs, in a similar<br>
way to voting today, but applying to an unlimited number of bugs. See<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=7345".<br>
<br>
2. Bulk Changes<br>
<br>
You know the drill - a large milestone change, a component movement,<br>
whatever, and lots of notifications are generated. If there's enough<br>
maybe you'll just go delete, delete, delete, whoops, there goes another<br>
notification that wasn't from the bulk change you missed.<br>
<br>
Shouldn't bulk changes send out one notification? A proposal for this<br>
is at "http://bugzilla.mozilla.org/show_bug.cgi?id=26943".<br>
<br>
3. Configurable Notification Criteria<br>
<br>
It would be good if you could choose what you want to receive. There<br>
are two parts to this.<br>
<br>
(a) Choose a selection of bugs you're interested in. This would be<br>
similar to CC except you let the set be computed from selection criteria<br>
rather than limited to the bugs your name is on. There is currently a<br>
limited version of this in the bugzilla preferences, ie "all qualifying<br>
bugs"/"all qualifying bugs except the ones I change"/"only those bugs<br>
which I am listed on the cc line".<br>
(b) Choose what changes will trigger a notification for the bugs you are<br>
watching. With this, you could choose whether you want to receive cc,<br>
dependency and keyword changes, for example.<br>
<br>
Both of these proposals live at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=14137".<br>
Note that they also live at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=17464", and the change <br>
has been checked in. This is fixed with Bugzilla 2.12 and is no longer<br>
an issue. Woo-Hoo!</P
></P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="SEARCHING"
>6.2. Better Searching</A
></H1
><P
><P
CLASS="LITERALLAYOUT"
>Current searching tools in Bugzilla include the querying mechanism,<br>
special summary reports and dependency trees. This message is about new<br>
facilities.<br>
<br>
1. General Summary Reports<br>
<br>
For some time now it has been apparent to me that the query bug list<br>
leaves a little to be desired in its linear nature. There is a need to<br>
have categorised subsets, and counts of each category. If you don't<br>
believe me, how about these facilities already in place or which people<br>
have asked for:<br>
<br>
Most Doomed Reports - Categorised On Assignee, Shows and Counts Number<br>
of Bugs For Each Assignee<br>
Bug #15806 (Most Voted For Bugs) - Categorised On Product, Shows Bugs<br>
Voters Most Want Fixed<br>
Bug #9789 (BugAThon Tracking Page) - Categorised On Developer (Subset),<br>
Counts Number of Bugs<br>
Bug #9409 and #9411 - The desire to be able to report on more subsets.<br>
<br>
Hopefully you can see the gist of what is desired here. It's a general<br>
reporting mechanism.<br>
<br>
This mechanism lets you choose the subset of bugs to operate on (like<br>
query), let's you categorise them, possibly along with subcategories and<br>
counts the number of bugs within each category. It might or might not<br>
show the actual bugs themselves, and it might limit the number of bugs<br>
within a category, or categories to report on.<br>
<br>
I'm further sure that many applications of this mechanism would only be<br>
recognised once it was implemented.<br>
<br>
The general summary reports bug is at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=12282".<br>
<br>
2. Related Bugs<br>
<br>
It would be nice to have a field where you could enter other bugs<br>
related to the current bug - it would be handy for navigation and<br>
possibly even finding duplicates. See<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=12286".<br>
<br>
3. Column Specification Support<br>
<br>
Currently query seems to get what columns to report on from whatever the<br>
user last used. This doesn't work well for "prepackaged queries", where<br>
you followed a link. You can probably add a column by specifying a sort<br>
column, but this is difficult and suboptimal.<br>
<br>
Furthermore, I find that when I want to add a column to a query, it's<br>
usually a one off and I would prefer it to go away for the next query. <br>
Hence, it would be nice to specify the columns that appear on the query<br>
(and general summary report) pages. The default query mechanism should<br>
be able to let you specify your default columns.<br>
<br>
This proposal lives at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=12284".</P
></P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="TRACKINGBUGS"
>6.3. Description Flags and Tracking Bugs</A
></H1
><P
><P
CLASS="LITERALLAYOUT"
>Since I last posted on this issue, we now have "keywords" that solve<br>
many of the issues of description and status whiteboard keywords. We<br>
have seen a migration towards keywords, but there is still further to<br>
go.<br>
<br>
Description ( + Status Whiteboard ) Keywords<br>
--------------------------------------------<br>
<br>
Some description keywords remain. I'd like to hear what reasons, other<br>
than time, there are for these staying as they are. I'm suspecting many<br>
are not really being used. Hopefully we can totally remove these<br>
eventually.<br>
<br>
Tracking Bugs<br>
-------------<br>
<br>
When I suggested keywords, I did so to get rid of tracking bugs too,<br>
though we've had less success on that front.<br>
<br>
There are many disadvantages to tracking bugs.<br>
<br>
- They can pollute bugs counts, and you must make sure you exclude<br>
them. I believe the meta keyword might be used for this purpose.<br>
- They have an assignee but there is nothing to fix, and that person can<br>
get whined at by Bugzilla.<br>
- It would be better to craft your own "dependency tree" rather than<br>
rely on a fixed hierachy in the bug system.<br>
- In creating a nice little hierachy, many bugs duplicate information<br>
that should be available in other ways, eg<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=12833" which is<br>
about beta 1 networking issues. These could fall behind the actual<br>
data. What tracking bugs are good for, ad hoc lists, is what keywords<br>
are better for.<br>
- An automatically generated dependency structure between one "tracking<br>
bug" and another would be better than a manual one, since it gives exact<br>
rather than manually set up classifications.<br>
<br>
Probably the only feature preventing tracking bugs being replaced is the<br>
dependency tree. The quintessential tracking bug seems to be bug #7229<br>
"chofmann's watch list", which probably has about a couple of hundred<br>
bugs at various levels, which allows a nice visualisation.<br>
<br>
Before keywords can replace tracking bugs better visualisation is going<br>
to be required. General summary reports and dependency forests of a bug<br>
list ("http://bugzilla.mozilla.org/show_bug.cgi?id=12992") could both<br>
help, but neither solves the problem totally. Perhaps keywords within<br>
keywords would help here. In any case, I'm still thinking about this<br>
one.<br>
<br>
Some tracking bugs could definitely be turned into keywords immediately<br>
though, and I'll point the finger at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=7954" here since that's<br>
what came to mind first.</P
></P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="BUGPROBS"
>6.4. Bug Issues</A
></H1
><P
><P
CLASS="LITERALLAYOUT"
>1. Inline Bug Changes<br>
<br>
Why do I see so many "moving to M5" and "reassigning to blahblah"<br>
messages, and in other circumstances none are entered? Why aren't these<br>
automatically generated? A comment should be only necessary when there<br>
is something to add, and if I'm not interested in this sort of<br>
information, I should be able to hide it.<br>
<br>
At the moment we're in a hybrid world where we don't get everything, but<br>
we can't get rid of the bug change "messages" either. Furthermore,<br>
"View Bug Activity" requires me to manually cross reference events on<br>
another page, rather than being able to visually see the chronological<br>
order. Shouldn't I be able to see all the information on one page?<br>
<br>
A proposal to allow bugs to be shown either way is at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=11368".<br>
<br>
2. Hard Wrapping Comments<br>
<br>
One thing that annoys me is the fact that comments are "hard wrapped" to<br>
a certain column width. This is a mistake Internet Mail and News has<br>
made, unlike every word processor in existence, and as a consequence,<br>
Usenet suffers to this day from bad software. Why has Bugzilla repeated<br>
the problem?<br>
<br>
Hard wrapping to a certain column width is open to abuse (see old<br>
Mozilla browsers that didn't wrap properly, resulting in many ugly bug<br>
reports we have to read to this day), and furthermore doesn't expand to<br>
fill greater screen sizes. I'm also under the impression the current<br>
hard wrap uses a non-standard HTML facility. See<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=11901".<br>
<br>
3. REMIND and LATER Are Evil<br>
<br>
I really hate REMIND and LATER. Not because they mean something<br>
won't be implemented, but because they aren't the best solutions.<br>
<br>
Why are they bad? Well, basically because they are not resolved, yet<br>
they are marked as such. Hence queries have to be well crafted to<br>
include them.<br>
<br>
LATER, according to Bugzilla, means it won't be done this release. <br>
There is a better mechanism of doing this, that is assigning to<br>
nobody@mozilla.org and making the milestone blank. It's more likely to<br>
appear in a casual query, and it doesn't resolve the bug.<br>
<br>
REMIND, according to Bugzilla, means it might still be implemented this<br>
release. Well, why not just move it to a later milestone then? You're<br>
a lot less likely to forget it. If it's really needed, a keyword would<br>
be better.<br>
<br>
Some people can't use blank milestones to mean an untargetted milestone,<br>
since they use this to assess new bugs that have no target. Hence, it<br>
would be nice to distinguish between bugs that have not yet been<br>
considered, and those that really are not assigned to any milestone in<br>
the future (assumedly beyond).<br>
<br>
All this is covered at<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=13534".<br>
<br>
4. Create An Enhancement Field<br>
<br>
Currently enhancement is an option in severity. This means that<br>
important enhancements (like for example, POP3 support) are not properly<br>
distinguished as such, because they need a proper severity. This<br>
dilutes the meaning of enhancement.<br>
<br>
If enhancement was separated, we could properly see what was an<br>
enhancement. See "http://bugzilla.mozilla.org/show_bug.cgi?id=9412". I<br>
see keywords like [RFE] and [FEATURE] that seem to be compensating for<br>
this problem.</P
></P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="DBASEINTEGRITY"
>6.5. Database Integrity</A
></H1
><P
><P
CLASS="LITERALLAYOUT"
>Bugzilla could be more proactive in detecting suboptimal situations and<br>
prevent them or whine about them.<br>
<br>
1. Bugzilla Crime #1: Marking A Bug Fixed With Unresolved Dependencies<br>
<br>
It can't be marked fixed with unresolved dependencies. Either mark it<br>
INVALID (tracking bugs), fix the dependencies at the same time, or<br>
resolve the blockers.<br>
<br>
See "http://bugzilla.mozilla.org/show_bug.cgi?id=24496".<br>
<br>
2. Keyword Restrictions<br>
<br>
Some keywords should only apply in certain circumstances, eg beta1 =><br>
Milestone <<br>
M14, css1 => Component = Style System are possibilities. See<br>
"http://bugzilla.mozilla.org/show_bug.cgi?id=26940".<br>
<br>
3. Whine About Old Votes<br>
<br>
Old votes can just sit on resolved bugs. This is problematic with<br>
duplicates especially. Automatic transferral/removal is not<br>
appropriate since bugs can be reopened, but a whining solution might<br>
work. See "http://bugzilla.mozilla.org/show_bug.cgi?id=27553".<br>
<br>
4. Whine And Warn About Milestone Mismatches<br>
<br>
Here's a fun one. Bug X (M17) depends on Bug Y (M15). Bug Y gets moved<br>
out to M19. The notification to the assignee of Bug X gets ignored (of<br>
course) and Bug X is now due to be fixed before one of its blockers.<br>
<br>
Warnings about this when it is detected as well as whining about it in<br>
email would help bring these issues to the attention of people sooner.<br>
<br>
Note that this would be less of a problem if we didn't have so many<br>
tracking bugs since they aren't updated that often and often have this<br>
problem.<br>
<br>
See "http://bugzilla.mozilla.org/show_bug.cgi?id=16743".</P
></P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="BZ30"
>6.6. Bugzilla 3.0</A
></H1
><P
>One day, Bugzilla 3.0 will have lots of cool stuff.</P
></DIV
></DIV
><DIV
CLASS="APPENDIX"
><HR><H1
><A
NAME="FAQ"
>Appendix A. The Bugzilla FAQ</A
></H1
><DIV
CLASS="QANDASET"
><DL
><DT
>1. <A
HREF="#FAQ_GENERAL"
>General Questions</A
></DT
><DD
><DL
><DT
>A.1.1. <A
HREF="#AEN1319"
> Where can I find information about Bugzilla?</A
></DT
><DT
>A.1.2. <A
HREF="#AEN1325"
> What license is Bugzilla distributed under?
</A
></DT
><DT
>A.1.3. <A
HREF="#AEN1331"
> How do I get commercial support for Bugzilla?
</A
></DT
><DT
>A.1.4. <A
HREF="#AEN1338"
> What major companies or projects are currently using Bugzilla
for bug-tracking?
</A
></DT
><DT
>A.1.5. <A
HREF="#AEN1363"
> Who maintains Bugzilla?
</A
></DT
><DT
>A.1.6. <A
HREF="#AEN1368"
> How does Bugzilla stack up against other bug-tracking databases?
</A
></DT
><DT
>A.1.7. <A
HREF="#AEN1375"
> How do I change my user name in Bugzilla?
</A
></DT
><DT
>A.1.8. <A
HREF="#AEN1380"
> Why doesn't Bugzilla offer this or that feature or compatability
with this other tracking software?
</A
></DT
><DT
>A.1.9. <A
HREF="#AEN1387"
> Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL?
</A
></DT
><DT
>A.1.10. <A
HREF="#AEN1405"
> Why do the scripts say "/usr/bonsaitools/bin/perl" instead of
"/usr/bin/perl" or something else?
</A
></DT
></DL
></DD
><DT
>2. <A
HREF="#FAQ_REDHAT"
>Red Hat Bugzilla</A
></DT
><DD
><DL
><DT
>A.2.1. <A
HREF="#AEN1422"
> What about Red Hat Bugzilla?
</A
></DT
><DT
>A.2.2. <A
HREF="#AEN1430"
> What are the primary benefits of Red Hat Bugzilla?
</A
></DT
><DT
>A.2.3. <A
HREF="#AEN1458"
> What's the current status of Red Hat Bugzilla?
</A
></DT
></DL
></DD
><DT
>3. <A
HREF="#FAQ_LOKI"
>Loki Bugzilla (AKA Fenris)</A
></DT
><DD
><DL
><DT
>A.3.1. <A
HREF="#AEN1474"
> What about Loki Bugzilla?
</A
></DT
><DT
>A.3.2. <A
HREF="#AEN1481"
> Who maintains Fenris (Loki Bugzilla) now?
</A
></DT
><DT
>A.3.3. <A
HREF="#AEN1486"
>
</A
></DT
></DL
></DD
><DT
>4. <A
HREF="#FAQ_PHB"
>Pointy-Haired-Boss Questions</A
></DT
><DD
><DL
><DT
>A.4.1. <A
HREF="#AEN1494"
> Is Bugzilla web-based or do you have to have specific software or
specific operating system on your machine?
</A
></DT
><DT
>A.4.2. <A
HREF="#AEN1499"
> Has anyone you know of already done any Bugzilla integration with
Perforce (SCM software)?
</A
></DT
><DT
>A.4.3. <A
HREF="#AEN1504"
> Does Bugzilla allow the user to track multiple projects?
</A
></DT
><DT
>A.4.4. <A
HREF="#AEN1509"
> If I am on many projects, and search for all bugs assigned to me, will
Bugzilla list them for me and allow me to sort by project, severity etc?
</A
></DT
><DT
>A.4.5. <A
HREF="#AEN1514"
> Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes,
are there any that are NOT allowed?
</A
></DT
><DT
>A.4.6. <A
HREF="#AEN1519"
> 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?
</A
></DT
><DT
>A.4.7. <A
HREF="#AEN1524"
> The index.html page doesn't show the footer. It's really annoying to have
to go to the querypage just to check my "my bugs" link. How do I get a footer
on static HTML pages?
</A
></DT
><DT
>A.4.8. <A
HREF="#AEN1530"
> Does Bugzilla provide any reporting features, metrics, graphs, etc? You
know, the type of stuff that management likes to see. :)
</A
></DT
><DT
>A.4.9. <A
HREF="#AEN1538"
> Is there email notification and if so, what do you see when you get an
email? Do you see bug number and title or is it only the number?
</A
></DT
><DT
>A.4.10. <A
HREF="#AEN1543"
> Can email notification be set up to send to multiple
people, some on the To List, CC List, BCC List etc?
</A
></DT
><DT
>A.4.11. <A
HREF="#AEN1548"
> If there is email notification, do users have to have any particular
type of email application?
</A
></DT
><DT
>A.4.12. <A
HREF="#AEN1555"
> If I just wanted to track certain bugs, as they go through life, can I
set it up to alert me via email whenever that bug changes, whether it be
owner, status or description etc.?
</A
></DT
><DT
>A.4.13. <A
HREF="#AEN1560"
> 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?
</A
></DT
><DT
>A.4.14. <A
HREF="#AEN1568"
> Does Bugzilla allow fields to be added, changed or deleted? If I want to
customize the bug submission form to meet our needs, can I do that using our
terminology?
</A
></DT
><DT
>A.4.15. <A
HREF="#AEN1573"
> Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</A
></DT
><DT
>A.4.16. <A
HREF="#AEN1578"
> Can a user create and save reports? Can they do this in Word format?
Excel format?
</A
></DT
><DT
>A.4.17. <A
HREF="#AEN1583"
> Can a user re-run a report with a new project, same query?
</A
></DT
><DT
>A.4.18. <A
HREF="#AEN1588"
> Can a user modify an existing report and then save it into another name?
</A
></DT
><DT
>A.4.19. <A
HREF="#AEN1593"
> Does Bugzilla have the ability to search by word, phrase, compound
search?
</A
></DT
><DT
>A.4.20. <A
HREF="#AEN1598"
> Can the admin person establish separate group and individual user
privileges?
</A
></DT
><DT
>A.4.21. <A
HREF="#AEN1603"
> 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?
</A
></DT
><DT
>A.4.22. <A
HREF="#AEN1608"
> Are there any backup features provided?
</A
></DT
><DT
>A.4.23. <A
HREF="#AEN1614"
> Can users be on the system while a backup is in progress?
</A
></DT
><DT
>A.4.24. <A
HREF="#AEN1619"
> 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
"Out-of-the-Box" solution.
</A
></DT
><DT
>A.4.25. <A
HREF="#AEN1626"
> 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?
</A
></DT
><DT
>A.4.26. <A
HREF="#AEN1631"
> Is there any licensing fee or other fees for using Bugzilla? Any
out-of-pocket cost other than the bodies needed as identified above?
</A
></DT
></DL
></DD
><DT
>5. <A
HREF="#FAQ_INSTALL"
>Bugzilla Installation</A
></DT
><DD
><DL
><DT
>A.5.1. <A
HREF="#AEN1638"
> How do I download and install Bugzilla?
</A
></DT
><DT
>A.5.2. <A
HREF="#AEN1644"
> How do I install Bugzilla on Windows NT?
</A
></DT
><DT
>A.5.3. <A
HREF="#AEN1649"
> Is there an easy way to change the Bugzilla cookie name?
</A
></DT
></DL
></DD
><DT
>6. <A
HREF="#FAQ_SECURITY"
>Bugzilla Security</A
></DT
><DD
><DL
><DT
>A.6.1. <A
HREF="#AEN1656"
> How do I completely disable MySQL security if it's giving me problems
(I've followed the instructions in the README!)?
</A
></DT
><DT
>A.6.2. <A
HREF="#AEN1662"
> Are there any security problems with Bugzilla?
</A
></DT
><DT
>A.6.3. <A
HREF="#AEN1667"
> I've implemented the security fixes mentioned in Chris Yeh's security
advisory of 5/10/2000 advising not to run MySQL as root, and am running into
problems with MySQL no longer working correctly.
</A
></DT
></DL
></DD
><DT
>7. <A
HREF="#FAQ_EMAIL"
>Bugzilla Email</A
></DT
><DD
><DL
><DT
>A.7.1. <A
HREF="#AEN1674"
> I have a user who doesn't want to receive any more email from Bugzilla.
How do I stop it entirely for this user?
</A
></DT
><DT
>A.7.2. <A
HREF="#AEN1679"
> I'm evaluating/testing Bugzilla, and don't want it to send email to
anyone but me. How do I do it?
</A
></DT
><DT
>A.7.3. <A
HREF="#AEN1684"
> I want whineatnews.pl to whine at something more, or other than, only new
bugs. How do I do it?
</A
></DT
><DT
>A.7.4. <A
HREF="#AEN1690"
> I don't like/want to use Procmail to hand mail off to bug_email.pl.
What alternatives do I have?
</A
></DT
><DT
>A.7.5. <A
HREF="#AEN1697"
> How do I set up the email interface to submit/change bugs via email?
</A
></DT
><DT
>A.7.6. <A
HREF="#AEN1702"
> Email takes FOREVER to reach me from bugzilla -- it's extremely slow.
What gives?
</A
></DT
><DT
>A.7.7. <A
HREF="#AEN1709"
> How come email never reaches me from bugzilla changes?
</A
></DT
></DL
></DD
><DT
>8. <A
HREF="#FAQ_DB"
>Bugzilla Database</A
></DT
><DD
><DL
><DT
>A.8.1. <A
HREF="#AEN1717"
> I've heard Bugzilla can be used with Oracle?
</A
></DT
><DT
>A.8.2. <A
HREF="#AEN1722"
> Bugs are missing from queries, but exist in the database (and I can pull
them up by specifying the bug ID). What's wrong?
</A
></DT
><DT
>A.8.3. <A
HREF="#AEN1727"
> I think my database might be corrupted, or contain invalid entries. What
do I do?
</A
></DT
><DT
>A.8.4. <A
HREF="#AEN1732"
> I want to manually edit some entries in my database. How?
</A
></DT
><DT
>A.8.5. <A
HREF="#AEN1737"
> I try to add myself as a user, but Bugzilla always tells me my password is wrong.
</A
></DT
><DT
>A.8.6. <A
HREF="#AEN1742"
> I think I've set up MySQL permissions correctly, but bugzilla still can't
connect.
</A
></DT
><DT
>A.8.7. <A
HREF="#AEN1747"
> How do I synchronize bug information among multiple different Bugzilla
databases?
</A
></DT
><DT
>A.8.8. <A
HREF="#AEN1754"
> Why do I get bizarre errors when trying to submit data, particularly problems
with "groupset"?
</A
></DT
><DT
>A.8.9. <A
HREF="#AEN1759"
> How come even after I delete bugs, the long descriptions show up?
</A
></DT
></DL
></DD
><DT
>9. <A
HREF="#FAQ_NT"
>Bugzilla and Win32</A
></DT
><DD
><DL
><DT
>A.9.1. <A
HREF="#AEN1766"
> What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</A
></DT
><DT
>A.9.2. <A
HREF="#AEN1771"
> Is there a "Bundle::Bugzilla" equivalent for Win32?
</A
></DT
><DT
>A.9.3. <A
HREF="#AEN1776"
> CGI's are failing with a "something.cgi is not a valid Windows NT
application" error. Why?
</A
></DT
><DT
>A.9.4. <A
HREF="#AEN1784"
> Can I have some general instructions on how to make Bugzilla on Win32 work?
</A
></DT
><DT
>A.9.5. <A
HREF="#AEN1790"
> I'm having trouble with the perl modules for NT not being able to talk to
to the database.
</A
></DT
></DL
></DD
><DT
>10. <A
HREF="#FAQ_USE"
>Bugzilla Usage</A
></DT
><DD
><DL
><DT
>A.10.1. <A
HREF="#AEN1811"
> The query page is very confusing. Isn't there a simpler way to query?
</A
></DT
><DT
>A.10.2. <A
HREF="#AEN1817"
> 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?
</A
></DT
><DT
>A.10.3. <A
HREF="#AEN1827"
> I can't upload anything into the database via the "Create Attachment"
link. What am I doing wrong?
</A
></DT
><DT
>A.10.4. <A
HREF="#AEN1832"
> Email submissions to Bugzilla that have attachments end up asking me to
save it as a "cgi" file.
</A
></DT
><DT
>A.10.5. <A
HREF="#AEN1837"
> How do I change a keyword in Bugzilla, once some bugs are using it?
</A
></DT
></DL
></DD
><DT
>11. <A
HREF="#FAQ_HACKING"
>Bugzilla Hacking</A
></DT
><DD
><DL
><DT
>A.11.1. <A
HREF="#AEN1844"
> What bugs are in Bugzilla right now?
</A
></DT
><DT
>A.11.2. <A
HREF="#AEN1853"
> How can I change the default priority to a null value? For instance, have the default
priority be "---" instead of "P2"?
</A
></DT
><DT
>A.11.3. <A
HREF="#AEN1859"
> What's the best way to submit patches? What guidelines should I follow?
</A
></DT
></DL
></DD
></DL
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_GENERAL"
></A
>1. General Questions</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1319"
></A
><B
>A.1.1. </B
> Where can I find information about Bugzilla?</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You can stay up-to-date with the latest Bugzilla
information at <A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
> http://www.mozilla.org/projects/bugzilla/</A
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1325"
></A
><B
>A.1.2. </B
> What license is Bugzilla distributed under?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Bugzilla is covered by the Mozilla Public License.
See details at <A
HREF="http://www.mozilla.org/MPL/"
TARGET="_top"
> http://www.mozilla.org/MPL/</A
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1331"
></A
><B
>A.1.3. </B
> How do I get commercial support for Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> <A
HREF="http://www.collab.net/"
TARGET="_top"
>www.collab.net</A
> offers
Bugzilla as part of their standard offering to large projects.
They do have some minimum fees that are pretty hefty, and generally
aren't interested in small projects.
</P
><P
> There are several experienced
Bugzilla hackers on the mailing list/newsgroup who are willing
to whore themselves out for generous compensation.
Try sending a message to the mailing list asking for a volunteer.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1338"
></A
><B
>A.1.4. </B
> What major companies or projects are currently using Bugzilla
for bug-tracking?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> There are <EM
>dozens</EM
> of major comapanies with public
Bugzilla sites to track bugs in their products. A few include:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>Netscape/AOL</TD
></TR
><TR
><TD
>Mozilla.org</TD
></TR
><TR
><TD
>AtHome Corporation</TD
></TR
><TR
><TD
>Red Hat Software</TD
></TR
><TR
><TD
>Loki Entertainment Software</TD
></TR
><TR
><TD
>SuSe Corp</TD
></TR
><TR
><TD
>The Horde Project</TD
></TR
><TR
><TD
>The Eazel Project</TD
></TR
><TR
><TD
>AbiSource</TD
></TR
><TR
><TD
>Real Time Enterprises, Inc</TD
></TR
><TR
><TD
>Eggheads.org</TD
></TR
><TR
><TD
>Strata Software</TD
></TR
><TR
><TD
>RockLinux</TD
></TR
><TR
><TD
>Creative Labs (makers of SoundBlaster)</TD
></TR
><TR
><TD
>The Apache Foundation</TD
></TR
><TR
><TD
>The Gnome Foundation</TD
></TR
><TR
><TD
>Linux-Mandrake</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> Suffice to say, there are more than enough huge projects using Bugzilla
that we can safely say it's extremely popular.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1363"
></A
><B
>A.1.5. </B
> Who maintains Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> There are many, many contributors from around the world maintaining Bugzilla.
The designated "Maintainer" is Tara Hernandez, with QA support by Matthew Tuck.
Dan Mosedale and Dawn Endico are employees of Mozilla.org responsible for the
installation of Bugzilla there, and are very frequent code contributors.
Terry Weissman originally ported Bugzilla, but "these days, Terry just hangs around
and heckles." The rest of us are mostly transient developers; Bugzilla suits
our needs, and we contribute code as we have needs for updates.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1368"
></A
><B
>A.1.6. </B
> How does Bugzilla stack up against other bug-tracking databases?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> A year has gone by, and I <EM
>still</EM
> can't find any head-to-head
comparisons of Bugzilla against other defect-tracking software. However, from my
personal 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.
</P
><P
> If you happen to be a commercial Bugzilla vendor, please step forward with a rebuttal
so I can include it in the FAQ. We're not in pursuit of Bugzilla ueber alles;
we simply love having a powerful, open-source tool to get our jobs done.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1375"
></A
><B
>A.1.7. </B
> How do I change my user name in Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You can't. However, the administrative account can, by simply opening
your user account in editusers.cgi and changing the login name.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1380"
></A
><B
>A.1.8. </B
> Why doesn't Bugzilla offer this or that feature or compatability
with this other tracking software?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> It may be that the support has not been built yet, or that you
have not yet found it. Bugzilla is making tremendous strides in
usability, customizability, scalability, and user interface. It
is widely considered the most complete and popular open-source
bug-tracking software in existence.
</P
><P
> 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
at <A
HREF="http://bugzilla.mozilla.org/"
TARGET="_top"
>bugzilla.mozilla.org</A
>.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1387"
></A
><B
>A.1.9. </B
> Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
>Terry Weissman answers,
<A
NAME="AEN1391"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> You're not the only one. But <EM
>I</EM
> am not very interested. I'm not
a real SQL or database person. I just wanted to make a useful tool,
and build it on top of free software. So, I picked MySQL, and
learned SQL by staring at the MySQL manual and some code lying
around here, and
wrote Bugzilla. I didn't know that Enum's were non-standard SQL.
I'm not sure if I would have cared, but I didn't even know. So, to
me, things are "portable" because it uses MySQL, and MySQL is
portable enough. I fully understand (now) that people want to be
portable to other databases, but that's never been a real concern
of mine.
</P
></BLOCKQUOTE
>
</P
><P
> Things aren't quite that grim these days, however. Terry pretty much
sums up much of the thinking many of us have for Bugzilla, but there
is light on the horizon for database-independence! Here are some options:
</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <EM
><A
HREF="http://bugzilla.redhat.com/"
TARGET="_top"
>Red Hat Bugzilla</A
></EM
>:
Runs a modified Bugzilla 2.8 atop an Oracle database.
</TD
></TR
><TR
><TD
> <EM
><A
HREF="http://sourceforge.net/projects/interzilla"
TARGET="_top"
>Interzilla</A
></EM
>:
A project to run Bugzilla on Interbase. No code released yet, however.
</TD
></TR
><TR
><TD
> <EM
>Bugzilla 3.0</EM
>: One of the primary stated goals
is multiple database support.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1405"
></A
><B
>A.1.10. </B
> Why do the scripts say "/usr/bonsaitools/bin/perl" instead of
"/usr/bin/perl" or something else?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Mozilla.org uses /usr/bonsaitools/bin/perl. The prime rule in making
submissions is "don't break bugzilla.mozilla.org". If it breaks it, your
patch will be reverted faster than you can do a diff.
</P
><P
> Here's Terry Weissman's comment, for some historical context:
<A
NAME="AEN1410"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> [This was] purely my own convention. I wanted a place to put a version of
Perl and other tools that was strictly under my control for the
various webtools, and not subject to anyone else. Edit it to point
to whatever you like.
</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> We always recommend that, if possible, you keep the path
as /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools
and /usr/bonsaitools/bin directory, then symlink your version
of perl to /usr/bonsaitools/bin/perl. This will make upgrading
your Bugzilla much easier in the future.
</P
><P
> Obviously, if you do not have root access to your Bugzilla
box, our suggestion is irrelevant.
</P
></BLOCKQUOTE
></DIV
></BLOCKQUOTE
>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_REDHAT"
></A
>2. Red Hat Bugzilla</H3
><P
> <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> <EM
>This section is no longer up-to-date.</EM
>
Please see the section on "Red Hat Bugzilla" under "Variants" in The Bugzilla Guide.
</P
></BLOCKQUOTE
></DIV
>
</P
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1422"
></A
><B
>A.2.1. </B
> What about Red Hat Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Red Hat Bugzilla is arguably more user-friendly, customizable, and scalable
than stock Bugzilla. Check it out at
http://bugzilla.redhat.com and the sources at ftp://people.redhat.com/dkl/.
They've set their Bugzilla up to work with Oracle out of the box.
Note that Redhat Bugzilla is based upon the 2.8 Bugzilla tree;
Bugzilla has made some tremendous advances since the 2.8 release.
Why not download both Bugzillas to check out the differences for
yourself?
</P
><P
> Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions:
<A
NAME="AEN1427"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> Somebody needs to take the ball and run with it. I'm the only
maintainer and am very pressed for time.
</P
></BLOCKQUOTE
>
If you, or someone you know, has the time and expertise to do the integration
work so main-tree Bugzilla 2.12 and higher integrates the Red
Hat Bugzilla Oracle modifications, please donate your
time to supporting the Bugzilla project.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1430"
></A
><B
>A.2.2. </B
> What are the primary benefits of Red Hat Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> <EM
>Dave Lawrence</EM
>:
<A
NAME="AEN1435"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> For the record, we are not using any template type implementation for
the cosmetic changes maded to Bugzilla. It is just alot of html changes
in the code itself. I admit I may have gotten a little carried away with it
but the corporate types asked for a more standardized interface to match up
with other projects relating to Red Hat web sites. A lot of other web based
internal tools I am working on also look like Bugzilla.
</P
><P
> I do want to land the changes that I have made to Bugzilla but I may
have to back out a good deal and make a different version of Red Hat's
Bugzilla for checking in to CVS. Especially the cosmetic changes because it
seems they may not fit the general public. I will do that as soon as I can.
I also still do my regular QA responsibilities along with Bugzilla so time
is difficult sometimes to come by.
</P
><P
> There are also a good deal of other changes that were requested by
management for things like support contracts and different permission
groups for making bugs private. Here is a short list of the major
changes that have been made:
</P
><P
></P
><OL
TYPE="1"
><LI
><P
> No enum types. All old enum types are now separate smaller tables.
</P
></LI
><LI
><P
> No bit wise operations. Not all databases support this so they were
changed to a more generic way of doing this task
</P
></LI
><LI
><P
> Bug reports can only be altered by the reporter, assignee, or a
privileged bugzilla user. The rest of the world can see the bug but in
a non-changeable format (unless the bug has been marked private). They
can however add comments, add and remove themselves from the CC list
</P
></LI
><LI
><P
> Different group scheme. Each group has an id number related to it.
There is a user_group table which contains userid to groupid mappings
to determine which groups each user belongs to. Additionally there is
a bug_group table that has bugid to groupid mappings to show which
groups can see a particular bug. If there are no entries for a bug in
this table then the bug is public.
</P
></LI
><LI
><P
> Product groups. product_table created to only allow certain products to
be visible for certain groups in both bug entry and query. This was
particulary helpful for support contracts.
</P
></LI
><LI
><P
> Of course many (too many) changes to Bugzilla code itself to allow use
with Oracle and still allow operation with Mysql if so desired.
Currently if you use Mysql it is set to use Mysql's old permission
scheme to keep breakage to a minimum. Hopefully one day this will
standardize on one style which may of course be something completely
different.
</P
></LI
><LI
><P
> Uses Text::Template perl module for rendering of the dynamic HTML pages
such as enter_bug.cgi, query.cgi, bug_form.pl, and for the header and
footer parts of the page. This allows the html to be separate from the
perl code for customizing the look and feel of the page to one's
preference.
</P
></LI
><LI
><P
> There are many other smaller changes. There is also a port to Oracle
that I have been working on as time permits but is not completely
finished but somewhat usable. I will merge it into our standard code
base when it becomes production quality. Unfortunately there will have
to be some conditionals in the code to make it work with other than
Oracle due to some differences between Oracle and Mysql.
</P
></LI
></OL
><P
> Both the Mysql and Oracle versions of our current code base are
available from ftp://people.redhat.com/dkl. If Terry/Tara wants I can submit
patch files for all of the changes I have made and he can determine what is
suitable for addition to the main bugzilla cade base. But for me to commit
changes to the actual CVS I will need to back out alot of things that are
not suitable for the rest of the Bugzilla community. I am open to
suggestions.
</P
></BLOCKQUOTE
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1458"
></A
><B
>A.2.3. </B
> What's the current status of Red Hat Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> This information is somewhat dated; I last updated it
7 June 2000. Please see the "Variants" section of "The Bugzilla Guide"
for more up-to-date information regarding Red Hat Bugzilla.
</P
></BLOCKQUOTE
></DIV
>
<EM
>Dave Lawrence</EM
>:
<A
NAME="AEN1465"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> I suppose the current thread warrants an update on the status of
Oracle and bugzilla ;) We have now been running Bugzilla 2.8 on
Oracle for the last two days in our production environment. I
tried to do as much testing as possible with it before going live
which is some of the reason for the long delay. I did not get
enough feedback as I would have liked from internal developers to
help weed out any bugs still left so I said "Fine, i will take it
live and then I will get the feedback I want :)" So it is now
starting to stabilize and it running quite well after working
feverishly the last two days fixing problems as soon as they came
in from the outside world. The current branch in cvs is up2date if
anyone would like to grab it and try it out. The oracle _setup.pl
is broken right now due to some last minute changes but I will
update that soon. Therefore you would probably need to create the
database tables the old fashioned way using the supplied sql
creation scripts located in the ./oracle directory. We have heavy
optimizations in the database it self thanks to the in-house DBA
here at Red Hat so it is running quite fast. The database itself
is located on a dual PII450 with 1GB ram and 14 high voltage
differential raided scsi drives. The tables and indexes are
partitioned in 4 chuncks across the raided drive which is nice
because when ever you need to do a full table scan, it is actually
starting in 4 different locations on 4 different drives
simultaneously. And the indexes of course are on separate drives
from the data so that speeds things up tremendously. When I can
find the time I will document all that we have done to get this
thing going to help others that may need it.
</P
><P
> As Matt has mentioned it is still using out-dated code and with a
little help I would like to bring everything up to date for
eventual incorporation with the main cvs tree. Due to other
duties I have with the company any help with this wiould be
appreciated. What we are using now is what I call a best first
effort. It definitely can be improved on and may even need
complete rewrites in a lot of areas. A lot of changes may have to
be made in the way Bugzilla does things currently to make this
transition to a more generic database interface. Fortunately when
making the Oracle changes I made sure I didn't do anything that I
would consider Oracle specific and could not be easily done with
other databases. Alot of the sql statements need to be broken up
into smaller utilities that themselves would need to make
decisions on what database they are using but the majority of the
code can be made database neutral.
</P
></BLOCKQUOTE
>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_LOKI"
></A
>3. Loki Bugzilla (AKA Fenris)</H3
><P
> <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> Loki's "Fenris" Bugzilla is based upon the (now ancient) Bugzilla 2.8
tree, and is no longer actively maintained.
It works well enough for Loki. Additionally, the major
differences in Fenris have now been integrated into
the main source tree of Bugzilla, so there's not much
reason to go grab the source. I leave this section of the
FAQ principally for historical interest, but unless Loki has further
input into Bugzilla's future, it will be deprecated in future versions
of the Guide.
</P
></BLOCKQUOTE
></DIV
>
</P
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1474"
></A
><B
>A.3.1. </B
> What about Loki Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Loki Games has a customized version of Bugzilla available at
http://fenris.lokigames.com. From that page,
<A
NAME="AEN1478"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> You may have noticed that Fenris is a fork from Bugzilla-- our
patches weren't suitable for integration --and a few people have
expressed interest in the code. Fenris has one major improvement
over Bugzilla, and that is individual comments are not appended
onto a string blob, they are stored as a record in a separate
table. This allows you to, for instance, separate comments out
according to privilege levels in case your bug database could
contain sensitive information not for public eyes. We also provide
things like email hiding to protect user's privacy, additional
fields such as 'user_affected' in case someone enters someone
else's bug, comment editing and deletion, and more conditional
system variables than Bugzilla does (turn off attachments,
qacontact, etc.).
</P
></BLOCKQUOTE
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1481"
></A
><B
>A.3.2. </B
> Who maintains Fenris (Loki Bugzilla) now?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Raphael Barrerro <raistlin@lokigames.com>.
Michael Vance created the initial fork, but no longer
maintains the project.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1486"
></A
><B
>A.3.3. </B
>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_PHB"
></A
>4. Pointy-Haired-Boss Questions</H3
><P
> <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> The title of this section doesn't mean you're a PHB -- it just means
you probably HAVE a PHB who wants to know this :)
</P
></BLOCKQUOTE
></DIV
>
</P
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1494"
></A
><B
>A.4.1. </B
> Is Bugzilla web-based or do you have to have specific software or
specific operating system on your machine?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> It is web and e-mail based. You can edit bugs by sending specially
formatted email to a properly configured Bugzilla, or control via the web.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1499"
></A
><B
>A.4.2. </B
> Has anyone you know of already done any Bugzilla integration with
Perforce (SCM software)?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes! You can find more information elsewhere in "The Bugzilla
Guide" in the "Integration with Third-Party Products" section.
The section on Perforce isn't very large, but as the maintainer
of the Guide is charged with Perforce/Bugzilla integration by
his company, you can expect this section to grow.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1504"
></A
><B
>A.4.3. </B
> Does Bugzilla allow the user to track multiple projects?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Absolutely! You can track up to a "soft-limit" of around
64 individual "Products", that can each be composed of as
many "Components" as you want. Check the Administration
section of the Bugzilla Guide for more information regarding
setting up Products and Components.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1509"
></A
><B
>A.4.4. </B
> If I am on many projects, and search for all bugs assigned to me, will
Bugzilla list them for me and allow me to sort by project, severity etc?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1514"
></A
><B
>A.4.5. </B
> Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes,
are there any that are NOT allowed?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. There are many specific MIME-types that are pre-defined by Bugzilla,
but you may specify any arbitrary MIME-type you need when you
upload the file. Since all attachments are stored in the database,
however, I recommend storing large binary attachments elsewhere
in the web server's file system and providing a hyperlink
as a comment, or in the provided "URL" field in the bug report.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1519"
></A
><B
>A.4.6. </B
> 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?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. However, modifying some fields, notably those related to bug
progression states, also require adjusting the program logic to
compensate for the change.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1524"
></A
><B
>A.4.7. </B
> The index.html page doesn't show the footer. It's really annoying to have
to go to the querypage just to check my "my bugs" link. How do I get a footer
on static HTML pages?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> This was a late-breaking question for the Guide, so I just have to
quote the relevant newsgroup thread on it.
</P
><P
CLASS="LITERALLAYOUT"
>> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd<br>
> enabled. Perhaps what would be better is a #include virtual and a<br>
> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command.<br>
><br>
> Please note that under most configurations, this also requires naming<br>
> the file from index.html to index.shtml (and making sure that it will<br>
> still be reconized as an index). Personally, I think this is better on<br>
> a per-installation basis (perhaps add something to the FAQ that says how<br>
> to do this).<br>
<br>
Good point. Yeah, easy enough to do, that it shouldn't be a big deal for<br>
someone to take it on if they want it. FAQ is a good place for it.<br>
<br>
> Dave Miller wrote:<br>
><br>
>> I did a little experimenting with getting the command menu and footer on<br>
>> the end of the index page while leaving it as an HTML file...<br>
>><br>
>> I was successful. :)<br>
>><br>
>> I added this line:<br>
>><br>
>> <br>
>><br>
>> Just before the </BODY> </HTML> at the end of the file. And it worked.<br>
>><br>
>> Thought I'd toss that out there. Should I check this in? For those that<br>
>> have SSI disabled, it'll act like a comment, so I wouldn't think it would<br>
>> break anything.<br>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1530"
></A
><B
>A.4.8. </B
> Does Bugzilla provide any reporting features, metrics, graphs, etc? You
know, the type of stuff that management likes to see. :)
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. Look at <A
HREF="http://bugzilla.mozilla.org/reports.cgi"
TARGET="_top"
> http://bugzilla.mozilla.org/reports.cgi</A
> for basic reporting
facilities.
</P
><P
> For more advanced reporting, I recommend hooking up a professional
reporting package, such as Crystal Reports, and use ODBC to access
the MySQL database. You can do a lot through the Query page of
Bugzilla as well, but right now Advanced Reporting is much
better accomplished through third-party utilities that can
interface with the database directly.
</P
><P
> Advanced Reporting is a Bugzilla 3.X proposed feature.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1538"
></A
><B
>A.4.9. </B
> Is there email notification and if so, what do you see when you get an
email? Do you see bug number and title or is it only the number?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Email notification is user-configurable. The bug id and Topic
of the bug report accompany each email notification, along with
a list of the changes made.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1543"
></A
><B
>A.4.10. </B
> Can email notification be set up to send to multiple
people, some on the To List, CC List, BCC List etc?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1548"
></A
><B
>A.4.11. </B
> If there is email notification, do users have to have any particular
type of email application?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Bugzilla email is sent in plain text, the most compatible mail format
on the planet.
<DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> 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
to messages in the format in which they were sent". For security reasons
Bugzilla ignores HTML tags in comments, and if a user sends HTML-based
email into Bugzilla the resulting comment looks downright awful.
</P
></BLOCKQUOTE
></DIV
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1555"
></A
><B
>A.4.12. </B
> If I just wanted to track certain bugs, as they go through life, can I
set it up to alert me via email whenever that bug changes, whether it be
owner, status or description etc.?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. Place yourself in the "cc" field of the bug you wish to monitor.
Then change your "Notify me of changes to" field in the Email Settings
tab of the User Preferences screen in Bugzilla to the "Only those
bugs which I am listed on the CC line" option.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1560"
></A
><B
>A.4.13. </B
> 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?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Mozilla allows data export through a custom DTD in XML format.
It does not, however, export to specific formats other than the
XML Mozilla DTD. Importing the data into Excel or any other application
is left as an exercise for the reader.
</P
><P
> If you create import filters to other applications from Mozilla's XML,
please submit your modifications for inclusion in future Bugzilla
distributions.
</P
><P
> As for data import, any application can send data to Bugzilla through
the HTTP protocol, or through Mozilla's XML API. However, it seems
kind of silly to put another front-end in front of Bugzilla;
it makes more sense to create a simplified bug submission form in
HTML. You can find an excellent example at
<A
HREF="http://www.mozilla.org/quality/help/bugzilla-helper.html"
TARGET="_top"
> http://www.mozilla.org/quality/help/bugzilla-helper.html</A
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1568"
></A
><B
>A.4.14. </B
> Does Bugzilla allow fields to be added, changed or deleted? If I want to
customize the bug submission form to meet our needs, can I do that using our
terminology?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1573"
></A
><B
>A.4.15. </B
> Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Currently, no. Internationalization support for Perl did not
exist in a robust fashion until the recent release of version 5.6.0;
Bugzilla is, and likely will remain (until 3.X) completely
non-localized.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1578"
></A
><B
>A.4.16. </B
> Can a user create and save reports? Can they do this in Word format?
Excel format?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. No. No.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1583"
></A
><B
>A.4.17. </B
> Can a user re-run a report with a new project, same query?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1588"
></A
><B
>A.4.18. </B
> Can a user modify an existing report and then save it into another name?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You can save an unlimited number of queries in Bugzilla. You are free
to modify them and rename them to your heart's desire.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1593"
></A
><B
>A.4.19. </B
> Does Bugzilla have the ability to search by word, phrase, compound
search?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You have no idea. Bugzilla's query interface, particularly with the
advanced Boolean operators, is incredibly versatile.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1598"
></A
><B
>A.4.20. </B
> Can the admin person establish separate group and individual user
privileges?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1603"
></A
><B
>A.4.21. </B
> 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?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Bugzilla does not lock records. It provides mid-air collision detection,
and offers the offending user a choice of options to deal with the conflict.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1608"
></A
><B
>A.4.22. </B
> Are there any backup features provided?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> MySQL, the database back-end for Bugzilla, allows hot-backup of data.
You can find strategies for dealing with backup considerations
at <A
HREF="http://www.mysql.com/doc/B/a/Backup.html"
TARGET="_top"
> http://www.mysql.com/doc/B/a/Backup.html</A
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1614"
></A
><B
>A.4.23. </B
> Can users be on the system while a backup is in progress?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yes. However, commits to the database must wait
until the tables are unlocked. Bugzilla databases are typically
very small, and backups routinely take less than a minute.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1619"
></A
><B
>A.4.24. </B
> 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
"Out-of-the-Box" solution.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> If Bugzilla is set up correctly from the start, continuing maintenance needs
are minimal and can be completed by unskilled labor. Things like rotate
backup tapes and check log files for the word "error".
</P
><P
> Commercial Bug-tracking software typically costs somewhere upwards
of $20,000 or more for 5-10 floating licenses. Bugzilla consultation
is available from skilled members of the newsgroup.
</P
><P
> As an example, as of this writing I typically charge
$115 for the first hour, and $89 each hour thereafter
for consulting work. It takes me three to five hours to make Bugzilla
happy on a Development installation of Linux-Mandrake.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1626"
></A
><B
>A.4.25. </B
> 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?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> It all depends on your level of commitment. Someone with much Bugzilla
experience can get you up and running in less than a day, and
your Bugzilla install can run untended for years. If your
Bugzilla strategy is critical to your business workflow, hire somebody
with reasonable UNIX or Perl skills to handle your process management and
bug-tracking maintenance & customization.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1631"
></A
><B
>A.4.26. </B
> Is there any licensing fee or other fees for using Bugzilla? Any
out-of-pocket cost other than the bodies needed as identified above?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> No. MySQL asks, if you find their product valuable, that you purchase
a support contract from them that suits your needs.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_INSTALL"
></A
>5. Bugzilla Installation</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1638"
></A
><B
>A.5.1. </B
> How do I download and install Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Check <A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
> http://www.mozilla.org/projects/bugzilla/</A
> for details.
Once you download it, untar it, read the README and
the Bugzilla Guide.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1644"
></A
><B
>A.5.2. </B
> How do I install Bugzilla on Windows NT?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Installation on Windows NT has its own section in
"The Bugzilla Guide".
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1649"
></A
><B
>A.5.3. </B
> Is there an easy way to change the Bugzilla cookie name?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> At present, no.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_SECURITY"
></A
>6. Bugzilla Security</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1656"
></A
><B
>A.6.1. </B
> How do I completely disable MySQL security if it's giving me problems
(I've followed the instructions in the README!)?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Run mysql like this: "mysqld --skip-grant-tables". Please remember <EM
>this
makes mysql as secure as taping a $100 to the floor of a football stadium
bathroom for safekeeping.</EM
> Please read the Security section of the
Administration chapter of "The Bugzilla Guide" before proceeding.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1662"
></A
><B
>A.6.2. </B
> Are there any security problems with Bugzilla?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> The Bugzilla code has not undergone a complete security audit.
It is recommended that you closely examine permissions on your Bugzilla
installation, and follow the recommended security guidelines found
in the README and in The Bugzilla Guide.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1667"
></A
><B
>A.6.3. </B
> I've implemented the security fixes mentioned in Chris Yeh's security
advisory of 5/10/2000 advising not to run MySQL as root, and am running into
problems with MySQL no longer working correctly.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> This is a common problem, related to running out of file descriptors.
Simply add "ulimit -n unlimited" to the script which starts
mysqld.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_EMAIL"
></A
>7. Bugzilla Email</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1674"
></A
><B
>A.7.1. </B
> I have a user who doesn't want to receive any more email from Bugzilla.
How do I stop it entirely for this user?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> With the email changes to 2.12, the user should be able to set
this in user email preferences.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1679"
></A
><B
>A.7.2. </B
> I'm evaluating/testing Bugzilla, and don't want it to send email to
anyone but me. How do I do it?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Edit the param for the mail text. Replace "To:" with "X-Real-To:",
replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)".
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1684"
></A
><B
>A.7.3. </B
> I want whineatnews.pl to whine at something more, or other than, only new
bugs. How do I do it?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Try Klaas Freitag's excellent patch for "whineatassigned" functionality.
You can find it at<A
HREF=" http://bugzilla.mozilla.org/show_bug.cgi?id=6679"
TARGET="_top"
> http://bugzilla.mozilla.org/show_bug.cgi?id=6679</A
>. This
patch is against an older version of Bugzilla, so you must apply
the diffs manually.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1690"
></A
><B
>A.7.4. </B
> I don't like/want to use Procmail to hand mail off to bug_email.pl.
What alternatives do I have?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You can call bug_email.pl directly from your aliases file, with
an entry like this:
<A
NAME="AEN1694"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl"
</P
></BLOCKQUOTE
>
However, this is fairly nasty and subject to problems; you also
need to set up your smrsh (sendmail restricted shell) to allow
it. In a pinch, though, it can work.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1697"
></A
><B
>A.7.5. </B
> How do I set up the email interface to submit/change bugs via email?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You can find an updated README.mailif file in the contrib/ directory
of your Bugzilla distribution that walks you through the setup.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1702"
></A
><B
>A.7.6. </B
> Email takes FOREVER to reach me from bugzilla -- it's extremely slow.
What gives?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> If you are using an alternate Mail Transport Agent (MTA other than
sendmail), make sure the options given in the "processmail" script for all
instances of "sendmail" are correct for your MTA. If you are using Sendmail,
you may wish to delete the "-ODeliveryMode=deferred" option in the
"processmail" script for every invocation of "sendmail". (Be sure and leave
the "-t" option, though!)
</P
><P
> A better alternative is to change the "-O" option to
"-ODeliveryMode=background". This prevents Sendmail from hanging your
Bugzilla Perl processes if the domain to which it must send mail
is unavailable.
</P
><P
> This is now a configurable parameter called "sendmailnow", available
from editparams.cgi.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1709"
></A
><B
>A.7.7. </B
> How come email never reaches me from bugzilla changes?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> 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.
</P
><P
> If you never receive mail from Bugzilla, chances you do not have
sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
to, "/usr/lib/sendmail".
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_DB"
></A
>8. Bugzilla Database</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1717"
></A
><B
>A.8.1. </B
> I've heard Bugzilla can be used with Oracle?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Red Hat Bugzilla, mentioned above, works with Oracle. The current version
from Mozilla.org does not have this capability. Unfortunately, though
you will sacrifice a lot of the really great features available in
Bugzilla 2.10 and 2.12 if you go with the 2.8-based Redhat version.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1722"
></A
><B
>A.8.2. </B
> Bugs are missing from queries, but exist in the database (and I can pull
them up by specifying the bug ID). What's wrong?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> You've almost certainly enabled the "shadow database", but for some
reason it hasn't been updated for all your bugs. This is the database
against which queries are run, so that really complex or slow queries won't
lock up portions of the database for other users. You can turn off the
shadow database in editparams.cgi. If you wish to continue using the shadow
database, then as your "bugs" user run "./syncshadowdb -syncall" from the
command line in the bugzilla installation directory to recreate your shadow
database. After it finishes, be sure to check the params and make sure that
"queryagainstshadowdb" is still turned on. The syncshadowdb program turns it
off if it was on, and is supposed to turn it back on when completed; that
way, if it crashes in the middle of recreating the database, it will stay
off forever until someone turns it back on by hand. Apparently, it doesn't
always do that yet.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1727"
></A
><B
>A.8.3. </B
> I think my database might be corrupted, or contain invalid entries. What
do I do?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home
directory) to see! If it all comes back, you're OK. If it doesn't come back
OK (i.e. any red letters), there are certain things Bugzilla can recover
from and certain things it can't. If it can't auto-recover, I hope you're
familiar with mysqladmin commands or have installed another way to manage
your database...
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1732"
></A
><B
>A.8.4. </B
> I want to manually edit some entries in my database. How?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> 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.
However, if you understand SQL you can use the mysqladmin utility to
manually insert, delete, and modify table information. Personally, I
use "phpMyAdmin". You have to compile a PHP module with MySQL
support to make it work, but it's very clean and easy to use.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1737"
></A
><B
>A.8.5. </B
> I try to add myself as a user, but Bugzilla always tells me my password is wrong.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled
the "crypt()" function. This prevented MySQL from storing encrypted passwords.
Upgrade to the "3.23 stable" version of MySQL and you should be good to go.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1742"
></A
><B
>A.8.6. </B
> I think I've set up MySQL permissions correctly, but bugzilla still can't
connect.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> 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
frustration. However, I do not recommend you run it this way on a regular
basis, unless you really want your web site defaced and your machine
cracked.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1747"
></A
><B
>A.8.7. </B
> How do I synchronize bug information among multiple different Bugzilla
databases?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Well, you can synchronize or you can move bugs. Synchronization will
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.
</P
><P
> 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.
</P
><P
> If you simply need to transfer bugs from one Bugzilla to another,
checkout the "move.pl" script in the Bugzilla distribution.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1754"
></A
><B
>A.8.8. </B
> Why do I get bizarre errors when trying to submit data, particularly problems
with "groupset"?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> If you're sure your MySQL parameters are correct, you might want turn
"strictvaluechecks" OFF in editparams.cgi. If you have "usebugsentry" set
"On", you also cannot submit a bug as readable by more than one group with
"strictvaluechecks" ON.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1759"
></A
><B
>A.8.9. </B
> How come even after I delete bugs, the long descriptions show up?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow
files there, with each filename corresponding to a
bug number. Also be sure to run syncshadowdb to make sure, if you are using
a shadow database, that the shadow database is current.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_NT"
></A
>9. Bugzilla and Win32</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1766"
></A
><B
>A.9.1. </B
> What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Remove Windows. Install Linux. Install Bugzilla.
The boss will never know the difference.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1771"
></A
><B
>A.9.2. </B
> Is there a "Bundle::Bugzilla" equivalent for Win32?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
installation on UNIX systems. If someone can volunteer to
create a suitable PPM bundle for Win32, it would be appreciated.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1776"
></A
><B
>A.9.3. </B
> CGI's are failing with a "something.cgi is not a valid Windows NT
application" error. Why?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> 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 <path>\perl.exe %s %s as the
executable.
</P
><P
> Microsoft has some advice on this matter, as well:
<A
NAME="AEN1781"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> "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"
</P
></BLOCKQUOTE
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1784"
></A
><B
>A.9.4. </B
> Can I have some general instructions on how to make Bugzilla on Win32 work?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> The following couple entries are deprecated in favor of the Windows installation
instructions available in the "Administration" portion of "The Bugzilla Guide".
However, they are provided here for historical interest and insight.
<P
CLASS="LITERALLAYOUT"
> 1. #!C:/perl/bin/perl had to be added to every perl file.<br>
2. Converted to Net::SMTP to handle mail messages instead of<br>
/usr/bin/sendmail.<br>
3. The crypt function isn't available on Windows NT (at least none that I<br>
am aware), so I made encrypted passwords = plaintext passwords.<br>
4. The system call to diff had to be changed to the Cygwin diff.<br>
5. This was just to get a demo running under NT, it seems to be working<br>
good, and I have inserted almost 100 bugs from another bug tracking<br>
system. Since this work was done just to get an in-house demo, I am NOT<br>
planning on making a patch for submission to Bugzilla. If you would<br>
like a zip file, let me know.<br>
<br>
Q: Hmm, couldn't figure it out from the general instructions above. How<br>
about step-by-step?<br>
A: Sure! Here ya go!<br>
<br>
1. Install IIS 4.0 from the NT Option Pack #4.<br>
2. Download and install Active Perl.<br>
3. Install the Windows GNU tools from Cygwin. Make sure to add the bin<br>
directory to your system path. (Everyone should have these, whether<br>
they decide to use Bugzilla or not. :-) )<br>
4. Download relevant packages from ActiveState at<br>
http://www.activestate.com/packages/zips/. + DBD-Mysql.zip<br>
5. Extract each zip file with WinZip, and install each ppd file using the<br>
notation: ppm install <module>.ppd<br>
6. Install Mysql. *Note: If you move the default install from c:\mysql,<br>
you must add the appropriate startup parameters to the NT service. (ex.<br>
-b e:\\programs\\mysql)<br>
7. Download any Mysql client. http://www.mysql.com/download_win.html<br>
8. Setup MySql. (These are the commands that I used.)<br>
<br>
I. Cleanup default database settings.<br>
C:\mysql\bin\mysql -u root mysql<br>
mysql> DELETE FROM user WHERE Host='localhost' AND User='';<br>
mysql> quit<br>
C:\mysql\bin\mysqladmin reload<br>
<br>
II. Set password for root.<br>
C:\mysql\bin\mysql -u root mysql<br>
mysql> UPDATE user SET Password=PASSWORD('new_password')<br>
WHERE user='root';<br>
mysql> FLUSH PRIVILEGES;<br>
mysql> quit<br>
C:\mysql\bin\mysqladmin -u root reload<br>
<br>
III. Create bugs user.<br>
C:\mysql\bin\mysql -u root -p<br>
mysql> insert into user (host,user,password)<br>
values('localhost','bugs','');<br>
mysql> quit<br>
C:\mysql\bin\mysqladmin -u root reload<br>
<br>
IV. Create the bugs database.<br>
C:\mysql\bin\mysql -u root -p<br>
mysql> create database bugs;<br>
<br>
V. Give the bugs user access to the bugs database.<br>
mysql> insert into db<br>
(host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv)<br>
values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N')<br>
mysql> quit<br>
C:\mysql\bin\mysqladmin -u root reload<br>
9. Run the table scripts to setup the bugs database.<br>
10. Change CGI.pm to use the following regular expression because of<br>
differing backslashes in NT versus UNIX.<br>
o $0 =~ m:[^\\]*$:;<br>
11. Had to make the crypt password = plain text password in the database.<br>
(Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The<br>
files that I changed were:<br>
o globals.pl<br>
o CGI.pl<br>
o alternately, you can try commenting all references to 'crypt'<br>
string and replace them with similar lines but without encrypt()<br>
or crypr() functions insida all files.<br>
12. Replaced sendmail with Windmail. Basically, you have to come up with a<br>
sendmail substitute for NT. Someone said that they used a Perl module<br>
(Net::SMTP), but I was trying to save time and do as little Perl coding<br>
as possible.<br>
13. Added "perl" to the beginning of all Perl system calls that use a perl<br>
script as an argument and renamed processmail to processmail.pl.<br>
14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm<br>
not sure about this one, but the read() under NT wasn't counting the<br>
EOLs without the binary read."<br>
</P
>
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1790"
></A
><B
>A.9.5. </B
> I'm having trouble with the perl modules for NT not being able to talk to
to the database.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Your modules may be outdated or inaccurate. Try:
<P
></P
><OL
TYPE="1"
><LI
><P
> Hitting http://www.activestate.com/ActivePerl
</P
></LI
><LI
><P
> Download ActivePerl
</P
></LI
><LI
><P
> Go to your prompt
</P
></LI
><LI
><P
> Type 'ppm'
</P
></LI
><LI
><P
> <TT
CLASS="PROMPT"
>PPM></TT
> <B
CLASS="COMMAND"
>install DBI DBD-mysql GD</B
>
</P
></LI
></OL
>
I reckon TimeDate and Data::Dumper come with the activeperl. You can check
the ActiveState site for packages for installation through PPM.
<A
HREF=" http://www.activestate.com/Packages/"
TARGET="_top"
> http://www.activestate.com/Packages/</A
>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_USE"
></A
>10. Bugzilla Usage</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1811"
></A
><B
>A.10.1. </B
> The query page is very confusing. Isn't there a simpler way to query?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> We are developing in that direction. You can follow progress on this
at <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=16775"
TARGET="_top"
> http://bugzilla.mozilla.org/show_bug.cgi?id=16775</A
>. Some functionality
is available in Bugzilla 2.12, and is available as "quicksearch.html"
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1817"
></A
><B
>A.10.2. </B
> 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?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> The current behavior is acceptable to bugzilla.mozilla.org and most
users. I personally don't like it. You have your choice of patches
to change this behavior, however.
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><A
HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"
TARGET="_top"
> Add a "and accept bug" radio button</A
></TD
></TR
><TR
><TD
><A
HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"
TARGET="_top"
> "Accept" button automatically assigns to you</A
></TD
></TR
></TBODY
></TABLE
><P
></P
>
Note that these patches are somewhat dated. You will need to do the find
and replace manually to apply them. They are very small, though. It is easy.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1827"
></A
><B
>A.10.3. </B
> I can't upload anything into the database via the "Create Attachment"
link. What am I doing wrong?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> The most likely cause is a very old browser or a browser that is
incompatible with file upload via POST. Download the latest Netscape,
Microsoft, or Mozilla browser to handle uploads correctly.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1832"
></A
><B
>A.10.4. </B
> Email submissions to Bugzilla that have attachments end up asking me to
save it as a "cgi" file.
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Yup. Just rename it once you download it, or save it under a different
filename. This will not be fixed anytime too soon, because it would
cripple some other functionality.
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1837"
></A
><B
>A.10.5. </B
> How do I change a keyword in Bugzilla, once some bugs are using it?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> In the Bugzilla administrator UI, edit the keyword and it will let you
replace the old keyword name with a new one. This will cause a problem
with the keyword cache. Run sanitycheck.cgi to fix it.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="QANDADIV"
><H3
><A
NAME="FAQ_HACKING"
></A
>11. Bugzilla Hacking</H3
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1844"
></A
><B
>A.11.1. </B
> What bugs are in Bugzilla right now?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> Try <A
HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=Bugzilla"
TARGET="_top"
> this link</A
> to view current bugs or requests for
enhancement for Bugzilla.
</P
><P
> You can view bugs marked for 2.14 release
<A
HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Bugzilla&target_milestone=Bugzilla+2.14"
TARGET="_top"
>here</A
>.
This list includes bugs for the 2.14 release that have already
been fixed and checked into CVS. Please consult the
<A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
> Bugzilla Project Page</A
> for details on how to
check current sources out of CVS so you can have these
bug fixes early!
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1853"
></A
><B
>A.11.2. </B
> How can I change the default priority to a null value? For instance, have the default
priority be "---" instead of "P2"?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
> This is well-documented here: <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"
TARGET="_top"
> http://bugzilla.mozilla.org/show_bug.cgi?id=49862</A
>. 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". Hmm, now that I think about it, that is kind of a klunky way to handle
it, but for now it's what we have! Although the bug has been closed "resolved wontfix",
there may be a better way to handle this...
</P
></DIV
></DIV
><DIV
CLASS="QANDAENTRY"
><DIV
CLASS="QUESTION"
><P
><A
NAME="AEN1859"
></A
><B
>A.11.3. </B
> What's the best way to submit patches? What guidelines should I follow?
</P
></DIV
><DIV
CLASS="ANSWER"
><P
><B
> </B
><P
></P
><OL
TYPE="1"
><LI
><P
> Enter a bug into bugzilla.mozilla.org for the "Webtools" product,
"Bugzilla" component.
</P
></LI
><LI
><P
> Upload your patch as a unified DIFF (having used "diff -u" against
the <EM
>current sources</EM
> 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
ID you submitted in step #1. Be sure and click the "Patch" radio
button to indicate the text you are sending is a patch!
</P
></LI
><LI
><P
> Announce your patch and the associated URL
(http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in
the newsgroup (netscape.public.mozilla.webtools). You'll get a really
good, fairly immediate reaction to the implications of your patch,
which will also give us an idea how well-received the change would
be.
</P
></LI
><LI
><P
> 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.
</P
></LI
><LI
><P
> Bask in the glory of the fact that you helped write the most successful
open-source bug-tracking software on the planet :)
</P
></LI
></OL
></P
></DIV
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="APPENDIX"
><HR><H1
><A
NAME="DOWNLOADLINKS"
>Appendix B. Software Download Links</A
></H1
><P
> All of these sites are current as of April, 2001. Hopefully
they'll stay current for a while.
</P
><P
> Apache Web Server: <A
HREF="http://www.apache.org/"
TARGET="_top"
>http://www.apache.org</A
>
Optional web server for Bugzilla, but recommended because of broad user base and support.
</P
><P
> Bugzilla: <A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
> http://www.mozilla.org/projects/bugzilla/</A
>
</P
><P
> MySQL: <A
HREF="http://www.mysql.org/"
TARGET="_top"
>http://www.mysql.org/</A
>
</P
><P
> Perl: <A
HREF="http://www.perl.org"
TARGET="_top"
>http://www.perl.org/</A
>
</P
><P
> CPAN: <A
HREF="http://www.cpan.org/"
TARGET="_top"
>http://www.cpan.org/</A
>
</P
><P
> DBI Perl module:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/DBI/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/DBI/</A
>
</P
><P
> Data::Dumper module:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Data/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Data/</A
>
</P
><P
> MySQL related Perl modules:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Mysql/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Mysql/</A
>
</P
><P
> TimeDate Perl module collection:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Date/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Date/</A
>
</P
><P
> GD Perl module:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/GD/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/GD/</A
>
Alternately, you should be able to find the latest version of
GD at <A
HREF="http://www.boutell.com/gd/"
TARGET="_top"
>http://www.boutell.com/gd/</A
>
</P
><P
> Chart::Base module:
<A
HREF="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Chart/"
TARGET="_top"
> ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Chart/</A
>
</P
><P
> LinuxDoc Software:
<A
HREF="http://www.linuxdoc.org/"
TARGET="_top"
>http://www.linuxdoc.org/</A
>
(for documentation maintenance)
</P
></DIV
><DIV
CLASS="APPENDIX"
><HR><H1
><A
NAME="DATABASE"
>Appendix C. The Bugzilla Database</A
></H1
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers?</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="DBSCHEMA"
>C.1. Database Schema Chart</A
></H1
><P
> <DIV
CLASS="MEDIAOBJECT"
><P
><IMG
SRC="dbschema.jpg"
ALT="Database Relationships"
></IMG
><DIV
CLASS="CAPTION"
><P
>Bugzilla database relationships chart</P
></DIV
></P
></DIV
>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="DBDOC"
>C.2. MySQL Bugzilla Database Introduction</A
></H1
><P
CLASS="LITERALLAYOUT"
><br>
Contributor(s): Matthew P. Barnson (mbarnson@excitehome.net)<br>
<br>
Last update: May 16, 2000<br>
<br>
Changes:<br>
Version 1.0: Initial public release (May 16, 2000)<br>
<br>
Maintainer: Matthew P. Barnson (mbarnson@excitehome.net)<br>
<br>
<br>
===<br>
Table Of Contents<br>
===<br>
<br>
FOREWORD<br>
INTRODUCTION<br>
THE BASICS<br>
THE TABLES<br>
THE DETAILS<br>
<br>
<br>
<br>
===<br>
FOREWORD<br>
===<br>
<br>
This information comes straight from my life. I was forced to learn how<br>
Bugzilla organizes database because of nitpicky requests from users for tiny<br>
changes in wording, rather than having people re-educate themselves or<br>
figure out how to work our procedures around the tool. It sucks, but it can<br>
and will happen to you, so learn how the schema works and deal with it when it<br>
comes.<br>
<br>
I'm sorry this version is plain text. I can whip this info out a lot faster<br>
if I'm not concerned about complex formatting. I'll get it into sgml for easy<br>
portability as time permits.<br>
<br>
The Bugzilla Database Schema has a home! In addition to availability via CVS<br>
and released versions 2.12 and higher of Bugzilla, you can find the latest &<br>
greatest version of the Bugzilla Database Schema at<br>
http://www.trilobyte.net/barnsons/. This is a living document; please be sure<br>
you are up-to-date with the latest version before mirroring.<br>
<br>
The Bugzilla Database Schema is designed to provide vital information<br>
regarding the structure of the MySQL database. Where appropriate, this<br>
document will refer to URLs rather than including documents in their entirety<br>
to ensure completeness even should this paper become out of date.<br>
<br>
This document is not maintained by Netscape or Netscape employees, so please<br>
do not contact them regarding errors or omissions contained herein. Please<br>
direct all questions, comments, updates, flames, etc. to Matthew P. Barnson<br>
mbarnson@excitehome.net) (barnboy or barnhome on irc.mozilla.org in<br>
#mozwebtools).<br>
<br>
I'm sure I've made some glaring errors or omissions in this paper -- please<br>
email me corrections or post corrections to the<br>
netscape.public.mozilla.webtools newsgroup.<br>
<br>
<br>
<br>
===<br>
INTRODUCTION<br>
===<br>
<br>
<br>
<br>
So, here you are with your brand-new installation of Bugzilla. You've got<br>
MySQL set up, Apache working right, Perl DBI and DBD talking to the database<br>
flawlessly. Maybe you've even entered a few test bugs to make sure email's<br>
working; people seem to be notified of new bugs and changes, and you can<br>
enter and edit bugs to your heart's content. Perhaps you've gone through the<br>
trouble of setting up a gateway for people to submit bugs to your database via<br>
email, have had a few people test it, and received rave reviews from your beta<br>
testers.<br>
<br>
What's the next thing you do? Outline a training strategy for your<br>
development team, of course, and bring them up to speed on the new tool you've<br>
labored over for hours.<br>
<br>
Your first training session starts off very well! You have a captive<br>
audience which seems enraptured by the efficiency embodied in this thing called<br>
"Bugzilla". You are caught up describing the nifty features, how people can<br>
save favorite queries in the database, set them up as headers and footers on<br>
their pages, customize their layouts, generate reports, track status with<br>
greater efficiency than ever before, leap tall buildings with a single bound<br>
and rescue Jane from the clutches of Certain Death!<br>
<br>
But Certain Death speaks up -- a tiny voice, from the dark corners of the<br>
conference room. "I have a concern," the voice hisses from the darkness,<br>
"about the use of the word 'verified'.<br>
<br>
The room, previously filled with happy chatter, lapses into reverential<br>
silence as Certain Death (better known as the Vice President of Software<br>
Engineering) continues. "You see, for two years we've used the word 'verified'<br>
to indicate that a developer or quality assurance engineer has confirmed that,<br>
in fact, a bug is valid. I don't want to lose two years of training to a<br>
new software product. You need to change the bug status of 'verified' to<br>
'approved' as soon as possible. To avoid confusion, of course."<br>
<br>
Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I<br>
don't think that would be a problem," You review the changes with Certain<br>
Death, and continue to jabber on, "no, it's not too big a change. I mean, we<br>
have the source code, right? You know, 'Use the Source, Luke' and all that...<br>
no problem," All the while you quiver inside like a beached jellyfish bubbling,<br>
burbling, and boiling on a hot Jamaican sand dune...<br>
<br>
Thus begins your adventure into the heart of Bugzilla. You've been forced<br>
to learn about non-portable enum() fields, varchar columns, and tinyint<br>
definitions. The Adventure Awaits You!<br>
<br>
<br>
<br>
===<br>
The Basics<br>
===<br>
<br>
If you were like me, at this point you're totally clueless about the<br>
internals of MySQL, and if it weren't for this executive order from the Vice<br>
President you couldn't care less about the difference between a "bigint" and a<br>
"tinyint" entry in MySQL. I'd refer you first to the MySQL documentation,<br>
available at http://www.mysql.com/doc.html, but that's mostly a confusing<br>
morass of high-level database jargon. Here are the basics you need to know<br>
about the database to proceed:<br>
<br>
1. To connect to your database, type "mysql -u root" at the command prompt as<br>
any user. If this works without asking you for a password, SHAME ON YOU! You<br>
should have locked your security down like the README told you to. You can<br>
find details on locking down your database in the Bugzilla FAQ in this<br>
directory (under "Security"), or more robust security generalities in the<br>
MySQL searchable documentation at<br>
http://www.mysql.com/php/manual.php3?section=Privilege_system .<br>
<br>
2. You should now be at a prompt that looks like this:<br>
<br>
mysql><br>
<br>
At the prompt, if "bugs" is the name of your Bugzilla database, type:<br>
<br>
mysql> use bugs;<br>
<br>
(don't forget the ";" at the end of each line, or you'll be kicking yourself<br>
all the way through this documentation)<br>
Young Grasshopper, you are now ready for the unveiling of the Bugzilla<br>
database, in the next section...<br>
<br>
<br>
<br>
===<br>
THE TABLES<br>
===<br>
<br>
Imagine your MySQL database as a series of spreadsheets, and you won't be too<br>
far off. If you use this command:<br>
<br>
mysql> show tables from bugs;<br>
<br>
you'll be able to see all the "spreadsheets" (tables) in your database. Cool,<br>
huh? It's kinda' like a filesystem, only much faster and more robust. Come<br>
on, I'll show you more!<br>
<br>
From the command issued above, you should now have some output that looks<br>
like this:<br>
<br>
+-------------------+<br>
| Tables in bugs |<br>
+-------------------+<br>
| attachments |<br>
| bugs |<br>
| bugs_activity |<br>
| cc |<br>
| components |<br>
| dependencies |<br>
| fielddefs |<br>
| groups |<br>
| keyworddefs |<br>
| keywords |<br>
| logincookies |<br>
| longdescs |<br>
| milestones |<br>
| namedqueries |<br>
| products |<br>
| profiles |<br>
| profiles_activity |<br>
| shadowlog |<br>
| versions |<br>
| votes |<br>
| watch |<br>
+-------------------+<br>
<br>
<br>
If it doesn't look quite the same, that probably means it's time to<br>
update this documentation :)<br>
<br>
Here's an overview of what each table does. Most columns in each table have<br>
descriptive names that make it fairly trivial to figure out their jobs.<br>
<br>
attachments: This table stores all attachments to bugs. It tends to be your<br>
largest table, yet also generally has the fewest entries because file<br>
attachments are so (relatively) large.<br>
<br>
bugs: This is the core of your system. The bugs table stores most of the<br>
current information about a bug, with the exception of the info stored in the<br>
other tables.<br>
<br>
bugs_activity: This stores information regarding what changes are made to bugs<br>
when -- a history file.<br>
<br>
cc: This tiny table simply stores all the CC information for any bug which has<br>
any entries in the CC field of the bug. Note that, like most other tables in<br>
Bugzilla, it does not refer to users by their user names, but by their unique<br>
userid, stored as a primary key in the profiles table.<br>
<br>
components: This stores the programs and components (or products and<br>
components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"<br>
(product) field is the full name of the product, rather than some other unique<br>
identifier, like bug_id and user_id are elsewhere in the database.<br>
<br>
dependencies: Stores data about those cool dependency trees.<br>
<br>
fielddefs: A nifty table that defines other tables. For instance, when you<br>
submit a form that changes the value of "AssignedTo" this table allows<br>
translation to the actual field name "assigned_to" for entry into MySQL.<br>
<br>
groups: defines bitmasks for groups. A bitmask is a number that can uniquely<br>
identify group memberships. For instance, say the group that is allowed to<br>
tweak parameters is assigned a value of "1", the group that is allowed to edit<br>
users is assigned a "2", and the group that is allowed to create new groups is<br>
assigned the bitmask of "4". By uniquely combining the group bitmasks (much<br>
like the chmod command in UNIX,) you can identify a user is allowed to tweak<br>
parameters and create groups, but not edit users, by giving him a bitmask of<br>
"5", or a user allowed to edit users and create groups, but not tweak<br>
parameters, by giving him a bitmask of "6" Simple, huh?<br>
If this makes no sense to you, try this at the mysql prompt:<br>
mysql> select * from groups;<br>
You'll see the list, it makes much more sense that way.<br>
<br>
keyworddefs: Definitions of keywords to be used<br>
<br>
keywords: Unlike what you'd think, this table holds which keywords are<br>
associated with which bug id's.<br>
<br>
logincookies: This stores every login cookie ever assigned to you for every<br>
machine you've ever logged into Bugzilla from. Curiously, it never does any<br>
housecleaning -- I see cookies in this file I've not used for months. However,<br>
since Bugzilla never expires your cookie (for convenience' sake), it makes<br>
sense.<br>
<br>
longdescs: The meat of bugzilla -- here is where all user comments are stored!<br>
You've only got 2^24 bytes per comment (it's a mediumtext field), so speak<br>
sparingly -- that's only the amount of space the Old Testament from the Bible<br>
would take (uncompressed, 16 megabytes). Each comment is keyed to the<br>
bug_id to which it's attached, so the order is necessarily chronological, for<br>
comments are played back in the order in which they are received.<br>
<br>
milestones: Interesting that milestones are associated with a specific product<br>
in this table, but Bugzilla does not yet support differing milestones by<br>
product through the standard configuration interfaces.<br>
<br>
namedqueries: This is where everybody stores their "custom queries". Very<br>
cool feature; it beats the tar out of having to bookmark each cool query you<br>
construct.<br>
<br>
products: What products you have, whether new bug entries are allowed for the<br>
product, what milestone you're working toward on that product, votes, etc. It<br>
will be nice when the components table supports these same features, so you<br>
could close a particular component for bug entry without having to close an<br>
entire product...<br>
<br>
profiles: Ahh, so you were wondering where your precious user information was<br>
stored? Here it is! With the passwords in plain text for all to see! (but<br>
sshh... don't tell your users!)<br>
<br>
profiles_activity: Need to know who did what when to who's profile? This'll<br>
tell you, it's a pretty complete history.<br>
<br>
shadowlog: I could be mistaken here, but I believe this table tells you when<br>
your shadow database is updated and what commands were used to update it. We<br>
don't use a shadow database at our site yet, so it's pretty empty for us.<br>
<br>
versions: Version information for every product<br>
<br>
votes: Who voted for what when<br>
<br>
watch: Who (according to userid) is watching who's bugs (according to their<br>
userid).<br>
<br>
<br>
===<br>
THE DETAILS<br>
===<br>
<br>
Ahh, so you're wondering just what to do with the information above? At the<br>
mysql prompt, you can view any information about the columns in a table with<br>
this command (where "table" is the name of the table you wish to view):<br>
<br>
mysql> show columns from table;<br>
<br>
You can also view all the data in a table with this command:<br>
<br>
mysql> select * from table;<br>
<br>
-- note: this is a very bad idea to do on, for instance, the "bugs" table if<br>
you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or<br>
50,000 bugs play across your screen.<br>
<br>
You can limit the display from above a little with the command, where<br>
"column" is the name of the column for which you wish to restrict information:<br>
<br>
mysql> select * from table where (column = "some info");<br>
<br>
-- or the reverse of this<br>
<br>
mysql> select * from table where (column != "some info");<br>
<br>
Let's take our example from the introduction, and assume you need to change<br>
the word "verified" to "approved" in the resolution field. We know from the<br>
above information that the resolution is likely to be stored in the "bugs"<br>
table. Note we'll need to change a little perl code as well as this database<br>
change, but I won't plunge into that in this document. Let's verify the<br>
information is stored in the "bugs" table:<br>
<br>
mysql> show columns from bugs<br>
<br>
(exceedingly long output truncated here)<br>
| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||<br>
<br>
Sorry about that long line. We see from this that the "bug status" column is<br>
an "enum field", which is a MySQL peculiarity where a string type field can<br>
only have certain types of entries. While I think this is very cool, it's not<br>
standard SQL. Anyway, we need to add the possible enum field entry<br>
'APPROVED' by altering the "bugs" table.<br>
<br>
mysql> ALTER table bugs CHANGE bug_status bug_status<br>
-> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",<br>
-> "VERIFIED", "APPROVED", "CLOSED") not null;<br>
<br>
(note we can take three lines or more -- whatever you put in before the<br>
semicolon is evaluated as a single expression)<br>
<br>
Now if you do this:<br>
<br>
mysql> show columns from bugs;<br>
<br>
you'll see that the bug_status field has an extra "APPROVED" enum that's<br>
available! Cool thing, too, is that this is reflected on your query page as<br>
well -- you can query by the new status. But how's it fit into the existing<br>
scheme of things?<br>
Looks like you need to go back and look for instances of the word "verified"<br>
in the perl code for Bugzilla -- wherever you find "verified", change it to<br>
"approved" and you're in business (make sure that's a case-insensitive search).<br>
Although you can query by the enum field, you can't give something a status<br>
of "APPROVED" until you make the perl changes. Note that this change I<br>
mentioned can also be done by editing checksetup.pl, which automates a lot of<br>
this. But you need to know this stuff anyway, right?<br>
<br>
I hope this database tutorial has been useful for you. If you have comments<br>
to add, questions, concerns, etc. please direct them to<br>
mbarnson@excitehome.net. Please direct flames to /dev/null :) Have a nice<br>
day!<br>
<br>
<br>
<br>
===<br>
LINKS<br>
===<br>
<br>
Great MySQL tutorial site:<br>
http://www.devshed.com/Server_Side/MySQL/<br>
<br>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="GRANTTABLES"
>C.3. MySQL Permissions & Grant Tables</A
></H1
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>The following portion of documentation comes from my answer to an old discussion of Keystone,
a cool product that does trouble-ticket tracking for IT departments. I wrote this post to the
Keystone support group regarding MySQL grant table permissions, and how to use them effectively.
It is badly in need of updating, as I believe MySQL has added a field or two to the grant tables
since this time, but it serves as a decent introduction and troubleshooting document for grant
table issues. I used Keynote to track my troubles until I discovered Bugzilla,
which gave me a whole new set of troubles to work on : )</P
></BLOCKQUOTE
></DIV
><P
CLASS="LITERALLAYOUT"
>From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999<br>
Date: Mon, 1 Mar 1999 21:37:04 -0700 <br>
From: Matthew Barnson matt_barnson@singletrac.com<br>
To: keystone-users@homeport.org<br>
Subject: [keystone-users] Grant Tables FAQ<br>
<br>
[The following text is in the "iso-8859-1" character set]<br>
[Your display is set for the "US-ASCII" character set]<br>
[Some characters may be displayed incorrectly]<br>
<br>
Maybe we can include this rambling message in the Keystone FAQ? It gets<br>
asked a lot, and the only option current listed in the FAQ is<br>
"--skip-grant-tables".<br>
<br>
Really, you can't go wrong by reading section 6 of the MySQL manual, at<br>
http://www.mysql.com/Manual/manual.html. I am sure their description is<br>
better than mine.<br>
<br>
MySQL runs fine without permissions set up correctly if you run the mysql<br>
daemon with the "--skip-grant-tables" option. Running this way denies<br>
access to nobody. Unfortunately, unless you've got yourself firewalled it<br>
also opens the potential for abuse if someone knows you're running it.<br>
<br>
Additionally, the default permissions for MySQL allow anyone at localhost<br>
access to the database if the database name begins with "test_" or is named<br>
"test" (i.e. "test_keystone"). You can change the name of your database in<br>
the keystone.conf file ($sys_dbname). This is the way I am doing it for<br>
some of my databases, and it works fine.<br>
<br>
The methods described below assume you're running MySQL on the same box as<br>
your webserver, and that you don't mind if your $sys_dbuser for Keystone has<br>
superuser access. See near the bottom of this message for a description of<br>
what each field does.<br>
<br>
Method #1:<br>
<br>
1. cd /var/lib<br>
#location where you'll want to run /usr/bin/mysql_install_db shell<br>
script from to get it to work.<br>
<br>
2. ln -s mysql data <br>
# soft links the "mysql" directory to "data", which is what<br>
mysql_install_db expects. Alternately, you can edit mysql_install_db and<br>
change all the "./data" references to "./mysql".<br>
<br>
3. Edit /usr/bin/mysql_install_db with your favorite text editor (vi,<br>
emacs, jot, pico, etc.)<br>
A) Copy the "INSERT INTO db VALUES<br>
('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately after<br>
itself. Chage the 'test\_%' value to 'keystone', or the value of<br>
$sys_dbname in keystone.conf.<br>
B) If you are running your keystone database with any user, you'll need to<br>
copy the "INSERT INTO user VALUES<br>
('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line after<br>
itself and change 'root' to the name of the keystone database user<br>
($sys_dbuser) in keystone.conf.<br>
<br>
# adds entries to the script to create grant tables for specific<br>
hosts and users. The user you set up has super-user access ($sys_dbuser) --<br>
you may or may not want this. The layout of mysql_install_db is really very<br>
uncomplicated.<br>
<br>
4. /usr/bin/mysqladmin shutdown<br>
# ya gotta shut it down before you can reinstall the grant tables!<br>
<br>
5. rm -i /var/lib/mysql/mysql/*.IS?' and answer 'Y' to the deletion<br>
questions.<br>
# nuke your current grant tables. This WILL NOT delete any other<br>
databases than your grant tables.<br>
<br>
6. /usr/bin/mysql_install_db<br>
# run the script you just edited to install your new grant tables.<br>
<br>
7. mysqladmin -u root password (new_password) <br>
# change the root MySQL password, or else anyone on localhost can<br>
login to MySQL as root and make changes. You can skip this step if you want<br>
keystone to connect as root with no password.<br>
<br>
8. mysqladmin -u (webserver_user_name) password (new_password) <br>
# change the password of the $sys_dbuser. Note that you will need<br>
to change the password in the keystone.conf file as well in $sys_dbpasswd,<br>
and if your permissions are set up incorrectly anybody can type the URL to<br>
your keystone.conf file and get the password. Not that this will help them<br>
much if your permissions are set to @localhost.<br>
<br>
<br>
<br>
Method #2: easier, but a pain reproducing if you have to delete your grant<br>
tables. This is the "recommended" method for altering grant tables in<br>
MySQL. I don't use it because I like the other way :)<br>
<br>
shell> mysql --user=root keystone<br>
<br>
mysql> GRANT<br>
SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS,<br>
FILE,<br>
ON keystone.*<br>
TO <$sys_dbuser name>@localhost<br>
IDENTIFIED BY '(password)'<br>
WITH GRANT OPTION;<br>
<br>
OR<br>
<br>
mysql> GRANT ALL PRIVELEGES <br>
ON keystone.*<br>
TO <$sys_dbuser name>@localhost<br>
IDENTIFIED BY '(password)'<br>
WITH GRANT OPTION;<br>
<br>
# this grants the required permissions to the keystone ($sys_dbuser)<br>
account defined in keystone.conf. However, if you are runnning many<br>
different MySQL-based apps, as we are, it's generally better to edit the<br>
mysql_install_db script to be able to quickly reproduce your permissions<br>
structure again. Note that the FILE privelege and WITH GRANT OPTION may not<br>
be in your best interest to include.<br>
<br>
<br>
GRANT TABLE FIELDS EXPLANATION:<br>
Quick syntax summary: "%" in MySQL is a wildcard. I.E., if you are<br>
defining your DB table and in the 'host' field and enter '%', that means<br>
that any host can access that database. Of course, that host must also have<br>
a valid db user in order to do anything useful. 'db'=name of database. In<br>
our case, it should be "keystone". "user" should be your "$sys_dbuser"<br>
defined in keystone.conf. Note that you CANNOT add or change a password by<br>
using the "INSERT INTO db (X)" command -- you must change it with the mysql<br>
-u command as defined above. Passwords are stored encrypted in the MySQL<br>
database, and if you try to enter it directly into the table they will not<br>
match.<br>
<br>
TABLE: USER. Everything after "password" is a privelege granted (Y/N).<br>
This table controls individual user global access rights.<br>
<br>
'host','user','password','select','insert','update','delete','index','alter'<br>
,'create','drop','grant','reload','shutdown','process','file'<br>
<br>
TABLE: DB. This controls access of USERS to databases.<br>
<br>
'host','db','user','select','insert','update','delete','index','alter','crea<br>
te','drop','grant'<br>
<br>
TABLE: HOST. This controls which HOSTS are allowed what global access<br>
rights. Note that the HOST table, USER table, and DB table are very closely<br>
connected -- if an authorized USER attempts an SQL request from an<br>
unauthorized HOST, she's denied. If a request from an authorized HOST is<br>
not an authorized USER, it is denied. If a globally authorized USER does<br>
not have rights to a certain DB, she's denied. Get the picture?<br>
<br>
'host','db','select','insert','update','delete','index','alter','create','dr<br>
op','grant'<br>
<br>
<br>
You should now have a working knowledge of MySQL grant tables. If there is<br>
anything I've left out of this answer that you feel is pertinent, or if my<br>
instructions don't work for you, please let me know and I'll re-post this<br>
letter again, corrected. I threw it together one night out of exasperation<br>
for all the newbies who don't know squat about MySQL yet, so it is almost<br>
guaranteed to have errors.<br>
<br>
Once again, you can't go wrong by reading section 6 of the MySQL manual. It<br>
is more detailed than I!<br>
http://www.mysql.com/Manual/manual.html.<br>
<br>
----------------------------------------------------------------------------<br>
10/12/2000<br>
Matthew sent in some mail with updated contact information:<br>
NEW CONTACT INFORMATION: <br>
<br>
------------------------ <br>
Matthew P. Barnson <br>
Manager, Systems Administration <br>
Excite@Home Business Applications <br>
mbarnson@excitehome.net <br>
(801)234-8300 <br>
<br>
<br>
</P
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CLEANUPWORK"
>C.4. Cleaning up after mucking with Bugzilla</A
></H1
><P
CLASS="LITERALLAYOUT"
>Contributed by Eric Hanson:<br>
There are several things, and one trick. There is a small tiny piece of<br>
documentation I saw once that said something very important.<br>
1) After pretty much any manual working of the Mysql db, you must<br>
delete a file in the bugzilla directory: data/versioncache<br>
Versioncache basically is a way to speed up bugzilla (from what I<br>
understand). It stores a lot of commonly used information. However,<br>
this file is refreshed every so often (I can't remember the time<br>
interval though). So eventually all changes do propogate out, so you<br>
may see stuff suddenly working.<br>
2) Assuming that failed, you will also have to check something with the<br>
checksetup.pl file. It actually is run twice. The first time it<br>
creates the file: localconfig. You can modify localconfig, (or not if<br>
you are doing bug_status stuff) or you should delete localconfig and<br>
rerun your modified checksetup.pl. Since I don't actually see anything<br>
in localconfig pertaining to bug_status, this point is mainly a FYI.<br>
</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="VARIANTS"
>Chapter 7. Bugzilla Variants</A
></H1
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
> I <EM
>know</EM
> there are more variants than just RedHat Bugzilla out there.
Please help me get information about them, their project status, and benefits there
might be in using them or in using their code in main-tree Bugzilla.
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="RHBUGZILLA"
>7.1. Red Hat Bugzilla</A
></H1
><P
> Red Hat Bugzilla is probably the most popular Bugzilla variant, aside from Mozilla Bugzilla,
on the planet.
One of the major benefits of Red Hat Bugzilla is the ability to work with Oracle as a
database, as well as MySQL.
Here's what Dave Lawrence had to say about the status of Red Hat Bugzilla,
<A
NAME="AEN1936"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
CLASS="LITERALLAYOUT"
> Hello. I apologize that I am getting back to you so late. It has been difficult to keep<br>
up with email this past week. I have checked out your updated documentation and I will<br>
have to say very good work. A few notes and additions as follows.<br>
<br>
(ed: from the FAQ)<br>
>For the record, we are not using any template type implementation for the cosmetic changes <br>
>maded to Bugzilla. It is just alot of html changes in the code itself. I admit I may have <br>
>gotten a little carried away with it but the corporate types asked for a more standardized <br>
>interface to match up with other projects relating to Red Hat web sites. A lot of other web <br>
>based internal tools I am working on also look like Bugzilla. <br>
<br>
<br>
This should probably be changed since we are now in fact using Text::Template for most<br>
of the html rendering. You actually state this later in your numbered list.<br>
<br>
Also number 6 contradicts number 8 where number 6 would be the most up to date status<br>
on the Oracle port.<br>
<br>
Additional Information:<br>
-----------------------------<br>
1. Comments are now stored in varchar fields of 4k in size each. If the comment is more<br>
than 4k it is broken up into chunks and given a sort number so each comment can be re<br>
assembled in the correct order. This was done because originally I was storing the comments<br>
in a long datatype which unfortunately cannot be indexed or joined with another table. This<br>
cause the search of text within the long description to be disabled for a long time. That<br>
is now working and is nto showing any noticeble performance hit that I can tell. <br>
<br>
2. Work is being started on internationalizing the Bugzilla source we have to allow our<br>
Japanese customers to enter bug reports into a single bugzilla system. This will probably<br>
be done by using the nvarchar data types supported by Oracle which allows storage of<br>
double byte characters and also the use of the Accept-Language in the http header for <br>
detection by Bugilla of which language to render.<br>
<br>
3. Of course even more cosmetic changes. It is difficult to keep up with the ever <br>
changing faces of www.redhat.com.<br>
<br>
4. Some convenience enhancements in the administration utilities. And more integration<br>
with other internal/external Red Hat web sites.<br>
<br>
I hope this information may prove helpful for your documentation. Please contact<br>
me if you have any more question or I can do anything else.<br>
<br>
Regards<br>
</P
></BLOCKQUOTE
>
</P
></DIV
></DIV
><DIV
CLASS="APPENDIX"
><HR><H1
><A
NAME="PATCHES"
>Appendix D. Useful Patches and Utilities for Bugzilla</A
></H1
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="SETPERL"
>D.1. The setperl.csh Utility</A
></H1
><P
>
You can use the "setperl.csh" utility to quickly and easily
change the path to perl on all your Bugzilla files.
This is a C-shell script; if you do not have "csh" or "tcsh" in the search
path on your system, it will not work!
</P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
> Download the "setperl.csh" utility to your Bugzilla
directory and make it executable.
</P
><OL
CLASS="SUBSTEPS"
TYPE="a"
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>cd /your/path/to/bugzilla</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>chmod u+x setperl.csh</B
>
</TT
>
</P
></LI
></OL
></LI
><LI
><P
> Prepare (and fix) Bugzilla file permissions.
</P
><OL
CLASS="SUBSTEPS"
TYPE="a"
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>chmod u+w *</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>chmod u+x duplicates.cgi</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>chmod a-x bug_status.html</B
>
</TT
>
</P
></LI
></OL
></LI
><LI
><P
> Run the script:
</P
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>./setperl.csh /your/path/to/perl</B
>
</TT
>
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1986"
></A
><P
><B
>Example D-1. Using Setperl to set your perl path</B
></P
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>./setperl.csh /usr/bin/perl</B
>
</TT
>
</P
></DIV
>
</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="CMDLINE"
>D.2. Command-line Bugzilla Queries</A
></H1
><P
> Users can query Bugzilla from the command line using
this suite of utilities.
</P
><P
> The query.conf file contains the mapping from options to field
names and comparison types. Quoted option names are "grepped" for, so
it should be easy to edit this file. Comments (#) have no effect; you
must make sure these lines do not contain any quoted "option"
</P
><P
> buglist is a shell script which submits a Bugzilla query and writes the
resulting HTML page to stdout. It supports both short options,
(such as "-Afoo" or "-Rbar") and long options (such as
"--assignedto=foo" or "--reporter=bar"). If the first character
of an option is not "-", it is treated as if it were prefixed
with "--default=".
</P
><P
> The columlist is taken from the COLUMNLIST environment variable.
This is equivalent to the "Change Columns" option when you list
bugs in buglist.cgi. If you have already used Bugzilla, use
<B
CLASS="COMMAND"
>grep COLUMLIST ~/.netscape/cookies</B
> to see
your current COLUMNLIST setting.
</P
><P
> bugs is a simple shell script which calls buglist and extracts
the bug numbers from the output. Adding the prefix
"http://bugzilla.mozilla.org/buglist.cgi?bug_id="
turns the bug list into a working link if any bugs are found.
Counting bugs is easy. Pipe the results through
<B
CLASS="COMMAND"
>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</B
>
</P
><P
> Akkana says she has good results piping buglist output through
<B
CLASS="COMMAND"
>w3m -T text/html -dump</B
>
</P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
> Download three files:
</P
><OL
CLASS="SUBSTEPS"
TYPE="a"
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash$</TT
>
<B
CLASS="COMMAND"
>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash$</TT
>
<B
CLASS="COMMAND"
>wget -O buglist 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</B
>
</TT
>
</P
></LI
><LI
><P
> <TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash#</TT
>
<B
CLASS="COMMAND"
>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</B
>
</TT
>
</P
></LI
></OL
></LI
><LI
><P
> Make your utilities executable:
<TT
CLASS="COMPUTEROUTPUT"
> <TT
CLASS="PROMPT"
>bash$</TT
>
<B
CLASS="COMMAND"
>chmod u+x buglist bugs</B
>
</TT
>
</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="SECTION"
><HR><H1
CLASS="SECTION"
><A
NAME="QUICKSEARCH"
>D.3. The Quicksearch Utility</A
></H1
><P
> Quicksearch is a new, experimental feature of the 2.12 release.
It consist of two Javascript files, "quicksearch.js" and "localconfig.js",
and two documentation files, "quicksearch.html" and "quicksearchhack.html"
</P
><P
> The index.html page has been updated to include the QuickSearch text box.
</P
><P
> To take full advantage of the query power, the Bugzilla maintainer must
edit "localconfig.js" according to the value sets used in the local installation.
</P
><P
> Currently, keywords must be hard-coded in localconfig.js. If they are not,
keywords are not automatically recognized. This means, if localconfig.js
is left unconfigured, that searching for a bug with the "foo" keyword
will only find bugs with "foo" in the summary, status whiteboard, product or
component name, but not those with the keyword "foo".
</P
><P
> Workarounds for Bugzilla users:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>search for '!foo' (this will find only bugs with the keyword "foo"</TD
></TR
><TR
><TD
>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> When this tool is ported from client-side JavaScript to server-side Perl,
the requirement for hard-coding keywords can be fixed.
<A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=70907"
TARGET="_top"
>This bug</A
>
has details.
</P
></DIV
></DIV
><DIV
CLASS="APPENDIX"
><HR><H1
><A
NAME="GFDL"
>Appendix E. GNU Free Documentation License</A
></H1
><P
>Version 1.1, March 2000</P
><A
NAME="AEN2042"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>Copyright (C) 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.</P
></BLOCKQUOTE
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_0"
>0. PREAMBLE</A
></H1
><P
>The purpose of this License is to make a manual, textbook,
or other written document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or
noncommercially. Secondarily, this License preserves for the
author and publisher a way to get credit for their work, while not
being considered responsible for modifications made by
others.</P
><P
>This License is a kind of "copyleft", which means that
derivative works of the document must themselves be free in the
same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.</P
><P
>We have designed this License in order to use it for manuals
for free software, because free software needs free documentation:
a free program should come with manuals providing the same
freedoms that the software does. But this License is not limited
to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a
printed book. We recommend this License principally for works
whose purpose is instruction or reference.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_1"
>1. APPLICABILITY AND DEFINITIONS</A
></H1
><P
>This License applies to any manual or other work that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. The "Document",
below, refers to any such manual or work. Any member of the
public is a licensee, and is addressed as "you".</P
><P
>A "Modified Version" of the Document means any work
containing the Document or a portion of it, either copied
verbatim, or with modifications and/or translated into another
language.</P
><P
>A "Secondary Section" is a named appendix or a front-matter
section of the Document that deals exclusively with the
relationship of the publishers or authors of the Document to the
Document's overall subject (or to related matters) and contains
nothing that could fall directly within that overall subject.
(For example, if the Document is in part a textbook of
mathematics, a Secondary Section may not explain any mathematics.)
The relationship could be a matter of historical connection with
the subject or with related matters, or of legal, commercial,
philosophical, ethical or political position regarding
them.</P
><P
>The "Invariant Sections" are certain Secondary Sections
whose titles are designated, as being those of Invariant Sections,
in the notice that says that the Document is released under this
License.</P
><P
>The "Cover Texts" are certain short passages of text that
are listed, as Front-Cover Texts or Back-Cover Texts, in the
notice that says that the Document is released under this
License.</P
><P
>A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification
is available to the general public, whose contents can be viewed
and edited directly and straightforwardly with generic text
editors or (for images composed of pixels) generic paint programs
or (for drawings) some widely available drawing editor, and that
is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format
whose markup has been designed to thwart or discourage subsequent
modification by readers is not Transparent. A copy that is not
"Transparent" is called "Opaque".</P
><P
>Examples of suitable formats for Transparent copies include
plain ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available DTD, and
standard-conforming simple HTML designed for human modification.
Opaque formats include PostScript, PDF, proprietary formats that
can be read and edited only by proprietary word processors, SGML
or XML for which the DTD and/or processing tools are not generally
available, and the machine-generated HTML produced by some word
processors for output purposes only.</P
><P
>The "Title Page" means, for a printed book, the title page
itself, plus such following pages as are needed to hold, legibly,
the material this License requires to appear in the title page.
For works in formats which do not have any title page as such,
"Title Page" means the text near the most prominent appearance of
the work's title, preceding the beginning of the body of the
text.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_2"
>2. VERBATIM COPYING</A
></H1
><P
>You may copy and distribute the Document in any medium,
either commercially or noncommercially, provided that this
License, the copyright notices, and the license notice saying this
License applies to the Document are reproduced in all copies, and
that you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or
distribute. However, you may accept compensation in exchange for
copies. If you distribute a large enough number of copies you
must also follow the conditions in section 3.</P
><P
>You may also lend copies, under the same conditions stated
above, and you may publicly display copies.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_3"
>3. COPYING IN QUANTITY</A
></H1
><P
>If you publish printed copies of the Document numbering more
than 100, and the Document's license notice requires Cover Texts,
you must enclose the copies in covers that carry, clearly and
legibly, all these Cover Texts: Front-Cover Texts on the front
cover, and Back-Cover Texts on the back cover. Both covers must
also clearly and legibly identify you as the publisher of these
copies. The front cover must present the full title with all
words of the title equally prominent and visible. You may add
other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim
copying in other respects.</P
><P
>If the required texts for either cover are too voluminous to
fit legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto
adjacent pages.</P
><P
>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a
machine-readable Transparent copy along with each Opaque copy, or
state in or with each Opaque copy a publicly-accessible
computer-network location containing a complete Transparent copy
of the Document, free of added material, which the general
network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the
latter option, you must take reasonably prudent steps, when you
begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you
distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.</P
><P
>It is requested, but not required, that you contact the
authors of the Document well before redistributing any large
number of copies, to give them a chance to provide you with an
updated version of the Document.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_4"
>4. MODIFICATIONS</A
></H1
><P
>You may copy and distribute a Modified Version of the
Document under the conditions of sections 2 and 3 above, provided
that you release the Modified Version under precisely this
License, with the Modified Version filling the role of the
Document, thus licensing distribution and modification of the
Modified Version to whoever possesses a copy of it. In addition,
you must do these things in the Modified Version:</P
><P
></P
><OL
TYPE="A"
><LI
><P
>Use in the Title Page
(and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if
there were any, be listed in the History section of the
Document). You may use the same title as a previous version if
the original publisher of that version gives permission.</P
></LI
><LI
><P
>List on the Title Page,
as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version,
together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than
five).</P
></LI
><LI
><P
>State on the Title page
the name of the publisher of the Modified Version, as the
publisher.</P
></LI
><LI
><P
>Preserve all the
copyright notices of the Document.</P
></LI
><LI
><P
>Add an appropriate
copyright notice for your modifications adjacent to the other
copyright notices.</P
></LI
><LI
><P
>Include, immediately
after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this
License, in the form shown in the Addendum below.</P
></LI
><LI
><P
>Preserve in that license
notice the full lists of Invariant Sections and required Cover
Texts given in the Document's license notice.</P
></LI
><LI
><P
>Include an unaltered
copy of this License.</P
></LI
><LI
><P
>Preserve the section
entitled "History", and its title, and add to it an item stating
at least the title, year, new authors, and publisher of the
Modified Version as given on the Title Page. If there is no
section entitled "History" in the Document, create one stating
the title, year, authors, and publisher of the Document as given
on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.</P
></LI
><LI
><P
>Preserve the network
location, if any, given in the Document for public access to a
Transparent copy of the Document, and likewise the network
locations given in the Document for previous versions it was
based on. These may be placed in the "History" section. You
may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.</P
></LI
><LI
><P
>In any section entitled
"Acknowledgements" or "Dedications", preserve the section's
title, and preserve in the section all the substance and tone of
each of the contributor acknowledgements and/or dedications
given therein.</P
></LI
><LI
><P
>Preserve all the
Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not
considered part of the section titles.</P
></LI
><LI
><P
>Delete any section
entitled "Endorsements". Such a section may not be included in
the Modified Version.</P
></LI
><LI
><P
>Do not retitle any
existing section as "Endorsements" or to conflict in title with
any Invariant Section.</P
></LI
></OL
><P
>If the Modified Version includes new front-matter sections
or appendices that qualify as Secondary Sections and contain no
material copied from the Document, you may at your option
designate some or all of these sections as invariant. To do this,
add their titles to the list of Invariant Sections in the Modified
Version's license notice. These titles must be distinct from any
other section titles.</P
><P
>You may add a section entitled "Endorsements", provided it
contains nothing but endorsements of your Modified Version by
various parties--for example, statements of peer review or that
the text has been approved by an organization as the authoritative
definition of a standard.</P
><P
>You may add a passage of up to five words as a Front-Cover
Text, and a passage of up to 25 words as a Back-Cover Text, to the
end of the list of Cover Texts in the Modified Version. Only one
passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the
Document already includes a cover text for the same cover,
previously added by you or by arrangement made by the same entity
you are acting on behalf of, you may not add another; but you may
replace the old one, on explicit permission from the previous
publisher that added the old one.</P
><P
>The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for
or to assert or imply endorsement of any Modified Version.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_5"
>5. COMBINING DOCUMENTS</A
></H1
><P
>You may combine the Document with other documents released
under this License, under the terms defined in section 4 above for
modified versions, provided that you include in the combination
all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your
combined work in its license notice.</P
><P
>The combined work need only contain one copy of this
License, and multiple identical Invariant Sections may be replaced
with a single copy. If there are multiple Invariant Sections with
the same name but different contents, make the title of each such
section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section
titles in the list of Invariant Sections in the license notice of
the combined work.</P
><P
>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section
entitled "History"; likewise combine any sections entitled
"Acknowledgements", and any sections entitled "Dedications". You
must delete all sections entitled "Endorsements."</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_6"
>6. COLLECTIONS OF DOCUMENTS</A
></H1
><P
>You may make a collection consisting of the Document and
other documents released under this License, and replace the
individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of
the documents in all other respects.</P
><P
>You may extract a single document from such a collection,
and distribute it individually under this License, provided you
insert a copy of this License into the extracted document, and
follow this License in all other respects regarding verbatim
copying of that document.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_7"
>7. AGGREGATION WITH INDEPENDENT WORKS</A
></H1
><P
>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of
a storage or distribution medium, does not as a whole count as a
Modified Version of the Document, provided no compilation
copyright is claimed for the compilation. Such a compilation is
called an "aggregate", and this License does not apply to the
other self-contained works thus compiled with the Document, on
account of their being thus compiled, if they are not themselves
derivative works of the Document.</P
><P
>If the Cover Text requirement of section 3 is applicable to
these copies of the Document, then if the Document is less than
one quarter of the entire aggregate, the Document's Cover Texts
may be placed on covers that surround only the Document within the
aggregate. Otherwise they must appear on covers around the whole
aggregate.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_8"
>8. TRANSLATION</A
></H1
><P
>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section
4. Replacing Invariant Sections with translations requires
special permission from their copyright holders, but you may
include translations of some or all Invariant Sections in addition
to the original versions of these Invariant Sections. You may
include a translation of this License provided that you also
include the original English version of this License. In case of
a disagreement between the translation and the original English
version of this License, the original English version will
prevail.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_9"
>9. TERMINATION</A
></H1
><P
>You may not copy, modify, sublicense, or distribute the
Document except as expressly provided for under this License. Any
other attempt to copy, modify, sublicense or distribute the
Document is void, and will automatically terminate your rights
under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses
terminated so long as such parties remain in full
compliance.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_10"
>10. FUTURE REVISIONS OF THIS LICENSE</A
></H1
><P
>The Free Software Foundation may publish new, revised
versions of the GNU Free Documentation License from time to time.
Such new versions will be similar in spirit to the present
version, but may differ in detail to address new problems or
concerns. See <A
HREF="http://www.gnu.org/copyleft/"
TARGET="_top"
>http://www.gnu.org/copyleft/</A
>.</P
><P
>Each version of the License is given a distinguishing
version number. If the Document specifies that a particular
numbered version of this License "or any later version" applies to
it, you have the option of following the terms and conditions
either of that specified version or of any later version that has
been published (not as a draft) by the Free Software Foundation.
If the Document does not specify a version number of this License,
you may choose any version ever published (not as a draft) by the
Free Software Foundation.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H1
CLASS="SECT1"
><A
NAME="GFDL_HOWTO"
>How to use this License for your documents</A
></H1
><P
>To use this License in a document you have written, include
a copy of the License in the document and put the following
copyright and license notices just after the title page:</P
><A
NAME="AEN2132"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
> Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License".</P
></BLOCKQUOTE
><P
>If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you have
no Front-Cover Texts, write "no Front-Cover Texts" instead of
"Front-Cover Texts being LIST"; likewise for Back-Cover
Texts.</P
><P
>If your document contains nontrivial examples of program
code, we recommend releasing these examples in parallel under your
choice of free software license, such as the GNU General Public
License, to permit their use in free software.</P
></DIV
></DIV
><DIV
CLASS="GLOSSARY"
><H1
><A
NAME="GLOSSARY"
>Glossary</A
></H1
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_A"
>A</A
></H1
><DL
><DT
><B
>There are no entries for A</B
></DT
><DD
><P
></P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_B"
>B</A
></H1
><DL
><DT
><B
>Bug</B
></DT
><DD
><P
>A "Bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Many also refer to a "Ticket" or "Issue"; in this context, they are synonymous.</P
></DD
><DT
><B
>Bug Number</B
></DT
><DD
><P
>Each Bugzilla Bug is assigned a number that uniquely identifies that Bug. The Bug associated with a Bug Number can be pulled up via a query, or easily from the very front page by typing the number in the "Find" box.</P
></DD
><DT
><B
>Bug Life Cycle</B
></DT
><DD
><P
>A Bug has stages through which it must pass before becoming a "closed bug", including acceptance, resolution, and verification. The "Bug Life Cycle" is moderately flexible according to the needs of the organization using it, though.</P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_I"
>I</A
></H1
><DL
><DT
><A
NAME="GLOSS_INFINITELOOP"
><B
>Infinite Loop</B
></A
></DT
><DD
><P
><EM
>See: </EM
><A
HREF="#GLOSS_RECURSION"
>Recursion</A
></P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_P"
>P</A
></H1
><DL
><DT
><B
>Product</B
></DT
><DD
><P
>A Product is a broad category of types of bugs. In general, there are several Components to a Product. A Product also defines a default Group (used for Bug Security) for all bugs entered into components beneath it.</P
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN2168"
></A
><P
><B
>Example 1. A Sample Product</B
></P
><P
>A company sells a software product called "X". They also maintain some older software called "Y", and have a secret project "Z". An effective use of Products might be to create Products "X", "Y", and "Z", each with Components "User Interface", "Database", and "Business Logic". They might also change group permissions so that only those people who are members of Group "Z" can see components and bugs under Product "Z".</P
></DIV
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_Q"
>Q</A
></H1
><DL
><DT
><B
>Q/A</B
></DT
><DD
><P
>"Q/A" is short for "Quality Assurance". In most large software development organizations, there is a team devoted to ensuring the product meets minimum standards before shipping. This team will also generally want to track the progress of bugs over their life cycle, thus the need for the "Q/A Contact" field in a Bug.</P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_R"
>R</A
></H1
><DL
><DT
><B
>Recursion</B
></DT
><DD
><P
><EM
>See: </EM
><A
HREF="#GLOSS_INFINITELOOP"
>Infinite Loop</A
></P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="GLOSS_Z"
>Z</A
></H1
><DL
><DT
><B
>Zarro Boogs Found</B
></DT
><DD
><P
>This is the cryptic response sent by Bugzilla when a query returned no results. It is just a goofy way of saying "Zero Bugs Found".</P
></DD
></DL
></DIV
></DIV
></DIV
></BODY
></HTML
>