<HTML
><HEAD
><TITLE
>The Bugzilla Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.61
"><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="AEN27"
>Matthew P. Barnson</A
></H3
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
>barnboy@trilobyte.net</P
></DIV
></DIV
><SPAN
CLASS="collab"
><SPAN
CLASS="collabname"
>Zach Lipton</SPAN
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
>zach AT zachlipton DOT com</P
></DIV
></DIV
><BR></SPAN
><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
><TR
><TD
ALIGN="LEFT"
>Revision 2.14.0</TD
><TD
ALIGN="LEFT"
>07 August 2001</TD
><TD
ALIGN="LEFT"
>Revised by: MPB</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Attempted to integrate relevant portions of the UNIX and
Windows installation instructions, moved some data from FAQ
to Install, removed references to README from text, added
Mac OS X install instructions, fixed a bunch
of tpyos (Mark Harig), linked text that referenced other
parts of the Guide, and nuked the old MySQL permissions
section.</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="abstract"
><A
NAME="AEN39"
></A
><P
></P
><P
> This is the documentation for Bugzilla, the Mozilla
bug-tracking system.
</P
><P
> Bugzilla is an enterprise-class set of software utilities
that, when used together, power issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
While it is easy to use and quite flexible, it is
difficult for a novice to install and maintain. Although we
have provided step-by-step directions, Bugzilla is not always
easy to get working. Please be sure the person responsible
for installing and maintaining this software is a qualified
professional for the operating system upon which you install
Bugzilla.
</P
><P
> THIS DOCUMENTATION IS MAINTAINED IN DOCBOOK 4.1.2 XML FORMAT.
IF YOU WISH TO MAKE CORRECTIONS, PLEASE MAKE THEM IN PLAIN
TEXT OR SGML DIFFS AGAINST THE SOURCE. I CANNOT ACCEPT
ADDITIONS TO THE GUIDE WRITTEN IN HTML!
</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="#using"
>Using Bugzilla</A
></DT
><DD
><DL
><DT
>2.1. <A
HREF="#whatis"
>What is Bugzilla?</A
></DT
><DT
>2.2. <A
HREF="#why"
>Why Should We Use Bugzilla?</A
></DT
><DT
>2.3. <A
HREF="#how"
>How do I use Bugzilla?</A
></DT
><DD
><DL
><DT
>2.3.1. <A
HREF="#myaccount"
>Create a Bugzilla Account</A
></DT
><DT
>2.3.2. <A
HREF="#query"
>The Bugzilla Query Page</A
></DT
><DT
>2.3.3. <A
HREF="#bugreports"
>Creating and Managing Bug Reports</A
></DT
><DD
><DL
><DT
>2.3.3.1. <A
HREF="#bug-writing"
>Writing a Great Bug Report</A
></DT
><DT
>2.3.3.2. <A
HREF="#bug-manage"
>Managing your Bug Reports</A
></DT
></DL
></DD
></DL
></DD
><DT
>2.4. <A
HREF="#init4me"
>Where can I find my user preferences?</A
></DT
><DD
><DL
><DT
>2.4.1. <A
HREF="#accountsettings"
>Account Settings</A
></DT
><DT
>2.4.2. <A
HREF="#emailsettings"
>Email Settings</A
></DT
><DD
><DL
><DT
>2.4.2.1. <A
HREF="#notification"
>Email Notification</A
></DT
><DT
>2.4.2.2. <A
HREF="#newemailtech"
>New Email Technology</A
></DT
><DT
>2.4.2.3. <A
HREF="#watchsettings"
>"Watching" Users</A
></DT
></DL
></DD
><DT
>2.4.3. <A
HREF="#footersettings"
>Page Footer</A
></DT
><DT
>2.4.4. <A
HREF="#permissionsettings"
>Permissions</A
></DT
></DL
></DD
><DT
>2.5. <A
HREF="#usingbz-conc"
>Using Bugzilla-Conclusion</A
></DT
></DL
></DD
><DT
>3. <A
HREF="#installation"
>Installation</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="#errata"
>ERRATA</A
></DT
><DT
>3.2. <A
HREF="#stepbystep"
>Step-by-step Install</A
></DT
><DD
><DL
><DT
>3.2.1. <A
HREF="#AEN509"
>Introduction</A
></DT
><DT
>3.2.2. <A
HREF="#AEN515"
>Installing the Prerequisites</A
></DT
><DT
>3.2.3. <A
HREF="#install-mysql"
>Installing MySQL Database</A
></DT
><DT
>3.2.4. <A
HREF="#install-perl"
>Perl (5.004 or greater)</A
></DT
><DT
>3.2.5. <A
HREF="#AEN602"
>DBI Perl Module</A
></DT
><DT
>3.2.6. <A
HREF="#AEN640"
>Data::Dumper Perl Module</A
></DT
><DT
>3.2.7. <A
HREF="#AEN645"
>MySQL related Perl Module Collection</A
></DT
><DT
>3.2.8. <A
HREF="#AEN654"
>TimeDate Perl Module Collection</A
></DT
><DT
>3.2.9. <A
HREF="#AEN658"
>GD Perl Module (1.8.3)</A
></DT
><DT
>3.2.10. <A
HREF="#AEN667"
>Chart::Base Perl Module (0.99c)</A
></DT
><DT
>3.2.11. <A
HREF="#AEN671"
>DB_File Perl Module</A
></DT
><DT
>3.2.12. <A
HREF="#AEN674"
>HTTP Server</A
></DT
><DT
>3.2.13. <A
HREF="#AEN692"
>Installing the Bugzilla Files</A
></DT
><DT
>3.2.14. <A
HREF="#AEN721"
>Setting Up the MySQL Database</A
></DT
><DT
>3.2.15. <A
HREF="#AEN768"
>Tweaking <TT
CLASS="filename"
>localconfig</TT
></A
></DT
><DT
>3.2.16. <A
HREF="#AEN806"
>Setting Up Maintainers Manually (Optional)</A
></DT
><DT
>3.2.17. <A
HREF="#AEN817"
>The Whining Cron (Optional)</A
></DT
><DT
>3.2.18. <A
HREF="#AEN827"
>Bug Graphs (Optional)</A
></DT
><DT
>3.2.19. <A
HREF="#AEN839"
>Securing MySQL</A
></DT
></DL
></DD
><DT
>3.3. <A
HREF="#osx"
>Mac OS X Installation Notes</A
></DT
><DT
>3.4. <A
HREF="#bsdinstall"
>BSD Installation Notes</A
></DT
><DT
>3.5. <A
HREF="#geninstall"
>Installation General Notes</A
></DT
><DD
><DL
><DT
>3.5.1. <A
HREF="#AEN941"
>Modifying Your Running System</A
></DT
><DT
>3.5.2. <A
HREF="#AEN948"
>Upgrading From Previous Versions</A
></DT
><DT
>3.5.3. <A
HREF="#htaccess"
><TT
CLASS="filename"
>.htaccess</TT
> files and security</A
></DT
><DT
>3.5.4. <A
HREF="#mod-throttle"
><TT
CLASS="filename"
>mod_throttle</TT
> and Security</A
></DT
><DT
>3.5.5. <A
HREF="#content-type"
>Preventing untrusted Bugzilla content from executing malicious Javascript code</A
></DT
><DT
>3.5.6. <A
HREF="#unixhistory"
>UNIX Installation Instructions History</A
></DT
></DL
></DD
><DT
>3.6. <A
HREF="#win32"
>Win32 Installation Notes</A
></DT
><DD
><DL
><DT
>3.6.1. <A
HREF="#wininstall"
>Win32 Installation: Step-by-step</A
></DT
><DT
>3.6.2. <A
HREF="#addlwintips"
>Additional Windows Tips</A
></DT
><DT
>3.6.3. <A
HREF="#bzldap"
>Bugzilla LDAP Integration</A
></DT
></DL
></DD
></DL
></DD
><DT
>4. <A
HREF="#administration"
>Administering Bugzilla</A
></DT
><DD
><DL
><DT
>4.1. <A
HREF="#postinstall-check"
>Post-Installation Checklist</A
></DT
><DT
>4.2. <A
HREF="#useradmin"
>User Administration</A
></DT
><DD
><DL
><DT
>4.2.1. <A
HREF="#defaultuser"
>Creating the Default User</A
></DT
><DT
>4.2.2. <A
HREF="#manageusers"
>Managing Other Users</A
></DT
><DD
><DL
><DT
>4.2.2.1. <A
HREF="#login"
>Logging In</A
></DT
><DT
>4.2.2.2. <A
HREF="#createnewusers"
>Creating new users</A
></DT
><DT
>4.2.2.3. <A
HREF="#disableusers"
>Disabling Users</A
></DT
><DT
>4.2.2.4. <A
HREF="#modifyusers"
>Modifying Users</A
></DT
></DL
></DD
></DL
></DD
><DT
>4.3. <A
HREF="#programadmin"
>Product, Component, Milestone, and Version
Administration</A
></DT
><DD
><DL
><DT
>4.3.1. <A
HREF="#products"
>Products</A
></DT
><DT
>4.3.2. <A
HREF="#components"
>Components</A
></DT
><DT
>4.3.3. <A
HREF="#versions"
>Versions</A
></DT
><DT
>4.3.4. <A
HREF="#milestones"
>Milestones</A
></DT
><DT
>4.3.5. <A
HREF="#voting"
>Voting</A
></DT
><DT
>4.3.6. <A
HREF="#groups"
>Groups and Group Security</A
></DT
></DL
></DD
><DT
>4.4. <A
HREF="#security"
>Bugzilla Security</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/Tinderbox2</A
></DT
></DL
></DD
><DT
>6. <A
HREF="#future"
>The Future of Bugzilla</A
></DT
><DT
>7. <A
HREF="#variants"
>Bugzilla Variants and Competitors</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="#rhbugzilla"
>Red Hat Bugzilla</A
></DT
><DT
>7.2. <A
HREF="#variant-fenris"
>Loki Bugzilla (Fenris)</A
></DT
><DT
>7.3. <A
HREF="#variant-issuezilla"
>Issuezilla</A
></DT
><DT
>7.4. <A
HREF="#variant-scarab"
>Scarab</A
></DT
><DT
>7.5. <A
HREF="#variant-perforce"
>Perforce SCM</A
></DT
><DT
>7.6. <A
HREF="#variant-sourceforge"
>SourceForge</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
><DD
><DL
><DT
>C.2.1. <A
HREF="#AEN2340"
>Bugzilla Database Basics</A
></DT
><DD
><DL
><DT
>C.2.1.1. <A
HREF="#AEN2369"
>Bugzilla Database Tables</A
></DT
></DL
></DD
></DL
></DD
><DT
>C.3. <A
HREF="#granttables"
>MySQL Permissions & Grant Tables</A
></DT
></DL
></DD
><DT
>D. <A
HREF="#patches"
>Useful Patches and Utilities for Bugzilla</A
></DT
><DD
><DL
><DT
>D.1. <A
HREF="#rewrite"
>Apache <TT
CLASS="filename"
>mod_rewrite</TT
> magic</A
></DT
><DT
>D.2. <A
HREF="#setperl"
>The setperl.csh Utility</A
></DT
><DT
>D.3. <A
HREF="#cmdline"
>Command-line Bugzilla Queries</A
></DT
><DT
>D.4. <A
HREF="#quicksearch"
>The Quicksearch Utility</A
></DT
><DT
>D.5. <A
HREF="#bzhacking"
>Hacking Bugzilla</A
></DT
><DD
><DL
><DT
>D.5.1. <A
HREF="#AEN2504"
>Things that have caused problems and should be avoided</A
></DT
><DT
>D.5.2. <A
HREF="#AEN2518"
>Coding Style for Bugzilla</A
></DT
></DL
></DD
></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="#AEN307"
>Some Famous Software Versions</A
></DT
><DT
>2-2. <A
HREF="#AEN317"
>Mozilla's Bugzilla Components</A
></DT
><DT
>3-1. <A
HREF="#AEN708"
>Setting up bonsaitools symlink</A
></DT
><DT
>3-2. <A
HREF="#AEN799"
>Running checksetup.pl as the web user</A
></DT
><DT
>3-3. <A
HREF="#AEN1048"
>Installing ActivePerl ppd Modules on Microsoft Windows</A
></DT
><DT
>3-4. <A
HREF="#AEN1233"
>Removing encrypt() for Windows NT Bugzilla version
2.12 or earlier</A
></DT
><DT
>4-1. <A
HREF="#AEN1470"
>Creating some Components</A
></DT
><DT
>4-2. <A
HREF="#AEN1499"
>Common Use of Versions</A
></DT
><DT
>4-3. <A
HREF="#AEN1503"
>A Different Use of Versions</A
></DT
><DT
>4-4. <A
HREF="#AEN1531"
>Using SortKey with Target Milestone</A
></DT
><DT
>4-5. <A
HREF="#AEN1567"
>When to Use Group Security</A
></DT
><DT
>4-6. <A
HREF="#AEN1584"
>Creating a New Group</A
></DT
><DT
>4-7. <A
HREF="#AEN1601"
>Bugzilla Groups</A
></DT
><DT
>D-1. <A
HREF="#AEN2448"
>Using Setperl to set your perl path</A
></DT
><DT
>1. <A
HREF="#AEN2769"
>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
> 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.14</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 follow the numbering
conventions of the main-tree Bugzilla releases, available at
<A
HREF="http://www.mozilla.org/projects/bugzilla"
TARGET="_top"
>http://www.mozilla.org/projects/bugzilla</A
>. Intermediate releases will have
a minor revision number following a period. The current version
of Bugzilla, as of this writing (August 10, 2001) is 2.14; if
something were seriously wrong with that edition of the Guide,
subsequent releases would receive an additional dotted-decimal
digit to indicate the update (2.14.1, 2.14.2, etc.).
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="AEN70"
></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 the 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 Matthew P. Barnson.
</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.
</P
><P
> Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". I
wholeheartedly endorse the use of GNU/Linux in every situation
where it is appropriate. It is an extremely versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</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
> Although the Bugzilla development team has taken great care to
ensure that all easily-exploitable bugs or options are
documented or fixed in the code, security holes surely exist.
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. The Bugzilla development
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
product, and are responsible for auditing it yourself to insure
your security needs are met.
</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="newversions"
>1.4. New Versions</A
></H1
><P
> This is the 2.14 version of The Bugzilla Guide. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the 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 writing Bugzilla and creating the
README upon which the UNIX installation 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
> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</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
>, and arrange with
Matt Barnson to check it into CVS.
</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="AEN129"
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Descriptions</TH
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Appearance</TH
></TR
></THEAD
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Warnings</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><DIV
CLASS="caution"
><P
></P
><TABLE
CLASS="caution"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/caution.gif"
HSPACE="5"
ALT="Caution"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Warnings.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Hint</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Hint.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Notes</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Note.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Information requiring special attention</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Warning.</P
></TD
></TR
></TABLE
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>File Names</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="filename"
>file.extension</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Directory Names</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="filename"
>directory</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Commands to be typed</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
CLASS="command"
>command</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Applications Names</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="application"
>application</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><I
CLASS="foreignphrase"
>Prompt</I
> of users command under bash shell</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>bash$</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><I
CLASS="foreignphrase"
>Prompt</I
> of root users command under bash shell</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>bash#</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><I
CLASS="foreignphrase"
>Prompt</I
> of user command under tcsh shell</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>tcsh$</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Environment Variables</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="envar"
>VARIABLE</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Emphasized word</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><EM
>word</EM
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Code Example</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
><TT
CLASS="sgmltag"
><para></TT
>Beginning and end of paragraph<TT
CLASS="sgmltag"
></para></TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="chapter"
><HR><H1
><A
NAME="using"
>Chapter 2. 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, & Where?</I
></P
></I
></TD
></TR
></TABLE
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="whatis"
>2.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, console, and HTTP APIs
</P
></LI
><LI
><P
> available integration with automated software
configuration management systems, including Perforce and
CVS (through the Bugzilla email interface and
checkin/checkout scripts)
</P
></LI
><LI
><P
> too many more features to list
</P
></LI
></UL
>
</P
><P
> Despite its current robustness and popularity, 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, little internationalization (although non-US
character sets are accepted for comments), 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 <SPAN
CLASS="QUOTE"
>"simple search"</SPAN
> 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 continually gains new features.
</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="why"
>2.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 <EM
>something</EM
> 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"
>2.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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
>2.3.1. Create a Bugzilla Account</A
></H2
><P
> First things 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/bugzilla-tip/"
TARGET="_top"
> http://landfill.tequilarista.org/bugzilla-tip/</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 moments, 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 <SPAN
CLASS="QUOTE"
>"Log In"</SPAN
> link in the yellow area at
the bottom of the page in your browser, then enter your
<SPAN
CLASS="QUOTE"
>"E-mail address"</SPAN
> and <SPAN
CLASS="QUOTE"
>"Password"</SPAN
>
you just received into the spaces provided, and select
<SPAN
CLASS="QUOTE"
>"Login"</SPAN
>.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you ever forget your password, you can come back to
this page, enter your <SPAN
CLASS="QUOTE"
>"E-mail address"</SPAN
>,
then select the <SPAN
CLASS="QUOTE"
>"E-mail me a password"</SPAN
>
button to have your password mailed to you again so
that you can login.
</P
></TD
></TR
></TABLE
></DIV
>
<DIV
CLASS="caution"
><P
></P
><TABLE
CLASS="caution"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/caution.gif"
HSPACE="5"
ALT="Caution"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Many modern browsers include an
<SPAN
CLASS="QUOTE"
>"Auto-Complete"</SPAN
> or <SPAN
CLASS="QUOTE"
>"Form
Fill"</SPAN
> 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
<SPAN
CLASS="QUOTE"
>"Bugzilla Query Page"</SPAN
>. 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"
>2.3.2. The Bugzilla Query Page</A
></H2
><P
> The Bugzilla Query Page is the heart and soul of the Bugzilla
user experience. 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 <TT
CLASS="filename"
>quicksearch.html</TT
> available to
use and simplify your searches. There is also a helper for
the query interface, called
<TT
CLASS="filename"
>queryhelp.cgi</TT
>. Landfill tends to run the
latest code, so these two utilities should be available there
for your perusal.
</P
><P
> At this point, let's visit the query page.
<A
HREF="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"
TARGET="_top"
> landfill.tequilarista.org/bugzilla-tip/query.cgi</A
>
</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 <SPAN
CLASS="QUOTE"
>"Status"</SPAN
> 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 <SPAN
CLASS="QUOTE"
>"Back"</SPAN
>
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 <SPAN
CLASS="QUOTE"
>"Bugzilla Query
Page"</SPAN
>. 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 "Bugzilla". Select this entry.
</P
></LI
><LI
><P
> Did you notice that some of the boxes to the right changed
when you selected "Bugzilla"? 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="AEN307"
></A
><P
><B
>Example 2-1. Some Famous Software Versions</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN309"
></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="AEN317"
></A
><P
><B
>Example 2-2. Mozilla's Bugzilla Components</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN319"
></A
><P
></P
><P
> Mozilla's "Bugzilla" Product is composed of several pieces (Components):
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><EM
>Administration</EM
>,
Administration of a bugzilla installation, including
<TT
CLASS="filename"
>editcomponents.cgi</TT
>,
<TT
CLASS="filename"
>editgroups.cgi</TT
>,
<TT
CLASS="filename"
>editkeywords.cgi</TT
>,
<TT
CLASS="filename"
>editparams.cgi</TT
>,
<TT
CLASS="filename"
>editproducts.cgi</TT
>,
<TT
CLASS="filename"
>editusers.cgi</TT
>,
<TT
CLASS="filename"
>editversions.cgi,</TT
> and
<TT
CLASS="filename"
>sanitycheck.cgi</TT
>.
</TD
></TR
><TR
><TD
><EM
>Bugzilla-General</EM
>,
Anything that doesn't fit in the other components, or spans
multiple components.
</TD
></TR
><TR
><TD
><EM
>Creating/Changing Bugs</EM
>,
Creating, changing, and viewing bugs.
<TT
CLASS="filename"
>enter_bug.cgi</TT
>,
<TT
CLASS="filename"
>post_bug.cgi</TT
>,
<TT
CLASS="filename"
>show_bug.cgi</TT
> and
<TT
CLASS="filename"
>process_bug.cgi</TT
>.
</TD
></TR
><TR
><TD
><EM
>Documentation</EM
>,
The bugzilla documentation, including anything in the
<TT
CLASS="filename"
>docs/</TT
> directory and The Bugzilla Guide
(This document :)
</TD
></TR
><TR
><TD
><EM
>Email</EM
>,
Anything to do with email sent by Bugzilla.
<TT
CLASS="filename"
>processmail</TT
>
</TD
></TR
><TR
><TD
><EM
>Installation</EM
>,
The installation process of Bugzilla. This includes
<TT
CLASS="filename"
>checksetup.pl</TT
> and whatever else it evolves into.
</TD
></TR
><TR
><TD
><EM
>Query/Buglist</EM
>,
Anything to do with searching for bugs and viewing the buglists.
<TT
CLASS="filename"
>query.cgi</TT
> and
<TT
CLASS="filename"
>buglist.cgi</TT
>
</TD
></TR
><TR
><TD
><EM
>Reporting/Charting</EM
>,
Getting reports from Bugzilla.
<TT
CLASS="filename"
>reports.cgi</TT
> and
<TT
CLASS="filename"
>duplicates.cgi</TT
>
</TD
></TR
><TR
><TD
><EM
>User Accounts</EM
>,
Anything about managing a user account from the user's perspective.
<TT
CLASS="filename"
>userprefs.cgi</TT
>, saved queries, creating accounts,
changing passwords, logging in, etc.
</TD
></TR
><TR
><TD
><EM
>User Interface</EM
>,
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates, etc.
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="bugreports"
>2.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"
>2.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 some bug-writing guidelines. If you
are reading this document as part of a Bugzilla CVS checkout
or un-tarred Bugzilla distribution, you should be able to
read them by clicking <A
HREF="../../bugwritinghelp.html"
TARGET="_top"
>here</A
>. If you are reading this online, check out the Mozilla.org bug-writing guidelines at <A
HREF="http://www.mozilla.org/quality/bug-writing-guidelines.html"
TARGET="_top"
>http://www.mozilla.org/quality/bug-writing-guidelines.html</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/bugzilla-tip/"
TARGET="_top"
> http://landfill.tequilarista.org/bugzilla-tip/</A
> in your browser.
</P
></LI
><LI
><P
> Select the <A
HREF="http://landfill.tequilarista.org/bugzilla-tip/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"
>2.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://landfill.tequilarista.org/bugzilla-tip/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://landfill.tequilarista.org/bugzilla-tip/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://landfill.tequilarista.org/bugzilla-tip/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://landfill.tequilarista.org/bugzilla-tip/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"
>2.4. Where can I find my user preferences?</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/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"
TARGET="_top"
> Landfill</A
>.
</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="accountsettings"
>2.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 <SPAN
CLASS="QUOTE"
>"Old
Password"</SPAN
> field. If you wish to change your
password, type the new password you want into the <SPAN
CLASS="QUOTE"
>"New
Password"</SPAN
> field and again into the <SPAN
CLASS="QUOTE"
>"Re-enter
new password"</SPAN
> field to ensure you typed your new
password correctly. Select the <SPAN
CLASS="QUOTE"
>"Submit"</SPAN
> button
and you are done.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="emailsettings"
>2.4.2. Email Settings</A
></H2
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="notification"
>2.4.2.1. Email Notification</A
></H3
><P
> Here you can reduce or increase the amount of email sent you
from Bugzilla. Although this is referred to as
<SPAN
CLASS="QUOTE"
>"Advanced Email Filtering Options"</SPAN
>, they are,
in fact, the standard email filter set. All of them are
self-explanatory, but you can use the filters in interesting
ways. For instance, some people (notably Quality Assurance
personnel) often only care to receive updates regarding a
bug when the bug changes state, so they can track bugs on
their flow charts and know when it is time to pull the bug
onto a quality assurance platform for inspection. Other
people set up email gateways to
<A
HREF="#bonsai"
>Bonsai, the Mozilla automated CVS management system</A
> or <A
HREF="#tinderbox"
>Tinderbox, the Mozilla automated build management system</A
>, and
restrict which types of Bugzilla information are fed to
these systems..
</P
></DIV
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="newemailtech"
>2.4.2.2. New Email Technology</A
></H3
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
>2.4.2.3. "Watching" Users</A
></H3
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
>2.4.3. Page Footer</A
></H2
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="permissionsettings"
>2.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"
>2.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="installation"
>Chapter 3. Installation</A
></H1
><P
> These installation instructions are presented assuming you are
installing on a UNIX or completely POSIX-compliant system. If
you are installing on Microsoft Windows or another oddball
operating system, please consult the appropriate sections in
this installation guide for notes on how to be successful.
</P
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="errata"
>3.1. ERRATA</A
></H1
><P
>Here are some miscellaneous notes about possible issues you
main run into when you begin your Bugzilla installation.
Reference platforms for Bugzilla installation are Redhat Linux
7.2, Linux-Mandrake 8.0, and Solaris 8.</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> If you are installing Bugzilla on S.u.S.e. Linux, or some
other distributions with <SPAN
CLASS="QUOTE"
>"paranoid"</SPAN
> 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
<TT
CLASS="filename"
>/var/spool/mqueue</TT
> directory has a mode of
<SPAN
CLASS="QUOTE"
>"drwx------"</SPAN
>. Type <B
CLASS="command"
>chmod 755
<TT
CLASS="filename"
>/var/spool/mqueue</TT
></B
> as root to
fix this problem.
</TD
></TR
><TR
><TD
> Bugzilla may be installed on Macintosh OS X (10), which is a
unix-based (BSD) operating system. Everything required for
Bugzilla on OS X will install cleanly, but the optional GD
perl module which is used for bug charting requires some
additional setup for installation. Please see the Mac OS X
installation section below for details
</TD
></TR
><TR
><TD
> Release Notes for Bugzilla 2.14 are available at
<TT
CLASS="filename"
>docs/rel_notes.txt</TT
> in your Bugzilla
source distribution.
</TD
></TR
><TR
><TD
> 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.
</TD
></TR
></TBODY
></TABLE
><P
></P
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><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"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><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><H1
CLASS="section"
><A
NAME="stepbystep"
>3.2. Step-by-step Install</A
></H1
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN509"
>3.2.1. Introduction</A
></H2
><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 (Microsoft
Windows) are not included in this section of the Guide; please
check out the <A
HREF="#win32"
>Win32 Installation Notes</A
> for further advice
on getting Bugzilla to work on Microsoft Windows.
</P
><P
> The Bugzilla Guide is contained in the "docs/" folder in your
Bugzilla distribution. It is available in plain text
(docs/txt), HTML (docs/html), or SGML source (docs/sgml).
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN515"
>3.2.2. Installing the Prerequisites</A
></H2
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>If you want to skip these manual installation steps for
the CPAN dependencies listed below, and are running the very
most recent version of Perl and MySQL (both the executables
and development libraries) on your system, check out
Bundle::Bugzilla in <A
HREF="#bundlebugzilla"
>Using Bundle::Bugzilla instead of manually installing Perl modules</A
></P
></TD
></TR
></TABLE
></DIV
><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, 5.6.1 is recommended if you wish
to use Bundle::Bugzilla)
</P
></LI
><LI
><P
> DBI Perl module
</P
></LI
><LI
><P
> Data::Dumper Perl module
</P
></LI
><LI
><P
> Bundle::Mysql Perl module collection
</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="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><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
>
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Linux-Mandrake 8.0, the author's test system, includes
every required and optional library for Bugzilla. The
easiest way to install them is by using the
<TT
CLASS="filename"
>urpmi</TT
> utility. If you follow these
commands, you should have everything you need for
Bugzilla, and <TT
CLASS="filename"
>checksetup.pl</TT
> should
not complain about any missing libraries. You may already
have some of these installed.</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
> urpmi
perl-mysql</B
></TD
></TR
><TR
><TD
><TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
> urpmi
perl-chart</B
></TD
></TR
><TR
><TD
><TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
> urpmi
perl-gd</B
></TD
></TR
><TR
><TD
><TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
> urpmi
perl-MailTools</B
> (for Bugzilla email
integration)</TD
></TR
><TR
><TD
><TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
> urpmi
apache-modules</B
></TD
></TR
></TBODY
></TABLE
><P
></P
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="install-mysql"
>3.2.3. Installing MySQL Database</A
></H2
><P
> Visit MySQL homepage at <A
HREF="http://www.mysql.com"
TARGET="_top"
>www.mysql.com</A
> and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in <TT
CLASS="filename"
>/var</TT
> which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to <TT
CLASS="filename"
>configure</TT
>.
</P
><P
> If you install from source or non-package (RPM, deb, etc.)
binaries you need to add
<I
CLASS="firstterm"
>mysqld</I
> to your
init scripts so the server daemon will come back up whenever
your machine reboots. Further discussion of UNIX init
sequences are beyond the scope of this guide.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>You should have your init script start
<I
CLASS="glossterm"
>mysqld</I
> with the ability to accept
large packets. By default, <TT
CLASS="filename"
>mysqld</TT
>
only accepts packets up to 64K long. This limits the size
of attachments you may put on bugs. If you add <TT
CLASS="option"
>-O
max_allowed_packet=1M</TT
> to the command that starts
<TT
CLASS="filename"
>mysqld</TT
> (or
<TT
CLASS="filename"
>safe_mysqld</TT
>), then you will be able
to have attachments up to about 1 megabyte.</P
></TD
></TR
></TABLE
></DIV
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you plan on running Bugzilla and MySQL on the same
machine, consider using the <TT
CLASS="option"
>--skip-networking</TT
>
option in the init script. This enhances security by
preventing network access to MySQL.
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="install-perl"
>3.2.4. Perl (5.004 or greater)</A
></H2
><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. Although Bugzilla runs with most
post-5.004 versions of Perl, it's a good idea to be up to the
very latest version if you can when running Bugzilla. As of
this writing, that is perl version 5.6.1.
</P
><P
> Perl is now a far cry from the the single compiler/interpreter
binary it once was. It includes a great many required modules
and quite a few other support files. If you're not up to or
not inclined to build perl from source, you'll want to install
it on your machine using some sort of packaging system (be it
RPM, deb, or what have you) to ensure a sane install. In the
subsequent sections you'll be installing quite a few perl
modules; this can be quite ornery if your perl installation
isn't up to snuff.
</P
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Many people complain that Perl modules will not install
for them. Most times, the error messages complain that they
are missing a file in <SPAN
CLASS="QUOTE"
>"@INC"</SPAN
>. Virtually every
time, this is due to permissions being set too restrictively
for you to compile Perl modules or not having the necessary
Perl development libraries installed on your system..
Consult your local UNIX systems administrator for help
solving these permissions issues; if you
<EM
>are</EM
> the local UNIX sysadmin, please
consult the newsgroup/mailing list for further assistance or
hire someone to help you out.
</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="tip"
><A
NAME="bundlebugzilla"
></A
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> You can skip the following Perl module installation steps by
installing <SPAN
CLASS="productname"
>Bundle::Bugzilla</SPAN
> from
<A
HREF="#gloss-cpan"
><I
CLASS="glossterm"
>CPAN</I
></A
>, which
includes them. All Perl module installation steps require
you have an active Internet connection. If you wish to use
Bundle::Bugzilla, however, you must be using the latest
version of Perl (at this writing, version 5.6.1)
</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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN602"
>3.2.5. DBI Perl Module</A
></H2
><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 can be found in <A
HREF="#downloadlinks"
>Appendix B</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="AEN609"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Replace "DBI" with the name of whichever module you wish
to install, such as Data::Dumper, TimeDate, GD, etc.</P
></TD
></TR
></TABLE
></DIV
>
</P
><P
></P
></DIV
>
To do it the hard way:
<DIV
CLASS="informalexample"
><A
NAME="AEN616"
></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><H2
CLASS="section"
><A
NAME="AEN640"
>3.2.6. Data::Dumper Perl Module</A
></H2
><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 (see <A
HREF="#downloadlinks"
>Appendix B</A
>) and
can be
installed by following the same four step make sequence used
for the DBI module.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN645"
>3.2.7. MySQL related Perl Module Collection</A
></H2
><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,
select the MySQL related ones. Later you will be asked if you wish
to provide backwards compatibility with the older MySQL packages; you
should answer YES to this question. The default is NO.
</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><H2
CLASS="section"
><A
NAME="AEN654"
>3.2.8. TimeDate Perl Module Collection</A
></H2
><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 (see link: <A
HREF="#downloadlinks"
>Appendix B</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><H2
CLASS="section"
><A
NAME="AEN658"
>3.2.9. GD Perl Module (1.8.3)</A
></H2
><P
> The GD library was written by Thomas Boutell a long while
ago to programatically generate images in C. Since then it's
become the defacto standard for programatic image
construction. The Perl bindings to it found in the GD library
are used on millions of web pages to generate graphs on the
fly. That's what bugzilla will be using it for so you must
install it if you want any of the graphing to work.
</P
><P
> Actually bugzilla uses the Graph module which relies on GD
itself. Isn't that always the way with object-oriented
programming? At any rate, you can find the GD library on CPAN
in <A
HREF="#downloadlinks"
>Appendix B</A
>.
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> The Perl GD library requires some other libraries that may
or may not be installed on your system, including
<TT
CLASS="classname"
>libpng</TT
> and
<TT
CLASS="classname"
>libgd</TT
>. 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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN667"
>3.2.10. Chart::Base Perl Module (0.99c)</A
></H2
><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, linked in <A
HREF="#downloadlinks"
>Appendix B</A
>. Note that
as with the GD perl module, only the version listed above, or
newer, will work. Earlier versions used GIF's, which are no
longer supported by the latest versions of GD.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN671"
>3.2.11. DB_File Perl Module</A
></H2
><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><H2
CLASS="section"
><A
NAME="AEN674"
>3.2.12. HTTP Server</A
></H2
><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 <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> user permissions accordingly.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>I strongly recommend Apache as the web server to use.
The Bugzilla Guide installation instructions, in general,
assume you are using Apache. As more users use different
webservers and send me information on the peculiarities of
installing using their favorite webserver, I will provide
notes for them.</P
></TD
></TR
></TABLE
></DIV
>
</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:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> AddHandler cgi-script .cgi
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> With apache you'll also want to make sure that within the
access.conf file the line:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> Options ExecCGI
</PRE
></FONT
></TD
></TR
></TABLE
>
is in the stanza that covers the directories into which
you intend to put the bugzilla .html and .cgi files.
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Users of newer versions of Apache will generally find both
of the above lines will be in the httpd.conf file, rather
than srm.conf or access.conf.
</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> There are important files and directories that should not
be a served by the HTTP server. These are most files in the
<SPAN
CLASS="QUOTE"
>"data"</SPAN
> and <SPAN
CLASS="QUOTE"
>"shadow"</SPAN
> directories
and the <SPAN
CLASS="QUOTE"
>"localconfig"</SPAN
> 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 <A
HREF="#htaccess"
>.htaccess files and security</A
> for details
on how to do this for Apache. I appreciate notes on how to
get this same functionality using other webservers.
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN692"
>3.2.13. Installing the Bugzilla Files</A
></H2
><P
> You should untar the Bugzilla files into a directory that
you're willing to make writable by the default web server user
(probably <SPAN
CLASS="QUOTE"
>"nobody"</SPAN
>). You may decide to put the
files off of the main web space for your web server or perhaps
off of <TT
CLASS="filename"
>/usr/local</TT
> with a symbolic link in
the web space that points to the Bugzilla directory. At any
rate, just dump all the files in the same place, and make sure
you can access the files in that directory through your web
server.
</P
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you symlink the bugzilla directory into your Apache's
HTML heirarchy, you may receive
<SPAN
CLASS="errorname"
>Forbidden</SPAN
> errors unless you add the
<SPAN
CLASS="QUOTE"
>"FollowSymLinks"</SPAN
> directive to the
<Directory> entry for the HTML root.
</P
></TD
></TR
></TABLE
></DIV
><P
> Once all the files are in a web accessible directory, make
that directory writable by your webserver's user. This is a
temporary step until you run the post-install
<TT
CLASS="filename"
>checksetup.pl</TT
> script, which locks down your
installation.
</P
><P
> Lastly, you'll need to set up a symbolic link to
<TT
CLASS="filename"
>/usr/bonsaitools/bin/perl</TT
> for the correct
location of your perl executable (probably
<TT
CLASS="filename"
>/usr/bin/perl</TT
>). Otherwise you must hack
all the .cgi files to change where they look for perl, or use
<A
HREF="#setperl"
>The setperl.csh Utility</A
>, found in
<A
HREF="#patches"
>Useful Patches and Utilities for Bugzilla</A
>. I suggest using the symlink
approach for future release compatability.
<DIV
CLASS="example"
><A
NAME="AEN708"
></A
><P
><B
>Example 3-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. For some UNIX
operating systems, you probably need to subsitute
<SPAN
CLASS="QUOTE"
>"/usr/local/bin/perl"</SPAN
> for
<SPAN
CLASS="QUOTE"
>"/usr/bin/perl"</SPAN
> below; if on certain other
UNIX systems, Perl may live in weird places like
<SPAN
CLASS="QUOTE"
>"/opt/perl"</SPAN
>. As root, run these commands:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> bash# mkdir /usr/bonsaitools
bash# mkdir /usr/bonsaitools/bin
bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> Alternately, you can simply run this perl one-liner to
change your path to perl in all the files in your Bugzilla
installation:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> perl -pi -e 's@#!/usr/bonsaitools/bin/perl@#!/usr/bin/perl@' *cgi *pl Bug.pm
</PRE
></FONT
></TD
></TR
></TABLE
>
Change the second path to perl to match your installation.
</P
></DIV
>
<DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you don't have root access to set this symlink up,
check out the
<A
HREF="#setperl"
>The setperl.csh Utility</A
>, listed in <A
HREF="#patches"
>Useful Patches and Utilities for Bugzilla</A
>. It will change the path to perl in all your Bugzilla files for you.
</P
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN721"
>3.2.14. Setting Up the MySQL Database</A
></H2
><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 <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
>, and will
have minimal permissions.
<DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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 <B
CLASS="command"
>DROP
DATABASE mysql</B
>.
</P
><P
>That would be bad.</P
></TD
></TR
></TABLE
></DIV
>
</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
<B
CLASS="command"
>mysql -u root -p</B
> 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 <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> user, and grant
sufficient permissions for checksetup.pl, which we'll use
later, to work its magic. This also restricts the
<SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> user to operations within a database
called <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
>, and only allows the account to
connect from <SPAN
CLASS="QUOTE"
>"localhost"</SPAN
>. 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
<TT
CLASS="filename"
>data</TT
> 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 <TT
CLASS="filename"
>localconfig</TT
>.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN768"
>3.2.15. Tweaking <TT
CLASS="filename"
>localconfig</TT
></A
></H2
><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 <SPAN
CLASS="QUOTE"
>"localhost"</SPAN
> if the
MySQL server is local
</P
></LI
><LI
><P
> database name: <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> if you're following
these directions
</P
></LI
><LI
><P
> MySQL username: <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> if you're following
these directions
</P
></LI
><LI
><P
> Password for the <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> MySQL account above
</P
></LI
></OL
>
</P
><P
> You should also install .htaccess files that the Apache
webserver will use to restrict access to Bugzilla data files.
See <A
HREF="#htaccess"
>.htaccess files and security</A
>.
</P
><P
> Once you are happy with the settings, re-run
<TT
CLASS="filename"
>checksetup.pl</TT
>. 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 <SPAN
CLASS="QUOTE"
>"edit parameters"</SPAN
> option
that is filled with editable treats.
</P
><P
> Should everything work, you will have a nearly empty Bugzilla
database and a newly-created <TT
CLASS="filename"
>localconfig</TT
>
file in your Bugzilla root directory.
</P
><P
> <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> The second time you run checksetup.pl, you should become
the user your web server runs as, and that you ensure that
you set the <SPAN
CLASS="QUOTE"
>"webservergroup"</SPAN
> 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 <SPAN
CLASS="QUOTE"
>"webserveruser"</SPAN
> parameter in
localconfig as well.
<DIV
CLASS="example"
><A
NAME="AEN799"
></A
><P
><B
>Example 3-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
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
bash# chown -R apache:apache /usr/local/bugzilla
bash# su - apache
bash# cd /usr/local/bugzilla
bash# ./checksetup.pl
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></DIV
>
</P
></TD
></TR
></TABLE
></DIV
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN806"
>3.2.16. Setting Up Maintainers Manually (Optional)</A
></H2
><P
> If you want to add someone else to every group by hand, you
can do it by typing the appropriate MySQL commands. Run
<B
CLASS="command"
> mysql -u root -p bugs</B
> You
may need different parameters, depending on your security
settings. 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
> (yes, that's <EM
>fifteen</EM
><SPAN
CLASS="QUOTE"
>"f"</SPAN
>'s.
</TD
></TR
></TBODY
></TABLE
><P
></P
> replacing XXX with the Bugzilla email address.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN817"
>3.2.17. The Whining Cron (Optional)</A
></H2
><P
> By now you have a fully functional bugzilla, but what good
are bugs if they're not annoying? To help make those bugs
more annoying you can set up bugzilla's automatic whining
system. This can be done by adding the following command as a
daily crontab entry (for help on that see that crontab man
page):
<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
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Depending on your system, crontab may have several manpages.
The following command should lead you to the most useful
page for this purpose:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> man 5 crontab
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN827"
>3.2.18. Bug Graphs (Optional)</A
></H2
><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><H2
CLASS="section"
><A
NAME="AEN839"
>3.2.19. Securing MySQL</A
></H2
><P
> If you followed the installation instructions for setting up
your "bugs" and "root" user in MySQL, much of this should not
apply to you. If you are upgrading an existing installation
of Bugzilla, you should pay close attention to this section.
</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
> Use .htaccess files with the Apache webserver to secure your
bugzilla install. See <A
HREF="#htaccess"
>.htaccess files and security</A
>
</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
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="osx"
>3.3. Mac OS X Installation Notes</A
></H1
><P
> There are a lot of common libraries and utilities out there
that Apple did not include with Mac OS X, but which run
perfectly well on it. The GD library, which Bugzilla needs to
do bug graphs, is one of these.
</P
><P
> The easiest way to get a lot of these is with a program called
Fink, which is similar in nature to the CPAN installer, but
installs common GNU utilities. Fink is available from
<http://sourceforge.net/projects/fink/>.
</P
><P
> Follow the instructions for setting up Fink. Once it's
installed, you'll want to run the following as root:
<B
CLASS="command"
>fink install gd</B
>
</P
><P
> It will prompt you for a number of dependencies, type 'y' and
hit enter to install all of the dependencies. Then watch it
work.
</P
><P
> To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at
/sw where it installs most of the software that it installs.
This means your libraries and headers for libgd will be at
/sw/lib and /sw/include instead of /usr/lib and
/usr/local/include. Because of these changed locations for
the libraries, the Perl GD module will not install directly
via CPAN (it looks for the specific paths instead of getting
them from your environment). But there's a way around that
:-)
</P
><P
> Instead of typing <SPAN
CLASS="QUOTE"
>"install GD"</SPAN
> at the
<TT
CLASS="prompt"
>cpan></TT
> prompt, type <B
CLASS="command"
>look
GD</B
>. This should go through the motions of
downloading the latest version of the GD module, then it will
open a shell and drop you into the build directory. Apply the
following patch to the Makefile.PL file (save the patch into a
file and use the command <B
CLASS="command"
>patch <
patchfile</B
>:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000
+++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001
@@ -3,8 +3,8 @@
warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
# =====> PATHS: CHECK AND ADJUST <=====
-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
my @LIBS = qw(-lgd -lpng -lz);
# FEATURE FLAGS
@@ -23,7 +23,7 @@
push @LIBS,'-lttf' if $TTF;
push @LIBS,'-ljpeg' if $JPEG;
-push @LIBS, '-lm' unless $^O eq 'MSWin32';
+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
# FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> Then, run these commands to finish the installation of the perl module:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><B
CLASS="command"
>perl Makefile.PL</B
></TD
></TR
><TR
><TD
><B
CLASS="command"
>make</B
></TD
></TR
><TR
><TD
><B
CLASS="command"
>make test</B
></TD
></TR
><TR
><TD
><B
CLASS="command"
>make install</B
></TD
></TR
><TR
><TD
>And don't forget to run <B
CLASS="command"
>exit</B
> to get back to cpan.</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
><P
> Happy Hacking!
</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="bsdinstall"
>3.4. BSD Installation Notes</A
></H1
><P
> For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
consult <A
HREF="#osx"
>Section 3.3</A
>.
</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="geninstall"
>3.5. Installation General Notes</A
></H1
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN941"
>3.5.1. Modifying Your Running System</A
></H2
><P
> Bugzilla optimizes database lookups by storing all relatively static
information in the versioncache file, located in the data/ subdirectory
under your installation directory.
</P
><P
> If you make a change to the structural data in your database
(the versions table for example), or to the
<SPAN
CLASS="QUOTE"
>"constants"</SPAN
> encoded in defparams.pl, you will
need to remove the cached content from the data directory
(by doing a <SPAN
CLASS="QUOTE"
>"rm data/versioncache"</SPAN
>), 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><H2
CLASS="section"
><A
NAME="AEN948"
>3.5.2. Upgrading From Previous Versions</A
></H2
><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
><P
> If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
the latest version, please consult the file, "UPGRADING-pre-2.8" in the
Bugzilla root directory after untarring the archive.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="htaccess"
>3.5.3. <TT
CLASS="filename"
>.htaccess</TT
> files and security</A
></H2
><P
> To enhance the security of your Bugzilla installation,
Bugzilla will generate
<I
CLASS="glossterm"
><TT
CLASS="filename"
>.htaccess</TT
></I
> files
which the Apache webserver can use to restrict access to
the bugzilla data files. The checksetup script will
generate the <TT
CLASS="filename"
>.htaccess</TT
> files.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you are using an alternate provider of
<SPAN
CLASS="productname"
>webdot</SPAN
> services for graphing
(as described when viewing
<TT
CLASS="filename"
>editparams.cgi</TT
> in your web
browser), you will need to change the ip address in
<TT
CLASS="filename"
>data/webdot/.htaccess</TT
> to the ip
address of the webdot server that you are using.
</P
></TD
></TR
></TABLE
></DIV
>
</P
><P
> The default .htaccess file may not provide adequate access
restrictions, depending on your web server configuration.
Be sure to check the <Directory> entries for your
Bugzilla directory so that the <TT
CLASS="filename"
>.htaccess</TT
>
file is allowed to override web server defaults. For instance,
let's assume your installation of Bugzilla is installed to
<TT
CLASS="filename"
>/usr/local/bugzilla</TT
>. You should have
this <Directory> entry in your <TT
CLASS="filename"
>httpd.conf</TT
>
file:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
<Directory /usr/local/bugzilla/>
Options +FollowSymLinks +Indexes +Includes +ExecCGI
AllowOverride All
</Directory>
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> The important part above is <SPAN
CLASS="QUOTE"
>"AllowOverride All"</SPAN
>.
Without that, the <TT
CLASS="filename"
>.htaccess</TT
> file created by
<TT
CLASS="filename"
>checksetup.pl</TT
> will not have sufficient
permissions to protect your Bugzilla installation.
</P
><P
> If you are using Internet Information Server or other web
server which does not observe <TT
CLASS="filename"
>.htaccess</TT
>
conventions, you can disable their creation by editing
<TT
CLASS="filename"
>localconfig</TT
> and setting the
<TT
CLASS="varname"
>$create_htaccess</TT
> variable to
<TT
CLASS="parameter"
><I
>0</I
></TT
>.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="mod-throttle"
>3.5.4. <TT
CLASS="filename"
>mod_throttle</TT
> and Security</A
></H2
><P
> It is possible for a user, by mistake or on purpose, to access
the database many times in a row which can result in very slow
access speeds for other users. If your Bugzilla installation
is experiencing this problem , you may install the Apache
module <TT
CLASS="filename"
>mod_throttle</TT
> which can limit
connections by ip-address. You may download this module at
<A
HREF="http://www.snert.com/Software/Throttle/"
TARGET="_top"
>http://www.snert.com/Software/Throttle/</A
>. Follow the instructions to install into your Apache install. <EM
>This module only functions with the Apache web server!</EM
>. You may use the <B
CLASS="command"
>ThrottleClientIP</B
> command provided by this module to accomplish this goal. See the <A
HREF="http://www.snert.com/Software/Throttle/"
TARGET="_top"
>Module Instructions</A
> for more information. </P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="content-type"
>3.5.5. Preventing untrusted Bugzilla content from executing malicious Javascript code</A
></H2
><P
>It is possible for a Bugzilla to execute malicious
Javascript code. Due to internationalization concerns, we are
unable to incorporate the code changes necessary to fulfill
the CERT advisory requirements mentioned in <A
HREF="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3"
TARGET="_top"
>http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</A
>. Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience. As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it. </P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
mv $i.tmp $i; done
</PRE
></FONT
></TD
></TR
></TABLE
></P
><P
> All this one-liner command does is search for all instances of
<SPAN
CLASS="QUOTE"
>"Content-type: text/html"</SPAN
> and replaces it with
<SPAN
CLASS="QUOTE"
>"Content-Type: text/html; charset=ISO-8859-1"</SPAN
>.
This specification prevents possible Javascript attacks on the
browser, and is suggested for all English-speaking sites. For
non-english-speaking Bugzilla sites, I suggest changing
<SPAN
CLASS="QUOTE"
>"ISO-8859-1"</SPAN
>, above, to <SPAN
CLASS="QUOTE"
>"UTF-8"</SPAN
>.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="unixhistory"
>3.5.6. UNIX Installation Instructions History</A
></H2
><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 <A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
TARGET="_top"
>http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</A
> ).
</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 by Matt Barnson.
Since that time, it's undergone extensive modification as
Bugzilla grew.
</P
><P
> Comments from people using this Guide for the first time are
particularly welcome.
</P
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="win32"
>3.6. Win32 Installation Notes</A
></H1
><P
>This section covers installation on Microsoft Windows 95,
98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms,
but please remember that the Bugzilla team and the author of the
Guide neither endorse nor support installation on Microsoft
Windows. Bugzilla installs and runs <EM
>best</EM
>
and <EM
>easiest</EM
> on UNIX-like operating systems,
and that is the way it will stay for the foreseeable future. The
Bugzilla team is considering supporting Win32 for the 2.16
release and later.</P
><P
>The easiest way to install Bugzilla on Intel-archiecture
machines is to install some variant of GNU/Linux, then follow
the UNIX installation instructions in this Guide. If you have
any influence in the platform choice for running this system,
please choose GNU/Linux instead of Microsoft Windows.</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="wininstall"
>3.6.1. Win32 Installation: Step-by-step</A
></H2
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> You should be familiar with, and cross-reference, the rest
of the
<A
HREF="#installation"
>Bugzilla Installation</A
> section while performing your
Win32 installation.
</P
><P
> Making Bugzilla work on Microsoft Windows is no
picnic. Support for Win32 has improved dramatically in the
last few releases, but, if you choose to proceed, you should
be a <EM
>very</EM
> skilled Windows Systems
Administrator with strong troubleshooting abilities, a high
tolerance for pain, and moderate perl skills. Bugzilla on NT
requires hacking source code and implementing some advanced
utilities. What follows is the recommended installation
procedure for Win32; additional suggestions are provided in
<A
HREF="#faq"
>Appendix A</A
>.
</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="procedure"
><OL
TYPE="1"
><LI
><P
> Install <A
HREF="http://www.apache.org/"
TARGET="_top"
>Apache Web
Server</A
> for Windows, and copy the Bugzilla files
somewhere Apache can serve them. Please follow all the
instructions referenced in <A
HREF="#installation"
>Bugzilla Installation</A
>
regarding your Apache configuration, particularly
instructions regarding the <SPAN
CLASS="QUOTE"
>"AddHandler"</SPAN
>
parameter and <SPAN
CLASS="QUOTE"
>"ExecCGI"</SPAN
>.
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> You may also use Internet Information Server or Personal
Web Server for this purpose. However, setup is quite
different. If ActivePerl doesn't seem to handle your
file associations correctly (for .cgi and .pl files),
please consult <A
HREF="#faq"
>Appendix A</A
>.
</P
><P
> If you are going to use IIS, if on Windows NT you must
be updated to at least Service Pack 4. Windows 2000
ships with a sufficient version of IIS.
</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><P
> Install <A
HREF="http://www.activestate.com/"
TARGET="_top"
>ActivePerl</A
> for Windows. Check <A
HREF="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/"
TARGET="_top"
>http://aspn.activestate.com/ASPN/Downloads/ActivePerl</A
> for a current compiled binary.
</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"
> Perl on Win32 FAQ</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
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> You can find a list of modules at
<A
HREF="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"
TARGET="_top"
> http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</A
>
</P
></TD
></TR
></TABLE
></DIV
><P
> The syntax for ppm is:
<TT
CLASS="computeroutput"
> <TT
CLASS="prompt"
>C:> </TT
><B
CLASS="command"
>ppm <modulename></B
>
</TT
>
</P
><DIV
CLASS="example"
><A
NAME="AEN1048"
></A
><P
><B
>Example 3-3. Installing ActivePerl ppd Modules on Microsoft Windows</B
></P
><P
><TT
CLASS="prompt"
>C:></TT
><B
CLASS="command"
>ppm
<TT
CLASS="option"
>DBD-Mysql</TT
></B
></P
><P
>Watch your capitalization!</P
></DIV
><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
> Install MySQL for NT.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> You can download MySQL for Windows NT from <A
HREF="http://www.mysql.com/"
TARGET="_top"
>MySQL.com</A
>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
</P
></TD
></TR
></TABLE
></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
><P
><SPAN
CLASS="QUOTE"
>"new_password"</SPAN
>, above, indicates
whatever password you wish to use for your
<SPAN
CLASS="QUOTE"
>"root"</SPAN
> user.</P
></LI
><LI
><A
NAME="ntbugs-password"
></A
><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
><P
><SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
>, above, indicates
whatever password you wish to use for your
<SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> user.</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
> Edit <TT
CLASS="filename"
>checksetup.pl</TT
> in your Bugzilla directory. Change
this line:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> my $webservergid = getgrnam($my_webservergroup);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> to
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> my $webservergid = $my_webservergroup;
</PRE
></FONT
></TD
></TR
></TABLE
>
or the name of the group you wish to own the files explicitly:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> my $webservergid = 'Administrators'
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></LI
><LI
><P
> Run <TT
CLASS="filename"
>checksetup.pl</TT
> from the Bugzilla directory.
</P
></LI
><LI
><P
>Edit <TT
CLASS="filename"
>localconfig</TT
> to suit your
requirements. Set <TT
CLASS="varname"
>$db_pass</TT
> to your
<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
> from <A
HREF="#ntbugs-password"
>step 5.d</A
>, and <TT
CLASS="varname"
>$webservergroup</TT
> to <SPAN
CLASS="QUOTE"
>"8"</SPAN
>.</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Not sure on the <SPAN
CLASS="QUOTE"
>"8"</SPAN
> for
<TT
CLASS="varname"
>$webservergroup</TT
> above. If it's
wrong, please send corrections.</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><P
> Edit <TT
CLASS="filename"
>defparams.pl</TT
> to suit your
requirements. Particularly, set
<TT
CLASS="varname"
>DefParam("maintainer")</TT
> and
<TT
CLASS="varname"
>DefParam("urlbase") to match your
install.</TT
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>This is yet another step I'm not sure of, since the
maintainer of this documentation does not maintain
Bugzilla on NT. If you can confirm or deny that this
step is required, please let me know.</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="procedure"
><OL
TYPE="1"
><LI
><P
> Download NTsendmail, available from<A
HREF="http://www.ntsendmail.com/"
TARGET="_top"
> www.ntsendmail.com</A
>. 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
></LI
><LI
><P
>Put ntsendmail.pm into your .\perl\lib directory.</P
></LI
><LI
><P
>Add to globals.pl:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> # these settings configure the NTsendmail process
use NTsendmail;
$ENV{"NTsendmail"}="your.smtpserver.box";
$ENV{"NTsendmail_debug"}=1;
$ENV{"NTsendmail_max_tries"}=5;
</PRE
></FONT
></TD
></TR
></TABLE
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Some mention to also edit
<TT
CLASS="varname"
>$db_pass</TT
> in
<TT
CLASS="filename"
>globals.pl</TT
> to be your
<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
>. Although this may get
you around some problem authenticating to your
database, since globals.pl is not normally
restricted by <TT
CLASS="filename"
>.htaccess</TT
>, your
database password is exposed to whoever uses your
web server.
</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><P
> Find and comment out all occurences of
<SPAN
CLASS="QUOTE"
>"<B
CLASS="command"
>open(SENDMAIL</B
>"</SPAN
> in
your Bugzilla directory. Then replace them with:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> # new sendmail functionality
my $mail=new NTsendmail;
my $from="bugzilla\@your.machine.name.tld";
my $to=$login;
my $subject=$urlbase;
$mail->send($from,$to,$subject,$msg);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Some have found success using the commercial product,
<SPAN
CLASS="productname"
>Windmail</SPAN
>.
You could try replacing your sendmail calls with:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
</PRE
></FONT
></TD
></TR
></TABLE
>
or something to that effect.
</P
></TD
></TR
></TABLE
></DIV
></LI
></OL
></DIV
></LI
><LI
><P
> Change all references in all files from
<TT
CLASS="filename"
>processmail</TT
> to
<TT
CLASS="filename"
>processmail.pl</TT
>, and
rename <TT
CLASS="filename"
>processmail</TT
> to
<TT
CLASS="filename"
>processmail.pl</TT
>.
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Many think this may be a change we want to make for
main-tree Bugzilla. It's painless for the UNIX folks,
and will make the Win32 people happier.
</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server
$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
$smtp->to($tolist); # recipient's address
$smtp->data(); # Start the mail
$smtp->datasend($msg);
$smtp->dataend(); # Finish sending the mail
$smtp->quit; # Close the SMTP connection
$logstr = "$logstr; mail sent to $tolist $cclist";
}
</PRE
></FONT
></TD
></TR
></TABLE
>
here is a test mail program for Net::SMTP:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
use Net::SMTP;
my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
=> 1, ); # connect to SMTP server
$smtp->auth;
$smtp->mail('you@yourcompany.com');# use the sender's adress
here
$smtp->to('someotherAddress@someotherdomain.com'); #
recipient's address
$smtp->data(); # Start the mail
$smtp->datasend('test');
$smtp->dataend(); # Finish sending the mail
$smtp->quit; # Close the SMTP connection
exit;
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></TD
></TR
></TABLE
></DIV
></LI
><LI
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> This step is optional if you are using IIS or another
web server which only decides on an interpreter based
upon the file extension (.pl), rather than the
<SPAN
CLASS="QUOTE"
>"shebang"</SPAN
> line (#/usr/bonsaitools/bin/perl)
</P
></TD
></TR
></TABLE
></DIV
><P
> Modify the path to perl on the first line (#!) of all
files to point to your Perl installation, and add
<SPAN
CLASS="QUOTE"
>"perl"</SPAN
> 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 <SPAN
CLASS="QUOTE"
>"setperl.csh"</SPAN
>
utility to speed part of this procedure, available in the
<A
HREF="#patches"
>Useful Patches and Utilities for Bugzilla</A
> section of The Bugzilla Guide.
However, it requires the Cygwin GNU-compatible environment
for Win32 be set up in order to work. See <A
HREF="http://www.cygwin.com/"
TARGET="_top"
>http://www.cygwin.com/</A
> for details on obtaining Cygwin.
</P
></LI
><LI
><P
> Modify the invocation of all system() calls in all perl
scripts in your Bugzilla directory. You should specify the
full path to perl for each system() call. For instance, change
this line in processmail:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
system ("./processmail",@ARGLIST);
</programlisting> to
<programlisting>
system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></LI
><LI
><P
> Add <TT
CLASS="function"
>binmode()</TT
> calls so attachments
will work (<A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000"
TARGET="_top"
>bug 62000</A
>).
</P
><P
> Because Microsoft Windows based systems handle binary
files different than Unix based systems, you need to add
the following lines to
<TT
CLASS="filename"
>createattachment.cgi</TT
> and
<TT
CLASS="filename"
>showattachment.cgi</TT
> before the
<TT
CLASS="function"
>require 'CGI.pl';</TT
> line.
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
binmode(STDIN);
binmode(STDOUT);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> According to <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000"
TARGET="_top"
>bug 62000</A
>, the perl documentation says that you should always use <TT
CLASS="function"
>binmode()</TT
> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than arbitrarily putting <TT
CLASS="function"
>binmode()</TT
> at the beginning of the attachment files, there should be logic to determine if <TT
CLASS="function"
>binmode()</TT
> is needed or not.
</P
></TD
></TR
></TABLE
></DIV
></LI
></OL
></DIV
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you are using IIS or Personal Web Server, you must add cgi
relationships to Properties -> Home directory (tab) ->
Application Settings (section) -> Configuration (button),
such as:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
.cgi to: <perl install directory>\perl.exe %s %s
.pl to: <perl install directory>\perl.exe %s %s
GET,HEAD,POST
</PRE
></FONT
></TD
></TR
></TABLE
>
Change the path to Perl to match your
install, of course.
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="addlwintips"
>3.6.2. Additional Windows Tips</A
></H2
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> From Andrew Pearson:
<A
NAME="AEN1221"
></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
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
</PRE
></FONT
></TD
></TR
></TABLE
>
</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
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If attempting to run Bugzilla 2.12 or older, you will need
to remove encrypt() calls from the Perl source. This is
<EM
>not necessary</EM
> for Bugzilla 2.13 and
later, which includes the current release, Bugzilla
2.14.
<DIV
CLASS="example"
><A
NAME="AEN1233"
></A
><P
><B
>Example 3-4. Removing encrypt() for Windows NT Bugzilla version
2.12 or earlier</B
></P
><P
> Replace this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</PRE
></FONT
></TD
></TR
></TABLE
>
with this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
my $enteredcryptpwd = $enteredpwd
</PRE
></FONT
></TD
></TR
></TABLE
>
in cgi.pl.
</P
></DIV
>
</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="bzldap"
>3.6.3. Bugzilla LDAP Integration</A
></H2
><P
> What follows is some late-breaking information on using the
LDAP authentication options with Bugzilla. The author has not
tested these (nor even formatted this section!) so please
contribute feedback to the newsgroup.
</P
><P
CLASS="literallayout"
><br>
Mozilla::LDAP module<br>
<br>
The Mozilla::LDAP module allows you to use LDAP for authentication to<br>
the Bugzilla system. This module is not required if you are not using<br>
LDAP.<br>
<br>
Mozilla::LDAP (aka PerLDAP) is available for download from<br>
http://www.mozilla.org/directory.<br>
<br>
NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.<br>
Follow the link for "Directory SDK for C" on that same page to<br>
download the SDK first. After you have installed this SDK, then<br>
install the PerLDAP module.<br>
----------------------------------------------------------------------<br>
<br>
Post-Installation Checklist<br>
----------------------------------------------------------------------<br>
Set useLDAP to "On" **only** if you will be using an LDAP directory<br>
for authentication. Be very careful when setting up this parameter;<br>
if you set LDAP authentication, but do not have a valid LDAP directory<br>
set up, you will not be able to log back in to Bugzilla once you log<br>
out. (If this happens, you can get back in by manually editing the<br>
data/params file, and setting useLDAP back to 0.)<br>
<br>
If using LDAP, you must set the three additional parameters:<br>
<br>
Set LDAPserver to the name (and optionally port) of your LDAP server.<br>
If no port is specified, it defaults to the default port of 389. (e.g<br>
"ldap.mycompany.com" or "ldap.mycompany.com:1234")<br>
<br>
Set LDAPBaseDN to the base DN for searching for users in your LDAP<br>
directory. (e.g. "ou=People,o=MyCompany") uids must be unique under<br>
the DN specified here.<br>
<br>
Set LDAPmailattribute to the name of the attribute in your LDAP<br>
directory which contains the primary email address. On most directory<br>
servers available, this is "mail", but you may need to change this.<br>
----------------------------------------------------------------------<br>
<br>
(Not sure where this bit should go, but it's important that it be in<br>
there somewhere...)<br>
----------------------------------------------------------------------<br>
Using LDAP authentication for Bugzilla:<br>
<br>
The existing authentication scheme for Bugzilla uses email addresses<br>
as the primary user ID, and a password to authenticate that user. All<br>
places within Bugzilla where you need to deal with user ID (e.g<br>
assigning a bug) use the email address.<br>
<br>
The LDAP authentication builds on top of this scheme, rather than<br>
replacing it. The initial log in is done with a username and password<br>
for the LDAP directory. This then fetches the email address from LDAP<br>
and authenticates seamlessly in the standard Bugzilla authentication<br>
scheme using this email address. If an account for this address<br>
already exists in your Bugzilla system, it will log in to that<br>
account. If no account for that email address exists, one is created<br>
at the time of login. (In this case, Bugzilla will attempt to use the<br>
"displayName" or "cn" attribute to determine the user's full name.)<br>
<br>
After authentication, all other user-related tasks are still handled<br>
by email address, not LDAP username. You still assign bugs by email<br>
address, query on users by email address, etc.<br>
----------------------------------------------------------------------<br>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="chapter"
><HR><H1
><A
NAME="administration"
>Chapter 4. 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 <SPAN
CLASS="QUOTE"
>"<A
HREF="#installation"
>Bugzilla Installation</A
>"</SPAN
> to the
letter, and logged into Bugzilla for the very first time with your
super-duper god account. You sit, contentedly staring at the
Bugzilla Query Screen, the worst of the whole mad business of
installing this terrific program behind you. It seems, though, you
have nothing yet to query! Your first act of business should be to
setup the operating parameters for Bugzilla so you can get busy
getting data into your bug tracker.
</P
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="postinstall-check"
>4.1. Post-Installation Checklist</A
></H1
><P
> After installation, follow the checklist below to help 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 <TT
CLASS="filename"
>editparams.cgi</TT
> in your web
browser. This should be available as the <SPAN
CLASS="QUOTE"
>"edit
parameters"</SPAN
> link from any Bugzilla screen once you
have logged in.
</P
></LI
><LI
><P
>The <SPAN
CLASS="QUOTE"
>"maintainer"</SPAN
> is the email address of
the person responsible for maintaining this Bugzilla
installation. The maintainer need not be a valid Bugzilla
user. Error pages, error emails, and administrative mail
will be sent with the maintainer as the return email
address.</P
><P
> Set <SPAN
CLASS="QUOTE"
>"maintainer"</SPAN
> 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
>The <SPAN
CLASS="QUOTE"
>"urlbase"</SPAN
> parameter defines the fully
qualified domain name and web server path to your Bugzilla
installation.</P
><P
> For example, if your bugzilla query page is
http://www.foo.com/bugzilla/query.cgi, set your
<SPAN
CLASS="QUOTE"
>"urlbase"</SPAN
> is http://www.foo.com/bugzilla/.
</P
></LI
><LI
><P
><SPAN
CLASS="QUOTE"
>"usebuggroups"</SPAN
> dictates whether or not to
implement group-based security for Bugzilla. If set,
Bugzilla bugs can have an associated groupmask defining
which groups of users are allowed to see and edit the
bug.</P
><P
> Set "usebuggroups" to "on" <EM
>only</EM
> if you
may wish to restrict access to products. I suggest leaving
this parameter <EM
>off</EM
> while initially
testing your Bugzilla.
</P
></LI
><LI
><P
> <SPAN
CLASS="QUOTE"
>"usebuggroupsentry"</SPAN
>, when set to
<SPAN
CLASS="QUOTE"
>"on"</SPAN
>, requires that all bugs have an associated
groupmask when submitted. This parameter is made for those
installations where product isolation is a necessity.
</P
><P
> Set "usebuggroupsentry" to "on" if you absolutely need to
restrict access to bugs from the moment they are submitted
through resolution. 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
> You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only
table-level write locking. What this means is that if
someone needs to make a change to a bug, they will lock the
entire table until the operation is complete. Locking for
write also blocks reads until the write is complete. The
<SPAN
CLASS="QUOTE"
>"shadowdb"</SPAN
> parameter was designed to get around
this limitation. While only a single user is allowed to
write to a table at a time, reads can continue unimpeded on
a read-only shadow copy of the database. Although your
database size will double, a shadow database can cause an
enormous performance improvement when implemented on
extremely high-traffic Bugzilla databases.
</P
><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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Enabling "shadowdb" can adversely affect the stability
of your installation of Bugzilla. You should regularly
check that your database is in sync. It is often
advisable to force a shadow database sync nightly via
<SPAN
CLASS="QUOTE"
>"cron"</SPAN
>.
</P
></TD
></TR
></TABLE
></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. Mozilla.org began needing
<SPAN
CLASS="QUOTE"
>"shadowdb"</SPAN
> when they reached around 40,000
Bugzilla users with several hundred Bugzilla bug changes and
comments per day.
</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
><SPAN
CLASS="QUOTE"
>"headerhtml"</SPAN
>, <SPAN
CLASS="QUOTE"
>"footerhtml"</SPAN
>,
<SPAN
CLASS="QUOTE"
>"errorhtml"</SPAN
>, <SPAN
CLASS="QUOTE"
>"bannerhtml"</SPAN
>, and
<SPAN
CLASS="QUOTE"
>"blurbhtml"</SPAN
> are all templates which control
display of headers, footers, errors, banners, and additional
data. We could go into some detail regarding the usage of
these, but it is really best just to monkey around with them
a bit to see what they do. I strongly recommend you copy
your <TT
CLASS="filename"
>data/params</TT
> file somewhere safe
before playing with these values, though. If they are
changed dramatically, it may make it impossible for you to
display Bugzilla pages to fix the problem until you have
restored your <TT
CLASS="filename"
>data/params</TT
> file.</P
><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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> The "headerhtml" text box is the HTML printed out
<EM
>before</EM
> any other code on the page,
except the CONTENT-TYPE header sent by the Bugzilla
engine. 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
></TD
></TR
></TABLE
></DIV
>
</P
></LI
><LI
><P
><SPAN
CLASS="QUOTE"
>"passwordmail"</SPAN
> is rather simple. Every
time a user creates an account, the text of this parameter
is read as the text to send to the new user along with their
password message.</P
><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
><SPAN
CLASS="QUOTE"
>"useqacontact"</SPAN
> allows you to define an
email address for each component, in addition to that of the
default owner, who will be sent carbon copies of incoming
bugs. The critical difference between a QA Contact and an
Owner is that the QA Contact follows the component. If you
reassign a bug from component A to component B, the QA
Contact for that bug will change with the reassignment,
regardless of owner.</P
><P
><SPAN
CLASS="QUOTE"
>"usestatuswhiteboard"</SPAN
> defines whether you
wish to have a free-form, overwritable field associated with
each bug. The advantage of the Status Whiteboard is that it
can be deleted or modified with ease, and provides an
easily-searchable field for indexing some bugs that have
some trait in common. Many people will put <SPAN
CLASS="QUOTE"
>"help
wanted"</SPAN
>, <SPAN
CLASS="QUOTE"
>"stalled"</SPAN
>, or <SPAN
CLASS="QUOTE"
>"waiting
on reply from somebody"</SPAN
> messages into the Status
Whiteboard field so those who peruse the bugs are aware of
their status even more than that which can be indicated by
the Resolution fields.</P
><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 many 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 installation instructions, or set this
value to "0" (never whine).
</P
></LI
><LI
><P
><SPAN
CLASS="QUOTE"
>"commenton"</SPAN
> fields allow you to dictate
what changes can pass without comment, and which must have a
comment from the person who changed them. Often,
administrators will allow users to add themselves to the CC
list, accept bugs, or change the Status Whiteboard without
adding a comment as to their reasons for the change, yet
require that most other changes come with an
explanation.</P
><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 at the very least.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
>
</P
></LI
><LI
><P
>The <SPAN
CLASS="QUOTE"
>"supportwatchers"</SPAN
> option can be an
exceptionally powerful tool in the hands of a power Bugzilla
user. By enabling this option, you allow users to receive
email updates whenever other users receive email updates.
This is, of course, subject to the groupset restrictions on
the bug; if the <SPAN
CLASS="QUOTE"
>"watcher"</SPAN
> would not normally be
allowed to view a bug, the watcher cannot get around the
system by setting herself up to watch the bugs of someone
with bugs outside her priveleges. She would still only
receive email updates for those bugs she could normally
view.</P
><P
>For Bugzilla sites which require strong inter-Product
security to prevent snooping, watchers are not a good
idea.</P
><P
> However, for most sites you should set
<SPAN
CLASS="QUOTE"
>"supportwatchers"</SPAN
> 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"
>4.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"
>4.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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
><P
>Yes, that is <EM
>fourteen</EM
>
<SPAN
CLASS="QUOTE"
>"f"</SPAN
>'s. A whole lot of f-ing going on if you
want to create a new administator.</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="manageusers"
>4.2.2. Managing Other Users</A
></H2
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="login"
>4.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"
>4.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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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 <B
CLASS="command"
>man
regexp</B
> 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
></TD
></TR
></TABLE
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Adding a user this way will <EM
>not</EM
>
send an email informing them of their username and
password. While useful for creating dummy accounts
(watchers which shuttle mail to another system, for
instance, or email addresses which are a mailing
list), in general it is preferable to log out and use
the <SPAN
CLASS="QUOTE"
>"New Account"</SPAN
> 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
></TD
></TR
></TABLE
></DIV
></LI
></OL
></DIV
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="disableusers"
>4.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"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Don't disable your own administrative account, or you
will hate life!
</P
><P
>At this time, <SPAN
CLASS="QUOTE"
>"Disabled Text"</SPAN
> does not
prevent a user from using the email interface. If you
have the email interface enabled, they can still
continue to submit bugs and comments that way. We need
a patch to fix this.</P
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="modifyusers"
>4.2.2.4. Modifying Users</A
></H3
><P
> Here I will attempt to describe the function of each option
on the Edit User 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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> For compatability reasons, you should probably stick
with email addresses as user login names. It will
make your life easier.
</P
></TD
></TR
></TABLE
></DIV
>
</P
></LI
><LI
><P
> <EM
>Real Name</EM
>: Duh!
</P
></LI
><LI
><P
> <EM
>Password</EM
>: You can change the user
password here. It is normal to only see asterisks.
</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, QA
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 QA
Contact, but will receive them if she is on the CC
list.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> She will still receive whining cron emails if
you set up the "whinemail" feature.
</P
></TD
></TR
></TABLE
></DIV
>
</P
></LI
><LI
><P
> <EM
>All Qualifying Bugs</EM
>: This
user is a glutton for punishment. If her name is
in the reporter, QA 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"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Don't disable the administrator account!</P
></TD
></TR
></TABLE
></DIV
>
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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 (e.g.: "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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
>4.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"
>4.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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="components"
>4.3.2. Components</A
></H2
><P
> Components are subsections of a Product.
<DIV
CLASS="example"
><A
NAME="AEN1470"
></A
><P
><B
>Example 4-1. Creating some Components</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1472"
></A
><P
></P
><P
> The computer game you are designing may have a "UI"
component, an "API" component, a "Sound System"
component, and a "Plugins" component, each overseen by
a different programmer. It often makes sense to divide
Components in Bugzilla according to the natural
divisions of responsibility within your Product or
company.
</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 QA 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 and Description fields
are free-form; the "Initial Owner" field must be that of a
user ID already existing in the database. If the initial
owner does not exist, Bugzilla will refuse to create the
component.
<DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
>
</P
></LI
><LI
><P
> Either Edit more components or return to the Bugzilla
Query 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"
>4.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="AEN1499"
></A
><P
><B
>Example 4-2. Common Use of Versions</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1501"
></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="AEN1503"
></A
><P
><B
>Example 4-3. A Different Use of Versions</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1505"
></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"
>4.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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> Milestone options will only appear for a Product if you
turned the "usetargetmilestone" field in the "Edit
Parameters" screen "On".
</P
></TD
></TR
></TABLE
></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="AEN1531"
></A
><P
><B
>Example 4-4. Using SortKey with Target Milestone</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1533"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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
></OL
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="voting"
>4.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"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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"
>4.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="AEN1567"
></A
><P
><B
>Example 4-5. When to Use Group Security</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1569"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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="AEN1584"
></A
><P
><B
>Example 4-6. Creating a New Group</B
></P
><DIV
CLASS="informalexample"
><A
NAME="AEN1586"
></A
><P
></P
><P
> I created a group called DefaultGroup with a
description of <SPAN
CLASS="QUOTE"
>"This is simply a group to play
with"</SPAN
>, and a New User RegExp of <SPAN
CLASS="QUOTE"
>".*@mydomain.tld"</SPAN
>.
This new group automatically includes all Bugzilla
users with "@mydomain.tld" 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"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><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"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><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
><P
> You may find this example illustrative for how bug groups work.
<DIV
CLASS="example"
><A
NAME="AEN1601"
></A
><P
><B
>Example 4-7. Bugzilla Groups</B
></P
><P
CLASS="literallayout"
><br>
Bugzilla Groups example<br>
-----------------------<br>
<br>
For this example, let us suppose we have four groups, call them<br>
Group1, Group2, Group3, and Group4.<br>
<br>
We have 5 users, User1, User2, User3, User4, User5.<br>
<br>
We have 8 bugs, Bug1, ..., Bug8.<br>
<br>
Group membership is defined by this chart:<br>
(X denotes that user is in that group.)<br>
(I apologize for the nasty formatting of this table. Try viewing<br>
it in a text-based browser or something for now. -MPB)<br>
<br>
G G G G<br>
r r r r<br>
o o o o<br>
u u u u<br>
p p p p<br>
1 2 3 4<br>
+-+-+-+-+<br>
User1|X| | | |<br>
+-+-+-+-+<br>
User2| |X| | |<br>
+-+-+-+-+<br>
User3|X| |X| |<br>
+-+-+-+-+<br>
User4|X|X|X| |<br>
+-+-+-+-+<br>
User5| | | | |<br>
+-+-+-+-+<br>
<br>
Bug restrictions are defined by this chart:<br>
(X denotes that bug is restricted to that group.)<br>
<br>
G G G G<br>
r r r r<br>
o o o o<br>
u u u u<br>
p p p p<br>
1 2 3 4<br>
+-+-+-+-+<br>
Bug1| | | | |<br>
+-+-+-+-+<br>
Bug2| |X| | |<br>
+-+-+-+-+<br>
Bug3| | |X| |<br>
+-+-+-+-+<br>
Bug4| | | |X|<br>
+-+-+-+-+<br>
Bug5|X|X| | |<br>
+-+-+-+-+<br>
Bug6|X| |X| |<br>
+-+-+-+-+<br>
Bug7|X|X|X| |<br>
+-+-+-+-+<br>
Bug8|X|X|X|X|<br>
+-+-+-+-+<br>
<br>
Who can see each bug?<br>
<br>
Bug1 has no group restrictions. Therefore, Bug1 can be seen by any<br>
user, whatever their group membership. This is going to be the only<br>
bug that User5 can see, because User5 isn't in any groups.<br>
<br>
Bug2 can be seen by anyone in Group2, that is User2 and User4.<br>
<br>
Bug3 can be seen by anyone in Group3, that is User3 and User4.<br>
<br>
Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of<br>
these users can see Bug4.<br>
<br>
Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This<br>
is only User4. User1 cannot see it because he is not in Group2, and<br>
User2 cannot see it because she is not in Group1.<br>
<br>
Bug6 can be seen by anyone who is in both Group1 and Group3. This<br>
would include User3 and User4. Similar to Bug5, User1 cannot see Bug6<br>
because he is not in Group3.<br>
<br>
Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This<br>
is only User4. All of the others are missing at least one of those<br>
group priveleges, and thus cannot see the bug.<br>
<br>
Bug8 can be seen by anyone who is in Group1, Group2, Group3, and<br>
Group4. There is nobody in all four of these groups, so nobody can<br>
see Bug8. It doesn't matter that User4 is in Group1, Group2, and<br>
Group3, since he isn't in Group4.<br>
</P
></DIV
>
</P
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="security"
>4.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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
><P
> Secure your installation.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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 Privilege 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 <SPAN
CLASS="QUOTE"
>"nobody"</SPAN
>. 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.
<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> <SPAN
CLASS="QUOTE"
>"nobody"</SPAN
> is a real user on UNIX systems.
Having a process run as user id <SPAN
CLASS="QUOTE"
>"nobody"</SPAN
>
is absolutely no protection against system crackers
versus using any other user account. As a general
security measure, I recommend you create unique user
ID's for each daemon running on your system and, if
possible, use "chroot" to jail that process away from
the rest of your system.
</P
></TD
></TR
></TABLE
></DIV
>
</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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
(e.g.: <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
></TD
></TR
></TABLE
></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> allow<br>
from all </Files> deny from all </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> deny<br>
from all </Files> allow from all </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 </P
>
</P
></LI
></OL
>
</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
>Bonsai is a web-based tool for managing <A
HREF="#cvs"
>CVS, the Concurrent Versioning System</A
>
. Using Bonsai, administrators can control open/closed status
of trees, query a fast relational database back-end for change,
branch, and comment information, and view changes made since the
last time the tree was closed. These kinds of changes cause the
engineer responsible to be <SPAN
CLASS="QUOTE"
>"on the hook"</SPAN
> (include
cool URL link here for Hook policies at mozilla.org). Bonsai
also includes gateways to <A
HREF="#tinderbox"
>Tinderbox, the Mozilla automated build management system</A
> and Bugzilla </P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="cvs"
>5.2. CVS</A
></H1
><P
>CVS integration is best accomplished, at this point, using
the Bugzilla Email Gateway. There have been some files
submitted to allow greater CVS integration, but we need to make
certain that Bugzilla is not tied into one particular software
management package.</P
><P
> Follow the instructions in the FAQ for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to
your Bugzilla e-mail gateway with the subject of <SPAN
CLASS="QUOTE"
>"[Bug
XXXX]"</SPAN
>, and you can have CVS check-in comments append
to your Bugzilla bug. If you have your check-in script include
an @resolution field, you can even change the Bugzilla bug
state.
</P
><P
> There is also a project, based upon somewhat dated Bugzilla
code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<A
HREF="http://homepages.kcbbs.gen.nz/~tonyg/"
TARGET="_top"
> http://homepages.kcbbs.gen.nz/~tonyg/</A
>, under the
<SPAN
CLASS="QUOTE"
>"cvszilla"</SPAN
> link.
</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="scm"
>5.3. Perforce SCM</A
></H1
><P
> You can find the project page for Bugzilla and Teamtrack
Perforce integration (p4dti) at: <A
HREF="http://www.ravenbrook.com/project/p4dti/"
TARGET="_top"
> http://www.ravenbrook.com/project/p4dti</A
> . <SPAN
CLASS="QUOTE"
>"p4dti"</SPAN
> 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 seamless. Perforce replication information will appear below
the comments of each bug. Be certain you have a matching set of
patches for the Bugzilla version you are installing. 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
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="tinderbox"
>5.4. Tinderbox/Tinderbox2</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
><FONT
COLOR="#000000"
><PRE
CLASS="synopsis"
>Bugzilla's Future. Much of this is the present, now.</PRE
></FONT
></TD
></TR
></TABLE
><P
> Bugzilla's future is a constantly-changing thing, as various developers
<SPAN
CLASS="QUOTE"
>"scratch an itch"</SPAN
> when it comes to functionality.
Thus this section is very malleable, subject to change without notice, etc.
You'll probably also notice the lack of formatting. I apologize that it's
not quite as readable as the rest of the Guide.
</P
><P
> <P
CLASS="literallayout"
><br>
Bugzilla Blue Sky<br>
<br>
Customisability<br>
<br>
One of the major stumbling blocks of Bugzilla has been that it is too<br>
rigid and does not adapt itself well enough to the needs of an<br>
organisation. This has led to organisations making changes to the<br>
Bugzilla code that need to be redone each new version of Bugzilla.<br>
Bugzilla should attempt to move away from this to a world where this<br>
doesn't need to occur.<br>
<br>
Most of the subsections in this section are currently explicit design<br>
goals for the "Bugzilla 3" rewrite. This does not necessarily mean<br>
that they will not occur before them in Bugzilla 2, but most are<br>
significant undertakings.<br>
<br>
Field Customisation<br>
<br>
Many installations wish to customise the fields that appear on bug<br>
reports. Current versions of Bugzilla offer limited<br>
customisability. In particular, some fields can be turned off.<br>
<br>
However, many administrators wish to add their own fields, and rename<br>
or otherwise modify existing fields. An architecture that supports<br>
this would be extraordinarily useful.<br>
<br>
Indeed, many fields work similarly and could be abstracted into "field<br>
types", so that an administrator need write little or no code to<br>
support the new fields they desire.<br>
<br>
Possible field types include text (eg status whiteboard), numbers,<br>
dates (eg report time), accounts (eg reporter, qa, cc), inter-bug<br>
relationships (dependencies, duplicates), option groups (platform, os,<br>
severity, priority, target milestone, version) etc.<br>
<br>
Ideally an administrator could configure their fields through a<br>
Bugzilla interface that requires no code to be added. However, it is<br>
highly unlikely this ideal will never be met, and in a similar way<br>
that office applications have scripting languages, Bugzilla should<br>
allow new field types to be written.<br>
<br>
Similarly, a common desire is for resolutions to be added or removed.<br>
<br>
Allocations<br>
<br>
?<br>
<br>
Option Groups<br>
<br>
?<br>
<br>
Relations<br>
<br>
?<br>
<br>
Database Integrity<br>
<br>
Furthermore, it is desirable for administrators to be able to specify<br>
rules that must or should apply between the fields on a bug report.<br>
<br>
For example, you might wish to specify that a bug with status ASSIGNED<br>
must have a target milestone field that that is not untargetted. Or<br>
that a bug with a certain number of votes should get ASSIGNED. Or<br>
that the QA contact must be different from the assignee.<br>
<br>
"Must" relationships could be implemented by refusing to make changes<br>
that violate the relationships, or alternatively, automatically<br>
updating certain fields in order to satisfy the criteria. Which<br>
occurs should be up to the administrator.<br>
<br>
"Should" relationships could be implemented by a combination of<br>
emitting warnings on the process bug page, the same on notification<br>
mails, or emitting periodic whine mails about the situation. Again,<br>
which occurs should be up to the administrator.<br>
<br>
It should also be possible for whine mails to be emitted for "must"<br>
relationships, as they might become violated through direct database<br>
access, Bugzilla bugs, or because they were there before the<br>
relationship was enforced.<br>
<br>
As well as implementing intra-bug constraints, it would be useful to<br>
create inter-bug constraints. For example, a bug that is dependent on<br>
another bug should not have an earlier milestone or greater priority<br>
than that bug.<br>
<br>
Database Adaptability<br>
<br>
Often an administrator desires that fields adapt to the values of<br>
other fields. For example, the value of a field might determine the<br>
possible values of another field or even whether it appears (whether<br>
it is "applicable").<br>
<br>
Limited adaptability is present in Bugzilla 2, and only on the<br>
"Product" field:<br>
* The possible values of the target milestone, version and component<br>
fields depend on the product.<br>
* UNCONFIRMED can be turned off for specific products.<br>
* Voting can be configured differently or turned off for different<br>
products, and there is a separate user vote limits for each<br>
product.<br>
<br>
It would be good if more adaptability was present, both in terms of<br>
all fields relying on the product, as well as the ability to adapt<br>
based on the value of all fields.<br>
<br>
Example ???<br>
<br>
General adaptability raises the issue of circular references between<br>
fields causing problems. One possible solution to this is to place<br>
the fields in a total ordering and require a field refer only to the<br>
previous fields.<br>
<br>
In Bugzilla 2, changing the product of a bug meant a second page would<br>
appear that allowed you to choose a new milestone, component and<br>
version, as those fields adapted themselves to the new product. This<br>
page could be generalised to support all instances where:<br>
* a field value must or might be changed because the possible values<br>
have changed<br>
* is going to drop off because it it is no longer applicable, and<br>
this should be confirmed<br>
* must be specified because it is suddenly applicable, and the<br>
default value, if one exists, might not be acceptable<br>
<br>
Database Independence<br>
<br>
Currently Bugzilla only runs on the MySQL database. It would be<br>
desirable for Bugzilla to run on other databases, because:<br>
* Organisations may have existing database products they use and<br>
would prefer to run a homogenous environment.<br>
* Databases each have their own shortcomings, including MySQL. An<br>
administrator might choose a database that would work better with<br>
their Bugzilla.<br>
<br>
This raises the possibility that we could use features that are only<br>
present in some databases, by appropriately falling back. For<br>
example, in the MySQL world, we live without:<br>
* record-level locking, instead we use table-level locking<br>
* referential and record constraints, instead we checking code<br>
* subselects, instead we use multiple queries and redundant "caches"<br>
<br>
Multiple Front Ends<br>
<br>
Currently Bugzilla is manipulated via the Web, and notifies via<br>
E-Mail. It would be desirable for Bugzilla to easily support various<br>
front ends.<br>
<br>
There is no reason that Bugzilla could not be controlled via a whole<br>
range of front ends, including Web, E-Mail, IRC, ICQ, etc, and<br>
similarly for how it notifies. It's also possible that we could<br>
introduce a special Bugzilla client that uses its own protocol, for<br>
maximum user productivity.<br>
<br>
Indeed a request reply might be returned via a totally different<br>
transport method than was use to submit the request.<br>
<br>
Internationalisation<br>
<br>
Bugzilla currently supports only English. All of the field names,<br>
user instructions, etc are written in English. It would be desirable<br>
to allow "language packs" so Bugzilla can be easily used in<br>
non-English speaking locales.<br>
<br>
To a degree field customisation supports this, because administrators<br>
could specify their own fields names anyway. However, there will<br>
always be some basic facilities not covered by this, and it is<br>
desirable that the administrator's interface also is<br>
internationalisable.<br>
<br>
Better Searching<br>
<br>
General Summary Reports<br>
<br>
Sometimes, the normal querying page leaves a lot to be desired. There<br>
are other facilities already in place or which people have asked for:<br>
<br>
Most Doomed Reports - All Bugs or All Bugs In A Product, Categorised<br>
On Assignee, Shows and Counts Number of Bugs For Each Assignee<br>
Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top Ten<br>
Bugs Voters Most Want Fixed<br>
Number of Open Bugs For An Assignee - Bug List, Categorised On<br>
Developers, Counts Number of Bugs In Category<br>
<br>
The important thing to realise is that people want categorised reports<br>
on all sorts of things - a general summary report.<br>
<br>
In a categorised report, you choose the subset of bugs you wish to<br>
operate on (similar to how you would specify a query), and then<br>
categorise them on one or more fields.<br>
<br>
For each category you display the count of the number of things in<br>
that category. You can optionally display the bugs themselves, or<br>
leave them out, just showing the counts. And you can optionally limit<br>
the number of things (bugs or subcategories) that display in each<br>
category.<br>
<br>
Such a mechanism would let you do all of the above and more.<br>
Applications of this mechanism would only be recognised once it was<br>
implemented.<br>
<br>
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.<br>
<br>
Column Specification Support<br>
<br>
Currently bug lists use the columns that you last used. This doesn't<br>
work well for "prepackaged queries", where you followed a link. You<br>
can probably add a column by specifying a sort column, but this is<br>
difficult and suboptimal.<br>
<br>
Furthermore, I find that when I want to add a column to a bug list,<br>
it's usually a one off and I would prefer it to go away for the next<br>
query. Hence, it would be nice to specify the columns that appear on<br>
the bug list (and general summary report) pages. The default query<br>
mechanism should be able to let you specify your default columns.<br>
<br>
Advanced Querying Redesign<br>
<br>
?<br>
<br>
Keywords<br>
<br>
People have a need to apply tags to bugs. In the beginning, people<br>
placed designators in the summary and status whiteboard. However,<br>
these fields were not designed for that, and so there were many flaws<br>
with this system:<br>
* They pollute the field with information that was never intended to<br>
be present.<br>
* Removing them with a bulk change is a difficult problem that has<br>
too many pitfalls to implement.<br>
* You can easily get the capitalisation wrong.<br>
<br>
Then dependencies were introduced (when?), and people realised that<br>
they could use them for "tracking bugs". Again, dependencies were not<br>
designed for that, and so there were more flaws, albeit different<br>
ones, including:<br>
* They aren't really bugs, so it's difficult to distinguish issues<br>
from bugs.<br>
* They can pollute bugs counts, and you must somehow exclude them<br>
from queries.<br>
* There is a whole lot of useless information on them. They have an<br>
assignee but there is nothing to fix, and that person can get<br>
whined at by Bugzilla. They have target milestones which must be<br>
manually maintained. And so on.<br>
<br>
Finally, keywords were introduced (when?) for this purpose to remove<br>
the need for these two systems. Unfortunately, the simple keywords<br>
implementation was itself lacking in certain features provided by the<br>
two previous systems, and has remained almost unchanged since its<br>
inception. Furthermore, it could not be forseen that in large<br>
installations, the sheer number of keywords could become unwieldly and<br>
could lead to a movement back to the other systems.<br>
<br>
The keywords system was the right idea, however, and it remains so.<br>
Fixing the keywords system is one of the most important Bugzilla<br>
issues.<br>
<br>
Bringing Keywords Up To Par<br>
<br>
For the most part, keywords are very good at what they do. It is easy<br>
to add and remove them (unlike summary/whiteboard designators), we can<br>
simply see what issues are present on a bug (unlike tracking bugs),<br>
and we do not confuse bugs with issues (unlike tracking bugs).<br>
<br>
However, there are still some "regressions" in the keyword system over<br>
previous systems:<br>
* Users wish to view the "dependency forest" of a keyword. While a<br>
dependency tree is of one bug, a dependency forest is of a bug<br>
list, and consists of a dependency tree for each member of the bug<br>
list. Users can work around this with tracking bugs by creating a<br>
tracking bug and viewing the dependency tree of that tracking bug.<br>
* Users wish to specify the keywords that initially apply to a bug,<br>
but instead they must edit the bug once it has already been<br>
submitted. They can work around this with summary designators,<br>
since they specify the summary at reporting time.<br>
* Users wish to store or share a bug list that contains a keywords<br>
column. Hence they wish to be able to specify what columns appear<br>
in the bug list URL, as mentioned earlier. They can work around<br>
this using summary designators, since almost all bug lists have a<br>
summary column.<br>
* Users wish to be able to view keywords on a bug list. However<br>
often they are only interested in a small number of keywords.<br>
Having a bug list with a keywords column means that all keywords<br>
will appear on a bug list. This can take a substantial amount of<br>
space where a bug has a lot of keywords, since the table columns<br>
in Bugzilla adjust to the largest cell in that column. Hence<br>
users wish to be able to specify which keywords should appear in<br>
the bug list. In a very real sense, each keyword is a field unto<br>
itself. Users can work around this by using summary designators,<br>
since they keywords will share the space in the summary column.<br>
* Users wish to know when bugs with a specific issue are resolved.<br>
Hence they wish to be able to receive notifications on all the<br>
bugs with a specific keyword. The introduction a generic watching<br>
facility (also for things like watching all bugs in a component)<br>
would achieve this. Users can work around this by using tracking<br>
bugs, as dependencies have an existing way of detecting fixes to<br>
bug a bug was blocked by.<br>
<br>
Dealing With The Keyword Overload<br>
<br>
At the time of writing, the mozilla.org installation has approximately<br>
100 keywords, and many more would be in use if the keywords system<br>
didn't have the problems it does.<br>
<br>
Such a large number of keywords introduces logistical problems:<br>
* It must be easy for someone to learn what a keyword means. If a<br>
keyword is buried within a lot of other keywords, it can be<br>
difficult to find.<br>
* It must be easy to see what keywords are on a bug. If the number<br>
of keywords is large, then this can be difficult.<br>
<br>
These lead some people to feel that there are "too many keywords".<br>
<br>
These problems are not without solutions however. It is harder to<br>
find a list of designators or tracking bugs than it is a list of<br>
keywords.<br>
<br>
The essential problem is it needs to be easy to find the keywords<br>
we're interested in through the mass of keywords.<br>
<br>
Keyword Applicability<br>
<br>
As has been previously mentioned, it is desirable for fields to be<br>
able to adapt to the values of other fields. This is certainly true<br>
for keywords. Many keywords are simply not relevant because of the<br>
bugs product, component, etc.<br>
<br>
Hence, by introducing keyword applicability, and not displaying<br>
keywords that are not relevant to the current bug, or clearly<br>
separating them, we can make the keyword overload problem less<br>
significant.<br>
<br>
Currently when you click on "keywords" on a bug, you get a list of all<br>
bugs. It would be desirable to introduce a list of keywords tailored<br>
to a specific bug, that reports, in order:<br>
* the keywords currently on the bug<br>
* the keywords not currently on the bug, but applicable to the bug<br>
* optionally, the keywords not applicable to the bug<br>
<br>
This essentially orders the keywords into three groups, where each<br>
group is more important than the previous, and therefore appears<br>
closer to the top.<br>
<br>
Keyword Grouping & Ordering<br>
<br>
We could further enhance both the global and bug specific keyword list<br>
by grouping keywords. We should always have a "flat" view of<br>
keywords, but other ways of viewing the keywords would be useful too.<br>
<br>
If keyword applicability was implemented, we could group keywords<br>
based on their "applicability condition". Keywords that apply to all<br>
bugs could be separated from keywords that apply to a specific<br>
product, both on the global keyword list and the keyword list of a bug<br>
that is in that product.<br>
<br>
We could specify groups of our own. For example, many keywords are in<br>
a mutually exclusive group, essentially like radio buttons in a user<br>
interface. This creates a natural grouping, although other groupings<br>
occur (which depends on your keywords).<br>
<br>
It is possible that we could use collapsing/expanding operations on<br>
"twisties" to only should the groups we are interested in.<br>
<br>
And instead of grouping keywords, we could order them on some metric<br>
of usefulness, such as:<br>
* when the keyword was last added to a bug<br>
* how many bugs the keyword is on<br>
* how many open bugs the keyword is on<br>
<br>
Opting Out Of Keywords<br>
<br>
Not all people are going to care about all keywords. Therefore it<br>
makes sense that you may wish to specify which keywords you are<br>
interested in, either on the bug page, or on notifications.<br>
<br>
Other keywords will therefore not bother users who are not interested<br>
in them.<br>
<br>
Keyword Security<br>
<br>
Currently all keywords are available and editable to all people with<br>
edit bugs access. This situation is clearly suboptimal.<br>
<br>
Although relying on good behaviour for people to not do what they<br>
shouldn't works reasonably well on the mozilla.org, it is better to<br>
enforce that behaviour - it can be breached through malice, accident<br>
or ignorance.<br>
<br>
And in the situation where it is desirable for the presence or absence<br>
of a keyword not to be revealed, organisations either need to be<br>
content with the divulgence, or not use keywords at all.<br>
<br>
In the situation where they choose to divulge, introducing the ability<br>
to restrict who can see the keyword would also reduce keyword<br>
overload.<br>
<br>
Personal Keywords<br>
<br>
Keywords join together a set of bugs which would otherwise be<br>
unrelated in the bug system.<br>
<br>
We allow users to store their own queries. However we don't allow<br>
them to store their own keywords on a bug. This reduces the<br>
usefulness of personal queries, since you cannot join a set of<br>
unrelated bugs together in a way that you wish. Lists of bug numbers<br>
can work, by they can only be used for small lists, and it is<br>
impossible to share a list between multiple queries.<br>
<br>
Personal keywords are necessary to replace personal tracking bugs, as<br>
they would not pollute the keyword space. Indeed, on many<br>
installations this could remove some keywords out of the global<br>
keyword space.<br>
<br>
In a similar vein and with similar effects, group keywords could be<br>
introduced that are only available to members of a specific group.<br>
<br>
Keyword Restrictions<br>
<br>
Keywords are not islands unto themselves. Along with their potential<br>
to be involved in the inter-field relationships mentioned earlier,<br>
keywords can also be related to other keywords.<br>
<br>
Essentially, there are two possibilities:<br>
* a set of keywords are mutually exclusive<br>
* the presence of a keyword implies another keyword must be present<br>
<br>
Introduction of the ability to specify these restrictions would have<br>
benefits.<br>
<br>
If mutually exclusive keywords were present on a bug, their removal<br>
would fix up the database, as well as reducing the number of keywords<br>
on that bug.<br>
<br>
In the situation where a keyword implies another keyword, there are<br>
two possiblities as to how to handle the situation.<br>
<br>
The first is automatically add the keyword. This would fix up the<br>
database, but it would increase the number of keywords on a bug.<br>
<br>
The second is to automatically remove the keyword, and alter queries<br>
so they pick up the first keyword as well as the removed keyword.<br>
This would fix up the database and reduce the number of keywords on a<br>
bug, but it might confuse users who don't see the keyword.<br>
Alternatively, the implied keywords could be listed separately.<br>
<br>
Notifications<br>
<br>
Every time a bug gets changed notifications get sent out to people<br>
letting them know about what changes have been made. This is a<br>
significant feature, and all sorts of questions can be raised, but<br>
they mainly boil down to when they should be sent and what they should<br>
look like.<br>
<br>
Changes You're Interested In<br>
<br>
As of version 2.12 users can specify what sort of changes they are<br>
interested in receiving notifications for. However, this is still<br>
limited. As yet there is no facility to specify which keywords you<br>
care about, and whether you care about changes to fields such as the<br>
QA contact changes.<br>
Furthermore, often an unnecessary comment will go along with a change,<br>
either because it is required, or the commenter is ignorant of how the<br>
new system works. While explaining why you did something is useful,<br>
merely commenting on what you did is not because that information is<br>
already accessible view "Bug Activity".<br>
<br>
Because of this unnecessary comment, a lot of changes that would<br>
otherwise not generate notifications for certain people do so, because<br>
few people are willing to turn off comments. One way to deal with<br>
this problem is to allow people to specify that their comments are<br>
purely explanatory, and that anyone who is not interested in the<br>
change will not be interested in the comment.<br>
<br>
Furthermore, one possible rationale for unnecessary comments is that<br>
the bug activity does not display on the normal page and hence it is<br>
difficult to cross reference comments and actions. Hence, it would be<br>
beneficial to be able to do this.<br>
<br>
Bugs You're Watching<br>
<br>
Currently to receive a notification about a bug you need to have your<br>
name on it. This is suboptimal because you need to know about a bug<br>
before you can receive notifications on it. Often you are interested<br>
in any bug with a field set to a specific value. For example, you<br>
might be interested in all bugs with a specific product, component or<br>
keyword.<br>
<br>
If someone could automatically receive notifications about these bugs,<br>
it would make everyone's lives easier. Currently the default assignee<br>
and QA contact for a component will automatically receive<br>
notifications for<br>
<br>
Question: This moves half way to a BCC.<br>
<br>
Bulk Changes<br>
<br>
A very useful feature of Bugzilla is the ability to perform an action<br>
on multiple bugs at once. However, this means that similar<br>
notifications are currently generated for each bug modified.<br>
<br>
This can result in a torrent of notifications that can annoy.<br>
<br>
Furthermore, since the bugs are all changed close to each other in<br>
time, it is easy for someone to mass delete all the notifications<br>
generated by a bulk change and miss an unrelated notification in the<br>
middle.<br>
<br>
These factors can lead to a tendency for people to delay bulk changes,<br>
or avoid them entirely. This is suboptimal.<br>
<br>
It would be better if a bulk change generated only one notification<br>
mail. This would vastly reduce the annoyance factor, and prevent<br>
accidental deletion of notifications.<br>
<br>
One problem with this change is that some people separate out<br>
notifications using filtering. This means that they would no longer<br>
be match parts of a bulk change under different filtering rules.<br>
<br>
One possibility to resolve this is to allow people to specify groups<br>
of bugs. All bugs within a group would go into the same<br>
notification. The filters could then distinguish the different bug<br>
groups.<br>
<br>
In any case, it is likely there would need to be a transition period<br>
to allow people to alter their filters.<br>
<br>
Nominations<br>
<br>
?<br>
<br>
Linking Bugzilla Installations<br>
<br>
The first example of linking Bugzilla installations together has is<br>
the introduction of bug moving in version 2.12. However, it would be<br>
useful to be able to link installations in more ways.<br>
* Dependencies and other relationships between bugs in other<br>
installations. This is difficult because dependencies are<br>
synchronised on both bugs, so the installation that changes<br>
dependencies would need to communicate the new state to the other<br>
installation. It would also mean that relationships and<br>
notifications that refer to other bugs would need to communicate<br>
with the other installation.<br>
* References to bugs in other installations. Currently if you type<br>
"bug XXX" or "bug #XXX" where XXX is a number, you get an<br>
automatic hyperlink to that bug. It would be useful if you could<br>
say "YYY bug #XXX" where YYY is the name of another installation.<br>
<br>
Retirement<br>
<br>
?<br>
<br>
Whiny Reports<br>
<br>
?<br>
<br>
Group Redesign<br>
<br>
?<br>
<br>
Hard Wrapping Comments<br>
<br>
Currently Bugzilla "hard wraps" its comments to a specific line size,<br>
similar to E-Mail. This has various problems:<br>
* The way it currently works, wrapping is done in the browser at<br>
submission time using a non-standard HTML extension not supported<br>
by some (uncommon) browsers. These browsers generate comments<br>
that scroll off the right side of the screen.<br>
* Because comments are of fixed width, when you expand your browser<br>
window, the comments do not expand to fit available space.<br>
<br>
It would be much better to move to a world of soft wrapping, where the<br>
browser wraps the text at display time, similar to a world processor.<br>
And as in a word processor, soft wrapping does not preclude the<br>
insertion of newlines.<br>
<br>
Hard wrapping is too entrenched into text E-Mail to fix, but we can<br>
fix Bugzilla without causing any problems. The old content will still<br>
be wrapped too early, but at least new content will work.<br>
</P
>
</P
></DIV
><DIV
CLASS="chapter"
><HR><H1
><A
NAME="variants"
>Chapter 7. Bugzilla Variants and Competitors</A
></H1
><P
>I created this section to answer questions about Bugzilla
competitors and variants, then found a wonderful site which covers
an awful lot of what I wanted to discuss. Rather than quote it in
its entirety, I'll simply refer you here: <A
HREF="http://linas.org/linux/pm.html"
TARGET="_top"
>http://linas.org/linux/pm.html</A
></P
><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
on the planet. One of the major benefits of Red Hat Bugzilla is
the ability to work with Oracle, MySQL, and PostGreSQL databases
serving as the back-end, instead of just MySQL. Dave Lawrence
has worked very hard to keep Red Hat Bugzilla up-to-date, and
many people prefer the snappier-looking page layout of Red Hat
Bugzilla to the default Mozilla-standard formatting.
</P
><P
>URL: <A
HREF="http://bugzilla.redhat.com/bugzilla/"
TARGET="_top"
>http://bugzilla.redhat.com/bugzilla/</A
></P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="variant-fenris"
>7.2. Loki Bugzilla (Fenris)</A
></H1
><P
>Fenris can be found at <A
HREF="http://fenris.lokigames.com/"
TARGET="_top"
>http://fenris.lokigames.com</A
>. It is a fork from Bugzilla.</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="variant-issuezilla"
>7.3. Issuezilla</A
></H1
><P
>Issuezilla is another fork from Bugzilla, and seems nearly
as popular as the Red Hat Bugzilla fork. Some Issuezilla team
members are regular contributors to the Bugzilla mailing
list/newsgroup. Issuezilla is not the primary focus of
bug-tracking at tigris.org, however. Their Java-based
bug-tracker, <A
HREF="#variant-scarab"
>Scarab, a newfangled Java-based issue tracker</A
>, is under heavy development
and looks promising!</P
><P
>URL: <A
HREF="http://issuezilla.tigris.org/servlets/ProjectHome"
TARGET="_top"
>http://issuezilla.tigris.org/servlets/ProjectHome</A
></P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="variant-scarab"
>7.4. Scarab</A
></H1
><P
>Scarab is a promising new bug-tracking system built using
Java Serlet technology. As of this writing, no source code has
been released as a package, but you can obtain the code from
CVS.
</P
><P
>URL: <A
HREF="http://scarab.tigris.org/"
TARGET="_top"
>http://scarab.tigris.org</A
></P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="variant-perforce"
>7.5. Perforce SCM</A
></H1
><P
>Although Perforce isn't really a bug tracker, it can be used
as such through the <SPAN
CLASS="QUOTE"
>"jobs"</SPAN
> functionality.</P
><P
><A
HREF="http://www.perforce.com/perforce/technotes/note052.html"
TARGET="_top"
>http://www.perforce.com/perforce/technotes/note052.html</A
>http://www.perforce.com/perforce/technotes/note052.html</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="variant-sourceforge"
>7.6. SourceForge</A
></H1
><P
>SourceForge is more of a way of coordinating geographically
distributed free software and open source projects over the
Internet than strictly a bug tracker, but if you're hunting for
bug-tracking for your open project, it may be just what the
software engineer ordered!</P
><P
>URL: <A
HREF="http://www.sourceforge.net"
TARGET="_top"
>http://www.sourceforge.net</A
></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="#AEN1722"
> Where can I find information about Bugzilla?</A
></DT
><DT
>A.1.2. <A
HREF="#AEN1728"
> What license is Bugzilla distributed under?
</A
></DT
><DT
>A.1.3. <A
HREF="#AEN1734"
> How do I get commercial support for Bugzilla?
</A
></DT
><DT
>A.1.4. <A
HREF="#AEN1741"
> What major companies or projects are currently using Bugzilla
for bug-tracking?
</A
></DT
><DT
>A.1.5. <A
HREF="#AEN1766"
> Who maintains Bugzilla?
</A
></DT
><DT
>A.1.6. <A
HREF="#AEN1772"
> How does Bugzilla stack up against other bug-tracking databases?
</A
></DT
><DT
>A.1.7. <A
HREF="#AEN1779"
> How do I change my user name in Bugzilla?
</A
></DT
><DT
>A.1.8. <A
HREF="#AEN1784"
> Why doesn't Bugzilla offer this or that feature or compatability
with this other tracking software?
</A
></DT
><DT
>A.1.9. <A
HREF="#AEN1791"
> Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL?
</A
></DT
><DT
>A.1.10. <A
HREF="#AEN1809"
> 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="#AEN1826"
> What about Red Hat Bugzilla?
</A
></DT
><DT
>A.2.2. <A
HREF="#AEN1834"
> What are the primary benefits of Red Hat Bugzilla?
</A
></DT
><DT
>A.2.3. <A
HREF="#AEN1862"
> 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="#AEN1875"
> What is Loki Bugzilla (Fenris)?
</A
></DT
></DL
></DD
><DT
>4. <A
HREF="#faq-phb"
>Pointy-Haired-Boss Questions</A
></DT
><DD
><DL
><DT
>A.4.1. <A
HREF="#AEN1886"
> 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="#AEN1891"
> Has anyone you know of already done any Bugzilla integration with
Perforce (SCM software)?
</A
></DT
><DT
>A.4.3. <A
HREF="#AEN1896"
> Does Bugzilla allow the user to track multiple projects?
</A
></DT
><DT
>A.4.4. <A
HREF="#AEN1901"
> 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="#AEN1906"
> 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="#AEN1911"
> 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="#AEN1918"
> 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="#AEN1940"
> 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="#AEN1948"
> 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="#AEN1953"
> 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="#AEN1958"
> If there is email notification, do users have to have any particular
type of email application?
</A
></DT
><DT
>A.4.12. <A
HREF="#AEN1965"
> 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="#AEN1970"
> 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="#AEN1978"
> Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</A
></DT
><DT
>A.4.15. <A
HREF="#AEN1983"
> Can a user create and save reports? Can they do this in Word format?
Excel format?
</A
></DT
><DT
>A.4.16. <A
HREF="#AEN1988"
> Can a user re-run a report with a new project, same query?
</A
></DT
><DT
>A.4.17. <A
HREF="#AEN1993"
> Can a user modify an existing report and then save it into another name?
</A
></DT
><DT
>A.4.18. <A
HREF="#AEN1998"
> Does Bugzilla have the ability to search by word, phrase, compound
search?
</A
></DT
><DT
>A.4.19. <A
HREF="#AEN2003"
> Can the admin person establish separate group and individual user
privileges?
</A
></DT
><DT
>A.4.20. <A
HREF="#AEN2008"
> 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.21. <A
HREF="#AEN2013"
> Are there any backup features provided?
</A
></DT
><DT
>A.4.22. <A
HREF="#AEN2019"
> Can users be on the system while a backup is in progress?
</A
></DT
><DT
>A.4.23. <A
HREF="#AEN2024"
> 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.24. <A
HREF="#AEN2031"
> 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.25. <A
HREF="#AEN2036"
> 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="#AEN2043"
> How do I download and install Bugzilla?
</A
></DT
><DT
>A.5.2. <A
HREF="#AEN2049"
> How do I install Bugzilla on Windows NT?
</A
></DT
><DT
>A.5.3. <A
HREF="#AEN2054"
> 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="#AEN2061"
> How do I completely disable MySQL security if it's giving me problems
(I've followed the instructions in the installation section of this guide!)?
</A
></DT
><DT
>A.6.2. <A
HREF="#AEN2067"
> Are there any security problems with Bugzilla?
</A
></DT
><DT
>A.6.3. <A
HREF="#AEN2072"
> 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="#AEN2079"
> 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="#AEN2084"
> 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="#AEN2089"
> 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="#AEN2095"
> 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="#AEN2102"
> How do I set up the email interface to submit/change bugs via email?
</A
></DT
><DT
>A.7.6. <A
HREF="#AEN2107"
> Email takes FOREVER to reach me from bugzilla -- it's extremely slow.
What gives?
</A
></DT
><DT
>A.7.7. <A
HREF="#AEN2114"
> 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="#AEN2122"
> I've heard Bugzilla can be used with Oracle?
</A
></DT
><DT
>A.8.2. <A
HREF="#AEN2127"
> 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="#AEN2132"
> I think my database might be corrupted, or contain invalid entries. What
do I do?
</A
></DT
><DT
>A.8.4. <A
HREF="#AEN2140"
> I want to manually edit some entries in my database. How?
</A
></DT
><DT
>A.8.5. <A
HREF="#AEN2145"
> 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="#AEN2150"
> I think I've set up MySQL permissions correctly, but bugzilla still can't
connect.
</A
></DT
><DT
>A.8.7. <A
HREF="#AEN2155"
> How do I synchronize bug information among multiple different Bugzilla
databases?
</A
></DT
><DT
>A.8.8. <A
HREF="#AEN2162"
> Why do I get bizarre errors when trying to submit data, particularly problems
with "groupset"?
</A
></DT
><DT
>A.8.9. <A
HREF="#AEN2167"
> 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="#AEN2177"
> What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</A
></DT
><DT
>A.9.2. <A
HREF="#AEN2182"
> Is there a "Bundle::Bugzilla" equivalent for Win32?
</A
></DT
><DT
>A.9.3. <A
HREF="#AEN2187"
> 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="#AEN2195"
> Can I have some general instructions on how to make Bugzilla on Win32 work?
</A
></DT
><DT
>A.9.5. <A
HREF="#AEN2201"
> 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="#AEN2222"
> The query page is very confusing. Isn't there a simpler way to query?
</A
></DT
><DT
>A.10.2. <A
HREF="#AEN2228"
> 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="#AEN2238"
> 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="#AEN2243"
> 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="#AEN2248"
> 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="#AEN2255"
> What bugs are in Bugzilla right now?
</A
></DT
><DT
>A.11.2. <A
HREF="#AEN2264"
> 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="#AEN2270"
> 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="AEN1722"
></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="AEN1728"
></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="AEN1734"
></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="AEN1741"
></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="AEN1766"
></A
><B
>A.1.5. </B
>
Who maintains Bugzilla?
</P
></DIV
><DIV
CLASS="answer"
><P
><B
> </B
>
Bugzilla maintenance has been in a state of flux recently.
Please check <A
HREF="http://www.mozilla.org/projects/bugzilla/"
TARGET="_top"
>the Bugzilla Project Page for the latest details. </A
>
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1772"
></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 bug-tracker 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="AEN1779"
></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="AEN1784"
></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="AEN1791"
></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="AEN1795"
></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="AEN1809"
></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="AEN1814"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
></BLOCKQUOTE
>
</P
></DIV
></DIV
></DIV
><DIV
CLASS="qandadiv"
><H3
><A
NAME="faq-redhat"
></A
>2. Red Hat Bugzilla</H3
><P
> <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> <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
></TD
></TR
></TABLE
></DIV
>
</P
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1826"
></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="AEN1831"
></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="AEN1834"
></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="AEN1839"
></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="AEN1862"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
>
<EM
>Dave Lawrence</EM
>:
<A
NAME="AEN1869"
></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
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1875"
></A
><B
>A.3.1. </B
>
What is Loki Bugzilla (Fenris)?
</P
></DIV
><DIV
CLASS="answer"
><P
><B
> </B
>
Loki Games has a customized version of Bugzilla available at
<A
HREF="http://fenris.lokigames.com/"
TARGET="_top"
>http://fenris.lokigames.com</A
>. There are some advantages to using Fenris, chief being separation of comments based upon user privacy level, data hiding, forced login for any data retrieval, and some additional fields. Loki has mainted their code, originally a fork from the Bugzilla 2.8 code base, and it is quite a bit different than stock Bugzilla at this point. I recommend you stick with official Bugzilla version 2.14 rather than using a fork, but it's up to you.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="qandadiv"
><H3
><A
NAME="faq-phb"
></A
>4. Pointy-Haired-Boss Questions</H3
><P
> <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
>
</P
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1886"
></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="AEN1891"
></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.
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1896"
></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="AEN1901"
></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="AEN1906"
></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="AEN1911"
></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
><P
> There is no GUI for adding fields to Bugzilla at this
time. You can follow development of this feature at
<A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=91037"
TARGET="_top"
>http://bugzilla.mozilla.org/show_bug.cgi?id=91037</A
>
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1918"
></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
>
It's possible to get the footer on the static index page using
Server Side Includes (SSI). The trick to doing this is making
sure that your web server is set up to allow SSI and specifically,
the #exec directive. You should also rename <TT
CLASS="filename"
>index.html</TT
>
to <TT
CLASS="filename"
>index.shtml</TT
>.
</P
><P
> After you've done all that, you can add the following line to
<TT
CLASS="filename"
>index.shtml</TT
>:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
<!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl'; PutFooter();&quot;" -->
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> This line will be replaced with the actual HTML for the footer
when the page is requested, so you should put this line where you
want the footer to appear.
</P
></TD
></TR
></TABLE
></DIV
></P
><P
> Because this method depends on being able to use a #exec directive,
and most ISP's will not allow that, there is an alternative method.
You could have a small script (such as <TT
CLASS="filename"
>api.cgi</TT
>)
that basically looks like:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
#!/usr/bonsaitools/bin/perl -w
require 'globals.pl';
if ($::FORM{sub} eq 'PutFooter') {
PutFooter();
} else {
die 'api.cgi was incorrectly called';
}
</PRE
></FONT
></TD
></TR
></TABLE
>
and then put this line in <TT
CLASS="filename"
>index.shtml</TT
>.
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
<!--#include virtual="api.cgi?sub=PutFooter"-->
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> This still requires being able to use Server Side Includes, if
this simply will not work for you, see <A
HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=80183"
TARGET="_top"
>bug 80183</A
>
for a third option.
</P
></TD
></TR
></TABLE
></DIV
></P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1940"
></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="AEN1948"
></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="AEN1953"
></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="AEN1958"
></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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></DIV
>
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN1965"
></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="AEN1970"
></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="AEN1978"
></A
><B
>A.4.14. </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="AEN1983"
></A
><B
>A.4.15. </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="AEN1988"
></A
><B
>A.4.16. </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="AEN1993"
></A
><B
>A.4.17. </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="AEN1998"
></A
><B
>A.4.18. </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="AEN2003"
></A
><B
>A.4.19. </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="AEN2008"
></A
><B
>A.4.20. </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="AEN2013"
></A
><B
>A.4.21. </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="AEN2019"
></A
><B
>A.4.22. </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="AEN2024"
></A
><B
>A.4.23. </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="AEN2031"
></A
><B
>A.4.24. </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="AEN2036"
></A
><B
>A.4.25. </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="AEN2043"
></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 Bugzilla Guide.
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN2049"
></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="AEN2054"
></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="AEN2061"
></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 installation section of this guide!)?
</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="AEN2067"
></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 Bugzilla Guide.
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN2072"
></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="AEN2079"
></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="AEN2084"
></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="AEN2089"
></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="AEN2095"
></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="AEN2099"
></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="AEN2102"
></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="AEN2107"
></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.
</P
><P
> If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi.
If you are using Postfix, you will also need to enable <SPAN
CLASS="QUOTE"
>"sendmailnow"</SPAN
>.
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN2114"
></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="AEN2122"
></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="AEN2127"
></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="AEN2132"
></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 <SPAN
CLASS="QUOTE"
>"sanity check"</SPAN
> utility
(<TT
CLASS="filename"
>./sanitycheck.cgi</TT
> in the
Bugzilla_home directory) from your web browser to see! If
it finishes without errors, you're
<EM
>probably</EM
> 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. Sanity Check, although it is a good
basic check on your database integrity, by no means is a
substitute for competent database administration and
avoiding deletion of data. It is not exhaustive, and was
created to do a basic check for the most common problems
in Bugzilla databases.
</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN2140"
></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="AEN2145"
></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="AEN2150"
></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="AEN2155"
></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="AEN2162"
></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="AEN2167"
></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
>
This should only happen with Bugzilla 2.14 if you are
using the <SPAN
CLASS="QUOTE"
>"shadow database"</SPAN
> feature, and your
shadow database is out of sync. Try running
<TT
CLASS="filename"
>syncshadowdb</TT
>
<TT
CLASS="option"
>-syncall</TT
> to make sure your shadow
database is in synch with your primary database.
</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="AEN2177"
></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="AEN2182"
></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="AEN2187"
></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="AEN2192"
></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="AEN2195"
></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"
><br>
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="AEN2201"
></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="AEN2222"
></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="AEN2228"
></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="AEN2238"
></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="AEN2243"
></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="AEN2248"
></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="AEN2255"
></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=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.16 release
<A
HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16"
TARGET="_top"
>here</A
>.
This list includes bugs for the 2.16 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="AEN2264"
></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="AEN2270"
></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 <SPAN
CLASS="QUOTE"
>"<A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
TARGET="_top"
>Bugzilla</A
>"</SPAN
>
product.
</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.com/"
TARGET="_top"
>http://www.mysql.com/</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="http://www.cpan.org/modules/by-module/DBI/"
TARGET="_top"
> http://www.cpan.org/modules/by-module/DBI/</A
>
</P
><P
> Data::Dumper module:
<A
HREF="http://www.cpan.org/modules/by-module/Data/"
TARGET="_top"
> http://www.cpan.org/modules/by-module/Data/</A
>
</P
><P
> MySQL related Perl modules:
<A
HREF="http://www.cpan.org/modules/by-module/Mysql/"
TARGET="_top"
> http://www.cpan.org/modules/by-module/Mysql/</A
>
</P
><P
> TimeDate Perl module collection:
<A
HREF="http://www.cpan.org/modules/by-module/Date/"
TARGET="_top"
> http://www.cpan.org/modules/by-module/Date/</A
>
</P
><P
> GD Perl module:
<A
HREF="http://www.cpan.org/modules/by-module/GD/"
TARGET="_top"
> http://www.cpan.org/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="http://www.cpan.org/modules/by-module/Chart/"
TARGET="_top"
> http://www.cpan.org/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"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> 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
></TD
></TR
></TABLE
></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="../images/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
> This information comes straight from my life. I was forced to learn how
Bugzilla organizes database because of nitpicky requests from users for tiny
changes in wording, rather than having people re-educate themselves or
figure out how to work our procedures around the tool. It sucks, but it can
and will happen to you, so learn how the schema works and deal with it when it
comes.
</P
><P
> So, here you are with your brand-new installation of Bugzilla. You've got
MySQL set up, Apache working right, Perl DBI and DBD talking to the database
flawlessly. Maybe you've even entered a few test bugs to make sure email's
working; people seem to be notified of new bugs and changes, and you can
enter and edit bugs to your heart's content. Perhaps you've gone through the
trouble of setting up a gateway for people to submit bugs to your database via
email, have had a few people test it, and received rave reviews from your beta
testers.
</P
><P
> What's the next thing you do? Outline a training strategy for your
development team, of course, and bring them up to speed on the new tool you've
labored over for hours.
</P
><P
> Your first training session starts off very well! You have a captive
audience which seems enraptured by the efficiency embodied in this thing called
"Bugzilla". You are caught up describing the nifty features, how people can
save favorite queries in the database, set them up as headers and footers on
their pages, customize their layouts, generate reports, track status with
greater efficiency than ever before, leap tall buildings with a single bound
and rescue Jane from the clutches of Certain Death!
</P
><P
> But Certain Death speaks up -- a tiny voice, from the dark corners of the
conference room. "I have a concern," the voice hisses from the darkness,
"about the use of the word 'verified'.
</P
><P
> The room, previously filled with happy chatter, lapses into reverential
silence as Certain Death (better known as the Vice President of Software
Engineering) continues. "You see, for two years we've used the word 'verified'
to indicate that a developer or quality assurance engineer has confirmed that,
in fact, a bug is valid. I don't want to lose two years of training to a
new software product. You need to change the bug status of 'verified' to
'approved' as soon as possible. To avoid confusion, of course."
</P
><P
> Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I
don't think that would be a problem," You review the changes with Certain
Death, and continue to jabber on, "no, it's not too big a change. I mean, we
have the source code, right? You know, 'Use the Source, Luke' and all that...
no problem," All the while you quiver inside like a beached jellyfish bubbling,
burbling, and boiling on a hot Jamaican sand dune...
</P
><P
> Thus begins your adventure into the heart of Bugzilla. You've been forced
to learn about non-portable enum() fields, varchar columns, and tinyint
definitions. The Adventure Awaits You!
</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN2340"
>C.2.1. Bugzilla Database Basics</A
></H2
><P
> If you were like me, at this point you're totally clueless
about the internals of MySQL, and if it weren't for this
executive order from the Vice President you couldn't care less
about the difference between a <SPAN
CLASS="QUOTE"
>"bigint"</SPAN
> and a
<SPAN
CLASS="QUOTE"
>"tinyint"</SPAN
> entry in MySQL. I recommend you refer
to the MySQL documentation, available at <A
HREF="http://www.mysql.com/doc.html"
TARGET="_top"
>MySQL.com</A
>. Below are the basics you need to know about the Bugzilla database. Check the chart above for more details.
</P
><P
><P
></P
><OL
TYPE="1"
><LI
><P
> To connect to your database:
</P
><P
> <TT
CLASS="prompt"
>bash#</TT
><B
CLASS="command"
>mysql</B
><TT
CLASS="parameter"
><I
>-u root</I
></TT
>
</P
><P
> If this works without asking you for a password,
<EM
>shame on you</EM
>! You should have
locked your security down like the installation
instructions told you to. You can find details on
locking down your database in the Bugzilla FAQ in this
directory (under "Security"), or more robust security
generalities in the MySQL searchable documentation at
http://www.mysql.com/php/manual.php3?section=Privilege_system .
</P
></LI
><LI
><P
>You should now be at a prompt that looks like
this:</P
><P
><TT
CLASS="prompt"
>mysql></TT
></P
><P
>At the prompt, if <SPAN
CLASS="QUOTE"
>"bugs"</SPAN
> is the name
you chose in the<TT
CLASS="filename"
>localconfig</TT
> file
for your Bugzilla database, type:</P
><P
><TT
CLASS="prompt"
>mysql</TT
><B
CLASS="command"
>use bugs;</B
></P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Don't forget the <SPAN
CLASS="QUOTE"
>";"</SPAN
> at the end of
each line, or you'll be kicking yourself later.</P
></TD
></TR
></TABLE
></DIV
></LI
></OL
>
</P
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="AEN2369"
>C.2.1.1. Bugzilla Database Tables</A
></H3
><P
> Imagine your MySQL database as a series of
spreadsheets, and you won't be too far off. If you use this
command:</P
><P
><TT
CLASS="prompt"
>mysql></TT
><B
CLASS="command"
>show tables from bugs;</B
></P
><P
>you'll be able to see all the
<SPAN
CLASS="QUOTE"
>"spreadsheets"</SPAN
> (tables) in your database. It
is similar to a file system, only faster and more robust for
certain types of operations.</P
><P
>From the command issued above, ou should have some
output that looks like this:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> +-------------------+
| Tables in bugs |
+-------------------+
| attachments |
| bugs |
| bugs_activity |
| cc |
| components |
| dependencies |
| fielddefs |
| groups |
| keyworddefs |
| keywords |
| logincookies |
| longdescs |
| milestones |
| namedqueries |
| products |
| profiles |
| profiles_activity |
| shadowlog |
| tokens |
| versions |
| votes |
| watch |
+-------------------+
</PRE
></FONT
></TD
></TR
></TABLE
></P
><P
CLASS="literallayout"
><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
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="granttables"
>C.3. MySQL Permissions & Grant Tables</A
></H1
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>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 : ) Although it is of limited use, it
still has SOME use, thus it's still included.</P
><P
> Please note, however, that I was a relatively new user to
MySQL at the time. Some of my suggestions, particularly in
how to set up security, showed a terrible lack of
security-related database experience.
</P
></TD
></TR
></TABLE
></DIV
><P
CLASS="literallayout"
><br>
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>
</P
></DIV
></DIV
><DIV
CLASS="appendix"
><HR><H1
><A
NAME="patches"
>Appendix D. Useful Patches and Utilities for Bugzilla</A
></H1
><P
>Are you looking for a way to put your Bugzilla into overdrive? Catch some of the niftiest tricks here in this section.</P
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="rewrite"
>D.1. Apache <TT
CLASS="filename"
>mod_rewrite</TT
> magic</A
></H1
><P
>Apache's <TT
CLASS="filename"
>mod_rewrite</TT
> module lets you do some truly amazing things with URL rewriting. Here are a couple of examples of what you can do.</P
><P
></P
><OL
TYPE="1"
><LI
><P
> Make it so if someone types
<TT
CLASS="computeroutput"
>http://www.foo.com/12345</TT
>,
Bugzilla spits back
http://www.foo.com/show_bug.cgi?id=12345. Try setting up
your VirtualHost section for Bugzilla with a rule like
this:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>
<VirtualHost 12.34.56.78>
RewriteEngine On
RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</VirtualHost>
</PRE
></FONT
></TD
></TR
></TABLE
></LI
><LI
><P
>There are many, many more things you can do with
mod_rewrite. As time goes on, I will include many more in
the Guide. For now, though, please refer to the mod_rewrite
documentation at <A
HREF="http://www.apache.org"
TARGET="_top"
>http://www.apache.org</A
></P
></LI
></OL
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="setperl"
>D.2. 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="AEN2448"
></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.3. 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.4. 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
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="bzhacking"
>D.5. Hacking Bugzilla</A
></H1
><P
> The following is a guide for reviewers when checking code into Bugzilla's
CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,
you should follow the rules and style conventions below. Any code that
does not adhere to these basic rules will not be added to Bugzilla's
codebase.
</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN2504"
>D.5.1. Things that have caused problems and should be avoided</A
></H2
><P
></P
><OL
TYPE="1"
><LI
><P
> Usage of variables in Regular Expressions
</P
><P
> It is very important that you don't use a variable in a regular
expression unless that variable is supposed to contain an expression.
This especially applies when using grep. You should use:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> grep ($_ eq $value, @array);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> -- NOT THIS --
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> grep (/$value/, @array);
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> If you need to use a non-expression variable inside of an expression, be
sure to quote it properly (using <TT
CLASS="function"
>\Q..\E</TT
>).
</P
></TD
></TR
></TABLE
></DIV
></LI
></OL
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN2518"
>D.5.2. Coding Style for Bugzilla</A
></H2
><P
> While it's true that not all of the code currently in Bugzilla adheres to
this (or any) styleguide, it is something that is being worked toward. Therefore,
we ask that all new code (submitted patches and new files) follow this guide
as closely as possible (if you're only changing 1 or 2 lines, you don't have
to reformat the entire file :).
</P
><P
> The Bugzilla development team has decided to adopt the perl style guide as
published by Larry Wall. This giude can be found in <SPAN
CLASS="QUOTE"
>"Programming
Perl"</SPAN
> (the camel book) or by typing <B
CLASS="command"
>man perlstyle</B
> at
your favorite shell prompt.
</P
><P
> What appears below if a brief summary, please refer to the perl style
guide if you don't see your question covered here. It is much better to submit
a patch which fails these criteria than no patch at all, but please try to meet
these minimum standards when submitting code to Bugzilla.
</P
><P
></P
><UL
><LI
><P
> Whitespace
</P
><P
> Bugzilla's preferred indentation is 4 spaces (no tabs, please).
</P
></LI
><LI
><P
> Curly braces.
</P
><P
> The opening brace of a block should be on the same line as the statement
that is causing the block and the closing brace should be at the same
indentation level as that statement, for example:
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> if ($var) {
print "The variable is true";
}
else {
print "Try again";
}
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
><P
> -- NOT THIS --
</P
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
> if ($var)
{
print "The variable is true";
}
else
{
print "Try again";
}
</PRE
></FONT
></TD
></TR
></TABLE
>
</P
></LI
><LI
><P
> Cookies
</P
><P
> Bugzilla uses cookies to ease the user experience, but no new patches
should <EM
>require</EM
> user-side cookies.
</P
></LI
><LI
><P
> File Names
</P
><P
> File names for bugzilla code and support documention should be legal across
multiple platforms. <TT
CLASS="computeroutput"
>\ / : * ? " < ></TT
>
and <TT
CLASS="computeroutput"
>|</TT
> are all illegal characters for filenames
on various platforms. Also, file names should not have spaces in them as they
can cause confusion in CVS and other mozilla.org utilities.
</P
></LI
><LI
><P
> Javascript dependencies
</P
><P
> While Bugzilla uses Javascript to make the user experience easier, no patch
to Bugzilla should <EM
>require</EM
> Javascript.
</P
></LI
><LI
><P
> Patch Format
</P
><P
> All patches submitted for inclusion into Bugzilla should be in the form of a
<SPAN
CLASS="QUOTE"
>"unified diff"</SPAN
>. This comes from using <SPAN
CLASS="QUOTE"
>"diff -u"</SPAN
>
instead of simply <SPAN
CLASS="QUOTE"
>"diff"</SPAN
> when creating your patch. This will
result in quicker acceptance of the patch.
</P
></LI
><LI
><P
> Schema Changes
</P
><P
> If you make schema changes, you should modify <TT
CLASS="filename"
>sanitycheck.cgi</TT
>
to support the new schema. All referential columns should be checked.
</P
></LI
><LI
><P
> Taint Mode
</P
><P
> All new cgis must run in Taint mode (Perl taint and DBI taint), and existing cgi's
which run in taint mode must not have taint mode turned off.
</P
></LI
><LI
><P
> Templatization
</P
><P
> Patches to Bugzilla need to support templates so they do not force user interface choices
on Bugzilla administrators.
</P
></LI
><LI
><P
> Variable Names
</P
><P
> If a variable is scoped globally (<TT
CLASS="computeroutput"
>$::variable</TT
>)
its name should be descriptive of what it contains. Local variables can be named
a bit looser, provided the context makes their content obvious. For example,
<TT
CLASS="computeroutput"
>$ret</TT
> could be used as a staging variable for a
routine's return value as the line <TT
CLASS="computeroutput"
>return $ret;</TT
>
will make it blatantly obvious what the variable holds and most likely be shown
on the same screen as <TT
CLASS="computeroutput"
>my $ret = "";</TT
>.
</P
></LI
><LI
><P
> Cross Database Compatability
</P
><P
> Bugzilla was originally written to work with MySQL and therefore took advantage
of some of its features that aren't contained in other RDBMS software. These
should be avoided in all new code. Examples of these features are enums and
<TT
CLASS="function"
>encrypt()</TT
>.
</P
></LI
><LI
><P
> Cross Platform Compatability
</P
><P
> While Bugzilla was written to be used on Unix based systems (and Unix/Linux is
still the only officially supported platform) there are many who desire/need to
run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive
not to make the lives of these people any more complicated and avoid doing things
that break Bugzilla's ability to run on multiple operating systems.
</P
></LI
></UL
></DIV
></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="AEN2583"
></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="AEN2673"
></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="AEN2678"
>0-9, high ascii</A
></H1
><DL
><DT
><B
>.htaccess</B
></DT
><DD
><P
> Apache web server, and other NCSA-compliant web servers,
observe the convention of using files in directories
called <TT
CLASS="filename"
>.htaccess</TT
> files. These
restrict parameters of the web server. In Bugzilla, they
are used to restrict access to certain files which would
otherwise compromise your installation. For instance, the
<TT
CLASS="filename"
>localconfig</TT
> file contains the
password to your database. If this information were
generally available, and remote access to your database
turned on, you risk corruption of your database by
computer criminals or the curious.
</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-a"
>A</A
></H1
><DL
><DT
><B
>Apache</B
></DT
><DD
><P
>In this context, Apache is the web server most
commonly used for serving up
<I
CLASS="glossterm"
>Bugzilla</I
> pages. Contrary to
popular belief, the apache web server has nothing to do
with the ancient and noble Native American tribe, but
instead derived its name from the fact that it was
<SPAN
CLASS="QUOTE"
>"a patchy"</SPAN
> version of the original
<SPAN
CLASS="acronym"
>NCSA</SPAN
> world-wide-web server.</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 <SPAN
CLASS="QUOTE"
>"Bug"</SPAN
> in Bugzilla refers to an issue
entered into the database which has an associated number,
assignments, comments, etc. Some also refer to a
<SPAN
CLASS="QUOTE"
>"tickets"</SPAN
> or <SPAN
CLASS="QUOTE"
>"issues"</SPAN
>; in the
context of Bugzilla, 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 <SPAN
CLASS="QUOTE"
>"closed bug"</SPAN
>, including
acceptance, resolution, and verification. The <SPAN
CLASS="QUOTE"
>"Bug
Life Cycle"</SPAN
> is moderately flexible according to
the needs of the organization using it, though.</P
></DD
><DT
><B
>Bugzilla</B
></DT
><DD
><P
> Bugzilla is the industry-standard bug tracking system. It
is quite popular among Open Source enthusiasts.
</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-c"
></A
></H1
><DL
><DT
><A
NAME="gloss-component"
><B
>Component</B
></A
></DT
><DD
><P
> A Component is a subsection of a Product. It should be a
narrow category, tailored to your organization. All
Products must contain at least one Component (and, as a
matter of fact, creating a Product with no Components will
create an error in Bugzilla).
</P
></DD
><DT
><A
NAME="gloss-cpan"
><B
><SPAN
CLASS="acronym"
>CPAN</SPAN
></B
></A
></DT
><DD
><P
><SPAN
CLASS="acronym"
>CPAN</SPAN
> stands for the
<SPAN
CLASS="QUOTE"
>"Comprehensive Perl Archive Network"</SPAN
>. CPAN
maintains a large number of extremely useful
<I
CLASS="glossterm"
>Perl</I
> modules. By themselves, Perl
modules generally do nothing, but when used as part of a
larger program, they provide much-needed algorithms and
functionality.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-d"
>D</A
></H1
><DL
><DT
><B
>daemon</B
></DT
><DD
><P
>A daemon is a computer program which runs in the
background. In general, most daemons are started at boot
time via System V init scripts, or through RC scripts on
BSD-based systems. <I
CLASS="glossterm"
>mysqld</I
>, the
MySQL server, and <I
CLASS="glossterm"
>apache</I
>, a web
server, are generally run as daemons.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-g"
></A
></H1
><DL
><DT
><B
>Groups</B
></DT
><DD
><P
>The word <SPAN
CLASS="QUOTE"
>"Groups"</SPAN
> has a very special
meaning to Bugzilla. Bugzilla's main security mechanism
comes by lumping users into groups, and assigning those
groups certain privileges to
<I
CLASS="glossterm"
>Products</I
> and
<I
CLASS="glossterm"
>Components</I
> in the
<I
CLASS="glossterm"
>Bugzilla</I
> database.</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
>A loop of information that never ends; see recursion.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-m"
>M</A
></H1
><DL
><DT
><B
>mysqld</B
></DT
><DD
><P
>mysqld is the name of the
<I
CLASS="glossterm"
>daemon</I
> for the MySQL database. In
general, it is invoked automatically through the use of
the System V init scripts on GNU/Linux and AT&T System
V-based systems, such as Solaris and HP/UX, or through the
RC scripts on BSD-based systems.</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="AEN2769"
></A
><P
><B
>Example 1. A Sample Product</B
></P
><P
>A company sells a software product called
<SPAN
CLASS="QUOTE"
>"X"</SPAN
>. They also maintain some older
software called <SPAN
CLASS="QUOTE"
>"Y"</SPAN
>, and have a secret
project <SPAN
CLASS="QUOTE"
>"Z"</SPAN
>. An effective use of Products
might be to create Products <SPAN
CLASS="QUOTE"
>"X"</SPAN
>,
<SPAN
CLASS="QUOTE"
>"Y"</SPAN
>, <SPAN
CLASS="QUOTE"
>"Z"</SPAN
>, each with Components
of User Interface, Database, and Business Logic. They
might also change group permissions so that only those
people who are members of Group <SPAN
CLASS="QUOTE"
>"Z"</SPAN
> can see
components and bugs under Product
<SPAN
CLASS="QUOTE"
>"Z"</SPAN
>.</P
></DIV
></DD
><DT
><B
>Perl</B
></DT
><DD
><P
>First written by Larry Wall, Perl is a remarkable
program language. It has the benefits of the flexibility
of an interpreted scripting language (such as shell
script), combined with the speed and power of a compiled
language, such as C. <I
CLASS="glossterm"
>Bugzilla</I
> is
maintained in Perl.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-q"
>Q</A
></H1
><DL
><DT
><B
>QA</B
></DT
><DD
><P
><SPAN
CLASS="QUOTE"
>"QA"</SPAN
>, <SPAN
CLASS="QUOTE"
>"Q/A"</SPAN
>, and
<SPAN
CLASS="QUOTE"
>"Q.A."</SPAN
> are short for <SPAN
CLASS="QUOTE"
>"Quality
Assurance"</SPAN
>. 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
<SPAN
CLASS="QUOTE"
>"QA Contact"</SPAN
> field in a Bug.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-r"
>R</A
></H1
><DL
><DT
><A
NAME="gloss-recursion"
><B
>Recursion</B
></A
></DT
><DD
><P
>The property of a function looking back at itself for
something. <SPAN
CLASS="QUOTE"
>"GNU"</SPAN
>, for instance, stands for
<SPAN
CLASS="QUOTE"
>"GNU's Not UNIX"</SPAN
>, thus recursing upon itself
for definition. For further clarity, see Infinite
Loop.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-s"
>S</A
></H1
><DL
><DT
><B
><SPAN
CLASS="acronym"
>SGML</SPAN
></B
></DT
><DD
><P
><SPAN
CLASS="acronym"
>SGML</SPAN
> stands for <SPAN
CLASS="QUOTE"
>"Standard
Generalized Markup Language"</SPAN
>. Created in the
1980's to provide an extensible means to maintain
documentation based upon content instead of presentation,
<SPAN
CLASS="acronym"
>SGML</SPAN
> has withstood the test of time as
a robust, powerful language.
<I
CLASS="glossterm"
><SPAN
CLASS="acronym"
>XML</SPAN
></I
> is the
<SPAN
CLASS="QUOTE"
>"baby brother"</SPAN
> of SGML; any valid
<SPAN
CLASS="acronym"
>XML</SPAN
> document it, by definition, a valid
<SPAN
CLASS="acronym"
>SGML</SPAN
> document. The document you are
reading is written and maintained in
<SPAN
CLASS="acronym"
>SGML</SPAN
>, and is also valid
<SPAN
CLASS="acronym"
>XML</SPAN
> if you modify the Document Type
Definition.</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-t"
>T</A
></H1
><DL
><DT
><A
NAME="gloss-target-milestone"
><B
>Target Milestone</B
></A
></DT
><DD
><P
> Target Milestones are Product goals. They are
configurable on a per-Product basis. Most software
development houses have a concept of
<SPAN
CLASS="QUOTE"
>"milestones"</SPAN
> where the people funding a
project expect certain functionality on certain dates.
Bugzilla facilitates meeting these milestones by giving
you the ability to declare by which milestone a bug will be
fixed, or an enhancement will be implemented.
</P
></DD
></DL
></DIV
><DIV
CLASS="glossdiv"
><H1
CLASS="glossdiv"
><A
NAME="gloss-z"
>Z</A
></H1
><DL
><DT
><A
NAME="zarro-boogs-found"
><B
>Zarro Boogs Found</B
></A
></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
>