diff options
| author | gerv%gerv.net <> | 2002-07-28 07:00:17 +0200 |
|---|---|---|
| committer | gerv%gerv.net <> | 2002-07-28 07:00:17 +0200 |
| commit | d8caf6045d10344c431918128e3803ca497565f3 (patch) | |
| tree | 1b2fbc50e442b6413a4ef0949e8ff7eed1df1361 /docs | |
| parent | a9bb18746686c1bf5497e27f7ac2e12d0e3fc31a (diff) | |
| download | bugzilla-d8caf6045d10344c431918128e3803ca497565f3.tar.gz bugzilla-d8caf6045d10344c431918128e3803ca497565f3.tar.xz | |
Merging new docs from 2.16 branch.
Diffstat (limited to 'docs')
104 files changed, 22087 insertions, 36197 deletions
diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index fe393753a..66bb333ec 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -43,166 +43,34 @@ NAME="AEN2">The Bugzilla Guide</H1 ><H3 CLASS="author" ><A -NAME="AEN27">Matthew P. Barnson</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 -><P -CLASS="pubdate" ->2001-04-25<BR></P -><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 +NAME="AEN5">Matthew P. Barnson</H3 +><H3 +CLASS="author" +><A +NAME="AEN9">The Bugzilla Team</H3 ><DIV ><DIV CLASS="abstract" ><A -NAME="AEN39"><P +NAME="AEN13"><P ></P ><P -> This is the documentation for Bugzilla, the Mozilla - bug-tracking system. +> This is the documentation for Bugzilla, the mozilla.org + bug-tracking system. + Bugzilla is an enterprise-class piece of software + that powers issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. </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! +> + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or SGML diffs, attached + to a bug filed in + <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation" +TARGET="_top" +>mozilla.org's Bugzilla</A +>. </P ><P ></P @@ -225,46 +93,26 @@ HREF="#about" ><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 +>1.2. <A HREF="#disclaimer" >Disclaimer</A ></DT ><DT ->1.4. <A +>1.3. <A HREF="#newversions" >New Versions</A ></DT ><DT ->1.5. <A +>1.4. <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 +>1.5. <A HREF="#conventions" >Document Conventions</A ></DT @@ -272,8 +120,8 @@ HREF="#conventions" ></DD ><DT >2. <A -HREF="#using" ->Using Bugzilla</A +HREF="#introduction" +>Introduction</A ></DT ><DD ><DL @@ -287,162 +135,117 @@ HREF="#whatis" HREF="#why" >Why Should We Use Bugzilla?</A ></DT -><DT ->2.3. <A -HREF="#how" ->How do I use Bugzilla?</A -></DT -><DT ->2.4. <A -HREF="#init4me" ->Where can I find my user preferences?</A -></DT -><DT ->2.5. <A -HREF="#usingbz-conc" ->Using Bugzilla-Conclusion</A -></DT ></DL ></DD ><DT >3. <A -HREF="#installation" ->Installation</A +HREF="#using" +>Using Bugzilla</A ></DT ><DD ><DL ><DT >3.1. <A -HREF="#errata" ->ERRATA</A +HREF="#how" +>How do I use Bugzilla?</A ></DT ><DT >3.2. <A -HREF="#stepbystep" ->Step-by-step Install</A +HREF="#hintsandtips" +>Hints and Tips</A ></DT ><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 -><DT ->3.6. <A -HREF="#win32" ->Win32 Installation Notes</A +HREF="#userpreferences" +>User Preferences</A ></DT ></DL ></DD ><DT >4. <A -HREF="#administration" ->Administering Bugzilla</A +HREF="#installation" +>Installation</A ></DT ><DD ><DL ><DT >4.1. <A -HREF="#postinstall-check" ->Post-Installation Checklist</A +HREF="#stepbystep" +>Step-by-step Install</A ></DT ><DT >4.2. <A -HREF="#useradmin" ->User Administration</A +HREF="#extraconfig" +>Optional Additional Configuration</A ></DT ><DT >4.3. <A -HREF="#programadmin" ->Product, Component, Milestone, and Version - Administration</A +HREF="#win32" +>Win32 Installation Notes</A ></DT ><DT >4.4. <A -HREF="#security" ->Bugzilla Security</A +HREF="#osx" +>Mac OS X Installation Notes</A +></DT +><DT +>4.5. <A +HREF="#troubleshooting" +>Troubleshooting</A ></DT ></DL ></DD ><DT >5. <A -HREF="#integration" ->Integrating Bugzilla with Third-Party Tools</A +HREF="#administration" +>Administering Bugzilla</A ></DT ><DD ><DL ><DT >5.1. <A -HREF="#bonsai" ->Bonsai</A +HREF="#parameters" +>Bugzilla Configuration</A ></DT ><DT >5.2. <A -HREF="#cvs" ->CVS</A +HREF="#useradmin" +>User Administration</A ></DT ><DT >5.3. <A -HREF="#scm" ->Perforce SCM</A +HREF="#programadmin" +>Product, Component, Milestone, and Version Administration</A ></DT ><DT >5.4. <A -HREF="#tinderbox" ->Tinderbox/Tinderbox2</A +HREF="#voting" +>Voting</A ></DT -></DL -></DD ><DT ->6. <A -HREF="#future" ->The Future of Bugzilla</A +>5.5. <A +HREF="#groups" +>Groups and Group Security</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 +>5.6. <A +HREF="#security" +>Bugzilla Security</A ></DT ><DT ->7.4. <A -HREF="#variant-scarab" ->Scarab</A +>5.7. <A +HREF="#cust-templates" +>Template Customisation</A ></DT ><DT ->7.5. <A -HREF="#variant-perforce" ->Perforce SCM</A +>5.8. <A +HREF="#upgrading" +>Upgrading to New Releases</A ></DT ><DT ->7.6. <A -HREF="#variant-sourceforge" ->SourceForge</A +>5.9. <A +HREF="#integration" +>Integrating Bugzilla with Third-Party Tools</A ></DT ></DL ></DD @@ -453,136 +256,84 @@ HREF="#faq" ></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 +>B.1. <A HREF="#dbschema" >Database Schema Chart</A ></DT ><DT ->C.2. <A +>B.2. <A HREF="#dbdoc" >MySQL Bugzilla Database Introduction</A ></DT -><DT ->C.3. <A -HREF="#granttables" ->MySQL Permissions & Grant Tables</A -></DT ></DL ></DD ><DT ->D. <A +>C. <A HREF="#patches" >Useful Patches and Utilities for Bugzilla</A ></DT ><DD ><DL ><DT ->D.1. <A +>C.1. <A HREF="#rewrite" ->Apache <TT +>Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</A -></DT -><DT ->D.2. <A -HREF="#setperl" ->The setperl.csh Utility</A +> + + magic</A ></DT ><DT ->D.3. <A +>C.2. <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 ></DL ></DD ><DT ->E. <A -HREF="#gfdl" ->GNU Free Documentation License</A +>D. <A +HREF="#variants" +>Bugzilla Variants and Competitors</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 +>D.1. <A +HREF="#rhbugzilla" +>Red Hat Bugzilla</A ></DT ><DT ->7. <A -HREF="#gfdl-7" ->AGGREGATION WITH INDEPENDENT WORKS</A +>D.2. <A +HREF="#variant-fenris" +>Loki Bugzilla (Fenris)</A ></DT ><DT ->8. <A -HREF="#gfdl-8" ->TRANSLATION</A +>D.3. <A +HREF="#variant-issuezilla" +>Issuezilla</A ></DT ><DT ->9. <A -HREF="#gfdl-9" ->TERMINATION</A +>D.4. <A +HREF="#variant-scarab" +>Scarab</A ></DT ><DT ->10. <A -HREF="#gfdl-10" ->FUTURE REVISIONS OF THIS LICENSE</A +>D.5. <A +HREF="#variant-perforce" +>Perforce SCM</A ></DT ><DT -><A -HREF="#gfdl-howto" ->How to use this License for your documents</A +>D.6. <A +HREF="#variant-sourceforge" +>SourceForge</A ></DT ></DL ></DD @@ -602,86 +353,22 @@ CLASS="LOT" >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="#AEN709" ->Setting up bonsaitools symlink</A -></DT -><DT ->3-2. <A -HREF="#AEN800" ->Running checksetup.pl as the web user</A -></DT -><DT ->3-3. <A -HREF="#AEN1051" ->Installing ActivePerl ppd Modules on Microsoft Windows</A -></DT -><DT ->3-4. <A -HREF="#AEN1064" ->Installing OpenInteract ppd Modules manually on Microsoft - Windows</A -></DT -><DT ->3-5. <A -HREF="#AEN1246" ->Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</A -></DT -><DT >4-1. <A -HREF="#AEN1483" ->Creating some Components</A +HREF="#AEN989" +>Installing ActivePerl ppd Modules on Microsoft + Windows</A ></DT ><DT >4-2. <A -HREF="#AEN1512" ->Common Use of Versions</A +HREF="#AEN1002" +>Installing OpenInteract ppd Modules manually on Microsoft + Windows</A ></DT ><DT >4-3. <A -HREF="#AEN1516" ->A Different Use of Versions</A -></DT -><DT ->4-4. <A -HREF="#AEN1544" ->Using SortKey with Target Milestone</A -></DT -><DT ->4-5. <A -HREF="#AEN1580" ->When to Use Group Security</A -></DT -><DT ->4-6. <A -HREF="#AEN1597" ->Creating a New Group</A -></DT -><DT ->4-7. <A -HREF="#AEN1614" ->Bugzilla Groups</A -></DT -><DT ->D-1. <A -HREF="#AEN2461" ->Using Setperl to set your perl path</A -></DT -><DT ->1. <A -HREF="#AEN2782" ->A Sample Product</A +HREF="#AEN1184" +>Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</A ></DT ></DL ></DIV @@ -695,79 +382,9 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="aboutthisguide">1.1. Purpose and Scope of this Guide</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.bugzilla.org/" -TARGET="_top" ->http://www.bugzilla.org/</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</H1 +NAME="copyright">1.1. Copyright Information</H1 ><A -NAME="AEN70"><TABLE +NAME="AEN31"><TABLE BORDER="0" WIDTH="100%" CELLSPACING="0" @@ -787,8 +404,7 @@ VALIGN="TOP" 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". + the license is included below. </P ></TD ><TD @@ -803,7 +419,7 @@ ALIGN="RIGHT" VALIGN="TOP" >--<SPAN CLASS="attribution" ->Copyright (c) 2000-2001 Matthew P. Barnson</SPAN +>Copyright (c) 2000-2002 Matthew P. Barnson and The Bugzilla Team</SPAN ></TD ><TD WIDTH="10%" @@ -813,24 +429,494 @@ WIDTH="10%" ><P > If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact Matthew P. Barnson. + please contact The Bugzilla Team. </P +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="gfdl">1.1.1. GNU Free Documentation License</H2 +><P +>Version 1.1, March 2000</P +><A +NAME="AEN38"><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-0">0. PREAMBLE</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-1">1. APPLICABILITY AND DEFINITIONS</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-2">2. VERBATIM COPYING</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-3">3. COPYING IN QUANTITY</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-4">4. MODIFICATIONS</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-5">5. COMBINING DOCUMENTS</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-6">6. COLLECTIONS OF DOCUMENTS</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-7">7. AGGREGATION WITH INDEPENDENT WORKS</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-8">8. TRANSLATION</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-9">9. TERMINATION</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-10">10. FUTURE REVISIONS OF THIS LICENSE</H3 +><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="section" +><HR><H3 +CLASS="section" +><A +NAME="gfdl-howto">How to use this License for your documents</H3 +><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="AEN128"><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 ><DIV CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="disclaimer">1.3. Disclaimer</H1 +NAME="disclaimer">1.2. Disclaimer</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. + This document may contain errors + and inaccuracies that may damage your system, cause your partner + to leave you, your boss to fire you, your cats to + pee on your furniture and clothing, and global thermonuclear + war. Proceed with caution. </P ><P > All copyrights are held by their respective owners, unless @@ -840,7 +926,7 @@ NAME="disclaimer">1.3. Disclaimer</H1 </P ><P > Naming of particular products or brands should not be seen as - endorsements, with the exception of the term "GNU/Linux". I + endorsements, with the exception of the term "GNU/Linux". We 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 @@ -849,8 +935,7 @@ NAME="disclaimer">1.3. Disclaimer</H1 ><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! + If you implement any suggestion in this Guide, implement this one! </P ><P > Although the Bugzilla development team has taken great care to @@ -862,7 +947,7 @@ NAME="disclaimer">1.3. Disclaimer</H1 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 + product, and are responsible for auditing it yourself to ensure your security needs are met. </P ></DIV @@ -871,9 +956,10 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="newversions">1.4. New Versions</H1 +NAME="newversions">1.3. New Versions</H1 ><P -> This is the 2.14 version of The Bugzilla Guide. If you are +> This is the 2.16 version of The Bugzilla Guide. It is so named + to match the current version of Bugzilla. 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. @@ -888,18 +974,9 @@ NAME="newversions">1.4. New Versions</H1 ><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/" +HREF="http://www.bugzilla.org/" TARGET="_top" ->Mozilla.org</A +>bugzilla.org</A > </P ></LI @@ -917,12 +994,27 @@ TARGET="_top" > </P ><P -> The latest version of this document can be checked out via CVS. - Please follow the instructions available at <A +> The latest version of this document can always 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. +>, + and check out the <TT +CLASS="filename" +>mozilla/webtools/bugzilla/docs/</TT +> + subtree. + </P +><P +> The Bugzilla Guide is currently only available in English. + If you would like to volunteer to translate it, please contact + <A +HREF="mailto:justdave@syndicomm.com" +TARGET="_top" +>Dave Miller</A +>. </P ></DIV ><DIV @@ -930,15 +1022,24 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="credits">1.5. Credits</H1 +NAME="credits">1.4. Credits</H1 ><P > The people listed below have made enormous contributions to the - creation of this Guide, through their dedicated hacking efforts, + creation of this Guide, through their writing, dedicated hacking efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: </P ><P > <A +HREF="mailto://mbarnson@sisna.com" +TARGET="_top" +>Matthew P. Barnson</A +> + for the Herculaean task of pulling together the Bugzilla Guide and + shepherding it to 2.14. + </P +><P +> <A HREF="mailto://terry@mozilla.org" TARGET="_top" >Terry Weissman</A @@ -950,18 +1051,18 @@ TARGET="_top" > <A HREF="mailto://tara@tequilarista.org" TARGET="_top" ->Tara - Hernandez</A -> for keeping Bugzilla development going - strong after Terry left Mozilla.org +>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 +> + for providing insight into the key differences between Red Hat's customized Bugzilla, and being largely responsible for the "Red Hat Bugzilla" appendix </P @@ -975,26 +1076,20 @@ TARGET="_top" questions and arguments on irc.mozilla.org in #mozwebtools </P ><P -> Last but not least, all the members of the <A +> 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</H1 ><P -> Thanks go to these people for significant contributions to this - documentation (in no particular order): +> Thanks also go to the following 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 +> Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, + Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham. </P ></DIV ><DIV @@ -1002,61 +1097,13 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="feedback">1.7. Feedback</H1 +NAME="conventions">1.5. Document Conventions</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</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</H1 -><P -> This document uses the following conventions - </P +>This document uses the following conventions:</P ><DIV CLASS="informaltable" ><A -NAME="AEN129"><P +NAME="AEN178"><P ></P ><TABLE BORDER="0" @@ -1082,7 +1129,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="caution" ><P ></P @@ -1103,12 +1150,13 @@ ALT="Caution"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Warnings.</P +>Don't run with scissors!</P ></TD ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -1118,7 +1166,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="tip" ><P ></P @@ -1139,12 +1187,13 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Hint.</P +>Would you like a breath mint?</P ></TD ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -1154,7 +1203,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="note" ><P ></P @@ -1175,12 +1224,13 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Note.</P +>Dear John...</P ></TD ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -1190,7 +1240,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="warning" ><P ></P @@ -1211,12 +1261,13 @@ ALT="Warning"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Warning.</P +>Read this or the cat gets it.</P ></TD ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -1226,10 +1277,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="filename" ->file.extension</TT -></TD +>filename</TT +> + </TD ></TR ><TR ><TD @@ -1239,10 +1291,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="filename" >directory</TT -></TD +> + </TD ></TR ><TR ><TD @@ -1252,10 +1305,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><B +> <B CLASS="command" >command</B -></TD +> + </TD ></TR ><TR ><TD @@ -1265,19 +1319,22 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><SPAN +> <SPAN CLASS="application" >application</SPAN -></TD +> + </TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of users command under bash shell</TD +> + + of users command under bash shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -1287,10 +1344,12 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of root users command under bash shell</TD +> + + of root users command under bash shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -1300,10 +1359,12 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of user command under tcsh shell</TD +> + + of user command under tcsh shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -1317,10 +1378,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="envar" >VARIABLE</TT -></TD +> + </TD ></TR ><TR ><TD @@ -1330,9 +1392,10 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><EM +> <EM >word</EM -></TD +> + </TD ></TR ><TR ><TD @@ -1342,7 +1405,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1355,7 +1418,9 @@ CLASS="programlisting" ><TT CLASS="sgmltag" ><para></TT ->Beginning and end of paragraph<TT +> +Beginning and end of paragraph +<TT CLASS="sgmltag" ></para></TT ></PRE @@ -1363,7 +1428,8 @@ CLASS="sgmltag" ></TD ></TR ></TABLE -></TD +> + </TD ></TR ></TBODY ></TABLE @@ -1376,135 +1442,83 @@ CLASS="sgmltag" CLASS="chapter" ><HR><H1 ><A -NAME="using">Chapter 2. Using Bugzilla</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 +NAME="introduction">Chapter 2. Introduction</H1 ><DIV CLASS="section" -><HR><H1 +><H1 CLASS="section" ><A NAME="whatis">2.1. What is Bugzilla?</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. +> Bugzilla is a bug- or issue-tracking system. Bug-tracking + systems allow individual or groups of developers effectively to keep track + of outstanding problems with their product. + Bugzilla was originally + written by Terry Weissman in a programming language called TCL, to + replace a rudimentary bug-tracking database used internally by 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 +>Bugzilla boasts many advanced features. These include: + <P ></P ><UL ><LI ><P -> integrated, product-based granular security schema - </P +>Powerful searching</P ></LI ><LI ><P -> inter-bug dependencies and dependency graphing - </P +>User-configurable email notifications of bug changes</P ></LI ><LI ><P -> advanced reporting capabilities - </P +>Full change history</P ></LI ><LI ><P -> a robust, stable RDBMS back-end - </P +>Inter-bug dependency tracking and graphing</P ></LI ><LI ><P -> extensive configurability - </P +>Excellent attachment management</P ></LI ><LI ><P -> a very well-understood and well-thought-out natural bug resolution protocol - </P +>Integrated, product-based, granular security schema</P ></LI ><LI ><P -> email, XML, console, and HTTP APIs - </P +>Fully security-audited, and runs under Perl's taint mode</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 +>A robust, stable RDBMS back-end</P ></LI ><LI ><P -> too many more features to list - </P +>Web, XML, email and console interfaces</P ></LI -></UL -> - </P +><LI ><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 +>Completely customisable and/or localisable web user + interface</P +></LI +><LI ><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 +>Extensive configurability</P +></LI +><LI ><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. +>Smooth upgrade pathway between versions</P +></LI +></UL +> </P ></DIV ><DIV @@ -1513,194 +1527,112 @@ CLASS="section" CLASS="section" ><A NAME="why">2.2. Why Should We Use Bugzilla?</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 +>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 +> + + 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, NASA, Linux-Mandrake, and VA Systems. + Combined with systems such as + <A +HREF="http://www.cvshome.org" +TARGET="_top" +>CVS</A +>, + <A +HREF="http://www.mozilla.org/bonsai.html" +TARGET="_top" +>Bonsai</A +>, or + <A +HREF="http://www.perforce.com" +TARGET="_top" +>Perforce SCM</A +>, 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 +> + 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 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 +>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 ><DIV -CLASS="section" +CLASS="chapter" ><HR><H1 +><A +NAME="using">Chapter 3. Using Bugzilla</H1 +><DIV +CLASS="section" +><H1 CLASS="section" ><A -NAME="how">2.3. How do I use Bugzilla?</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 +NAME="how">3.1. How do I use Bugzilla?</H1 ><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" +>This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + <A +HREF="http://landfill.bugzilla.org/" 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 +>Landfill</A +>, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and 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</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/" +NAME="myaccount">3.1.1. Create a Bugzilla Account</H2 +><P +>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 Bugzilla, use this URL: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" TARGET="_top" -> http://landfill.tequilarista.org/bugzilla-tip/</A +> http://landfill.bugzilla.org/bugzilla-tip/</A > </P ><P @@ -1709,621 +1641,413 @@ TARGET="_top" 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 +>Click the + <SPAN +CLASS="QUOTE" +>"Open a new Bugzilla account"</SPAN +> + + link, enter your email address and, optionally, your name in the + spaces provided, then click + <SPAN +CLASS="QUOTE" +>"Create Account"</SPAN +> + + .</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 +>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 can be + changed to something more memorable.</P ></LI ><LI ><P -> Click the <SPAN +>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 + link in the yellow area at the bottom of the page in your browser, + enter your email address and password into the spaces provided, and + click + <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 + </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 +>You are now logged in. Bugzilla uses cookies for authentication + so, unless your IP address changes, you should not have to log in + again.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="query">2.3.2. The Bugzilla Query Page</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 +NAME="bug_page">3.1.2. Anatomy of a Bug</H2 ><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" +>The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1" 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 +> Bug 1 on Landfill</A > - 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 + + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla.</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"><P -><B ->Example 2-1. Some Famous Software Versions</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN309"><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"><P -><B ->Example 2-2. Mozilla's Bugzilla Components</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN319"><P -></P -><P -> Mozilla's "Bugzilla" Product is composed of several pieces (Components): - <P +> <EM +>Product and Component</EM +>: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + 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 +> <EM +>Administration:</EM +> + Administration of a Bugzilla installation.</TD ></TR ><TR ><TD -><EM ->Bugzilla-General</EM ->, - Anything that doesn't fit in the other components, or spans - multiple components. - </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 +> <EM +>Creating/Changing Bugs:</EM +> + Creating, changing, and viewing bugs.</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 +> <EM +>Documentation:</EM +> + The Bugzilla documentation, including The Bugzilla Guide.</TD ></TR ><TR ><TD -><EM ->Email</EM ->, - Anything to do with email sent by Bugzilla. - <TT -CLASS="filename" ->processmail</TT +> <EM +>Email:</EM > - </TD + Anything to do with email sent by Bugzilla.</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 +> <EM +>Installation:</EM +> + The installation process of Bugzilla.</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 +> <EM +>Query/Buglist:</EM > - </TD + Anything to do with searching for bugs and viewing the + buglists.</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 +> <EM +>Reporting/Charting:</EM > - </TD + Getting reports from Bugzilla.</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 +> <EM +>User Accounts:</EM +> + Anything about managing a user account from the user's perspective. + 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 +> <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 +></LI +><LI ><P -></P -></DIV -></DIV +> <EM +>Status and Resolution:</EM > - </P + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items.</P +></LI +><LI ><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 +> <EM +>Assigned To:</EM +> + The person responsible for fixing the bug.</P +></LI +><LI ><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 +> <EM +>*URL:</EM +> + A URL associated with the bug, if any.</P ></LI ><LI ><P -> OK, now let's select the "Bugzilla" component from its scrollbox. - </P +> <EM +>Summary:</EM +> + A one-sentence summary of the problem.</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 +> <EM +>*Status Whiteboard:</EM +> + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.</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 +> <EM +>*Keywords:</EM +> + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.</P +></LI +><LI +><P +> <EM +>Platform and OS:</EM +> + These indicate the computing environment where the bug was + found.</P +></LI +><LI +><P +> <EM +>Version:</EM +> + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about.</P +></LI +><LI +><P +> <EM +>Priority:</EM +> + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs.</P +></LI +><LI +><P +> <EM +>Severity:</EM +> + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request.</P +></LI +><LI +><P +> <EM +>*Target:</EM +> + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates.</P +></LI +><LI +><P +> <EM +>Reporter:</EM +> + The person who filed the bug.</P +></LI +><LI +><P +> <EM +>CC list:</EM +> + A list of people who get mail when the bug changes.</P +></LI +><LI +><P +> <EM +>Attachments:</EM +> + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.</P +></LI +><LI +><P +> <EM +>*Dependencies:</EM +> + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here.</P +></LI +><LI +><P +> <EM +>*Votes:</EM +> + Whether this bug has any votes.</P +></LI +><LI +><P +> <EM +>Additional Comments:</EM +> + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.</P ></LI ></OL +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="query">3.1.3. Searching for Bugs</H2 ><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 +>The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/query.cgi" +TARGET="_top" +> landfill.bugzilla.org/bugzilla-tip/query.cgi</A +> + + .</P +><P +>The Search page has controls for selecting different possible + values for all of the fields in a bug, as described above. Once you've + defined a search, you can either run it, or save it as a Remembered + Query, which can optionally appear in the footer of your pages.</P +><P +>Highly advanced querying is done using Boolean Charts, which have + their own + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html" +TARGET="_top" +> context-sensitive help</A +> + + .</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="list">3.1.4. Bug Lists</H2 +><P +>If you run a search, a list of matching bugs will be returned. + The default search is to return all open bugs on the system - don't try + running this search on a Bugzilla installation with a lot of + bugs!</P ><P -> A couple more interesting things about the Bug List page: - <P +>The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features can be + accessed using the links at the bottom of the list: + <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 +> <EM +>Long Format:</EM +> + + this gives you a large page with a non-editable summary of the fields + of each bug.</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 +> <EM +>Change Columns:</EM +> + + change the bug attributes which appear in the list.</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 +> <EM +>Change several bugs at once:</EM +> + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner.</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 +> <EM +>Send mail to bug owners:</EM +> + + Sends mail to the owners of all bugs on the list.</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 @@ -2331,485 +2055,290 @@ BORDER="0" ></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</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</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 +NAME="bugreports">3.1.5. Filing Bugs</H2 ><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" +>Years of bug writing experience has been distilled for your + reading pleasure into the + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html" TARGET="_top" -> http://www.mozilla.org/quality/help/beginning-duplicate-finding.html</A ->. - </P +> Bug Writing Guidelines</A +>. + While some of the advice is Mozilla-specific, the basic principles of + reporting Reproducible, Specific bugs, isolating the Product you are + using, the Version of the Product, the Component which failed, the + Hardware Platform, and Operating System you were using at the time of + the failure go a long way toward ensuring accurate, responsible fixes + for the bug that bit you.</P ><P -> 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 +>The procedure for filing a test bug is as follows:</P ><P ></P ><OL TYPE="1" ><LI ><P -> Go back to <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/" +>Go to + <A +HREF="http://landfill.bugzilla.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" +> Landfill</A +> + in your browser and click + <A +HREF="http://landfill.bugzilla.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 +> Enter a new bug report</A +>. + </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 +>Select a product - any one will do.</P ></LI ><LI ><P -> Leave the "CC" text box blank. Fill in the "URL" box - with "http://www.mozilla.org". - </P +>Fill in the fields. Bugzilla should have made reasonable + guesses, based upon your browser, for the "Platform" and "OS" + drop-down boxes. If they are wrong, change them.</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 +>Select "Commit" and send in your bug report.</P ></LI ></OL -><P -> Voila! Select "Commit" and send in your bug report! Next - we'll look at resolving bugs. - </P +></DIV ></DIV ><DIV CLASS="section" -><HR><H3 +><HR><H1 CLASS="section" ><A -NAME="bug-manage">2.3.3.2. Managing your Bug Reports</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 +NAME="hintsandtips">3.2. Hints and Tips</H1 ><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 +>This section distills some Bugzilla tips and best practices + that have been developed.</P ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="init4me">2.4. Where can I find my user preferences?</H1 +NAME="AEN434">3.2.1. Autolinkification</H2 +><P +>Bugzilla comments are plain text - so posting HTML will result + in literal HTML tags rather than being interpreted by a browser. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + http://www.bugzilla.org will be turned into + <A +HREF="http://www.bugzilla.org" +TARGET="_top" +>http://www.bugzilla.org</A +>. + Other strings which get linkified in the obvious manner are: + <P +></P ><TABLE BORDER="0" -WIDTH="100%" -CELLSPACING="0" -CELLPADDING="0" -CLASS="EPIGRAPH" +><TBODY ><TR ><TD -WIDTH="45%" -> </TD +>bug 12345</TD +></TR +><TR ><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 +>bug 23456, comment 53</TD +></TR +><TR +><TD +>attachment 4321</TD +></TR +><TR +><TD +>mailto:george@example.com</TD +></TR +><TR +><TD +>george@example.com</TD +></TR +><TR +><TD +>ftp://ftp.mozilla.org</TD ></TR +><TR +><TD +>Most other sorts of URL</TD +></TR +></TBODY ></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 +></P +> + </P +><P +>A corollary here is that if you type a bug number in a comment, + you should put the word "bug" before it, so it gets autolinkified + for the convenience of others. + </P +></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="accountsettings">2.4.1. Account Settings</H2 +NAME="quicksearch">3.2.2. Quicksearch</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. +>Quicksearch is a single-text-box query tool which uses + metacharacters to indicate what is to be searched. For example, typing + "<TT +CLASS="filename" +>foo|bar</TT +>" + into Quicksearch would search for "foo" or "bar" in the + summary and status whiteboard of a bug; adding + "<TT +CLASS="filename" +>:BazProduct</TT +>" would + search only in that product. </P +><P +>You'll find the Quicksearch box on Bugzilla's + front page, along with a + <A +HREF="../../quicksearch.html" +TARGET="_top" +>Help</A +> + link which details how to use it.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="emailsettings">2.4.2. Email Settings</H2 +NAME="commenting">3.2.3. Comments</H2 +><P +>If you are changing the fields on a bug, only comment if + either you have something pertinent to say, or Bugzilla requires it. + Otherwise, you may spam people unnecessarily with bug mail. + To take an example: a user can set up their account to filter out messages + where someone just adds themselves to the CC field of a bug + (which happens a lot.) If you come along, add yourself to the CC field, + and add a comment saying "Adding self to CC", then that person + gets a pointless piece of mail they would otherwise have avoided. + </P +><P +> Don't use sigs in comments. Signing your name ("Bill") is acceptable, + particularly if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. + </P +></DIV ><DIV CLASS="section" -><H3 +><HR><H2 CLASS="section" ><A -NAME="notification">2.4.2.1. Email Notification</H3 +NAME="attachments">3.2.4. Attachments</H2 ><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 +> Use attachments, rather than comments, for large chunks of ASCII data, + such as trace, debugging output files, or log files. That way, it doesn't + bloat the bug for everyone who wants to read it, and cause people to + receive fat, useless mails. + </P +><P +>Trim screenshots. There's no need to show the whole screen if + you are pointing out a single-pixel problem. + </P +><P +>Don't attach simple test cases (e.g. one HTML file, one + CSS file and an image) as a ZIP file. Instead, upload them in + reverse order and edit the referring file so that they point to the + attached files. This way, the test case works immediately + out of the bug. + </P ></DIV ><DIV CLASS="section" -><HR><H3 +><HR><H2 CLASS="section" ><A -NAME="newemailtech">2.4.2.2. New Email Technology</H3 -><DIV -CLASS="note" +NAME="AEN463">3.2.5. Filing Bugs</H2 ><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 +>Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + </P ><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 +> You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + </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 +>If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + </P +></DIV ></DIV ><DIV CLASS="section" -><HR><H3 +><HR><H1 CLASS="section" ><A -NAME="watchsettings">2.4.2.3. "Watching" Users</H3 -><DIV -CLASS="note" +NAME="userpreferences">3.3. User Preferences</H1 ><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 +>Once you have logged in, you can customise various aspects of + Bugzilla via the "Edit prefs" link in the page footer. + The preferences are split into four tabs:</P +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="accountsettings">3.3.1. Account Settings</H2 ><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 +>On this tab, you can change your basic account information, + including your password, email address and real 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" +>"Password"</SPAN +> + field at the top of the page. + If you attempt to change your email address, a confirmation + email is sent to both the old and new addresses, with a link to use to + confirm the change. This helps to prevent account hijacking.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="footersettings">2.4.3. Page Footer</H2 +NAME="emailsettings">3.3.2. Email Settings</H2 +><P +>On this tab you can reduce or increase the amount of email sent + you from Bugzilla, opting in our out depending on your relationship to + the bug and the change that was made to it. (Note that you can also do + client-side filtering using the X-Bugzilla-Reason header which Bugzilla + adds to all bugmail.)</P +><P +>By entering user email names, delineated by commas, into the + "Users to watch" text entry box you can receive a copy of all the + bugmail of other users (security settings permitting.) This powerful + functionality enables seamless transitions as developers change + projects or users go on holiday.</P ><DIV CLASS="note" ><P @@ -2831,58 +2360,9 @@ ALT="Note"></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 +>The ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator.</P ></TD ></TR ></TABLE @@ -2893,232 +2373,62 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="permissionsettings">2.4.4. Permissions</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 +NAME="footersettings">3.3.3. Page Footer</H2 +><P +>On the Search page, you can store queries in Bugzilla, so if you + regularly run a particular query it is just a drop-down menu away. + Once you have a stored query, you can come + here to request that it also be displayed in your page footer.</P ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="usingbz-conc">2.5. Using Bugzilla-Conclusion</H1 +NAME="permissionsettings">3.3.4. Permissions</H2 ><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 +>This is a purely informative page which outlines your current + permissions on this installation of Bugzilla - what product groups you + are in, and whether you can edit bugs or perform various administration + functions.</P +></DIV ></DIV ></DIV ><DIV CLASS="chapter" ><HR><H1 ><A -NAME="installation">Chapter 3. Installation</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 +NAME="installation">Chapter 4. Installation</H1 ><DIV CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="errata">3.1. ERRATA</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 +><H1 CLASS="section" ><A -NAME="stepbystep">3.2. Step-by-step Install</H1 +NAME="stepbystep">4.1. Step-by-step Install</H1 ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN509">3.2.1. Introduction</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 +NAME="AEN492">4.1.1. Introduction</H2 ><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 +>Bugzilla has been successfully installed under Solaris, Linux, + and Win32. Win32 is not yet officially supported, but many people + have got it working fine. + Please see 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 +> + for further advice on getting Bugzilla to work on Microsoft + Windows.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN515">3.2.2. Installing the Prerequisites</H2 +NAME="AEN496">4.1.2. Package List</H2 ><DIV CLASS="note" ><P @@ -3140,84 +2450,204 @@ ALT="Note"></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 +> If you are running the very most recent + version of Perl and MySQL (both the executables and development + libraries) on your system, you can skip these manual installation + steps for the Perl modules by using Bundle::Bugzilla; see + <A HREF="#bundlebugzilla" >Using Bundle::Bugzilla instead of manually installing Perl modules</A -></P +>. + </P ></TD ></TR ></TABLE ></DIV ><P -> The software packages necessary for the proper running of bugzilla are: - <P +>The software packages necessary for the proper running of + Bugzilla (with download links) are: + <P ></P ><OL TYPE="1" ><LI ><P -> MySQL database server and the mysql client (3.22.5 or greater) - </P +> <A +HREF="http://www.mysql.com/" +TARGET="_top" +>MySQL database server</A +> + (3.22.5 or greater) + </P +></LI +><LI +><P +> <A +HREF="http://www.perl.org" +TARGET="_top" +>Perl</A +> + (5.005 or greater, 5.6.1 is recommended if you wish to + use Bundle::Bugzilla) + </P +></LI +><LI +><P +>Perl Modules (minimum version): + <P +></P +><OL +TYPE="a" +><LI +><P +> <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template</A +> + (v2.07) + </P ></LI ><LI ><P -> Perl (5.004 or greater, 5.6.1 is recommended if you wish - to use Bundle::Bugzilla) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/AppConfig/" +TARGET="_top" +>AppConfig + </A +> + (v1.52) + </P ></LI ><LI ><P -> DBI Perl module - </P +> <A +HREF="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz" +TARGET="_top" +>Text::Wrap</A +> + (v2001.0131) + </P ></LI ><LI ><P -> Data::Dumper Perl module - </P +> <A +HREF="http://search.cpan.org/search?dist=File-Spec" +TARGET="_top" +>File::Spec + </A +> + (v0.8.2) + </P ></LI ><LI ><P -> Bundle::Mysql Perl module collection - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Data/" +TARGET="_top" +>Data::Dumper + </A +> + (any) + </P ></LI ><LI ><P -> TimeDate Perl module collection - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Mysql/" +TARGET="_top" +>DBD::mysql + </A +> + (v1.2209) + </P ></LI ><LI ><P -> GD perl module (1.8.3) (optional, for bug charting) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/DBI/" +TARGET="_top" +>DBI</A +> + (v1.13) + </P ></LI ><LI ><P -> Chart::Base Perl module (0.99c) (optional, for bug charting) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Date/" +TARGET="_top" +>Date::Parse + </A +> + (any) + </P +></LI +><LI +><P +> CGI::Carp + (any) + </P +></LI +></OL +> + and, optionally: + <P +></P +><OL +TYPE="a" +><LI +><P +> <A +HREF="http://www.cpan.org/modules/by-module/GD/" +TARGET="_top" +>GD</A +> + (v1.19) for bug charting + </P +></LI +><LI +><P +> <A +HREF="http://www.cpan.org/modules/by-module/Chart/" +TARGET="_top" +>Chart::Base + </A +> + (v0.99c) for bug charting + </P ></LI ><LI ><P -> DB_File Perl module (optional, for bug charting) - </P +> XML::Parser + (any) for the XML interface + </P ></LI ><LI ><P -> The web server of your choice. Apache is recommended. - </P +> MIME::Parser + (any) for the email interface + </P +></LI +></OL +> + </P ></LI ><LI ><P -> MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </P +> The web server of your choice. + <A +HREF="http://www.apache.org/" +TARGET="_top" +>Apache</A +> + is highly recommended. + </P ></LI ></OL > - <DIV + <DIV CLASS="warning" ><P ></P @@ -3238,24 +2668,20 @@ ALT="Warning"></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 +>It is a good idea, while installing Bugzilla, to ensure that there + is some kind of firewall between you and the rest of the Internet, + because your machine may be insecure for periods during the install. + 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 + + <DIV CLASS="note" ><P ></P @@ -3276,20 +2702,23 @@ ALT="Note"></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 +>Linux-Mandrake 8.0 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 +> + + 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 +> + + should not complain about any missing libraries. You may already have + some of these installed.</P ><P ></P ><TABLE @@ -3297,59 +2726,69 @@ BORDER="0" ><TBODY ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-mysql</B -></TD +>urpmi perl-mysql</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-chart</B -></TD +>urpmi perl-chart</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-gd</B -></TD +>urpmi perl-gd</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-MailTools</B -> (for Bugzilla email - integration)</TD +>urpmi perl-MailTools</B +> + + (for Bugzilla email integration)</TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - apache-modules</B -></TD +>urpmi apache-modules</B +> + </TD ></TR ></TBODY ></TABLE @@ -3360,7 +2799,6 @@ CLASS="command" ></TABLE ></DIV > - </P ></DIV ><DIV @@ -3368,31 +2806,17 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="install-mysql">3.2.3. Installing MySQL Database</H2 +NAME="install-mysql">4.1.3. MySQL</H2 ><P -> Visit MySQL homepage at <A +>Visit the 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 ->. +> + to grab and install the latest stable release of the server. </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 +><DIV CLASS="note" ><P ></P @@ -3413,138 +2837,91 @@ ALT="Note"></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 +> Many of the binary + versions of MySQL store their data files in + <TT CLASS="filename" ->mysqld</TT -> (or - <TT +>/var</TT +>. + On some Unix systems, this is part of a smaller root partition, + and may not have room for your bug database. You can set the data + directory as an option to <TT CLASS="filename" ->safe_mysqld</TT ->), then you will be able - to have attachments up to about 1 megabyte.</P +>configure</TT +> + if you build MySQL from source yourself.</P ></TD ></TR ></TABLE ></DIV +><P +>If you install from something other than an RPM or Debian + package, you will need to add <TT +CLASS="filename" +>mysqld</TT > - + 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. </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" +>Change your init script to start + <TT +CLASS="filename" +>mysqld</TT +> + 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. + There is a Bugzilla parameter for maximum attachment size; + you should configure it to match the value you choose here.</P ><P -> If you plan on running Bugzilla and MySQL on the same - machine, consider using the <TT +>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 + option in the init script. This enhances security by preventing + network access to MySQL.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="install-perl">3.2.4. Perl (5.004 or greater)</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 +NAME="install-perl">4.1.4. Perl</H2 ><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 +>Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from + <A +HREF="http://www.perl.com" +TARGET="_top" +>perl.com</A +> for the rare + *nix systems which don't have it. + Although Bugzilla runs with all post-5.005 + 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 ><DIV CLASS="tip" ><A @@ -3567,43 +2944,42 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can skip the following Perl module installation steps by - installing <SPAN +>You can skip the following Perl module installation steps by + installing + <SPAN CLASS="productname" >Bundle::Bugzilla</SPAN -> from - <A +> + + 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 +>, + which installs all required modules for you.</P ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT -> <B +> + + <B CLASS="command" ->perl -MCPAN - -e 'install "Bundle::Bugzilla"'</B +>perl -MCPAN -e 'install "Bundle::Bugzilla"'</B > - </TT + </TT > - </P + </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 +>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 @@ -3614,282 +2990,240 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN602">3.2.5. DBI Perl Module</H2 +NAME="perl-modules">4.1.5. Perl Modules</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 +> + All Perl modules can be found on the + <A +HREF="http://www.cpan.org" +TARGET="_top" +>Comprehensive Perl + Archive Network</A +> (CPAN). The + CPAN servers have a real tendency to bog down, so please use mirrors. + </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. +>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. + To use the CPAN shell to install a module: </P ><P -> To use the CPAN shell to install DBI: - <DIV -CLASS="informalexample" -><A -NAME="AEN609"><P -></P -><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + <B CLASS="command" ->perl -MCPAN -e 'install "DBI"'</B -> - </TT +>perl -MCPAN -e 'install "<modulename>"'</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 ->Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc.</P -></TD -></TR -></TABLE -></DIV + </TT > - </P + </P ><P -></P -></DIV -> - To do it the hard way: - <DIV -CLASS="informalexample" -><A -NAME="AEN616"><P -></P +> To do it the hard way: + </P ><P -> Untar the module tarball -- it should create its own directory - </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 +>CD to the directory just created, and enter the following + commands: + <P ></P ><OL TYPE="1" ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >perl Makefile.PL</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make test</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make install</B > - </TT + </TT > - </P + </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 +><DIV +CLASS="warning" ><P ></P -></DIV +><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 error 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 > - </P + 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="section" -><HR><H2 +><HR><H3 CLASS="section" ><A -NAME="AEN640">3.2.6. Data::Dumper Perl Module</H2 +NAME="AEN642">4.1.5.1. DBI</H3 ><P -> The Data::Dumper module provides data structure persistence for Perl - (similar to Java's serialization). It comes with later sub-releases of - Perl 5.004, but a re-installation just to be sure it's available won't - hurt anything. - </P +>The DBI module is a generic Perl module used 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 +></DIV +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A +NAME="AEN645">4.1.5.2. Data::Dumper</H3 ><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 +>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 ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H3 CLASS="section" ><A -NAME="AEN645">3.2.7. MySQL related Perl Module Collection</H2 +NAME="AEN648">4.1.5.3. MySQL-related modules</H3 ><P -> The Perl/MySQL interface requires a few mutually-dependent perl - modules. These modules are grouped together into the the - Msql-Mysql-modules package. This package can be found at CPAN. - After the archive file has been downloaded it should - be untarred. - </P +>The Perl/MySQL interface requires a few mutually-dependent Perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package.</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 +>The MakeMaker process will ask you a few questions about the + desired compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if your + desired target is the MySQL or mSQL packages, you should + 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 -> 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. +>A host of 'localhost' should be fine and a testing user of 'test' + with a null password should find itself with sufficient access to run + tests on the 'test' database which MySQL created upon installation. </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 +><HR><H3 CLASS="section" ><A -NAME="AEN654">3.2.8. TimeDate Perl Module Collection</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 +NAME="AEN653">4.1.5.4. TimeDate modules</H3 +><P +>Many of the more common date/time/calendar related Perl modules + have been grouped into a bundle similar to the MySQL modules bundle. + This bundle is stored on the CPAN under the name TimeDate. + The component module we're most interested in is the Date::Format + module, but installing all of them is probably a good idea anyway. + </P ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H3 CLASS="section" ><A -NAME="AEN658">3.2.9. GD Perl Module (1.8.3)</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 +NAME="AEN656">4.1.5.5. GD (optional)</H3 ><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 +>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 ><DIV CLASS="note" ><P @@ -3911,20 +3245,20 @@ ALT="Note"></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 +>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 +> + 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 +>. + The full requirements are listed in the Perl GD library README. + If compiling GD fails, it's probably because you're + missing a required library.</P ></TD ></TR ></TABLE @@ -3932,52 +3266,49 @@ CLASS="classname" ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H3 CLASS="section" ><A -NAME="AEN667">3.2.10. Chart::Base Perl Module (0.99c)</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 +NAME="AEN663">4.1.5.6. Chart::Base (optional)</H3 +><P +>The Chart module provides Bugzilla with on-the-fly charting + abilities. It can be installed in the usual fashion after it has been + fetched from CPAN. + Note that earlier versions that 0.99c used GIFs, which are no longer + supported by the latest versions of GD.</P ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H3 CLASS="section" ><A -NAME="AEN671">3.2.11. DB_File Perl Module</H2 +NAME="AEN666">4.1.5.7. Template Toolkit</H3 ><P -> DB_File is a module which allows Perl programs to make use - of the facilities provided by Berkeley DB version 1.x. This - module is required by collectstats.pl which is used for bug - charting. If you plan to make use of bug charting, you must - install this module. - </P +>When you install Template Toolkit, you'll get asked various + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. However, there are + known problems with XS Stash and Perl 5.005_02 and lower. If you + wish to use these older versions of Perl, please use the regular + stash.</P +></DIV ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN674">3.2.12. HTTP Server</H2 +NAME="AEN669">4.1.6. HTTP Server</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 +>You have a freedom of choice here - Apache, Netscape or any other + server on UNIX would do. You can 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 +> + user permissions accordingly. + <DIV CLASS="note" ><P ></P @@ -3998,24 +3329,22 @@ ALT="Note"></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 +>We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us.</P ></TD ></TR ></TABLE ></DIV > - </P + </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 +>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 httpd.conf + file: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -4025,18 +3354,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> AddHandler cgi-script .cgi - </PRE +>AddHandler cgi-script .cgi</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> With apache you'll also want to make sure that within the - access.conf file the line: - <TABLE +>With Apache you'll also want to make sure that within the + httpd.conf file the line: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -4046,18 +3374,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> Options ExecCGI -AllowOverride Limit -</PRE +>Options ExecCGI AllowOverride Limit</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 + + is in the stanza that covers the directories into which you intend to + put the bugzilla .html and .cgi files. + + <DIV CLASS="note" ><P ></P @@ -4078,18 +3405,17 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> AllowOverride Limit allows the use of a Deny statement in the - .htaccess file generated by checksetup.pl - </P +>AllowOverride Limit allows the use of a Deny statement in the + .htaccess file generated by checksetup.pl</P ><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 +>Users of older versions of Apache may find the above lines + in the srm.conf and access.conf files, respecitvely.</P ></TD ></TR ></TABLE ></DIV +> + </P ><DIV CLASS="warning" ><P @@ -4111,28 +3437,31 @@ ALT="Warning"></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 +>There are important files and directories that should not be a + served by the HTTP server - most files in the + <SPAN CLASS="QUOTE" >"data"</SPAN -> and <SPAN +> + and + <SPAN CLASS="QUOTE" >"shadow"</SPAN -> directories - and the <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 +> + file. You should configure your HTTP server to not serve + 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 +> + for details on how to do this for Apache; the checksetup.pl + script should create appropriate .htaccess files for you.</P ></TD ></TR ></TABLE @@ -4143,24 +3472,22 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN693">3.2.13. Installing the Bugzilla Files</H2 +NAME="AEN688">4.1.7. Bugzilla</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 +>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 +>). + You may decide to put the files in the main web space for your + web server or perhaps in + <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 +> + with a symbolic link in the web space that points to the Bugzilla + directory.</P ><DIV CLASS="tip" ><P @@ -4182,102 +3509,50 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> If you symlink the bugzilla directory into your Apache's - HTML heirarchy, you may receive - <SPAN +>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 +> + errors unless you add the + <SPAN CLASS="QUOTE" >"FollowSymLinks"</SPAN -> directive to the - <Directory> entry for the HTML root. - </P +> + directive to the <Directory> entry for the HTML root + in httpd.conf.</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 +>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 +> + script, which locks down your installation.</P ><P -> Lastly, you'll need to set up a symbolic link to - <TT +>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 +> + 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="AEN709"><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 +>). + Otherwise you must hack all the .cgi files to change where they look + for Perl. This can be done using the following Perl one-liner, but + I suggest using the symlink approach to avoid upgrade hassles. + </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 +> + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -4287,243 +3562,185 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> perl -pi -e 's@#!/usr/bonsaitools/bin/perl@#!/usr/bin/perl@' *cgi *pl Bug.pm processmail syncshadowdb - </PRE +>perl -pi -e + 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm + processmail syncshadowdb</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 + + Change <TT +CLASS="filename" +>/usr/bin/perl</TT +> to match the location + of Perl on your machine. + </P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN722">3.2.14. Setting Up the MySQL Database</H2 +NAME="AEN705">4.1.8. Setting Up the MySQL Database</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 +>After you've gotten all the software installed and working you're + ready to start preparing the database for its life as 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 +>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 -> +>, and will have minimal permissions. </P ><P -> Give the MySQL root user a password. MySQL passwords are - limited to 16 characters. - <P +>Begin by giving the MySQL root user a password. MySQL passwords are limited + to 16 characters. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT -> <B +> + + <B CLASS="command" ->mysql - -u root mysql</B -> </TT +>mysql -u root mysql</B > - </TD + </TT +> + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT -> <B +> + + <B CLASS="command" -> UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root'; </B -> </TT +>UPDATE user SET Password=PASSWORD('<new_password'>) + WHERE user='root';</B +> + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT -> <B +> + + <B CLASS="command" ->FLUSH - PRIVILEGES;</B -> </TT +>FLUSH PRIVILEGES;</B +> + </TT > - </TD + </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 +> + + 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 +> + + and enter <new_password>. Remember that MySQL user names have + nothing to do with Unix user names (login names).</P ><P -> Next, we create the <SPAN +>Next, we use an SQL <B +CLASS="command" +>GRANT</B +> command to create a + <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 +> + + 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 +> + user to operations within a database called + <SPAN CLASS="QUOTE" >"bugs"</SPAN ->, and only allows the account to - connect from <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 +>. + 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 +>Remember to set <bugs_password> to some unique password. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, - ALTER,CREATE,DROP,REFERENCES - ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</B + ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '<bugs_password>';</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" -> mysql> - </TT +>mysql></TT > - <B + + <B CLASS="command" -> FLUSH PRIVILEGES; - </B +>FLUSH PRIVILEGES;</B > - </TT + </TT > - </TD + </TD ></TR ></TBODY ></TABLE @@ -4531,219 +3748,129 @@ CLASS="command" ></P > </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="AEN741">4.1.9. <TT +CLASS="filename" +>checksetup.pl</TT +></H2 ><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 +>Next, run the magic checksetup.pl script. (Many thanks to + <A +HREF="mailto:holgerschurig@nikocity.de" +TARGET="_top" +>Holger Schurig </A +> + for writing this script!) + This script is designed to make sure your MySQL database and other + configuration options are consistent with the Bugzilla CGI files. + 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 +> + directory, and create all the MySQL tables. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >./checksetup.pl</B -> </TT > - </TD + </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="AEN769">3.2.15. Tweaking <TT +> + + The first time you run it, it will create a file called + <TT CLASS="filename" >localconfig</TT -></H2 +>.</P ><P -> This file contains a variety of settings you may need to tweak including - how Bugzilla should connect to the MySQL database. - </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 +>The connection settings include: + <P ></P ><OL TYPE="1" ><LI ><P -> server's host: just use <SPAN +>server's host: just use + <SPAN CLASS="QUOTE" >"localhost"</SPAN -> if the - MySQL server is local - </P +> + if the MySQL server is local</P ></LI ><LI ><P -> database name: <SPAN +>database name: + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> if you're following - these directions - </P +> + if you're following these directions</P ></LI ><LI ><P -> MySQL username: <SPAN +>MySQL username: + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> if you're following - these directions - </P +> + if you're following these directions</P ></LI ><LI ><P -> Password for the <SPAN +>Password for the + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> MySQL account above - </P +> + MySQL account; (<bugs_password>) 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 +>Once you are happy with the settings, + <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 +>su</TT +> to the user + your web server runs as, and re-run + <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="AEN800"><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 +>checksetup.pl</TT +>. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) + On this second run, it will create the database and an administrator + account for which you will be prompted to provide information.</P ><DIV CLASS="note" ><P @@ -4765,10 +3892,9 @@ ALT="Note"></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 +>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 @@ -4779,203 +3905,16 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN807">3.2.16. Setting Up Maintainers Manually (Optional)</H2 +NAME="AEN773">4.1.10. Securing MySQL</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 +>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 -></P -> replacing XXX with the Bugzilla email address. - </P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="AEN818">3.2.17. The Whining Cron (Optional)</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="AEN828">3.2.18. Bug Graphs (Optional)</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="AEN840">3.2.19. Securing MySQL</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 +>Most MySQL installs have "interesting" default security + parameters: + <P ></P ><TABLE BORDER="0" @@ -5007,96 +3946,100 @@ BORDER="0" > </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 +>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 +>To see your permissions do: + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >mysql -u root -p</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >use mysql;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >show tables;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >select * from user;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >select * from db;</B > - </TT + </TT > - </TD + </TD ></TR ></TBODY ></TABLE @@ -5105,8 +4048,8 @@ CLASS="command" > </P ><P -> To fix the gaping holes: - <P +>To fix the gaping holes: + <P ></P ><TABLE BORDER="0" @@ -5117,11 +4060,12 @@ BORDER="0" ></TR ><TR ><TD ->UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</TD +>UPDATE user SET Password=PASSWORD('new_password') WHERE + user='root';</TD ></TR ><TR ><TD -> FLUSH PRIVILEGES;</TD +>FLUSH PRIVILEGES;</TD ></TR ></TBODY ></TABLE @@ -5130,8 +4074,8 @@ BORDER="0" > </P ><P -> If you're not running "mit-pthreads" you can use: - <P +>If you're not running "mit-pthreads" you can use: + <P ></P ><TABLE BORDER="0" @@ -5159,10 +4103,10 @@ BORDER="0" > </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 +>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" @@ -5190,173 +4134,205 @@ BORDER="0" > </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 +>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 +>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 +>using the --user= option to mysqld to run it as an + unprivileged user.</P ></LI ><LI ><P -> starting MySQL in a chroot jail - </P +>running MySQL in a chroot jail</P ></LI ><LI ><P -> running the httpd in a "chrooted" jail - </P +>running the httpd in a chroot 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 +>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 +>running MySQL on a separate untrusted machine</P ></LI ><LI ><P -> making backups ;-) - </P +>making backups ;-)</P ></LI ></OL > </P ></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="AEN839">4.1.11. Configuring Bugzilla</H2 +><P +> You should run through the parameters on the Edit Parameters page + (link in the footer) and set them all to appropriate values. + They key parameters are documented in <A +HREF="#parameters" +>Section 5.1</A +>. + </P +></DIV ></DIV ><DIV CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="osx">3.3. Mac OS X Installation Notes</H1 +NAME="extraconfig">4.2. Optional Additional Configuration</H1 +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN845">4.2.1. Dependency Charts</H2 ><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 +>As well as the text-based dependency graphs, Bugzilla also + supports dependency graphing, using a package called 'dot'. + Exactly how this works is controlled by the 'webdotbase' parameter, + which can have one of three values: + </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 +></P +><OL +TYPE="1" +><LI ><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 +> A complete file path to the command 'dot' (part of + <A +HREF="http://www.graphviz.org/" +TARGET="_top" +>GraphViz</A +>) + will generate the graphs locally + </P +></LI +><LI +><P +> A URL prefix pointing to an installation of the webdot package will + generate the graphs remotely + </P +></LI +><LI +><P +> A blank value will disable dependency graphing. + </P +></LI +></OL > - </P + </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 +>So, to get this working, install + <A +HREF="http://www.graphviz.org/" +TARGET="_top" +>GraphViz</A +>. If you + do that, you need to + <A +HREF="http://httpd.apache.org/docs/mod/mod_imap.html" +TARGET="_top" +>enable + server-side image maps</A +> in Apache. + Alternatively, you could set up a webdot server, or use the AT&T + public webdot server (the + default for the webdotbase param). Note that AT&T's server won't work + if Bugzilla is only accessible using HTTPS. + </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="AEN860">4.2.2. Bug Graphs</H2 ><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 +>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 -> Instead of typing <SPAN -CLASS="QUOTE" ->"install GD"</SPAN -> at the +>Add a cron entry like this to run <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 +CLASS="filename" +>collectstats.pl</TT +> + daily at 5 after midnight: + <P +></P +><TABLE BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" +><TBODY ><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') { +> <TT +CLASS="computeroutput" +> <TT +CLASS="prompt" +>bash#</TT +> - - </PRE -></FONT -></TD + <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 +><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="AEN873">4.2.3. The Whining Cron</H2 ><P -> Then, run these commands to finish the installation of the perl module: +>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 to complain at engineers + which leave their bugs in the NEW state without triaging them. + </P +><P +> 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 @@ -5364,98 +4340,158 @@ BORDER="0" ><TBODY ><TR ><TD -><B +> <TT +CLASS="computeroutput" +> <B CLASS="command" ->perl Makefile.PL</B -></TD +>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 -><B -CLASS="command" ->make</B -></TD -></TR -><TR +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/tip.gif" +HSPACE="5" +ALT="Tip"></TD ><TD -><B -CLASS="command" ->make test</B -></TD -></TR +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 -><B -CLASS="command" ->make install</B +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>man 5 crontab</PRE +></FONT ></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 + </P +></TD +></TR +></TABLE +></DIV ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="bsdinstall">3.4. BSD Installation Notes</H1 +NAME="bzldap">4.2.4. LDAP Authentication</H2 ><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 +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 +>This information on using the LDAP + authentication options with Bugzilla is old, and the authors do + not know of anyone who has tested it. Approach with caution. + </P +></TD +></TR +></TABLE ></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="geninstall">3.5. Installation General Notes</H1 -><DIV -CLASS="section" -><H2 -CLASS="section" -><A -NAME="AEN942">3.5.1. Modifying Your Running System</H2 +> + </P ><P -> Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory. +> The existing authentication + scheme for Bugzilla uses email addresses as the primary user ID, and a + password to authenticate that user. All places within Bugzilla where + you need to deal with user ID (e.g assigning a bug) use the email + address. The LDAP authentication builds on top of this scheme, rather + than replacing it. The initial log in is done with a username and + password for the LDAP directory. This then fetches the email address + from LDAP and authenticates seamlessly in the standard Bugzilla + authentication scheme using this email address. If an account for this + address already exists in your Bugzilla system, it will log in to that + account. If no account for that email address exists, one is created at + the time of login. (In this case, Bugzilla will attempt to use the + "displayName" or "cn" attribute to determine the user's full name.) + After authentication, all other user-related tasks are still handled by + email address, not LDAP username. You still assign bugs by email + address, query on users by email address, etc. </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. +>Using LDAP for Bugzilla authentication requires the + Mozilla::LDAP (aka PerLDAP) Perl module. The + Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. + After you have installed the SDK, then install the PerLDAP module. + Mozilla::LDAP and the Directory SDK for C are both + <A +HREF="http://www.mozilla.org/directory/" +TARGET="_top" +>available for + download</A +> from mozilla.org. </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. +> Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for + authentication. Be very careful when setting up this parameter; if you + set LDAP authentication, but do not have a valid LDAP directory set up, + you will not be able to log back in to Bugzilla once you log out. (If + this happens, you can get back in by manually editing the data/params + file, and setting useLDAP back to 0.) + </P +><P +>If using LDAP, you must set the + three additional parameters: Set LDAPserver to the name (and optionally + port) of your LDAP server. If no port is specified, it defaults to the + default port of 389. (e.g "ldap.mycompany.com" or + "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching + for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids + must be unique under the DN specified here. Set LDAPmailattribute to + the name of the attribute in your LDAP directory which contains the + primary email address. On most directory servers available, this is + "mail", but you may need to change this. </P ></DIV ><DIV @@ -5463,47 +4499,101 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN949">3.5.2. Upgrading From Previous Versions</H2 +NAME="content-type">4.2.5. Preventing untrusted Bugzilla content from executing malicious + Javascript code</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 +>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 -> 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. +> <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl + </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 +><P +>Note: using <meta> tags to set the charset is not + recommended, as there's a bug in Netscape 4.x which causes pages + marked up in this way to load twice.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="htaccess">3.5.3. <TT +NAME="htaccess">4.2.6. <TT CLASS="filename" >.htaccess</TT -> files and security</H2 +> + files and security</H2 ><P -> To enhance the security of your Bugzilla installation, - Bugzilla will generate - <I -CLASS="glossterm" -><TT +>To enhance the security of your Bugzilla installation, Bugzilla's + <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 +>checksetup.pl</TT +> script will generate + <I +CLASS="glossterm" +> <TT CLASS="filename" >.htaccess</TT -> files. - - <DIV +> + </I +> + + files which the Apache webserver can use to restrict access to the + bugzilla data files. + These .htaccess files will not work with Apache 1.2.x - but this + has security holes, so you shouldn't be using it anyway. + <DIV CLASS="note" ><P ></P @@ -5524,52 +4614,58 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> If you are using an alternate provider of - <SPAN +>If you are using an alternate provider of + <SPAN CLASS="productname" >webdot</SPAN -> services for graphing - (as described when viewing - <TT +> + + 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 +> + + 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 +> + + 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 +>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 + + 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 +> + + . You should have this <Directory> entry in your + <TT CLASS="filename" >httpd.conf</TT > - file: - </P + + file:</P ><P -> <TABLE +> +<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -5579,50 +4675,58 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -<Directory /usr/local/bugzilla/> +> <Directory /usr/local/bugzilla/> Options +FollowSymLinks +Indexes +Includes +ExecCGI AllowOverride All </Directory> - - </PRE +</PRE ></FONT ></TD ></TR ></TABLE > + </P ><P -> The important part above is <SPAN +>The important part above is + <SPAN CLASS="QUOTE" >"AllowOverride All"</SPAN ->. - Without that, the <TT +> + + . Without that, the + <TT CLASS="filename" >.htaccess</TT -> file created by - <TT +> + + file created by + <TT CLASS="filename" >checksetup.pl</TT -> will not have sufficient - permissions to protect your Bugzilla installation. - </P +> + + 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 +>If you are using Internet Information Server (IIS) or another + web server which does not observe + <TT CLASS="filename" >.htaccess</TT > - conventions, you can disable their creation by editing - <TT + conventions, you can disable their creation by editing + <TT CLASS="filename" >localconfig</TT -> and setting the - <TT +> + and setting the + <TT CLASS="varname" >$create_htaccess</TT -> variable to - <TT +> + variable to + <TT CLASS="parameter" ><I >0</I @@ -5635,163 +4739,133 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="mod-throttle">3.5.4. <TT +NAME="mod-throttle">4.2.7. <TT CLASS="filename" >mod_throttle</TT -> and Security</H2 +> + + and Security</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 +>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 +> + + 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 +> 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 +> + + 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 +>Module + Instructions</A +> + for more information.</P +></DIV ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="content-type">3.5.5. Preventing untrusted Bugzilla content from executing malicious Javascript code</H2 +NAME="win32">4.3. Win32 Installation Notes</H1 ><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 +>This section covers installation on Microsoft Windows. + Bugzilla has been made to work on Win32 platforms, but the Bugzilla team + wish to emphasise that 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="warning" ><P +></P ><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" +CLASS="warning" WIDTH="100%" +BORDER="0" ><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 +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/warning.gif" +HSPACE="5" +ALT="Warning"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +>After that warning, here's the situation for 2.16 + and Windows. It doesn't work at all out of the box. + You are almost certainly better off getting + the 2.17 version from CVS (after consultation with the Bugzilla Team to + make sure you are pulling on a stable day) because we'll be doing a load + of work to make the Win32 experience more pleasant than it is now. + </P ></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</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" +> If you still want to try this, to have any hope of getting it to work, + you'll need to apply the + <A +HREF="" 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</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 +>mail patch</A +> from + <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=124174" +TARGET="_top" +>bug 124174</A +>. + After that, you'll need to read the (outdated) installation + instructions below, some (probably a lot better) <A +HREF="http://bugzilla.mozilla.org/attachment.cgi?id=84430&action=view" +TARGET="_top" +>more + recent ones</A +> kindly provided by Toms Baugis and Jean-Sebastien + Guay, and also check the + <A +HREF="http://www.bugzilla.org/releases/2.16/docs/win32.html" +TARGET="_top" +>Bugzilla 2.16 Win32 update page + </A +>. If we get time, + we'll write some better installation instructions for 2.16 and put + them up there. But no promises. + </P ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="wininstall">3.6.1. Win32 Installation: Step-by-step</H2 +NAME="wininstall">4.3.1. Win32 Installation: Step-by-step</H2 ><DIV CLASS="note" ><P @@ -5813,31 +4887,33 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You should be familiar with, and cross-reference, the rest - of the - <A +>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 +> + + 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 +>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 +> + + 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 +> + + .</P ></TD ></TR ></TABLE @@ -5848,27 +4924,34 @@ CLASS="procedure" TYPE="1" ><LI ><P -> Install <A +>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 +>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 + + regarding your Apache configuration, particularly instructions + regarding the + <SPAN CLASS="QUOTE" >"AddHandler"</SPAN > - parameter and <SPAN + + parameter and + <SPAN CLASS="QUOTE" >"ExecCGI"</SPAN ->. - </P +> + + .</P ><DIV CLASS="note" ><P @@ -5890,20 +4973,20 @@ ALT="Note"></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 +>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 ><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 +>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 @@ -5911,46 +4994,54 @@ HREF="#faq" ></LI ><LI ><P -> Install <A +>Install + <A HREF="http://www.activestate.com/" TARGET="_top" >ActivePerl</A -> for Windows. Check <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 +> 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 +>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 +> 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 +> Perl on Win32 FAQ</A > - </P + </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, - GD, AppConfig, and Template. You may need to extract them from - .zip format using Winzip or other unzip program first. Most of - these additional ppm modules can be downloaded from ActiveState, - but AppConfig and Template should be obtained from OpenInteract - using <A +>Use ppm from your perl\bin directory to install the following + packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using + <A HREF="http://openinteract.sourceforge.net/" TARGET="_top" ->the instructions on - the Template Toolkit web site</A ->. - </P +>the + instructions on the Template Toolkit web site</A +> + + .</P ><DIV CLASS="note" ><P @@ -5972,116 +5063,129 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can find a list of modules at - <A +>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 +> http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</A > - or <A + + or + <A HREF="http://www.activestate.com/PPMPackages/5.6plus" TARGET="_top" ->http://www.activestate.com/PPMPackages/5.6plus</A +> http://www.activestate.com/PPMPackages/5.6plus</A > - </P + </P ></TD ></TR ></TABLE ></DIV ><P -> The syntax for ppm is: - <TT +>The syntax for ppm is: + <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" ->C:> </TT -><B +>C:></TT +> + + <B CLASS="command" >ppm <modulename></B > - </TT + </TT > - </P + </P ><DIV CLASS="example" ><A -NAME="AEN1051"><P +NAME="AEN989"><P ><B ->Example 3-3. Installing ActivePerl ppd Modules on Microsoft Windows</B +>Example 4-1. Installing ActivePerl ppd Modules on Microsoft + Windows</B ></P ><P -><TT +> <TT CLASS="prompt" >C:></TT -><B +> + + <B CLASS="command" ->ppm - <TT +>ppm + <TT CLASS="option" >DBD-Mysql</TT -></B -></P +> + </B +> + </P ><P >Watch your capitalization!</P ></DIV ><P -> ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the - version at OpenInteract: - </P +>ActiveState's 5.6Plus directory also contains an AppConfig + ppm, so you might see the following error when trying to install + the version at OpenInteract:</P ><P > <TT CLASS="computeroutput" -> Error installing package 'AppConfig': Read a PPD for - 'AppConfig', but it is not intended for this build of Perl - (MSWin32-x86-multi-thread) - </TT +>Error installing package 'AppConfig': Read a PPD + for 'AppConfig', but it is not intended for this build of Perl + (MSWin32-x86-multi-thread)</TT > - </P + </P ><P -> If so, download both <A +>If so, download both + <A HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz" TARGET="_top" ->the - tarball</A -> and <A +> the tarball</A +> + + and + <A HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd" TARGET="_top" ->the - ppd</A -> directly from OpenInteract, then run ppm from within - the same directory to which you downloaded those files and - install the package by referencing the ppd file explicitly via in - the install command, f.e.: - <DIV +> the ppd</A +> + + directly from OpenInteract, then run ppm from within the same + directory to which you downloaded those files and install the + package by referencing the ppd file explicitly via in the install + command, f.e.: + <DIV CLASS="example" ><A -NAME="AEN1064"><P +NAME="AEN1002"><P ><B ->Example 3-4. Installing OpenInteract ppd Modules manually on Microsoft - Windows</B +>Example 4-2. Installing OpenInteract ppd Modules manually on Microsoft + Windows</B ></P ><P -> <TT +> <TT CLASS="computeroutput" -><B +> <B CLASS="command" ->install +>install <TT CLASS="filename" >C:\AppConfig.ppd</TT -></B -></TT > - </P + </B +> + </TT +> + </P ></DIV > </P ></LI ><LI ><P -> Install MySQL for NT. - <DIV +>Install MySQL for NT. + <DIV CLASS="note" ><P ></P @@ -6102,193 +5206,211 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can download MySQL for Windows NT from <A +>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 +> + + . Some find it helpful to use the WinMySqlAdmin utility, included + with the download, to set up the database.</P ></TD ></TR ></TABLE ></DIV > - </P + </P ></LI ><LI ><P -> Setup MySQL - </P +>Setup MySQL</P ><OL CLASS="SUBSTEPS" TYPE="a" ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" ->C:> </TT +>C:></TT > - <B + + <B CLASS="command" >C:\mysql\bin\mysql -u root mysql</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" ->DELETE FROM user WHERE Host='localhost' AND User='';</B +>DELETE FROM user WHERE Host='localhost' AND + User='';</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</B + WHERE user='root';</B > - </TT + </TT > - </P + </P ><P -><SPAN +> <SPAN CLASS="QUOTE" >"new_password"</SPAN ->, above, indicates - whatever password you wish to use for your - <SPAN +> + + , above, indicates whatever password you wish to use for your + <SPAN CLASS="QUOTE" >"root"</SPAN -> user.</P +> + + user.</P ></LI ><LI ><A NAME="ntbugs-password" ></A ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" ->GRANT SELECT, INSERT, UPDATE, DELETE, - INDEX, ALTER, CREATE, DROP, REFERENCES - ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</B +>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, + ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost + IDENTIFIED BY 'bugs_password';</B > - </TT + </TT > - </P + </P ><P -><SPAN +> <SPAN CLASS="QUOTE" >"bugs_password"</SPAN ->, above, indicates - whatever password you wish to use for your - <SPAN +> + + , above, indicates whatever password you wish to use for your + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> user.</P +> + + user.</P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >FLUSH PRIVILEGES;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >create database bugs;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >exit;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >C:></TT > - <B + + <B CLASS="command" ->C:\mysql\bin\mysqladmin -u root -p reload</B +>C:\mysql\bin\mysqladmin -u root -p + reload</B > - </TT + </TT > - </P + </P ></LI ></OL ></LI ><LI ><P -> Edit <TT +>Edit + <TT CLASS="filename" >checksetup.pl</TT -> in your Bugzilla directory. Change - this line: - </P +> + + in your Bugzilla directory. Change this line:</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6298,19 +5420,18 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = getgrnam($my_webservergroup); - </PRE +>my $webservergid = + getgrnam($my_webservergroup);</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> to - </P +>to</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6320,15 +5441,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = $my_webservergroup; - </PRE +>my $webservergid = + $my_webservergroup;</PRE ></FONT ></TD ></TR ></TABLE > -or the name of the group you wish to own the files explicitly: - <TABLE + + or the name of the group you wish to own the files explicitly: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6338,46 +5460,64 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = 'Administrators' - </PRE +>my $webservergid = + 'Administrators'</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></LI ><LI ><P -> Run <TT +>Run + <TT CLASS="filename" >checksetup.pl</TT -> from the Bugzilla directory. - </P +> + + from the Bugzilla directory.</P ></LI ><LI ><P ->Edit <TT +>Edit + <TT CLASS="filename" >localconfig</TT -> to suit your - requirements. Set <TT +> + + to suit your requirements. Set + <TT CLASS="varname" >$db_pass</TT -> to your - <SPAN +> + + to your + <SPAN CLASS="QUOTE" >"bugs_password"</SPAN -> from <A +> + + from + <A HREF="#ntbugs-password" >step 5.d</A ->, and <TT +> + + , and + <TT CLASS="varname" >$webservergroup</TT -> to <SPAN +> + + to + <SPAN CLASS="QUOTE" >"8"</SPAN ->.</P +> + + .</P ><DIV CLASS="note" ><P @@ -6399,15 +5539,19 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Not sure on the <SPAN +>Not sure on the + <SPAN CLASS="QUOTE" >"8"</SPAN -> for - <TT +> + + for + <TT CLASS="varname" >$webservergroup</TT -> above. If it's - wrong, please send corrections.</P +> + + above. If it's wrong, please send corrections.</P ></TD ></TR ></TABLE @@ -6415,21 +5559,24 @@ CLASS="varname" ></LI ><LI ><P -> Edit <TT +>Edit + <TT CLASS="filename" >defparams.pl</TT -> to suit your - requirements. Particularly, set - <TT +> + + to suit your requirements. Particularly, set + <TT CLASS="varname" >DefParam("maintainer")</TT -> and - <TT +> + + and + <TT CLASS="varname" ->DefParam("urlbase") to match your - install.</TT +>DefParam("urlbase") to match your install.</TT > - </P + </P ><DIV CLASS="note" ><P @@ -6452,9 +5599,9 @@ 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 + 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 @@ -6482,30 +5629,38 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <EM +>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 +> + + , not a requirement. Some other mail packages that can work + include + <A HREF="http://www.blat.net/" TARGET="_top" >BLAT</A ->, - <A +> + + , + <A HREF="http://www.geocel.com/windmail/" TARGET="_top" >Windmail</A ->, - <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 +>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 @@ -6516,12 +5671,16 @@ CLASS="procedure" TYPE="1" ><LI ><P -> Download NTsendmail, available from<A +>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 +> 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 @@ -6540,12 +5699,11 @@ WIDTH="100%" 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 +># 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 @@ -6571,28 +5729,34 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Some mention to also edit - <TT +>Some mention to also edit + <TT CLASS="varname" >$db_pass</TT -> in - <TT +> + + in + <TT CLASS="filename" >globals.pl</TT -> to be your - <SPAN +> + + 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 +> + + . 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 +> + + , your database password is exposed to whoever uses your web + server.</P ></TD ></TR ></TABLE @@ -6600,16 +5764,19 @@ CLASS="filename" ></LI ><LI ><P -> Find and comment out all occurences of - <SPAN +>Find and comment out all occurences of + <SPAN CLASS="QUOTE" ->"<B +>" + <B CLASS="command" >open(SENDMAIL</B ->"</SPAN -> in - your Bugzilla directory. Then replace them with: - <TABLE +> + "</SPAN +> + + in your Bugzilla directory. Then replace them with: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6619,19 +5786,16 @@ WIDTH="100%" 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 +># 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 + </P ><DIV CLASS="note" ><P @@ -6653,13 +5817,14 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Some have found success using the commercial product, - <SPAN +>Some have found success using the commercial product, + <SPAN CLASS="productname" >Windmail</SPAN ->. - You could try replacing your sendmail calls with: - <TABLE +> + + . You could try replacing your sendmail calls with: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6669,15 +5834,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </PRE +>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 + + or something to that effect.</P ></TD ></TR ></TABLE @@ -6688,24 +5854,31 @@ CLASS="programlisting" ></LI ><LI ><P -> Change all references in all files from - <TT +>Change all references in all files from + <TT CLASS="filename" >processmail</TT -> to - <TT +> + + to + <TT CLASS="filename" >processmail.pl</TT ->, and - rename <TT +> + + , and rename + <TT CLASS="filename" >processmail</TT -> to - <TT +> + + to + <TT CLASS="filename" >processmail.pl</TT ->. - </P +> + + .</P ><DIV CLASS="note" ><P @@ -6727,10 +5900,9 @@ ALT="Note"></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 +>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 @@ -6756,8 +5928,10 @@ ALT="Note"></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 +>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%" @@ -6780,14 +5954,15 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } -</PRE + </PRE ></FONT ></TD ></TR ></TABLE > -here is a test mail program for Net::SMTP: -<TABLE + + here is a test mail program for Net::SMTP: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6814,13 +5989,13 @@ recipient's address exit; -</PRE + </PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></TD ></TR ></TABLE @@ -6848,50 +6023,58 @@ ALT="Note"></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 +>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 +> + + 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 +>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 +> + + 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 + + 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 +> + + 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 +> + + 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 +>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%" @@ -6901,50 +6084,61 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> +> system ("./processmail",@ARGLIST); - </programlisting> to - <programlisting> + </programlisting> to + <programlisting> system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); - </PRE + + </PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></LI ><LI ><P -> Add <TT +>Add + <TT CLASS="function" >binmode()</TT -> calls so attachments - will work (<A +> + + calls so attachments will work ( + <A HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" TARGET="_top" ->bug 62000</A ->). - </P +>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 +>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 +> + + and + <TT CLASS="filename" >showattachment.cgi</TT -> before the - <TT +> + + before the + <TT CLASS="function" >require 'CGI.pl';</TT -> line. -</P +> + + line.</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -6958,7 +6152,7 @@ CLASS="programlisting" binmode(STDIN); binmode(STDOUT); -</PRE + </PRE ></FONT ></TD ></TR @@ -6986,28 +6180,35 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> According to <A +>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 +> 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 +> + + 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 +> + + at the beginning of the attachment files, there should be logic + to determine if + <TT CLASS="function" >binmode()</TT -> is needed or not. - </P +> + + is needed or not.</P ></TD ></TR ></TABLE @@ -7036,13 +6237,12 @@ ALT="Tip"></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 +>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 +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -7052,19 +6252,16 @@ WIDTH="100%" 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 +>.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 +> + + Change the path to Perl to match your install, of course.</P ></TD ></TR ></TABLE @@ -7075,7 +6272,7 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="addlwintips">3.6.2. Additional Windows Tips</H2 +NAME="addlwintips">4.3.2. Additional Windows Tips</H2 ><DIV CLASS="tip" ><P @@ -7097,25 +6294,25 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> From Andrew Pearson: - <A -NAME="AEN1234"><BLOCKQUOTE +>From Andrew Pearson: + <A +NAME="AEN1172"><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" +>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 +> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</A > - </P + </P ><P -> Basically you need to add two String Keys in the - registry at the following location: - </P +>Basically you need to add two String Keys in the registry at + the following location:</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -7125,29 +6322,27 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </PRE +> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> The keys should be called ".pl" and ".cgi", and both - should have a value something like: - <B +>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 ><P -> The KB article only talks about .pl, but it goes into - more detail and provides a perl test script. - </P +>The KB article only talks about .pl, but it goes into more + detail and provides a perl test script.</P ></BLOCKQUOTE > - </P + </P ></TD ></TR ></TABLE @@ -7173,24 +6368,25 @@ ALT="Tip"></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 +>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 +> + + for Bugzilla 2.13 and later, which includes the current release, + Bugzilla &bz-ver;. + <DIV CLASS="example" ><A -NAME="AEN1246"><P +NAME="AEN1184"><P ><B ->Example 3-5. Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</B +>Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</B ></P ><P -> Replace this: - <TABLE +>Replace this: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -7200,17 +6396,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </PRE +>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . + ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my + $enteredcryptpwd = FetchOneColumn();</PRE ></FONT ></TD ></TR ></TABLE -> -with this: - <TABLE +> + + with this: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -7220,270 +6416,448 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -my $enteredcryptpwd = $enteredpwd - </PRE +>my $enteredcryptpwd = $enteredpwd</PRE ></FONT ></TD ></TR ></TABLE -> - in cgi.pl. - </P +> + + in cgi.pl.</P ></DIV > - </P + </P ></TD ></TR ></TABLE ></DIV ></DIV +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="osx">4.4. Mac OS X Installation Notes</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, because 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 <A +HREF="../sgml/gd-makefile.patch" +TARGET="_top" +>this patch</A +> + to the Makefile.PL file (save the + patch into a file and use the command + <B +CLASS="command" +>patch < patchfile</B +>.) + </P +><P +>Then, run these commands to finish the installation of the GD + 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 +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="troubleshooting">4.5. Troubleshooting</H1 +><P +>This section gives solutions to common Bugzilla installation + problems. + </P ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="bzldap">3.6.3. Bugzilla LDAP Integration</H2 +NAME="AEN1218">4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</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. +> Try executing <B +CLASS="command" +>perl -MCPAN -e 'install CPAN'</B +> + and then continuing. </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 +> Certain older versions of the CPAN toolset were somewhat naive about how + to upgrade Perl modules. When a couple of modules got rolled into the core + Perl distribution for 5.6.1, CPAN thought that the best way to get those + modules up to date was to haul down the Perl distribution itself and + build it. Needless to say, this has caused headaches for just about + everybody. Upgrading to a newer version of CPAN with the + commandline above should fix things. + </P ></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="AEN1223">4.5.2. DBD::Sponge::db prepare failed</H2 +><P +> The following error message may appear due to a bug in DBD::mysql + (over which the Bugzilla team have no control): + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248. + SV = NULL(0x0) at 0x20fc444 + REFCNT = 1 + FLAGS = (PADBUSY,PADMY) +</PRE +></FONT +></TD +></TR +></TABLE +><P +> To fix this, go to + <TT +CLASS="filename" +><path-to-perl>/lib/DBD/sponge.pm</TT +> + in your Perl installation and replace + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; +</PRE +></FONT +></TD +></TR +></TABLE +><P +> by + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; +</PRE +></FONT +></TD +></TR +></TABLE +><P +> (note the S added to NAME.) + </P ></DIV ><DIV -CLASS="chapter" -><HR><H1 +CLASS="section" +><HR><H2 +CLASS="section" ><A -NAME="administration">Chapter 4. Administering Bugzilla</H1 +NAME="paranoid-security">4.5.3. cannot chdir(/var/spool/mqueue)</H2 +><P +>If you are installing Bugzilla on SuSE 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: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD ><FONT -COLOR="RED" -> Or, I just got this cool thing installed. Now what the heck do I - do with it? - </FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>cannot chdir(/var/spool/mqueue): Permission denied +</PRE +></FONT +></TD +></TR +></TABLE +> + </P ><P -> So you followed <SPAN +> This is because your + <TT +CLASS="filename" +>/var/spool/mqueue</TT +> + directory has a mode of + <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 +>"drwx------"</SPAN +>. Type + <B +CLASS="command" +>chmod 755 + <TT +CLASS="filename" +>/var/spool/mqueue</TT +> + </B +> + as root to fix this problem. + </P +></DIV +></DIV +></DIV ><DIV -CLASS="section" +CLASS="chapter" ><HR><H1 +><A +NAME="administration">Chapter 5. Administering Bugzilla</H1 +><DIV +CLASS="section" +><H1 CLASS="section" ><A -NAME="postinstall-check">4.1. Post-Installation Checklist</H1 +NAME="parameters">5.1. Bugzilla Configuration</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 +>Bugzilla is configured by changing various parameters, accessed + from the "Edit parameters" link in the page footer. Here are + some of the key parameters on that page. You should run down this + list and set them appropriately after installing Bugzilla.</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 +> + <B +CLASS="command" +>maintainer</B +>: + The maintainer parameter is the email address of the person + responsible for maintaining this + Bugzilla installation. The address need not be that of a valid Bugzilla + account.</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 +> <B +CLASS="command" +>urlbase</B +>: + This 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 +>For example, if your Bugzilla query page is + <TT +CLASS="filename" +>http://www.foo.com/bugzilla/query.cgi</TT +>, + set your <SPAN CLASS="QUOTE" >"urlbase"</SPAN -> is http://www.foo.com/bugzilla/. - </P +> + to <TT +CLASS="filename" +>http://www.foo.com/bugzilla/</TT +>.</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 +> <B +CLASS="command" +>usebuggroups</B +>: + This dictates whether or not to implement group-based security for + Bugzilla. If set, Bugzilla bugs can have an associated 'group', + defining which 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 +> + if you may wish to restrict access to particular bugs to certain + groups of users. I suggest leaving + this parameter <EM >off</EM -> while initially - testing your Bugzilla. - </P +> + while initially testing your Bugzilla.</P ></LI ><LI ><P -> <SPAN -CLASS="QUOTE" ->"usebuggroupsentry"</SPAN ->, when set to - <SPAN +> <B +CLASS="command" +>usebuggroupsentry</B +>: + Bugzilla Products can have a group associated with them, so that + certain users can only see bugs in certain products. When this parameter + is set to <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 +>, this places all newly-created bugs in the + group for their product immediately.</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 +> <B +CLASS="command" +>shadowdb</B +>: + 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 +> + 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 +> As a guide, 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 -> 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 +>The value of the parameter defines the name of the + shadow bug database. + Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. + <DIV CLASS="note" ><P ></P @@ -7504,206 +6878,110 @@ ALT="Note"></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 +>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 + </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 +>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" +> <B +CLASS="command" +>shutdownhtml</B +>: + + If you need to shut down Bugzilla to perform administration, enter + some descriptive HTML here and anyone who tries to use Bugzilla will + receive a page to that effect. Obviously, editparams.cgi will + still be accessible so you can remove the HTML and re-enable Bugzilla. + :-) + </P +></LI +><LI ><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" +> <B +CLASS="command" +>passwordmail</B +>: + + Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along with + their password message.</P ><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 +>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" ->"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 +> <B +CLASS="command" +>useqacontact</B +>: + + This allows you to define an email address for each component, in + addition + to that of the default owner, who will be sent carbon copies of + incoming bugs.</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 +> <B +CLASS="command" +>usestatuswhiteboard</B +>: + This defines whether you wish to have a free-form, overwritable field + associated with each bug. The advantage of the Status Whiteboard is + that it can be deleted or modified with ease, and provides an + easily-searchable field for indexing some bugs that have some trait + in common. + </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 +> <B +CLASS="command" +>whinedays</B +>: + Set this to the number of days you want to let bugs go + in the NEW or REOPENED state before notifying people they have + untouched new bugs. If you do not plan to use this feature, simply do + not set up the whining cron job described in the installation + instructions, or set this value to "0" (never whine).</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 +> <B +CLASS="command" +>commenton*</B +>: + All these + fields allow you to dictate what changes can pass without comment, + and which must have a comment from the person who changed them. + Often, administrators will allow users to add themselves to the CC + list, accept bugs, or change the Status Whiteboard without adding a + comment as to their reasons for the change, yet require that most + other changes come with an explanation.</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 @@ -7724,54 +7002,36 @@ ALT="Note"></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 +>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 + </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 +> <B +CLASS="command" +>supportwatchers</B +>: + + Turning on this option allows users to ask to receive copies of + all a particular other user's bug email. 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 privileges. 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 +> + 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 privileges. They would still only receive email + updates for those bugs she could normally view.</P ></LI ></OL ></DIV @@ -7781,26 +7041,19 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="useradmin">4.2. User Administration</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 +NAME="useradmin">5.2. User Administration</H1 ><DIV CLASS="section" -><HR><H2 +><H2 CLASS="section" ><A -NAME="defaultuser">4.2.1. Creating the Default User</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 +NAME="defaultuser">5.2.1. Creating the Default User</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 delete + the "super user" account, re-running checksetup.pl will again prompt + you for this username and password.</P ><DIV CLASS="tip" ><P @@ -7822,36 +7075,60 @@ ALT="Tip"></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 +>If you wish to add more administrative users, you must use the + MySQL interface. Run "mysql" from the command line, and use these + commands: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +> <TT CLASS="prompt" >mysql></TT -> use bugs;</B > - <B + <B CLASS="command" -><TT +>use bugs;</B +> + </TD +></TR +><TR +><TD +> <TT CLASS="prompt" >mysql></TT -> update profiles set - groupset=0x7ffffffffffffff where login_name = "(user's - login name)"; </B > - </P + + <B +CLASS="command" +> update profiles set groupset=0x7ffffffffffffff where login_name = + "(user's login name)"; + </B +> + </TD +></TR +></TBODY +></TABLE ><P ->Yes, that is <EM +></P +> + </P +><P +>Yes, that is + <EM >fourteen</EM > - <SPAN + + <SPAN CLASS="QUOTE" >"f"</SPAN ->'s. A whole lot of f-ing going on if you - want to create a new administator.</P +> + + 's. A whole lot of f-ing going on if you want to create a new + administator.</P ></TD ></TR ></TABLE @@ -7862,125 +7139,32 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="manageusers">4.2.2. Managing Other Users</H2 +NAME="manageusers">5.2.2. Managing Other Users</H2 ><DIV CLASS="section" ><H3 CLASS="section" ><A -NAME="login">4.2.2.1. Logging In</H3 +NAME="createnewusers">5.2.2.1. Creating new users</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</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 +>Your users can create their own user accounts by clicking the + "New Account" link at the bottom of each page (assuming they + aren't logged in as someone else already.) However, should you + desire to create user accounts ahead of time, here is how you do + it.</P ><P ></P ><OL TYPE="1" ><LI ><P -> After logging in, click the "Users" link at the footer - of the query page. - </P +>After logging in, click the "Users" link at the footer of + the query page, and then click "Add a new user".</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 +>Fill out the form presented. This page is self-explanatory. + When done, click "Submit".</P ><DIV CLASS="note" ><P @@ -8002,22 +7186,24 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Adding a user this way will <EM +>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 + + 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 +> + + 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 @@ -8030,202 +7216,73 @@ CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="disableusers">4.2.2.3. Disabling Users</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" +NAME="modifyusers">5.2.2.2. Modifying Users</H3 ><P -> Don't disable your own administrative account, or you - will hate life! - </P +>To see a specific user, search for their login name + in the box provided on the "Edit Users" page. To see all users, + leave the box blank.</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 +>You can search in different ways the listbox to the right + of the text entry box. You can match by + case-insensitive substring (the default), + regular expression, or a + <EM +>reverse</EM > - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="modifyusers">4.2.2.4. Modifying Users</H3 + regular expression match, which finds every user name which does NOT + match the regular expression. (Please see + the <B +CLASS="command" +>man regexp</B +> + manual page for details on regular expression syntax.) + </P ><P -> Here I will attempt to describe the function of each option - on the Edit User screen. - </P +>Once you have found your user, you can change the following + fields:</P ><P ></P ><UL ><LI ><P -> <EM +> <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 +>: + This is generally the user's full email address. However, if you + have are using the emailsuffix Param, this may just be the user's + login name. Note that users can now change their login names + themselves (to any valid email address.) + </P ></LI ><LI ><P -> <EM +> <EM >Real Name</EM ->: Duh! - </P +>: The user's real name. Note that + Bugzilla does not require this to create an account.</P ></LI ><LI ><P -> <EM +> <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 +>: + You can change the user's password here. Users can automatically + request a new password, so you shouldn't need to do this often. + If you want to disable an account, see Disable Text below. + </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 +> <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 +>: + If you type anything in this box, including just a space, the + user is prevented from logging in, or making any changes to + bugs via the web interface. + The HTML you type in this box is presented to the user when + they attempt to perform these actions, and should explain + why the account was disabled. + <DIV CLASS="warning" ><P ></P @@ -8252,7 +7309,8 @@ VALIGN="TOP" ></TABLE ></DIV > - <DIV + + <DIV CLASS="note" ><P ></P @@ -8273,143 +7331,110 @@ ALT="Note"></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 +>The user can still submit bugs via + the e-mail gateway, if you set it up, even if the disabled text + field is filled in. The e-mail gateway should + <EM >not</EM -> be enabled for secure - installations of Bugzilla. - </P +> + be enabled for secure installations of Bugzilla.</P ></TD ></TR ></TABLE ></DIV > - </P + </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 +> <EM +><groupname></EM +>: + If you have created some groups, e.g. "securitysensitive", then + checkboxes will appear here to allow you to add users to, or + remove them from, these groups. + </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 +> <EM +>canconfirm</EM +>: + This field is only used if you have enabled the "unconfirmed" + status. If you enable this for a user, + that user can then move bugs from "Unconfirmed" to a "Confirmed" + status (e.g.: "New" status).</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" +> <EM +>creategroups</EM +>: + This option will allow a user to create and destroy groups in + Bugzilla.</P +></LI +><LI ><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" +> <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. Even if this + option is unchecked, users can still add comments to bugs. + </P +></LI +><LI ><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 +> <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. + </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 +> <EM +>editkeywords</EM +>: + If you use Bugzilla's keyword functionality, enabling this + feature allows a user to create and destroy keywords. As always, + the keywords for existing bugs containing the keyword the user + wishes to destroy must be changed before Bugzilla will allow it + to die.</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 +> <EM +>editusers</EM +>: + This flag allows a user to do what you're doing right now: edit + other users. This will allow those with the right to do so to + remove administrator privileges from other users or grant them to + themselves. Enable with care.</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 privileges from other users or grant them - to themselves. Enable with care. - </P +> <EM +>tweakparams</EM +>: + This flag allows a user to change Bugzilla's Params + (using <TT +CLASS="filename" +>editparams.cgi</TT +>.)</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 +> <EM +><productname></EM +>: + This allows an administrator to specify the products in which + a user can see bugs. The user must still have the + "editbugs" privilege to edit bugs in these products.</P ></LI ></UL ></DIV @@ -8420,64 +7445,33 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="programadmin">4.3. Product, Component, Milestone, and Version - Administration</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 +NAME="programadmin">5.3. Product, Component, Milestone, and Version Administration</H1 ><DIV CLASS="section" -><HR><H2 +><H2 CLASS="section" ><A -NAME="products">4.3.1. Products</H2 -><FONT -COLOR="RED" ->Formerly, and in some spots still, called - "Programs"</FONT +NAME="products">5.3.1. Products</H2 ><P -> <A +> <A HREF="#gloss-product" ><I CLASS="glossterm" ->Products</I +> 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 +> + + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...)</P +><P +>Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes + required to move a bug automatically from the UNCONFIRMED status to the + NEW status.</P ><P >To create a new product:</P ><P @@ -8486,227 +7480,76 @@ CLASS="glossterm" 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 +>Select "products" from the footer</P ></LI ><LI ><P -> Select the "Add" link to the right of "Add a new product". - </P +>Select the "Add" link in the bottom right</P ></LI ><LI ><P -> Enter the name of the product and a description. The - Description field is free-form. - </P +>Enter the name of the product and a description. The + Description field may contain HTML.</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 +>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 ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="components">4.3.2. Components</H2 -><P -> Components are subsections of a Product. - - <DIV -CLASS="example" -><A -NAME="AEN1483"><P -><B ->Example 4-1. Creating some Components</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1485"><P -></P +NAME="components">5.3.2. Components</H2 ><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 +>Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.</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 +> 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 +>; + these can be changed on bug submission, or at any later point in + a bug's life.</P ><P -> To create a new Component: - </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 +>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 +>Select the "Add" link in the bottom right.</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 +>Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. + </P ></LI ></OL ></DIV @@ -8715,108 +7558,32 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="versions">4.3.3. Versions</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="AEN1512"><P -><B ->Example 4-2. Common Use of Versions</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1514"><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="AEN1516"><P -><B ->Example 4-3. A Different Use of Versions</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1518"><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 +NAME="versions">5.3.3. Versions</H2 ><P -></P -></DIV -></DIV -> - </P -><P -> To create and edit Versions: +>Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the most recent version with + the bug. </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 +>From the "Edit product" screen, select "Edit Versions"</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 +>You will notice that the product already has the default + version "undefined". Click the "Add" link in the bottom right.</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 +>Enter the name of the Version. This field takes text only. + Then click the "Add" button.</P ></LI ></OL ></DIV @@ -8825,14 +7592,11 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="milestones">4.3.4. Milestones</H2 +NAME="milestones">5.3.4. Milestones</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 +>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.</P ><DIV CLASS="note" ><P @@ -8854,78 +7618,49 @@ ALT="Note"></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 +>Milestone options will only appear for a Product if you turned + on the "usetargetmilestone" Param in the "Edit Parameters" screen. + </P ></TD ></TR ></TABLE ></DIV ><P -> To create new Milestones, set Default Milestones, and set - Milestone URL: - </P +>To create new Milestones, set Default Milestones, and set + Milestone URL:</P ><P ></P ><OL TYPE="1" ><LI ><P -> Select "edit milestones" - </P +>Select "Edit milestones" from the "Edit product" page.</P ></LI ><LI ><P -> Select "Add" to the right of the "Add a new milestone" - text - </P +>Select "Add" in the bottom right corner. + 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="AEN1544"><P -><B ->Example 4-4. Using SortKey with Target Milestone</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1546"><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 +>Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this particular + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add".</P ></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" +>From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean. </P +><DIV +CLASS="tip" ><P ></P ><TABLE -CLASS="note" +CLASS="tip" WIDTH="100%" BORDER="0" ><TR @@ -8934,83 +7669,39 @@ WIDTH="25" ALIGN="CENTER" VALIGN="TOP" ><IMG -SRC="../images/note.gif" +SRC="../images/tip.gif" HSPACE="5" -ALT="Note"></TD +ALT="Tip"></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 +>If you want your milestone document to be restricted so + that it can only be viewed by people in a particular Bugzilla + group, the best way is to attach the document to a bug in that + group, and make the URL the URL of that attachment.</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 ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="voting">4.3.5. Voting</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 +NAME="voting">5.4. Voting</H1 ><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 +>Voting allows users to be given a pot of votes which they can allocate + to bugs, to indicate that they'd like them fixed. + This allows developers to gauge + user need for a particular enhancement or bugfix. By allowing bugs with + a certain number of votes to automatically move from "UNCONFIRMED" to + "NEW", users of the bug system can help high-priority bugs garner + attention so they don't sit for a long time awaiting triage.</P ><P >To modify Voting settings:</P ><P @@ -9019,250 +7710,104 @@ NAME="voting">4.3.5. Voting</H2 TYPE="1" ><LI ><P -> Navigate to the "Edit product" screen for the Product you - wish to modify - </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 +><EM +>Maximum Votes per person</EM +>: + 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 +><EM +>Maximum Votes a person can put on a single + bug"</EM +>: + It should probably be some number lower than the + "Maximum votes per person". Don't set this field to "0" if + "Maximum votes per person" is non-zero; that doesn't make + any sense.</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 +><EM +>Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state</EM +>: + Setting this field to "0" disables the automatic move of + bugs from UNCONFIRMED to NEW. + </P ></LI ><LI ><P -> Once you have adjusted the values to your preference, - select the "Update" button. - </P +>Once you have adjusted the values to your preference, click + "Update".</P ></LI ></OL ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="groups">4.3.6. Groups and Group Security</H2 +NAME="groups">5.5. Groups and Group Security</H1 ><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="AEN1580"><P -><B ->Example 4-5. When to Use Group Security</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1582"><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" +>Groups allow the administrator + to isolate bugs or products that should only be seen by certain people. + There are two types of group - Generic Groups, and Product-Based Groups. + </P ><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 +> Product-Based Groups are matched with products, and allow you to restrict + access to bugs on a per-product basis. They are enabled using the + usebuggroups Param. Turning on the usebuggroupsentry + Param will mean bugs automatically get added to their product group when + filed. + </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 +> Generic Groups have no special relationship to products; + you create them, and put bugs in them + as required. One example of the use of Generic Groups + is Mozilla's "Security" group, + into which security-sensitive bugs are placed until fixed. Only the + Mozilla Security Team are members of this group. + </P ><P -> To enable Generic Group Security ("usebuggroups"): - </P +>To create Generic Groups:</P ><P ></P ><OL TYPE="1" ><LI ><P -> Turn "On" "usebuggroups" in the "Edit Parameters" screen. - </P +>Select the "groups" + link in the footer.</P ></LI ><LI ><P -> You will generally have no groups set up. Select the - "groups" link in the footer. - </P +>Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.</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 +>Fill out the "New Name", "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. + When you have finished, click "Add".</P ></LI -><LI +></OL ><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="AEN1597"><P -><B ->Example 4-6. Creating a New Group</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1599"><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 +>To use Product-Based Groups:</P ><P ></P -></DIV -></DIV -> When you have finished, select the Add - button. - </P -></LI -></OL +><OL +TYPE="1" +><LI ><P -> To enable Product-Based Group Security (usebuggroupsentry): - </P +>Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit + Parameters" screen.</P ><DIV CLASS="warning" ><P @@ -9284,27 +7829,29 @@ ALT="Warning"></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 +>XXX is this still true? + "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 -><P -></P -><OL -TYPE="1" +></LI ><LI ><P -> Turn "On" "usebuggroups" and "usebuggroupsentry" in the - "Edit Parameters" screen. - </P +>In future, when you create a Product, a matching group will be + automatically created. If you need to add a Product Group to + a Product which was created before you turned on usebuggroups, + then simply create a new group, as outlined above, with the + same name as the Product.</P +></LI +></OL ><DIV CLASS="warning" ><P @@ -9326,178 +7873,34 @@ ALT="Warning"></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 +>Bugzilla currently has a limit of 64 groups per installation. If + you have more than about 50 products, you should consider + running multiple Bugzillas. Ask in the newsgroup for other + suggestions for working around this restriction.</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="AEN1614"><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 privileges, 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 +> Note that group permissions are such that you need to be a member + of <EM +>all</EM +> the groups a bug is in, for whatever + reason, to see that bug. + </P ></DIV ><DIV CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="security">4.4. Bugzilla Security</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 +NAME="security">5.6. Bugzilla Security</H1 ><DIV -CLASS="note" +CLASS="warning" ><P ></P ><TABLE -CLASS="note" +CLASS="warning" WIDTH="100%" BORDER="0" ><TR @@ -9506,26 +7909,23 @@ WIDTH="25" ALIGN="CENTER" VALIGN="TOP" ><IMG -SRC="../images/note.gif" +SRC="../images/warning.gif" HSPACE="5" -ALT="Note"></TD +ALT="Warning"></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 +>Poorly-configured MySQL and Bugzilla 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 +><DIV CLASS="note" ><P ></P @@ -9546,68 +7946,65 @@ ALT="Note"></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 +>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 +> mozilla-webtools@mozilla.org</A > - </P + </P ></TD ></TR ></TABLE ></DIV -> - <P +><P +>To secure your installation: + + <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 +>Ensure you are running at least MysQL version 3.22.32 or newer. + Earlier versions had notable security holes and (from a security + point of view) poor 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" +> <EM +>There is no substitute for understanding the tools on your + system!</EM +> + + Read + <A +HREF="http://www.mysql.com/doc/P/r/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 +> The MySQL Privilege System</A +> + until you can recite it from memory!</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 +>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 +>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 +> + + . 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 @@ -9628,44 +8025,77 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> <SPAN +> <SPAN CLASS="QUOTE" >"nobody"</SPAN -> is a real user on UNIX systems. - Having a process run as user id <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 + + 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 + </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 +>Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. + The localconfig file stores your "bugs" database account password. + In addition, some + files under $BUGZILLA_HOME/data/ store sensitive information. + </P +><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 +><P +>When you run checksetup.pl, the script will attempt to modify + various permissions on files which Bugzilla uses. If you do not have + a webservergroup set in the localconfig file, then Bugzilla will have + to make certain files world readable and/or writable. + <EM +>THIS IS INSECURE!</EM +> + + . This means that anyone who can get access to your system can do + whatever they want to your Bugzilla installation.</P ><DIV CLASS="note" ><P @@ -9687,199 +8117,458 @@ ALT="Note"></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 +>This also means that if your webserver runs all cgi scripts + as the same user/group, anyone on the system who can run cgi + scripts will be able to take control of your Bugzilla + installation.</P ></TD ></TR ></TABLE ></DIV ><P -> On Apache, you can use .htaccess files to protect access - to these directories, as outlined in <A +>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 +>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 +>Bug + 65572</A > - </P + + for adequate protection in your data/ directory.</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/ - directory. <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 localconfig> deny<br> - from all </Files> allow from all </P +><Files comments> allow from all </Files><br> + deny from all</P > - </P + </P ><P -> Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/shadow - directory. <P +>Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/ directory. + <P CLASS="literallayout" -> deny from all </P +><Files localconfig> deny from all </Files><br> + allow from all</P > - </P + </P ></LI ></OL > </P ></DIV -></DIV ><DIV -CLASS="chapter" +CLASS="section" ><HR><H1 +CLASS="section" ><A -NAME="integration">Chapter 5. Integrating Bugzilla with Third-Party Tools</H1 +NAME="cust-templates">5.7. Template Customisation</H1 +><P +> One of the large changes for 2.16 was the templatisation of the + entire user-facing UI, using the + <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template Toolkit</A +>. + Administrators can now configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + </P +><P +> Templatisation also makes localised versions of Bugzilla possible, + for the first time. In the future, a Bugzilla installation may + have templates installed for multiple localisations, and select + which ones to use based on the user's browser language setting. + </P ><DIV CLASS="section" -><H1 +><HR><H2 CLASS="section" ><A -NAME="bonsai">5.1. Bonsai</H1 +NAME="AEN1539">5.7.1. What to Edit</H2 ><P ->Bonsai is a web-based tool for managing <A -HREF="#cvs" ->CVS, the Concurrent Versioning System</A +> There are two different ways of editing of Bugzilla's templates, + and which you use depends mainly on how you upgrade Bugzilla. The + template directory structure is that there's a top level directory, + <TT +CLASS="filename" +>template</TT +>, which contains a directory for + each installed localisation. The default English templates are + therefore in <TT +CLASS="filename" +>en</TT +>. Underneath that, there + is the <TT +CLASS="filename" +>default</TT +> directory and optionally the + <TT +CLASS="filename" +>custom</TT +> directory. The <TT +CLASS="filename" +>default</TT > - . 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 + directory contains all the templates shipped with Bugzilla, whereas + the <TT +CLASS="filename" +>custom</TT +> directory does not exist at first and + must be created if you want to use it. + </P +><P +> The first method of making customisations is to directly edit the + templates in <TT +CLASS="filename" +>template/en/default</TT +>. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + <B +CLASS="command" +>cvs update</B +>, any template fixes will get + automagically merged into your modified versions. + </P +><P +> If you use this method, your installation will break if CVS conflicts + occur. + </P +><P +> The other method is to copy the templates into a mirrored directory + structure under <TT +CLASS="filename" +>template/en/custom</TT +>. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. + </P +><P +> If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. + </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 directly edit the compiled templates in + <TT +CLASS="filename" +>data/template/*</TT +> - your + changes will be lost when Template Toolkit recompiles them. + </P +></TD +></TR +></TABLE +></DIV ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="cvs">5.2. CVS</H1 +NAME="AEN1558">5.7.2. How To Edit Templates</H2 ><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 +> The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template Toolkit home + page</A +>. However, you should particularly remember (for security + reasons) to always HTML filter things which come from the database or + user input, to prevent cross-site scripting attacks. + </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 +> However, one thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you fail to do this, you may open up + your installation to cross-site scripting attacks. + </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/" +> Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. + </P +><P +> Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + </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 are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + <A +HREF="http://www.bugzilla.org/developerguide.html" TARGET="_top" -> http://homepages.kcbbs.gen.nz/~tonyg/</A ->, under the - <SPAN -CLASS="QUOTE" ->"cvszilla"</SPAN -> link. - </P +>Developers' + Guide</A +>. + </P +></TD +></TR +></TABLE +></DIV ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="scm">5.3. Perforce SCM</H1 +NAME="AEN1568">5.7.3. Template Formats</H2 ><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 +> Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending <TT +CLASS="filename" +>&format=simple</TT +> to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. + </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 +> To see if a CGI supports multiple output formats, grep the + CGI for "ValidateOutputFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs. + </P +><P +> To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. + </P +><P +> Write your template in whatever markup or text style is appropriate. + </P +><P +> You now need to decide what content type you want your template + served as. Open up the <TT +CLASS="filename" +>localconfig</TT +> file and find the + <TT +CLASS="filename" +>$contenttypes</TT +> + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. + </P +><P +> Save the template as <TT +CLASS="filename" +><stubname>-<formatname>.<contenttypetag>.tmpl</TT +>. + Try out the template by calling the CGI as + <TT +CLASS="filename" +><cginame>.cgi?format=<formatname></TT +> . + </P ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="tinderbox">5.4. Tinderbox/Tinderbox2</H1 +NAME="AEN1581">5.7.4. Particular Templates</H2 ><P ->We need Tinderbox integration information.</P -></DIV -></DIV -><DIV -CLASS="chapter" -><HR><H1 -><A -NAME="future">Chapter 6. The Future of Bugzilla</H1 -><TABLE +> There are a few templates you may be particularly interested in + customising for your installation. + </P +><P +> <B +CLASS="command" +>index.html.tmpl</B +>: + This is the Bugzilla front page. + </P +><P +> <B +CLASS="command" +>global/header.html.tmpl</B +>: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + </P +><P +> <B +CLASS="command" +>global/banner.html.tmpl</B +>: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customise this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + </P +><P +> <B +CLASS="command" +>global/footer.html.tmpl</B +>: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + </P +><P +> <B +CLASS="command" +>bug/create/user-message.html.tmpl</B +>: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + </P +><P +> <B +CLASS="command" +>bug/create/create.html.tmpl</B +> and + <B +CLASS="command" +>bug/create/comment.txt.tmpl</B +>: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided" +TARGET="_top" +>guided + bug submission form</A +>. + </P +><P +> To make this work, create a custom template for + <TT +CLASS="filename" +>enter_bug.cgi</TT +> (the default template, on which you + could base it, is <TT +CLASS="filename" +>create.html.tmpl</TT +>), + and either call it <TT +CLASS="filename" +>create.html.tmpl</TT +> or use a format and + call it <TT +CLASS="filename" +>create-<formatname>.html.tmpl</TT +>. + Put it in the <TT +CLASS="filename" +>custom/bug/create</TT +> + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + </P +><P +> Then, create a template like + <TT +CLASS="filename" +>custom/bug/create/comment.txt.tmpl</TT +>, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + </P +><P +> For example, if your enter_bug template had a field + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -9888,739 +8577,202 @@ WIDTH="100%" ><FONT COLOR="#000000" ><PRE -CLASS="synopsis" ->Bugzilla's Future. Much of this is the present, now.</PRE +CLASS="programlisting" +><input type="text" name="buildid" size="30"></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 + and then your comment.txt.tmpl had + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>BuildID: [% form.buildid %]</PRE +></FONT +></TD +></TR +></TABLE +> + then + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>BuildID: 20020303</PRE +></FONT +></TD +></TR +></TABLE +> + would appear in the initial checkin comment. + </P +></DIV ></DIV -><DIV -CLASS="chapter" -><HR><H1 -><A -NAME="variants">Chapter 7. Bugzilla Variants and Competitors</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</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. +NAME="upgrading">5.8. Upgrading to New Releases</H1 +><P +>A plain Bugzilla is fairly easy to upgrade from one version to a + newer one. Always read the release notes to see if there are any issues + that you might need to take note of. It is recommended that you take a + backup of your database and your entire Bugzilla installation before attempting an + upgrade. You can upgrade a 'clean' installation by untarring a new + tarball over the old installation. If you are upgrading from 2.12 or + later, and have cvs installed, you can type <TT +CLASS="filename" +>cvs -z3 update</TT +>, + and resolve conflicts if there are any. </P ><P ->URL: <A -HREF="http://bugzilla.redhat.com/bugzilla/" -TARGET="_top" ->http://bugzilla.redhat.com/bugzilla/</A -></P +>However, things get a bit more complicated if you've made + changes to Bugzilla's code. In this case, you may have to re-make or + reapply those changes. One good method is to take a diff of your customised + version against the original, so you can survey all that you've changed. + Hopefully, templatisation will reduce the need for + this in the future.</P +><P +>From version 2.8 onwards, Bugzilla databases can be automatically + carried forward during an upgrade. However, because the developers of + Bugzilla are constantly adding new + tables, columns and fields, you'll probably get SQL errors if you just + update the code and attempt to use Bugzilla. Always run the + <TT +CLASS="filename" +>checksetup.pl</TT +> + script whenever you upgrade your installation.</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><H1 CLASS="section" ><A -NAME="variant-fenris">7.2. Loki Bugzilla (Fenris)</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 +NAME="integration">5.9. Integrating Bugzilla with Third-Party Tools</H1 ><DIV CLASS="section" -><HR><H1 +><H2 CLASS="section" ><A -NAME="variant-issuezilla">7.3. Issuezilla</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 +NAME="bonsai">5.9.1. Bonsai</H2 ><P ->URL: <A -HREF="http://issuezilla.tigris.org/servlets/ProjectHome" -TARGET="_top" ->http://issuezilla.tigris.org/servlets/ProjectHome</A -></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. Bonsai + also integrates with + <A +HREF="#tinderbox" +>Tinderbox, the Mozilla automated build management system</A +>. + </P ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="variant-scarab">7.4. Scarab</H1 +NAME="cvs">5.9.2. CVS</H2 ><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 +>CVS integration is best accomplished, at this point, using the + Bugzilla Email Gateway.</P ><P ->URL: <A -HREF="http://scarab.tigris.org/" +>Follow the instructions in this Guide 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 CVSZilla 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://scarab.tigris.org</A -></P +> http://homepages.kcbbs.gen.nz/~tonyg/</A +>. + </P ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="variant-perforce">7.5. Perforce SCM</H1 +NAME="scm">5.9.3. Perforce SCM</H2 ><P ->Although Perforce isn't really a bug tracker, it can be used - as such through the <SPAN +>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" ->"jobs"</SPAN -> functionality.</P -><P -><A -HREF="http://www.perforce.com/perforce/technotes/note052.html" +>"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://www.perforce.com/perforce/technotes/note052.html</A ->http://www.perforce.com/perforce/technotes/note052.html</P +> 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 +><HR><H2 CLASS="section" ><A -NAME="variant-sourceforge">7.6. SourceForge</H1 +NAME="tinderbox">5.9.4. Tinderbox/Tinderbox2</H2 ><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 +>We need Tinderbox integration information.</P +></DIV ></DIV ></DIV ><DIV @@ -10628,6 +8780,9 @@ CLASS="appendix" ><HR><H1 ><A NAME="faq">Appendix A. The Bugzilla FAQ</H1 +><P +> This FAQ includes questions not covered elsewhere in the Guide. + </P ><DIV CLASS="qandaset" ><DL @@ -10640,207 +8795,149 @@ HREF="#faq-general" ><DL ><DT >A.1.1. <A -HREF="#AEN1735" +HREF="#AEN1649" > Where can I find information about Bugzilla?</A ></DT ><DT >A.1.2. <A -HREF="#AEN1741" +HREF="#AEN1655" > What license is Bugzilla distributed under? </A ></DT ><DT >A.1.3. <A -HREF="#AEN1747" +HREF="#AEN1661" > How do I get commercial support for Bugzilla? </A ></DT ><DT >A.1.4. <A -HREF="#AEN1754" +HREF="#AEN1668" > What major companies or projects are currently using Bugzilla for bug-tracking? </A ></DT ><DT >A.1.5. <A -HREF="#AEN1779" +HREF="#AEN1693" > Who maintains Bugzilla? </A ></DT ><DT >A.1.6. <A -HREF="#AEN1785" +HREF="#AEN1699" > How does Bugzilla stack up against other bug-tracking databases? </A ></DT ><DT >A.1.7. <A -HREF="#AEN1792" -> How do I change my user name in Bugzilla? - </A -></DT -><DT ->A.1.8. <A -HREF="#AEN1797" +HREF="#AEN1705" > Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </A ></DT ><DT ->A.1.9. <A -HREF="#AEN1804" +>A.1.8. <A +HREF="#AEN1712" > Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </A ></DT ><DT ->A.1.10. <A -HREF="#AEN1822" +>A.1.9. <A +HREF="#AEN1717" > 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="#AEN1839" -> What about Red Hat Bugzilla? - </A -></DT -><DT ->A.2.2. <A -HREF="#AEN1847" -> What are the primary benefits of Red Hat Bugzilla? - </A -></DT -><DT ->A.2.3. <A -HREF="#AEN1875" -> 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="#AEN1888" -> What is Loki Bugzilla (Fenris)? +>A.1.10. <A +HREF="#AEN1723" +> Is there an easy way to change the Bugzilla cookie name? </A ></DT ></DL ></DD ><DT ->4. <A +>2. <A HREF="#faq-phb" ->Pointy-Haired-Boss Questions</A +>Managerial Questions</A ></DT ><DD ><DL ><DT ->A.4.1. <A -HREF="#AEN1899" -> Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? +>A.2.1. <A +HREF="#AEN1733" +> Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </A ></DT ><DT ->A.4.2. <A -HREF="#AEN1904" -> Has anyone you know of already done any Bugzilla integration with +>A.2.2. <A +HREF="#AEN1738" +> Can Bugzilla integrate with Perforce (SCM software)? </A ></DT ><DT ->A.4.3. <A -HREF="#AEN1909" +>A.2.3. <A +HREF="#AEN1743" > Does Bugzilla allow the user to track multiple projects? </A ></DT ><DT ->A.4.4. <A -HREF="#AEN1914" +>A.2.4. <A +HREF="#AEN1748" > 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="#AEN1919" -> Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, +>A.2.5. <A +HREF="#AEN1753" +> 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="#AEN1924" +>A.2.6. <A +HREF="#AEN1758" > 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="#AEN1931" -> 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="#AEN1953" +>A.2.7. <A +HREF="#AEN1765" > 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="#AEN1961" +>A.2.8. <A +HREF="#AEN1772" > 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? + email? </A ></DT ><DT ->A.4.10. <A -HREF="#AEN1966" +>A.2.9. <A +HREF="#AEN1777" > 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="#AEN1971" -> If there is email notification, do users have to have any particular +>A.2.10. <A +HREF="#AEN1782" +> Do users have to have any particular type of email application? </A ></DT ><DT ->A.4.12. <A -HREF="#AEN1978" -> 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="#AEN1983" +>A.2.11. <A +HREF="#AEN1789" > 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 @@ -10848,68 +8945,49 @@ HREF="#AEN1983" </A ></DT ><DT ->A.4.14. <A -HREF="#AEN1991" +>A.2.12. <A +HREF="#AEN1797" > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </A ></DT ><DT ->A.4.15. <A -HREF="#AEN1996" +>A.2.13. <A +HREF="#AEN1802" > Can a user create and save reports? Can they do this in Word format? Excel format? </A ></DT ><DT ->A.4.16. <A -HREF="#AEN2001" -> Can a user re-run a report with a new project, same query? - </A -></DT -><DT ->A.4.17. <A -HREF="#AEN2006" -> Can a user modify an existing report and then save it into another name? - </A -></DT -><DT ->A.4.18. <A -HREF="#AEN2011" +>A.2.14. <A +HREF="#AEN1807" > Does Bugzilla have the ability to search by word, phrase, compound search? </A ></DT ><DT ->A.4.19. <A -HREF="#AEN2016" -> Can the admin person establish separate group and individual user - privileges? - </A -></DT -><DT ->A.4.20. <A -HREF="#AEN2021" +>A.2.15. <A +HREF="#AEN1812" > 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="#AEN2026" +>A.2.16. <A +HREF="#AEN1817" > Are there any backup features provided? </A ></DT ><DT ->A.4.22. <A -HREF="#AEN2032" +>A.2.17. <A +HREF="#AEN1823" > Can users be on the system while a backup is in progress? </A ></DT ><DT ->A.4.23. <A -HREF="#AEN2037" +>A.2.18. <A +HREF="#AEN1828" > 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 @@ -10918,8 +8996,8 @@ HREF="#AEN2037" </A ></DT ><DT ->A.4.24. <A -HREF="#AEN2044" +>A.2.19. <A +HREF="#AEN1834" > 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 @@ -10928,8 +9006,8 @@ HREF="#AEN2044" </A ></DT ><DT ->A.4.25. <A -HREF="#AEN2049" +>A.2.20. <A +HREF="#AEN1839" > 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 @@ -10937,55 +9015,28 @@ HREF="#AEN2049" ></DL ></DD ><DT ->5. <A -HREF="#faq-install" ->Bugzilla Installation</A -></DT -><DD -><DL -><DT ->A.5.1. <A -HREF="#AEN2056" -> How do I download and install Bugzilla? - </A -></DT -><DT ->A.5.2. <A -HREF="#AEN2062" -> How do I install Bugzilla on Windows NT? - </A -></DT -><DT ->A.5.3. <A -HREF="#AEN2067" -> Is there an easy way to change the Bugzilla cookie name? - </A -></DT -></DL -></DD -><DT ->6. <A +>3. <A HREF="#faq-security" >Bugzilla Security</A ></DT ><DD ><DL ><DT ->A.6.1. <A -HREF="#AEN2074" +>A.3.1. <A +HREF="#AEN1846" > 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!)? + (I've followed the instructions in the installation section of this guide)? </A ></DT ><DT ->A.6.2. <A -HREF="#AEN2080" +>A.3.2. <A +HREF="#AEN1852" > Are there any security problems with Bugzilla? </A ></DT ><DT ->A.6.3. <A -HREF="#AEN2085" +>A.3.3. <A +HREF="#AEN1857" > 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. @@ -10994,164 +9045,138 @@ HREF="#AEN2085" ></DL ></DD ><DT ->7. <A +>4. <A HREF="#faq-email" >Bugzilla Email</A ></DT ><DD ><DL ><DT ->A.7.1. <A -HREF="#AEN2092" +>A.4.1. <A +HREF="#AEN1864" > 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="#AEN2097" +>A.4.2. <A +HREF="#AEN1869" > 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="#AEN2102" +>A.4.3. <A +HREF="#AEN1874" > 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="#AEN2108" +>A.4.4. <A +HREF="#AEN1880" > 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="#AEN2115" +>A.4.5. <A +HREF="#AEN1887" > How do I set up the email interface to submit/change bugs via email? </A ></DT ><DT ->A.7.6. <A -HREF="#AEN2120" -> Email takes FOREVER to reach me from bugzilla -- it's extremely slow. +>A.4.6. <A +HREF="#AEN1892" +> Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? </A ></DT ><DT ->A.7.7. <A -HREF="#AEN2127" -> How come email never reaches me from bugzilla changes? +>A.4.7. <A +HREF="#AEN1899" +> How come email from Bugzilla changes never reaches me? </A ></DT ></DL ></DD ><DT ->8. <A +>5. <A HREF="#faq-db" >Bugzilla Database</A ></DT ><DD ><DL ><DT ->A.8.1. <A -HREF="#AEN2135" +>A.5.1. <A +HREF="#AEN1907" > I've heard Bugzilla can be used with Oracle? </A ></DT ><DT ->A.8.2. <A -HREF="#AEN2140" -> 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="#AEN2145" +>A.5.2. <A +HREF="#AEN1912" > I think my database might be corrupted, or contain invalid entries. What do I do? </A ></DT ><DT ->A.8.4. <A -HREF="#AEN2153" +>A.5.3. <A +HREF="#AEN1920" > I want to manually edit some entries in my database. How? </A ></DT ><DT ->A.8.5. <A -HREF="#AEN2158" +>A.5.4. <A +HREF="#AEN1925" > 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="#AEN2163" -> I think I've set up MySQL permissions correctly, but bugzilla still can't +>A.5.5. <A +HREF="#AEN1930" +> I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </A ></DT ><DT ->A.8.7. <A -HREF="#AEN2168" +>A.5.6. <A +HREF="#AEN1935" > How do I synchronize bug information among multiple different Bugzilla databases? </A ></DT -><DT ->A.8.8. <A -HREF="#AEN2175" -> Why do I get bizarre errors when trying to submit data, particularly problems - with "groupset"? - </A -></DT -><DT ->A.8.9. <A -HREF="#AEN2180" -> How come even after I delete bugs, the long descriptions show up? - </A -></DT ></DL ></DD ><DT ->9. <A +>6. <A HREF="#faq-nt" >Bugzilla and Win32</A ></DT ><DD ><DL ><DT ->A.9.1. <A -HREF="#AEN2190" +>A.6.1. <A +HREF="#AEN1944" > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </A ></DT ><DT ->A.9.2. <A -HREF="#AEN2195" +>A.6.2. <A +HREF="#AEN1949" > Is there a "Bundle::Bugzilla" equivalent for Win32? </A ></DT ><DT ->A.9.3. <A -HREF="#AEN2200" +>A.6.3. <A +HREF="#AEN1954" > 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="#AEN2208" -> Can I have some general instructions on how to make Bugzilla on Win32 work? - </A -></DT -><DT ->A.9.5. <A -HREF="#AEN2214" +>A.6.4. <A +HREF="#AEN1962" > I'm having trouble with the perl modules for NT not being able to talk to to the database. </A @@ -11159,70 +9184,76 @@ HREF="#AEN2214" ></DL ></DD ><DT ->10. <A +>7. <A HREF="#faq-use" >Bugzilla Usage</A ></DT ><DD ><DL ><DT ->A.10.1. <A -HREF="#AEN2235" +>A.7.1. <A +HREF="#AEN1983" +> How do I change my user name (email address) in Bugzilla? + </A +></DT +><DT +>A.7.2. <A +HREF="#AEN1988" > The query page is very confusing. Isn't there a simpler way to query? </A ></DT ><DT ->A.10.2. <A -HREF="#AEN2241" +>A.7.3. <A +HREF="#AEN1993" > 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="#AEN2251" +>A.7.4. <A +HREF="#AEN2003" > 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="#AEN2256" +>A.7.5. <A +HREF="#AEN2008" > 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="#AEN2261" +>A.7.6. <A +HREF="#AEN2013" > How do I change a keyword in Bugzilla, once some bugs are using it? </A ></DT ></DL ></DD ><DT ->11. <A +>8. <A HREF="#faq-hacking" >Bugzilla Hacking</A ></DT ><DD ><DL ><DT ->A.11.1. <A -HREF="#AEN2268" +>A.8.1. <A +HREF="#AEN2020" > What bugs are in Bugzilla right now? </A ></DT ><DT ->A.11.2. <A -HREF="#AEN2277" +>A.8.2. <A +HREF="#AEN2029" > 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="#AEN2283" +>A.8.3. <A +HREF="#AEN2035" > What's the best way to submit patches? What guidelines should I follow? </A ></DT @@ -11240,7 +9271,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1735"><B +NAME="AEN1649"><B >A.1.1. </B > Where can I find information about Bugzilla?</P @@ -11253,9 +9284,9 @@ CLASS="answer" > You can stay up-to-date with the latest Bugzilla information at <A -HREF="http://www.mozilla.org/projects/bugzilla/" +HREF="http://www.bugzilla.org/" TARGET="_top" -> http://www.mozilla.org/projects/bugzilla/</A +> http://www.bugzilla.org/</A > </P ></DIV @@ -11266,7 +9297,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1741"><B +NAME="AEN1655"><B >A.1.2. </B > What license is Bugzilla distributed under? @@ -11293,7 +9324,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1747"><B +NAME="AEN1661"><B >A.1.3. </B > How do I get commercial support for Bugzilla? @@ -11317,7 +9348,7 @@ TARGET="_top" ><P > There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing - to whore themselves out for generous compensation. + to make themselves available for generous compensation. Try sending a message to the mailing list asking for a volunteer. </P ></DIV @@ -11328,7 +9359,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1754"><B +NAME="AEN1668"><B >A.1.4. </B > What major companies or projects are currently using Bugzilla @@ -11360,15 +9391,15 @@ BORDER="0" ></TR ><TR ><TD ->AtHome Corporation</TD +>NASA</TD ></TR ><TR ><TD ->Red Hat Software</TD +>AtHome Corporation</TD ></TR ><TR ><TD ->Loki Entertainment Software</TD +>Red Hat Software</TD ></TR ><TR ><TD @@ -11380,10 +9411,6 @@ BORDER="0" ></TR ><TR ><TD ->The Eazel Project</TD -></TR -><TR -><TD >AbiSource</TD ></TR ><TR @@ -11416,6 +9443,10 @@ BORDER="0" ></TR ><TR ><TD +>Ximian</TD +></TR +><TR +><TD >Linux-Mandrake</TD ></TR ></TBODY @@ -11436,7 +9467,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1779"><B +NAME="AEN1693"><B >A.1.5. </B > Who maintains Bugzilla? @@ -11448,12 +9479,13 @@ CLASS="answer" ><B > </B > - Bugzilla maintenance has been in a state of flux recently. - Please check <A -HREF="http://www.mozilla.org/projects/bugzilla/" + A + <A +HREF="http://www.bugzilla.org/who_we_are.html" TARGET="_top" ->the Bugzilla Project Page for the latest details. </A -> +>core team</A +>, + led by Dave Miller (justdave@syndicomm.com). </P ></DIV ></DIV @@ -11463,7 +9495,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1785"><B +NAME="AEN1699"><B >A.1.6. </B > How does Bugzilla stack up against other bug-tracking databases? @@ -11475,11 +9507,9 @@ CLASS="answer" ><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 + We can't find any head-to-head comparisons of Bugzilla against + other defect-tracking software. If you know of one, please + get in touch. However, from the author's personal experience with other bug-trackers, Bugzilla offers superior performance on commodity hardware, better price (free!), more developer- friendly features (such as stored @@ -11489,10 +9519,9 @@ CLASS="answer" </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. + step forward with a list of advantages your product has over + Bugzilla. We'd be happy to include it in the "Competitors" + section. </P ></DIV ></DIV @@ -11502,32 +9531,9 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1792"><B +NAME="AEN1705"><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="AEN1797"><B ->A.1.8. </B -> Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </P @@ -11550,7 +9556,7 @@ CLASS="answer" 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/" +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" TARGET="_top" >bugzilla.mozilla.org</A >. @@ -11563,11 +9569,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1804"><B ->A.1.9. </B +NAME="AEN1712"><B +>A.1.8. </B > Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </P ></DIV ><DIV @@ -11575,74 +9581,10 @@ CLASS="answer" ><P ><B > </B ->Terry Weissman answers, - <A -NAME="AEN1808"><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 > + There is DB-independence work afoot. PostgreSQL support is planned + for 2.18, and full DB-independence can't be far further on. </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 @@ -11651,8 +9593,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1822"><B ->A.1.10. </B +NAME="AEN1717"><B +>A.1.9. </B > Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? @@ -11664,143 +9606,16 @@ CLASS="answer" ><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="AEN1827"><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" + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally + Terry wanted a place to put a version of Perl and other tools + that was strictly under his control. + </P ><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 + as /usr/bonsaitools/bin/perl, and simply add symlink. + 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">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="AEN1839"><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="AEN1844"><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 @@ -11809,251 +9624,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1847"><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="AEN1852"><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="AEN1875"><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="AEN1882"><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">3. Loki Bugzilla (AKA Fenris)</H3 -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN1888"><B ->A.3.1. </B +NAME="AEN1723"><B +>A.1.10. </B > - What is Loki Bugzilla (Fenris)? + Is there an easy way to change the Bugzilla cookie name? </P ></DIV ><DIV @@ -12062,12 +9636,7 @@ CLASS="answer" ><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. + At present, no. </P ></DIV ></DIV @@ -12076,7 +9645,7 @@ TARGET="_top" CLASS="qandadiv" ><H3 ><A -NAME="faq-phb">4. Pointy-Haired-Boss Questions</H3 +NAME="faq-phb">2. Managerial Questions</H3 ><P > <DIV CLASS="note" @@ -12099,8 +9668,7 @@ ALT="Note"></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 :) +> Questions likely to be asked by managers. :-) </P ></TD ></TR @@ -12114,11 +9682,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1899"><B ->A.4.1. </B +NAME="AEN1733"><B +>A.2.1. </B > - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </P ></DIV ><DIV @@ -12138,10 +9706,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1904"><B ->A.4.2. </B +NAME="AEN1738"><B +>A.2.2. </B > - Has anyone you know of already done any Bugzilla integration with + Can Bugzilla integrate with Perforce (SCM software)? </P ></DIV @@ -12162,8 +9730,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1909"><B ->A.4.3. </B +NAME="AEN1743"><B +>A.2.3. </B > Does Bugzilla allow the user to track multiple projects? </P @@ -12174,11 +9742,10 @@ CLASS="answer" ><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. + Absolutely! You can track any number of Products (although you + are limited to about 55 or so if + you are using Product-Based Groups), that can each be composed of any + number of Components. </P ></DIV ></DIV @@ -12188,8 +9755,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1914"><B ->A.4.4. </B +NAME="AEN1748"><B +>A.2.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? @@ -12211,10 +9778,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1919"><B ->A.4.5. </B +NAME="AEN1753"><B +>A.2.5. </B > - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, + Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? </P ></DIV @@ -12224,12 +9791,11 @@ CLASS="answer" ><B > </B > - Yes. There are many specific MIME-types that are pre-defined by Bugzilla, + Yes - any sort of attachment is allowed, although administrators can + configure a maximum size. + 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. + upload the file. </P ></DIV ></DIV @@ -12239,8 +9805,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1924"><B ->A.4.6. </B +NAME="AEN1758"><B +>A.2.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 @@ -12274,193 +9840,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1931"><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="AEN1953"><B ->A.4.8. </B +NAME="AEN1765"><B +>A.2.7. </B > Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -12477,7 +9858,7 @@ HREF="http://bugzilla.mozilla.org/reports.cgi" TARGET="_top" > http://bugzilla.mozilla.org/reports.cgi</A > for basic reporting - facilities. + and graphing facilities. </P ><P > For more advanced reporting, I recommend hooking up a professional @@ -12487,9 +9868,6 @@ TARGET="_top" 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 @@ -12498,11 +9876,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1961"><B ->A.4.9. </B +NAME="AEN1772"><B +>A.2.8. </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? + email? </P ></DIV ><DIV @@ -12511,8 +9889,8 @@ CLASS="answer" ><B > </B > - Email notification is user-configurable. The bug id and Topic - of the bug report accompany each email notification, along with + Email notification is user-configurable. By default, the bug id and + Summary of the bug report accompany each email notification, along with a list of the changes made. </P ></DIV @@ -12523,8 +9901,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1966"><B ->A.4.10. </B +NAME="AEN1777"><B +>A.2.9. </B > Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? @@ -12546,10 +9924,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1971"><B ->A.4.11. </B +NAME="AEN1782"><B +>A.2.10. </B > - If there is email notification, do users have to have any particular + Do users have to have any particular type of email application? </P ></DIV @@ -12603,35 +9981,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1978"><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="AEN1983"><B ->A.4.13. </B +NAME="AEN1789"><B +>A.2.11. </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 @@ -12675,8 +10026,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1991"><B ->A.4.14. </B +NAME="AEN1797"><B +>A.2.12. </B > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? @@ -12688,10 +10039,10 @@ CLASS="answer" ><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. + To a certain extent, yes. 2.16's templates mean that you can localise + the user-facing UI (and several projects are doing exactly that.) However, + error messages and the admin interface are currently not localisable. + This should be achieved by 2.18. </P ></DIV ></DIV @@ -12701,8 +10052,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1996"><B ->A.4.15. </B +NAME="AEN1802"><B +>A.2.13. </B > Can a user create and save reports? Can they do this in Word format? Excel format? @@ -12724,53 +10075,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2001"><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="AEN2006"><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="AEN2011"><B ->A.4.18. </B +NAME="AEN1807"><B +>A.2.14. </B > Does Bugzilla have the ability to search by word, phrase, compound search? @@ -12793,31 +10099,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2016"><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="AEN2021"><B ->A.4.20. </B +NAME="AEN1812"><B +>A.2.15. </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 @@ -12841,8 +10124,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2026"><B ->A.4.21. </B +NAME="AEN1817"><B +>A.2.16. </B > Are there any backup features provided? </P @@ -12869,8 +10152,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2032"><B ->A.4.22. </B +NAME="AEN1823"><B +>A.2.17. </B > Can users be on the system while a backup is in progress? </P @@ -12893,8 +10176,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2037"><B ->A.4.23. </B +NAME="AEN1828"><B +>A.2.18. </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 @@ -12909,20 +10192,14 @@ CLASS="answer" ><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". + If Bugzilla is set up correctly from the start, continuing maintenance + needs are minimal and can be done easily using the web interface. </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. + is available from skilled members of the newsgroup. Simple questions + are answered there and then. </P ></DIV ></DIV @@ -12932,8 +10209,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2044"><B ->A.4.24. </B +NAME="AEN1834"><B +>A.2.19. </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 @@ -12963,8 +10240,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2049"><B ->A.4.25. </B +NAME="AEN1839"><B +>A.2.20. </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? @@ -12986,96 +10263,18 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-install">5. Bugzilla Installation</H3 -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN2056"><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="AEN2062"><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 +NAME="faq-security">3. Bugzilla Security</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2067"><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">6. Bugzilla Security</H3 -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN2074"><B ->A.6.1. </B +NAME="AEN1846"><B +>A.3.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!)? + (I've followed the instructions in the installation section of this guide)? </P ></DIV ><DIV @@ -13084,12 +10283,11 @@ CLASS="answer" ><B > </B > - Run mysql like this: "mysqld --skip-grant-tables". Please remember <EM + 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 + 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 @@ -13099,8 +10297,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2080"><B ->A.6.2. </B +NAME="AEN1852"><B +>A.3.2. </B > Are there any security problems with Bugzilla? </P @@ -13111,8 +10309,9 @@ CLASS="answer" ><B > </B > - The Bugzilla code has not undergone a complete security audit. - It is recommended that you closely examine permissions on your Bugzilla + The Bugzilla code has undergone a reasonably complete security audit, + and user-facing CGIs run under Perl's taint mode. However, + it is recommended that you closely examine permissions on your Bugzilla installation, and follow the recommended security guidelines found in The Bugzilla Guide. </P @@ -13124,8 +10323,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2085"><B ->A.6.3. </B +NAME="AEN1857"><B +>A.3.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 @@ -13149,15 +10348,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-email">7. Bugzilla Email</H3 +NAME="faq-email">4. Bugzilla Email</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2092"><B ->A.7.1. </B +NAME="AEN1864"><B +>A.4.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? @@ -13169,8 +10368,8 @@ CLASS="answer" ><B > </B > - With the email changes to 2.12, the user should be able to set - this in user email preferences. + The user should be able to set + this in user email preferences (uncheck all boxes.) </P ></DIV ></DIV @@ -13180,8 +10379,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2097"><B ->A.7.2. </B +NAME="AEN1869"><B +>A.4.2. </B > I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? @@ -13193,8 +10392,8 @@ CLASS="answer" ><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)". + Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". </P ></DIV ></DIV @@ -13204,8 +10403,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2102"><B ->A.7.3. </B +NAME="AEN1874"><B +>A.4.3. </B > I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? @@ -13234,8 +10433,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2108"><B ->A.7.4. </B +NAME="AEN1880"><B +>A.4.4. </B > I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? @@ -13250,7 +10449,7 @@ CLASS="answer" You can call bug_email.pl directly from your aliases file, with an entry like this: <A -NAME="AEN2112"><BLOCKQUOTE +NAME="AEN1884"><BLOCKQUOTE CLASS="BLOCKQUOTE" ><P > bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" @@ -13269,8 +10468,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2115"><B ->A.7.5. </B +NAME="AEN1887"><B +>A.4.5. </B > How do I set up the email interface to submit/change bugs via email? </P @@ -13292,10 +10491,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2120"><B ->A.7.6. </B +NAME="AEN1892"><B +>A.4.6. </B > - Email takes FOREVER to reach me from bugzilla -- it's extremely slow. + Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? </P ></DIV @@ -13306,7 +10505,8 @@ CLASS="answer" > </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 + sendmail), make sure the options given in the "processmail" and other + scripts for all instances of "sendmail" are correct for your MTA. </P ><P @@ -13324,10 +10524,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2127"><B ->A.7.7. </B +NAME="AEN1899"><B +>A.4.7. </B > - How come email never reaches me from bugzilla changes? + How come email from Bugzilla changes never reaches me? </P ></DIV ><DIV @@ -13353,15 +10553,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-db">8. Bugzilla Database</H3 +NAME="faq-db">5. Bugzilla Database</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2135"><B ->A.8.1. </B +NAME="AEN1907"><B +>A.5.1. </B > I've heard Bugzilla can be used with Oracle? </P @@ -13372,10 +10572,10 @@ CLASS="answer" ><B > </B > - Red Hat Bugzilla, mentioned above, works with Oracle. The current version + Red Hat Bugzilla 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. + Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. </P ></DIV ></DIV @@ -13385,43 +10585,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2140"><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="AEN2145"><B ->A.8.3. </B +NAME="AEN1912"><B +>A.5.2. </B > I think my database might be corrupted, or contain invalid entries. What do I do? @@ -13465,8 +10630,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2153"><B ->A.8.4. </B +NAME="AEN1920"><B +>A.5.3. </B > I want to manually edit some entries in my database. How? </P @@ -13492,8 +10657,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2158"><B ->A.8.5. </B +NAME="AEN1925"><B +>A.5.4. </B > I try to add myself as a user, but Bugzilla always tells me my password is wrong. </P @@ -13516,10 +10681,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2163"><B ->A.8.6. </B +NAME="AEN1930"><B +>A.5.5. </B > - I think I've set up MySQL permissions correctly, but bugzilla still can't + I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </P ></DIV @@ -13543,8 +10708,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2168"><B ->A.8.7. </B +NAME="AEN1935"><B +>A.5.6. </B > How do I synchronize bug information among multiple different Bugzilla databases? @@ -13573,82 +10738,20 @@ CLASS="answer" </P ></DIV ></DIV -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN2175"><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="AEN2180"><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">9. Bugzilla and Win32</H3 +NAME="faq-nt">6. Bugzilla and Win32</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2190"><B ->A.9.1. </B +NAME="AEN1944"><B +>A.6.1. </B > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </P @@ -13670,8 +10773,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2195"><B ->A.9.2. </B +NAME="AEN1949"><B +>A.6.2. </B > Is there a "Bundle::Bugzilla" equivalent for Win32? </P @@ -13694,8 +10797,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2200"><B ->A.9.3. </B +NAME="AEN1954"><B +>A.6.3. </B > CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? @@ -13715,7 +10818,7 @@ CLASS="answer" ><P > Microsoft has some advice on this matter, as well: <A -NAME="AEN2205"><BLOCKQUOTE +NAME="AEN1959"><BLOCKQUOTE CLASS="BLOCKQUOTE" ><P > "Set application mappings. In the ISM, map the extension for the script @@ -13738,120 +10841,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2208"><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="AEN2214"><B ->A.9.5. </B +NAME="AEN1962"><B +>A.6.4. </B > I'm having trouble with the perl modules for NT not being able to talk to to the database. @@ -13916,15 +10907,38 @@ TARGET="_top" CLASS="qandadiv" ><H3 ><A -NAME="faq-use">10. Bugzilla Usage</H3 +NAME="faq-use">7. Bugzilla Usage</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2235"><B ->A.10.1. </B +NAME="AEN1983"><B +>A.7.1. </B +> + How do I change my user name (email address) in Bugzilla? + </P +></DIV +><DIV +CLASS="answer" +><P +><B +> </B +> + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + </P +></DIV +></DIV +><DIV +CLASS="qandaentry" +><DIV +CLASS="question" +><P +><A +NAME="AEN1988"><B +>A.7.2. </B > The query page is very confusing. Isn't there a simpler way to query? </P @@ -13935,13 +10949,9 @@ CLASS="answer" ><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" + The interface was simplified by a UI designer for 2.16. Further + suggestions for improvement are welcome, but we won't sacrifice power for + simplicity. </P ></DIV ></DIV @@ -13951,8 +10961,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2241"><B ->A.10.2. </B +NAME="AEN1993"><B +>A.7.3. </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? @@ -13965,7 +10975,7 @@ CLASS="answer" > </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 + users. You have your choice of patches to change this behavior, however. <P ></P @@ -13993,8 +11003,8 @@ TARGET="_top" ><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. + Note that these patches are somewhat dated. You will need to apply + them manually. </P ></DIV ></DIV @@ -14004,8 +11014,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2251"><B ->A.10.3. </B +NAME="AEN2003"><B +>A.7.4. </B > I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? @@ -14029,8 +11039,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2256"><B ->A.10.4. </B +NAME="AEN2008"><B +>A.7.5. </B > Email submissions to Bugzilla that have attachments end up asking me to save it as a "cgi" file. @@ -14043,7 +11053,7 @@ CLASS="answer" > </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 + filename. This will not be fixed anytime soon, because it would cripple some other functionality. </P ></DIV @@ -14054,8 +11064,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2261"><B ->A.10.5. </B +NAME="AEN2013"><B +>A.7.6. </B > How do I change a keyword in Bugzilla, once some bugs are using it? </P @@ -14077,15 +11087,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-hacking">11. Bugzilla Hacking</H3 +NAME="faq-hacking">8. Bugzilla Hacking</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2268"><B ->A.11.1. </B +NAME="AEN2020"><B +>A.8.1. </B > What bugs are in Bugzilla right now? </P @@ -14104,13 +11114,13 @@ TARGET="_top" enhancement for Bugzilla. </P ><P -> You can view bugs marked for 2.16 release +> You can view bugs marked for 2.18 release <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16" +HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.18" TARGET="_top" >here</A >. - This list includes bugs for the 2.16 release that have already + This list includes bugs for the 2.18 release that have already been fixed and checked into CVS. Please consult the <A HREF="http://www.mozilla.org/projects/bugzilla/" @@ -14128,8 +11138,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2277"><B ->A.11.2. </B +NAME="AEN2029"><B +>A.8.2. </B > How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? @@ -14148,9 +11158,7 @@ TARGET="_top" >. 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... + "editparams.cgi". </P ></DIV ></DIV @@ -14160,8 +11168,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2283"><B ->A.11.3. </B +NAME="AEN2035"><B +>A.8.3. </B > What's the best way to submit patches? What guidelines should I follow? </P @@ -14190,21 +11198,21 @@ TARGET="_top" ></LI ><LI ><P -> Upload your patch as a unified DIFF (having used "diff -u" against +> 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! + ID you submitted in step #1. Be sure and click the "Patch" checkbox + 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 + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) 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 @@ -14235,116 +11243,7 @@ TARGET="_top" CLASS="appendix" ><HR><H1 ><A -NAME="downloadlinks">Appendix B. Software Download Links</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</H1 +NAME="database">Appendix B. The Bugzilla Database</H1 ><DIV CLASS="note" ><P @@ -14366,8 +11265,9 @@ ALT="Note"></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 +>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 @@ -14377,7 +11277,7 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="dbschema">C.1. Database Schema Chart</H1 +NAME="dbschema">B.1. Database Schema Chart</H1 ><P > <DIV CLASS="mediaobject" @@ -14398,183 +11298,171 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="dbdoc">C.2. MySQL Bugzilla Database Introduction</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 +NAME="dbdoc">B.2. MySQL Bugzilla Database Introduction</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="AEN2353">C.2.1. Bugzilla Database Basics</H2 +NAME="AEN2077">B.2.1. Bugzilla Database Basics</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 +>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 +> + + and a + <SPAN CLASS="QUOTE" >"tinyint"</SPAN -> entry in MySQL. I recommend you refer - to the MySQL documentation, available at <A +> + + 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 +> + + . 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 +>To connect to your database:</P ><P -> <TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" >mysql</B -><TT +> + + <TT CLASS="parameter" ><I >-u root</I ></TT > - </P + </P ><P -> If this works without asking you for a password, - <EM +>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 +> + + ! 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 + <A +HREF="http://www.mysql.com/php/manual.php3?section=Privilege_system" +TARGET="_top" +>MySQL + searchable documentation</A +>. + </P ></LI ><LI ><P ->You should now be at a prompt that looks like - this:</P +>You should now be at a prompt that looks like this:</P ><P -><TT +> <TT CLASS="prompt" >mysql></TT -></P +> + </P ><P ->At the prompt, if <SPAN +>At the prompt, if + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> is the name - you chose in the<TT +> + + is the name you chose in the + <TT CLASS="filename" >localconfig</TT -> file - for your Bugzilla database, type:</P +> + + file for your Bugzilla database, type:</P ><P -><TT +> <TT CLASS="prompt" >mysql</TT -><B +> + + <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 +> + </P ></LI ></OL > @@ -14584,31 +11472,31 @@ CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="AEN2382">C.2.1.1. Bugzilla Database Tables</H3 +NAME="AEN2104">B.2.1.1. Bugzilla Database Tables</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 +>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 +> <TT CLASS="prompt" >mysql></TT -><B +> + <B CLASS="command" >show tables from bugs;</B -></P +> + </P ><P ->you'll be able to see all the - <SPAN +>you'll be able to see the names of 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 +> + (tables) in your database.</P ><P >From the command issued above, ou should have some output that looks like this: - <TABLE +<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -14644,16 +11532,16 @@ CLASS="programlisting" | votes | | watch | +-------------------+ - </PRE +</PRE ></FONT ></TD ></TR ></TABLE -></P +> +</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> @@ -14815,278 +11703,55 @@ Although you can query by the enum field,&nbs 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</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 PRIVILEGES <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</H1 +NAME="patches">Appendix C. Useful Patches and Utilities for Bugzilla</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 +>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 +NAME="rewrite">C.1. Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</H1 +> + + magic</H1 ><P ->Apache's <TT +>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 +> + + 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 +>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 +> + + , 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" @@ -15097,13 +11762,11 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -<VirtualHost 12.34.56.78> +> <VirtualHost 12.34.56.78> RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </VirtualHost> - - </PRE +</PRE ></FONT ></TD ></TR @@ -15111,14 +11774,14 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] ></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 +>There are many, many more things you can do with mod_rewrite. + Please refer to the mod_rewrite documentation at + <A HREF="http://www.apache.org" TARGET="_top" >http://www.apache.org</A -></P +>. + </P ></LI ></OL ></DIV @@ -15127,369 +11790,130 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="setperl">D.2. The setperl.csh Utility</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 +NAME="cmdline">C.2. Command-line Bugzilla Queries</H1 ><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 +>There are a suite of Unix utilities for querying Bugzilla from the + command line. They live in the + <TT +CLASS="filename" +>contrib/cmdline</TT +> + directory. However, they + have not yet been updated to work with 2.16 (post-templatisation.). + There are three files - <TT +CLASS="filename" +>query.conf</TT +>, + <TT +CLASS="filename" +>buglist</TT +> and <TT +CLASS="filename" +>bugs</TT +>.</P ><P -> Prepare (and fix) Bugzilla file permissions. - </P -><OL -CLASS="SUBSTEPS" -TYPE="a" -><LI +><TT +CLASS="filename" +>query.conf</TT +> + 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 -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> - <B -CLASS="command" ->chmod u+w *</B -> - </TT +><TT +CLASS="filename" +>buglist</TT > - </P -></LI -><LI + 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 -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> <B -CLASS="command" ->chmod - u+x duplicates.cgi</B -> </TT -> - </P -></LI -><LI +>The column list 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, grep for COLUMNLIST + in your cookies file to see your current COLUMNLIST setting.</P ><P -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> - <B +><TT +CLASS="filename" +>bugs</TT +> is a simple shell script which calls + <TT +CLASS="filename" +>buglist</TT +> 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" ->chmod a-x bug_status.html</B +>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</B > - </TT -> - </P -></LI -></OL -></LI -><LI -><P -> Run the script: - </P + </P ><P -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> - <B +>Akkana Peck says she has good results piping + <TT +CLASS="filename" +>buglist</TT +> output through + <B CLASS="command" ->./setperl.csh /your/path/to/perl</B -> - </TT +>w3m -T text/html -dump</B > -<DIV -CLASS="example" + </P +></DIV +></DIV +><DIV +CLASS="appendix" +><HR><H1 ><A -NAME="AEN2461"><P -><B ->Example D-1. Using Setperl to set your perl path</B -></P +NAME="variants">Appendix D. Bugzilla Variants and Competitors</H1 ><P -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> - <B -CLASS="command" ->./setperl.csh /usr/bin/perl</B -> - </TT -> - </P -></DIV +>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 -></LI -></OL -></DIV -></DIV + </P ><DIV CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="cmdline">D.3. Command-line Bugzilla Queries</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 +NAME="rhbugzilla">D.1. Red Hat Bugzilla</H1 ><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 +>Red Hat Bugzilla is a fork of Bugzilla 2.8. + One of its major benefits is the ability + to work with Oracle, MySQL, and PostGreSQL databases serving as the + back-end, instead of just MySQL. Dave Lawrence of Red Hat is + active in the Bugzilla community, and we hope to see a reunification + of the fork before too long.</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 +>URL: + <A +HREF="http://bugzilla.redhat.com/bugzilla/" +TARGET="_top" +> http://bugzilla.redhat.com/bugzilla/</A > </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</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 +NAME="variant-fenris">D.2. Loki Bugzilla (Fenris)</H1 ><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. +>Fenris was a fork from Bugzilla made by Loki Games; when + Loki went into receivership, it died. While Loki's other code lives on, + its custodians recommend Bugzilla for future bug-tracker deployments. </P ></DIV ><DIV @@ -15497,864 +11921,75 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="bzhacking">D.5. Hacking Bugzilla</H1 +NAME="variant-issuezilla">D.3. Issuezilla</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 +>Issuezilla was another fork from Bugzilla, made by collab.net and + hosted at tigris.org. It is also dead; the primary focus of bug-tracking + at tigris.org is their Java-based bug-tracker, + <A +HREF="#variant-scarab" +>Scarab</A +>.</P +></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="AEN2517">D.5.1. Things that have caused problems and should be avoided</H2 +NAME="variant-scarab">D.4. Scarab</H1 ><P -></P -><OL -TYPE="1" -><LI -><P -> Usage of variables in Regular Expressions - </P +>Scarab is a new open source bug-tracking system built using Java + Serlet technology. It is currently at version 1.0 beta 8.</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 +>URL: + <A +HREF="http://scarab.tigris.org/" +TARGET="_top" +>http://scarab.tigris.org</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 -> 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 + </P ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="AEN2531">D.5.2. Coding Style for Bugzilla</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 +NAME="variant-perforce">D.5. Perforce SCM</H1 ><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 +>Although Perforce isn't really a bug tracker, it can be used as + such through the <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 +>"jobs"</SPAN > - 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 + functionality.</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 +>URL: + <A +HREF="http://www.perforce.com/perforce/technotes/note052.html" +TARGET="_top" +> http://www.perforce.com/perforce/technotes/note052.html + </A > - 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 + </P ></DIV ><DIV -CLASS="appendix" +CLASS="section" ><HR><H1 +CLASS="section" ><A -NAME="gfdl">Appendix E. GNU Free Documentation License</H1 -><P ->Version 1.1, March 2000</P -><A -NAME="AEN2596"><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><H2 -CLASS="sect1" -><A -NAME="gfdl-0">0. PREAMBLE</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-1">1. APPLICABILITY AND DEFINITIONS</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-2">2. VERBATIM COPYING</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-3">3. COPYING IN QUANTITY</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-4">4. MODIFICATIONS</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-5">5. COMBINING DOCUMENTS</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-6">6. COLLECTIONS OF DOCUMENTS</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-7">7. AGGREGATION WITH INDEPENDENT WORKS</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-8">8. TRANSLATION</H2 +NAME="variant-sourceforge">D.6. SourceForge</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><H2 -CLASS="sect1" -><A -NAME="gfdl-9">9. TERMINATION</H2 -><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><H2 -CLASS="sect1" -><A -NAME="gfdl-10">10. FUTURE REVISIONS OF THIS LICENSE</H2 +>SourceForge is a way of coordinating geographically + distributed free software and open source projects over the Internet. + It has a built-in bug tracker, but it's not highly thought of.</P ><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/" +>URL: + <A +HREF="http://www.sourceforge.net" 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><H2 -CLASS="sect1" -><A -NAME="gfdl-howto">How to use this License for your documents</H2 -><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="AEN2686"><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 +> http://www.sourceforge.net</A +> + </P ></DIV ></DIV ><DIV @@ -16367,7 +12002,7 @@ CLASS="glossdiv" ><H1 CLASS="glossdiv" ><A -NAME="AEN2691">0-9, high ascii</H1 +NAME="AEN2183">0-9, high ascii</H1 ><DL ><DT ><B @@ -16375,24 +12010,22 @@ NAME="AEN2691">0-9, high ascii</H1 ></DT ><DD ><P -> Apache web server, and other NCSA-compliant web servers, - observe the convention of using files in directories - called <TT +>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 +> + + to restrict access to certain files. In Bugzilla, they are used + to keep secret files which would otherwise + compromise your installation - e.g. 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 +> + file contains the password to your database. + curious.</P ></DD ></DL ></DIV @@ -16409,23 +12042,28 @@ NAME="gloss-a">A</H1 ></DT ><DD ><P ->In this context, Apache is the web server most - commonly used for serving up - <I +>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 +> + + 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 +> + + version of the original + <SPAN CLASS="acronym" >NCSA</SPAN -> world-wide-web server.</P +> + + world-wide-web server.</P ></DD ></DL ></DIV @@ -16442,21 +12080,24 @@ NAME="gloss-b">B</H1 ></DT ><DD ><P -> A <SPAN +>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 +>"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 +> + or + <SPAN CLASS="QUOTE" >"issues"</SPAN ->; in the - context of Bugzilla, they are synonymous. - </P +>; + in the context of Bugzilla, they are synonymous.</P ></DD ><DT ><B @@ -16464,29 +12105,10 @@ CLASS="QUOTE" ></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 +>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 @@ -16494,9 +12116,8 @@ CLASS="QUOTE" ></DT ><DD ><P -> Bugzilla is the industry-standard bug tracking system. It - is quite popular among Open Source enthusiasts. - </P +>Bugzilla is the world-leading free software bug tracking system. + </P ></DD ></DL ></DIV @@ -16514,39 +12135,39 @@ NAME="gloss-component"><B ></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 +>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 +> <SPAN CLASS="acronym" >CPAN</SPAN -></B +> + </B ></DT ><DD ><P -><SPAN +> <SPAN CLASS="acronym" >CPAN</SPAN -> stands for the - <SPAN +> + + stands for the + <SPAN CLASS="QUOTE" >"Comprehensive Perl Archive Network"</SPAN ->. CPAN - maintains a large number of extremely useful - <I +>. + 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 +> + modules - encapsulated chunks of code for performing a + particular task.</P ></DD ></DL ></DIV @@ -16563,18 +12184,19 @@ NAME="gloss-d">D</H1 ></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 +>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 +>, + the MySQL server, and + <I CLASS="glossterm" >apache</I ->, a web - server, are generally run as daemons.</P +>, + a web server, are generally run as daemons.</P ></DD ></DL ></DIV @@ -16591,43 +12213,25 @@ NAME="gloss-g"></H1 ></DT ><DD ><P ->The word <SPAN +>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 +> + + has a very special meaning to Bugzilla. Bugzilla's main security + mechanism comes by placing users in groups, and assigning those + groups certain privileges to view bugs in particular + <I CLASS="glossterm" >Products</I -> and - <I -CLASS="glossterm" ->Components</I -> in the - <I +> + in the + <I CLASS="glossterm" >Bugzilla</I -> database.</P -></DD -></DL -></DIV -><DIV -CLASS="glossdiv" -><H1 -CLASS="glossdiv" -><A -NAME="gloss-i">I</H1 -><DL -><DT -><A -NAME="gloss-infiniteloop"><B ->Infinite Loop</B -></DT -><DD -><P ->A loop of information that never ends; see recursion.</P +> + database.</P ></DD ></DL ></DIV @@ -16644,15 +12248,16 @@ NAME="gloss-m">M</H1 ></DT ><DD ><P ->mysqld is the name of the - <I +>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 +> + + 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 @@ -16669,55 +12274,11 @@ NAME="gloss-p">P</H1 ></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="AEN2782"><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 +>A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, + there are several Components to a Product. A Product may define a + group (used for security) for all bugs entered into + its Components.</P ></DD ><DT ><B @@ -16725,15 +12286,16 @@ CLASS="QUOTE" ></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 +>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 +> + + is maintained in Perl.</P ></DD ></DL ></DIV @@ -16750,57 +12312,33 @@ NAME="gloss-q">Q</H1 ></DT ><DD ><P -><SPAN +> <SPAN CLASS="QUOTE" >"QA"</SPAN ->, <SPAN +>, + <SPAN CLASS="QUOTE" >"Q/A"</SPAN ->, and - <SPAN +>, and + <SPAN CLASS="QUOTE" >"Q.A."</SPAN -> are short for <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 +>"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</H1 -><DL -><DT -><A -NAME="gloss-recursion"><B ->Recursion</B -></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 +> + + field in a bug.</P ></DD ></DL ></DIV @@ -16813,57 +12351,71 @@ NAME="gloss-s">S</H1 ><DL ><DT ><B -><SPAN +> <SPAN CLASS="acronym" >SGML</SPAN -></B +> + </B ></DT ><DD ><P -><SPAN +> <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 +> + + 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 +> + + has withstood the test of time as a robust, powerful language. + <I CLASS="glossterm" -><SPAN +> <SPAN CLASS="acronym" >XML</SPAN -></I -> is the - <SPAN +> + </I +> + + is the + <SPAN CLASS="QUOTE" >"baby brother"</SPAN -> of SGML; any valid - <SPAN +> + + of SGML; any valid + <SPAN CLASS="acronym" >XML</SPAN -> document it, by definition, a valid - <SPAN +> + + document it, by definition, a valid + <SPAN CLASS="acronym" >SGML</SPAN -> document. The document you are - reading is written and maintained in - <SPAN +> + + document. The document you are reading is written and maintained in + <SPAN CLASS="acronym" >SGML</SPAN ->, and is also valid - <SPAN +>, + and is also valid + <SPAN CLASS="acronym" >XML</SPAN -> if you modify the Document Type - Definition.</P +> + + if you modify the Document Type Definition.</P ></DD ></DL ></DIV @@ -16881,18 +12433,18 @@ NAME="gloss-target-milestone"><B ></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 +>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 +> + + 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 @@ -16910,9 +12462,9 @@ NAME="zarro-boogs-found"><B ></DT ><DD ><P ->This is the cryptic response sent by Bugzilla when a - query returned no results. It is just a goofy way of - saying "Zero Bugs Found".</P +>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 diff --git a/docs/html/about.html b/docs/html/about.html index cef771118..7f1f78467 100644 --- a/docs/html/about.html +++ b/docs/html/about.html @@ -13,8 +13,8 @@ REL="PREVIOUS" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="NEXT" -TITLE="Purpose and Scope of this Guide" -HREF="aboutthisguide.html"></HEAD +TITLE="Copyright Information" +HREF="copyright.html"></HEAD ><BODY CLASS="chapter" BGCOLOR="#FFFFFF" @@ -56,7 +56,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="aboutthisguide.html" +HREF="copyright.html" ACCESSKEY="N" >Next</A ></TD @@ -79,36 +79,26 @@ CLASS="TOC" ></DT ><DT >1.1. <A -HREF="aboutthisguide.html" ->Purpose and Scope of this Guide</A -></DT -><DT ->1.2. <A HREF="copyright.html" >Copyright Information</A ></DT ><DT ->1.3. <A +>1.2. <A HREF="disclaimer.html" >Disclaimer</A ></DT ><DT ->1.4. <A +>1.3. <A HREF="newversions.html" >New Versions</A ></DT ><DT ->1.5. <A +>1.4. <A HREF="credits.html" >Credits</A ></DT ><DT ->1.6. <A -HREF="translations.html" ->Translations</A -></DT -><DT ->1.7. <A +>1.5. <A HREF="conventions.html" >Document Conventions</A ></DT @@ -149,7 +139,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="aboutthisguide.html" +HREF="copyright.html" ACCESSKEY="N" >Next</A ></TD @@ -169,7 +159,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->Purpose and Scope of this Guide</TD +>Copyright Information</TD ></TR ></TABLE ></DIV diff --git a/docs/html/aboutthisguide.html b/docs/html/aboutthisguide.html deleted file mode 100644 index cbd21435c..000000000 --- a/docs/html/aboutthisguide.html +++ /dev/null @@ -1,184 +0,0 @@ -<HTML -><HEAD -><TITLE ->Purpose and Scope of this Guide</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="About This Guide" -HREF="about.html"><LINK -REL="PREVIOUS" -TITLE="About This Guide" -HREF="about.html"><LINK -REL="NEXT" -TITLE="Copyright Information" -HREF="copyright.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="about.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 1. About This Guide</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="copyright.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="aboutthisguide">1.1. Purpose and Scope of this Guide</H1 -><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.16</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.bugzilla.org/" -TARGET="_top" ->http://www.bugzilla.org/</A ->. Intermediate releases will have - a minor revision number following a period. The current version - of Bugzilla, as of this writing (April 2nd, 2002) is 2.16; 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.16.1, 2.16.2, etc.). - Got it? Good. - </P -></DIV -><DIV -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="about.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="copyright.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->About This Guide</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="about.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Copyright Information</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/administration.html b/docs/html/administration.html index 24a48255b..c85d9acdd 100644 --- a/docs/html/administration.html +++ b/docs/html/administration.html @@ -10,11 +10,11 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="Win32 Installation Notes" -HREF="win32.html"><LINK +TITLE="Troubleshooting" +HREF="troubleshooting.html"><LINK REL="NEXT" -TITLE="Post-Installation Checklist" -HREF="postinstall-check.html"></HEAD +TITLE="Bugzilla Configuration" +HREF="parameters.html"></HEAD ><BODY CLASS="chapter" BGCOLOR="#FFFFFF" @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="win32.html" +HREF="troubleshooting.html" ACCESSKEY="P" >Prev</A ></TD @@ -56,7 +56,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="postinstall-check.html" +HREF="parameters.html" ACCESSKEY="N" >Next</A ></TD @@ -69,7 +69,7 @@ WIDTH="100%"></DIV CLASS="chapter" ><H1 ><A -NAME="administration">Chapter 4. Administering Bugzilla</H1 +NAME="administration">Chapter 5. Administering Bugzilla</H1 ><DIV CLASS="TOC" ><DL @@ -78,97 +78,138 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->4.1. <A -HREF="postinstall-check.html" ->Post-Installation Checklist</A +>5.1. <A +HREF="parameters.html" +>Bugzilla Configuration</A ></DT ><DT ->4.2. <A +>5.2. <A HREF="useradmin.html" >User Administration</A ></DT ><DD ><DL ><DT ->4.2.1. <A +>5.2.1. <A HREF="useradmin.html#defaultuser" >Creating the Default User</A ></DT ><DT ->4.2.2. <A +>5.2.2. <A HREF="useradmin.html#manageusers" >Managing Other Users</A ></DT ></DL ></DD ><DT ->4.3. <A +>5.3. <A HREF="programadmin.html" ->Product, Component, Milestone, and Version - Administration</A +>Product, Component, Milestone, and Version Administration</A ></DT ><DD ><DL ><DT ->4.3.1. <A +>5.3.1. <A HREF="programadmin.html#products" >Products</A ></DT ><DT ->4.3.2. <A +>5.3.2. <A HREF="programadmin.html#components" >Components</A ></DT ><DT ->4.3.3. <A +>5.3.3. <A HREF="programadmin.html#versions" >Versions</A ></DT ><DT ->4.3.4. <A +>5.3.4. <A HREF="programadmin.html#milestones" >Milestones</A ></DT +></DL +></DD ><DT ->4.3.5. <A -HREF="programadmin.html#voting" +>5.4. <A +HREF="voting.html" >Voting</A ></DT ><DT ->4.3.6. <A -HREF="programadmin.html#groups" +>5.5. <A +HREF="groups.html" >Groups and Group Security</A ></DT -></DL -></DD ><DT ->4.4. <A +>5.6. <A HREF="security.html" >Bugzilla Security</A ></DT +><DT +>5.7. <A +HREF="cust-templates.html" +>Template Customisation</A +></DT +><DD +><DL +><DT +>5.7.1. <A +HREF="cust-templates.html#AEN1539" +>What to Edit</A +></DT +><DT +>5.7.2. <A +HREF="cust-templates.html#AEN1558" +>How To Edit Templates</A +></DT +><DT +>5.7.3. <A +HREF="cust-templates.html#AEN1568" +>Template Formats</A +></DT +><DT +>5.7.4. <A +HREF="cust-templates.html#AEN1581" +>Particular Templates</A +></DT +></DL +></DD +><DT +>5.8. <A +HREF="upgrading.html" +>Upgrading to New Releases</A +></DT +><DT +>5.9. <A +HREF="integration.html" +>Integrating Bugzilla with Third-Party Tools</A +></DT +><DD +><DL +><DT +>5.9.1. <A +HREF="integration.html#bonsai" +>Bonsai</A +></DT +><DT +>5.9.2. <A +HREF="integration.html#cvs" +>CVS</A +></DT +><DT +>5.9.3. <A +HREF="integration.html#scm" +>Perforce SCM</A +></DT +><DT +>5.9.4. <A +HREF="integration.html#tinderbox" +>Tinderbox/Tinderbox2</A +></DT +></DL +></DD ></DL ></DIV -><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.html" ->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 ><DIV CLASS="NAVFOOTER" @@ -186,7 +227,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="win32.html" +HREF="troubleshooting.html" ACCESSKEY="P" >Prev</A ></TD @@ -204,7 +245,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="postinstall-check.html" +HREF="parameters.html" ACCESSKEY="N" >Next</A ></TD @@ -214,7 +255,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Win32 Installation Notes</TD +>Troubleshooting</TD ><TD WIDTH="34%" ALIGN="center" @@ -224,7 +265,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->Post-Installation Checklist</TD +>Bugzilla Configuration</TD ></TR ></TABLE ></DIV diff --git a/docs/html/bonsai.html b/docs/html/bonsai.html deleted file mode 100644 index 034f483b1..000000000 --- a/docs/html/bonsai.html +++ /dev/null @@ -1,160 +0,0 @@ -<HTML -><HEAD -><TITLE ->Bonsai</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"><LINK -REL="PREVIOUS" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"><LINK -REL="NEXT" -TITLE="CVS" -HREF="cvs.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="integration.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 5. Integrating Bugzilla with Third-Party Tools</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="cvs.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="bonsai">5.1. Bonsai</H1 -><P ->Bonsai is a web-based tool for managing <A -HREF="cvs.html" ->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.html" ->Tinderbox, the Mozilla automated build management system</A -> and Bugzilla </P -></DIV -><DIV -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="integration.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="cvs.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Integrating Bugzilla with Third-Party Tools</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="integration.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->CVS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/bsdinstall.html b/docs/html/bsdinstall.html deleted file mode 100644 index 84bcdbfcc..000000000 --- a/docs/html/bsdinstall.html +++ /dev/null @@ -1,149 +0,0 @@ -<HTML -><HEAD -><TITLE ->BSD Installation Notes</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Installation" -HREF="installation.html"><LINK -REL="PREVIOUS" -TITLE="Mac OS X Installation Notes" -HREF="osx.html"><LINK -REL="NEXT" -TITLE="Installation General Notes" -HREF="geninstall.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="osx.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 3. Installation</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="geninstall.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="bsdinstall">3.4. BSD Installation Notes</H1 -><P -> For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please - consult <A -HREF="osx.html" ->Section 3.3</A ->. - </P -></DIV -><DIV -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="osx.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="geninstall.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Mac OS X Installation Notes</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="installation.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Installation General Notes</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/bzhacking.html b/docs/html/bzhacking.html deleted file mode 100644 index d34310624..000000000 --- a/docs/html/bzhacking.html +++ /dev/null @@ -1,492 +0,0 @@ -<HTML -><HEAD -><TITLE ->Hacking Bugzilla</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Useful Patches and Utilities for Bugzilla" -HREF="patches.html"><LINK -REL="PREVIOUS" -TITLE="The Quicksearch Utility" -HREF="quicksearch.html"><LINK -REL="NEXT" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="quicksearch.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix D. Useful Patches and Utilities for Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="bzhacking">D.5. Hacking Bugzilla</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" -><H2 -CLASS="section" -><A -NAME="AEN2436">D.5.1. Things that have caused problems and should be avoided</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" -><H2 -CLASS="section" -><A -NAME="AEN2450">D.5.2. Coding Style for Bugzilla</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 -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="quicksearch.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->The Quicksearch Utility</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="patches.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->GNU Free Documentation License</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/cmdline.html b/docs/html/cmdline.html index 9553d2eb6..a3825c25a 100644 --- a/docs/html/cmdline.html +++ b/docs/html/cmdline.html @@ -13,11 +13,14 @@ REL="UP" TITLE="Useful Patches and Utilities for Bugzilla" HREF="patches.html"><LINK REL="PREVIOUS" -TITLE="The setperl.csh Utility" -HREF="setperl.html"><LINK +TITLE="Apache + mod_rewrite + + magic" +HREF="rewrite.html"><LINK REL="NEXT" -TITLE="The Quicksearch Utility" -HREF="quicksearch.html"></HEAD +TITLE="Bugzilla Variants and Competitors" +HREF="variants.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +48,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="setperl.html" +HREF="rewrite.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +56,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Appendix D. Useful Patches and Utilities for Bugzilla</TD +>Appendix C. Useful Patches and Utilities for Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="quicksearch.html" +HREF="variants.html" ACCESSKEY="N" >Next</A ></TD @@ -73,134 +76,80 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="cmdline">D.3. Command-line Bugzilla Queries</H1 +NAME="cmdline">C.2. Command-line Bugzilla Queries</H1 ><P -> Users can query Bugzilla from the command line using this suite - of utilities. - </P +>There are a suite of Unix utilities for querying Bugzilla from the + command line. They live in the + <TT +CLASS="filename" +>contrib/cmdline</TT +> + directory. However, they + have not yet been updated to work with 2.16 (post-templatisation.). + There are three files - <TT +CLASS="filename" +>query.conf</TT +>, + <TT +CLASS="filename" +>buglist</TT +> and <TT +CLASS="filename" +>bugs</TT +>.</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 +><TT +CLASS="filename" +>query.conf</TT +> + 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 +><TT +CLASS="filename" +>buglist</TT +> + 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 +>The column list 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, grep for COLUMNLIST + in your cookies file 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 +><TT +CLASS="filename" +>bugs</TT +> is a simple shell script which calls + <TT +CLASS="filename" +>buglist</TT +> 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 +>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</B > </P ><P -> Akkana says she has good results piping buglist output through - <B +>Akkana Peck says she has good results piping + <TT +CLASS="filename" +>buglist</TT +> 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="NAVFOOTER" @@ -218,7 +167,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="setperl.html" +HREF="rewrite.html" ACCESSKEY="P" >Prev</A ></TD @@ -236,7 +185,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="quicksearch.html" +HREF="variants.html" ACCESSKEY="N" >Next</A ></TD @@ -246,7 +195,13 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->The setperl.csh Utility</TD +>Apache + <TT +CLASS="filename" +>mod_rewrite</TT +> + + magic</TD ><TD WIDTH="34%" ALIGN="center" @@ -260,7 +215,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->The Quicksearch Utility</TD +>Bugzilla Variants and Competitors</TD ></TR ></TABLE ></DIV diff --git a/docs/html/contributors.html b/docs/html/contributors.html deleted file mode 100644 index 5d4e28e0c..000000000 --- a/docs/html/contributors.html +++ /dev/null @@ -1,150 +0,0 @@ -<HTML -><HEAD -><TITLE ->Contributors</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="About This Guide" -HREF="about.html"><LINK -REL="PREVIOUS" -TITLE="Credits" -HREF="credits.html"><LINK -REL="NEXT" -TITLE="Feedback" -HREF="feedback.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="credits.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 1. About This Guide</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="feedback.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="contributors">1.6. Contributors</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="credits.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="feedback.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Credits</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="about.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Feedback</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/conventions.html b/docs/html/conventions.html index d86336cc1..40ce3f8c4 100644 --- a/docs/html/conventions.html +++ b/docs/html/conventions.html @@ -13,11 +13,11 @@ REL="UP" TITLE="About This Guide" HREF="about.html"><LINK REL="PREVIOUS" -TITLE="Translations" -HREF="translations.html"><LINK +TITLE="Credits" +HREF="credits.html"><LINK REL="NEXT" -TITLE="Using Bugzilla" -HREF="using.html"></HEAD +TITLE="Introduction" +HREF="introduction.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="translations.html" +HREF="credits.html" ACCESSKEY="P" >Prev</A ></TD @@ -59,7 +59,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="N" >Next</A ></TD @@ -73,14 +73,13 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="conventions">1.7. Document Conventions</H1 +NAME="conventions">1.5. Document Conventions</H1 ><P -> This document uses the following conventions - </P +>This document uses the following conventions:</P ><DIV CLASS="informaltable" ><A -NAME="AEN91"><P +NAME="AEN178"><P ></P ><TABLE BORDER="0" @@ -106,7 +105,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="caution" ><P ></P @@ -132,7 +131,8 @@ VALIGN="TOP" ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -142,7 +142,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="tip" ><P ></P @@ -163,12 +163,13 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Warm jar lids under the hot tap to loosen them.</P +>Would you like a breath mint?</P ></TD ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -178,7 +179,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="note" ><P ></P @@ -204,7 +205,8 @@ VALIGN="TOP" ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -214,7 +216,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><DIV +> <DIV CLASS="warning" ><P ></P @@ -240,7 +242,8 @@ VALIGN="TOP" ></TR ></TABLE ></DIV -></TD +> + </TD ></TR ><TR ><TD @@ -250,10 +253,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="filename" ->file.extension</TT -></TD +>filename</TT +> + </TD ></TR ><TR ><TD @@ -263,10 +267,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="filename" >directory</TT -></TD +> + </TD ></TR ><TR ><TD @@ -276,10 +281,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><B +> <B CLASS="command" >command</B -></TD +> + </TD ></TR ><TR ><TD @@ -289,19 +295,22 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><SPAN +> <SPAN CLASS="application" >application</SPAN -></TD +> + </TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of users command under bash shell</TD +> + + of users command under bash shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -311,10 +320,12 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of root users command under bash shell</TD +> + + of root users command under bash shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -324,10 +335,12 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><I +> <I CLASS="foreignphrase" >Prompt</I -> of user command under tcsh shell</TD +> + + of user command under tcsh shell</TD ><TD ALIGN="LEFT" VALIGN="MIDDLE" @@ -341,10 +354,11 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TT +> <TT CLASS="envar" >VARIABLE</TT -></TD +> + </TD ></TR ><TR ><TD @@ -354,9 +368,10 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><EM +> <EM >word</EM -></TD +> + </TD ></TR ><TR ><TD @@ -366,7 +381,7 @@ VALIGN="MIDDLE" ><TD ALIGN="LEFT" VALIGN="MIDDLE" -><TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -379,7 +394,9 @@ CLASS="programlisting" ><TT CLASS="sgmltag" ><para></TT ->Beginning and end of paragraph<TT +> +Beginning and end of paragraph +<TT CLASS="sgmltag" ></para></TT ></PRE @@ -387,7 +404,8 @@ CLASS="sgmltag" ></TD ></TR ></TABLE -></TD +> + </TD ></TR ></TBODY ></TABLE @@ -411,7 +429,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="translations.html" +HREF="credits.html" ACCESSKEY="P" >Prev</A ></TD @@ -429,7 +447,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="N" >Next</A ></TD @@ -439,7 +457,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Translations</TD +>Credits</TD ><TD WIDTH="34%" ALIGN="center" @@ -453,7 +471,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Using Bugzilla</TD +>Introduction</TD ></TR ></TABLE ></DIV diff --git a/docs/html/copyright.html b/docs/html/copyright.html index 7506903bb..8501809e6 100644 --- a/docs/html/copyright.html +++ b/docs/html/copyright.html @@ -13,8 +13,8 @@ REL="UP" TITLE="About This Guide" HREF="about.html"><LINK REL="PREVIOUS" -TITLE="Purpose and Scope of this Guide" -HREF="aboutthisguide.html"><LINK +TITLE="About This Guide" +HREF="about.html"><LINK REL="NEXT" TITLE="Disclaimer" HREF="disclaimer.html"></HEAD @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="aboutthisguide.html" +HREF="about.html" ACCESSKEY="P" >Prev</A ></TD @@ -73,9 +73,9 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="copyright">1.2. Copyright Information</H1 +NAME="copyright">1.1. Copyright Information</H1 ><A -NAME="AEN39"><TABLE +NAME="AEN31"><TABLE BORDER="0" WIDTH="100%" CELLSPACING="0" @@ -95,8 +95,7 @@ VALIGN="TOP" 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". + the license is included below. </P ></TD ><TD @@ -123,6 +122,477 @@ WIDTH="10%" copyright, or publishing this document in non-electronic form, please contact The Bugzilla Team. </P +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="gfdl">1.1.1. GNU Free Documentation License</H2 +><P +>Version 1.1, March 2000</P +><A +NAME="AEN38"><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-0">0. PREAMBLE</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-1">1. APPLICABILITY AND DEFINITIONS</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-2">2. VERBATIM COPYING</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-3">3. COPYING IN QUANTITY</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-4">4. MODIFICATIONS</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-5">5. COMBINING DOCUMENTS</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-6">6. COLLECTIONS OF DOCUMENTS</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-7">7. AGGREGATION WITH INDEPENDENT WORKS</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-8">8. TRANSLATION</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-9">9. TERMINATION</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-10">10. FUTURE REVISIONS OF THIS LICENSE</H3 +><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="section" +><H3 +CLASS="section" +><A +NAME="gfdl-howto">How to use this License for your documents</H3 +><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="AEN128"><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 ><DIV CLASS="NAVFOOTER" @@ -140,7 +610,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="aboutthisguide.html" +HREF="about.html" ACCESSKEY="P" >Prev</A ></TD @@ -168,7 +638,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Purpose and Scope of this Guide</TD +>About This Guide</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/credits.html b/docs/html/credits.html index c4d3a69f6..a15f56fb7 100644 --- a/docs/html/credits.html +++ b/docs/html/credits.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="New Versions" HREF="newversions.html"><LINK REL="NEXT" -TITLE="Translations" -HREF="translations.html"></HEAD +TITLE="Document Conventions" +HREF="conventions.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -59,7 +59,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="translations.html" +HREF="conventions.html" ACCESSKEY="N" >Next</A ></TD @@ -73,10 +73,10 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="credits">1.5. Credits</H1 +NAME="credits">1.4. Credits</H1 ><P > The people listed below have made enormous contributions to the - creation of this Guide, through their dedicated hacking efforts, + creation of this Guide, through their writing, dedicated hacking efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: </P @@ -86,7 +86,8 @@ HREF="mailto://mbarnson@sisna.com" TARGET="_top" >Matthew P. Barnson</A > - for pulling together the Bugzilla Guide and shepherding it to 2.14. + for the Herculaean task of pulling together the Bugzilla Guide and + shepherding it to 2.14. </P ><P > <A @@ -101,18 +102,18 @@ TARGET="_top" > <A HREF="mailto://tara@tequilarista.org" TARGET="_top" ->Tara - Hernandez</A -> for keeping Bugzilla development going - strong after Terry left Mozilla.org +>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 +> + for providing insight into the key differences between Red Hat's customized Bugzilla, and being largely responsible for the "Red Hat Bugzilla" appendix </P @@ -126,7 +127,8 @@ TARGET="_top" questions and arguments on irc.mozilla.org in #mozwebtools </P ><P -> Last but not least, all the members of the <A +> 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 @@ -138,7 +140,7 @@ TARGET="_top" </P ><P > Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, - Ron Teitelbaum, Jacob Steenhagen, Joe Robins. + Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham. </P ></DIV ><DIV @@ -175,7 +177,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="translations.html" +HREF="conventions.html" ACCESSKEY="N" >Next</A ></TD @@ -199,7 +201,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Translations</TD +>Document Conventions</TD ></TR ></TABLE ></DIV diff --git a/docs/html/cust-templates.html b/docs/html/cust-templates.html new file mode 100644 index 000000000..7987f2aba --- /dev/null +++ b/docs/html/cust-templates.html @@ -0,0 +1,585 @@ +<HTML +><HEAD +><TITLE +>Template Customisation</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="PREVIOUS" +TITLE="Bugzilla Security" +HREF="security.html"><LINK +REL="NEXT" +TITLE="Upgrading to New Releases" +HREF="upgrading.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="security.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Administering Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="upgrading.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="cust-templates">5.7. Template Customisation</H1 +><P +> One of the large changes for 2.16 was the templatisation of the + entire user-facing UI, using the + <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template Toolkit</A +>. + Administrators can now configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + </P +><P +> Templatisation also makes localised versions of Bugzilla possible, + for the first time. In the future, a Bugzilla installation may + have templates installed for multiple localisations, and select + which ones to use based on the user's browser language setting. + </P +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1539">5.7.1. What to Edit</H2 +><P +> There are two different ways of editing of Bugzilla's templates, + and which you use depends mainly on how you upgrade Bugzilla. The + template directory structure is that there's a top level directory, + <TT +CLASS="filename" +>template</TT +>, which contains a directory for + each installed localisation. The default English templates are + therefore in <TT +CLASS="filename" +>en</TT +>. Underneath that, there + is the <TT +CLASS="filename" +>default</TT +> directory and optionally the + <TT +CLASS="filename" +>custom</TT +> directory. The <TT +CLASS="filename" +>default</TT +> + directory contains all the templates shipped with Bugzilla, whereas + the <TT +CLASS="filename" +>custom</TT +> directory does not exist at first and + must be created if you want to use it. + </P +><P +> The first method of making customisations is to directly edit the + templates in <TT +CLASS="filename" +>template/en/default</TT +>. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + <B +CLASS="command" +>cvs update</B +>, any template fixes will get + automagically merged into your modified versions. + </P +><P +> If you use this method, your installation will break if CVS conflicts + occur. + </P +><P +> The other method is to copy the templates into a mirrored directory + structure under <TT +CLASS="filename" +>template/en/custom</TT +>. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. + </P +><P +> If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. + </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 directly edit the compiled templates in + <TT +CLASS="filename" +>data/template/*</TT +> - your + changes will be lost when Template Toolkit recompiles them. + </P +></TD +></TR +></TABLE +></DIV +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1558">5.7.2. How To Edit Templates</H2 +><P +> The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template Toolkit home + page</A +>. However, you should particularly remember (for security + reasons) to always HTML filter things which come from the database or + user input, to prevent cross-site scripting attacks. + </P +><P +> However, one thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you fail to do this, you may open up + your installation to cross-site scripting attacks. + </P +><P +> Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. + </P +><P +> Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + </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 are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + <A +HREF="http://www.bugzilla.org/developerguide.html" +TARGET="_top" +>Developers' + Guide</A +>. + </P +></TD +></TR +></TABLE +></DIV +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1568">5.7.3. Template Formats</H2 +><P +> Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending <TT +CLASS="filename" +>&format=simple</TT +> to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. + </P +><P +> To see if a CGI supports multiple output formats, grep the + CGI for "ValidateOutputFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs. + </P +><P +> To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. + </P +><P +> Write your template in whatever markup or text style is appropriate. + </P +><P +> You now need to decide what content type you want your template + served as. Open up the <TT +CLASS="filename" +>localconfig</TT +> file and find the + <TT +CLASS="filename" +>$contenttypes</TT +> + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. + </P +><P +> Save the template as <TT +CLASS="filename" +><stubname>-<formatname>.<contenttypetag>.tmpl</TT +>. + Try out the template by calling the CGI as + <TT +CLASS="filename" +><cginame>.cgi?format=<formatname></TT +> . + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1581">5.7.4. Particular Templates</H2 +><P +> There are a few templates you may be particularly interested in + customising for your installation. + </P +><P +> <B +CLASS="command" +>index.html.tmpl</B +>: + This is the Bugzilla front page. + </P +><P +> <B +CLASS="command" +>global/header.html.tmpl</B +>: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + </P +><P +> <B +CLASS="command" +>global/banner.html.tmpl</B +>: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customise this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + </P +><P +> <B +CLASS="command" +>global/footer.html.tmpl</B +>: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + </P +><P +> <B +CLASS="command" +>bug/create/user-message.html.tmpl</B +>: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + </P +><P +> <B +CLASS="command" +>bug/create/create.html.tmpl</B +> and + <B +CLASS="command" +>bug/create/comment.txt.tmpl</B +>: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided" +TARGET="_top" +>guided + bug submission form</A +>. + </P +><P +> To make this work, create a custom template for + <TT +CLASS="filename" +>enter_bug.cgi</TT +> (the default template, on which you + could base it, is <TT +CLASS="filename" +>create.html.tmpl</TT +>), + and either call it <TT +CLASS="filename" +>create.html.tmpl</TT +> or use a format and + call it <TT +CLASS="filename" +>create-<formatname>.html.tmpl</TT +>. + Put it in the <TT +CLASS="filename" +>custom/bug/create</TT +> + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + </P +><P +> Then, create a template like + <TT +CLASS="filename" +>custom/bug/create/comment.txt.tmpl</TT +>, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + </P +><P +> For example, if your enter_bug template had a field + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +><input type="text" name="buildid" size="30"></PRE +></FONT +></TD +></TR +></TABLE +> + and then your comment.txt.tmpl had + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>BuildID: [% form.buildid %]</PRE +></FONT +></TD +></TR +></TABLE +> + then + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>BuildID: 20020303</PRE +></FONT +></TD +></TR +></TABLE +> + would appear in the initial checkin comment. + </P +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="security.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="upgrading.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Bugzilla Security</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Upgrading to New Releases</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/cvs.html b/docs/html/cvs.html deleted file mode 100644 index edc17f315..000000000 --- a/docs/html/cvs.html +++ /dev/null @@ -1,174 +0,0 @@ -<HTML -><HEAD -><TITLE ->CVS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"><LINK -REL="PREVIOUS" -TITLE="Bonsai" -HREF="bonsai.html"><LINK -REL="NEXT" -TITLE="Perforce SCM" -HREF="scm.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="bonsai.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 5. Integrating Bugzilla with Third-Party Tools</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="scm.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="cvs">5.2. CVS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="bonsai.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="scm.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Bonsai</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="integration.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Perforce SCM</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/database.html b/docs/html/database.html index f9e826544..95bce503e 100644 --- a/docs/html/database.html +++ b/docs/html/database.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="Software Download Links" -HREF="downloadlinks.html"><LINK +TITLE="The Bugzilla FAQ" +HREF="faq.html"><LINK REL="NEXT" TITLE="Database Schema Chart" HREF="dbschema.html"></HEAD @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="downloadlinks.html" +HREF="faq.html" ACCESSKEY="P" >Prev</A ></TD @@ -69,7 +69,7 @@ WIDTH="100%"></DIV CLASS="appendix" ><H1 ><A -NAME="database">Appendix C. The Bugzilla Database</H1 +NAME="database">Appendix B. The Bugzilla Database</H1 ><DIV CLASS="TOC" ><DL @@ -78,20 +78,15 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->C.1. <A +>B.1. <A HREF="dbschema.html" >Database Schema Chart</A ></DT ><DT ->C.2. <A +>B.2. <A HREF="dbdoc.html" >MySQL Bugzilla Database Introduction</A ></DT -><DT ->C.3. <A -HREF="granttables.html" ->MySQL Permissions & Grant Tables</A -></DT ></DL ></DIV ><DIV @@ -115,8 +110,9 @@ ALT="Note"></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 +>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 @@ -138,7 +134,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="downloadlinks.html" +HREF="faq.html" ACCESSKEY="P" >Prev</A ></TD @@ -166,7 +162,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Software Download Links</TD +>The Bugzilla FAQ</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/dbdoc.html b/docs/html/dbdoc.html index 589a7a7bd..49e9b6526 100644 --- a/docs/html/dbdoc.html +++ b/docs/html/dbdoc.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="Database Schema Chart" HREF="dbschema.html"><LINK REL="NEXT" -TITLE="MySQL Permissions & Grant Tables" -HREF="granttables.html"></HEAD +TITLE="Useful Patches and Utilities for Bugzilla" +HREF="patches.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Appendix C. The Bugzilla Database</TD +>Appendix B. The Bugzilla Database</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="granttables.html" +HREF="patches.html" ACCESSKEY="N" >Next</A ></TD @@ -73,183 +73,171 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="dbdoc">C.2. MySQL Bugzilla Database Introduction</H1 +NAME="dbdoc">B.2. MySQL Bugzilla Database Introduction</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 +>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 +>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 +>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 +>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 +>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 +>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 +>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 +>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" ><H2 CLASS="section" ><A -NAME="AEN2272">C.2.1. Bugzilla Database Basics</H2 +NAME="AEN2077">B.2.1. Bugzilla Database Basics</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 +>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 +> + + and a + <SPAN CLASS="QUOTE" >"tinyint"</SPAN -> entry in MySQL. I recommend you refer - to the MySQL documentation, available at <A +> + + 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 +> + + . 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 +>To connect to your database:</P ><P -> <TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" >mysql</B -><TT +> + + <TT CLASS="parameter" ><I >-u root</I ></TT > - </P + </P ><P -> If this works without asking you for a password, - <EM +>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 +> + + ! 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 + <A +HREF="http://www.mysql.com/php/manual.php3?section=Privilege_system" +TARGET="_top" +>MySQL + searchable documentation</A +>. + </P ></LI ><LI ><P ->You should now be at a prompt that looks like - this:</P +>You should now be at a prompt that looks like this:</P ><P -><TT +> <TT CLASS="prompt" >mysql></TT -></P +> + </P ><P ->At the prompt, if <SPAN +>At the prompt, if + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> is the name - you chose in the<TT +> + + is the name you chose in the + <TT CLASS="filename" >localconfig</TT -> file - for your Bugzilla database, type:</P +> + + file for your Bugzilla database, type:</P ><P -><TT +> <TT CLASS="prompt" >mysql</TT -><B +> + + <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 +> + </P ></LI ></OL > @@ -259,31 +247,31 @@ CLASS="section" ><H3 CLASS="section" ><A -NAME="AEN2301">C.2.1.1. Bugzilla Database Tables</H3 +NAME="AEN2104">B.2.1.1. Bugzilla Database Tables</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 +>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 +> <TT CLASS="prompt" >mysql></TT -><B +> + <B CLASS="command" >show tables from bugs;</B -></P +> + </P ><P ->you'll be able to see all the - <SPAN +>you'll be able to see the names of 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 +> + (tables) in your database.</P ><P >From the command issued above, ou should have some output that looks like this: - <TABLE +<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -319,16 +307,16 @@ CLASS="programlisting" | votes | | watch | +-------------------+ - </PRE +</PRE ></FONT ></TD ></TR ></TABLE -></P +> +</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> @@ -490,21 +478,6 @@ Although you can query by the enum field,&nbs 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 @@ -543,7 +516,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="granttables.html" +HREF="patches.html" ACCESSKEY="N" >Next</A ></TD @@ -567,7 +540,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->MySQL Permissions & Grant Tables</TD +>Useful Patches and Utilities for Bugzilla</TD ></TR ></TABLE ></DIV diff --git a/docs/html/dbschema.html b/docs/html/dbschema.html index 4e6fa37df..f4b0ef714 100644 --- a/docs/html/dbschema.html +++ b/docs/html/dbschema.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Appendix C. The Bugzilla Database</TD +>Appendix B. The Bugzilla Database</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,7 +73,7 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="dbschema">C.1. Database Schema Chart</H1 +NAME="dbschema">B.1. Database Schema Chart</H1 ><P > <DIV CLASS="mediaobject" diff --git a/docs/html/disclaimer.html b/docs/html/disclaimer.html index 982639d90..dfec8aaab 100644 --- a/docs/html/disclaimer.html +++ b/docs/html/disclaimer.html @@ -73,16 +73,15 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="disclaimer">1.3. Disclaimer</H1 +NAME="disclaimer">1.2. Disclaimer</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. + This document may contain errors + and inaccuracies that may damage your system, cause your partner + to leave you, your boss to fire you, your cats to + pee on your furniture and clothing, and global thermonuclear + war. Proceed with caution. </P ><P > All copyrights are held by their respective owners, unless @@ -113,7 +112,7 @@ NAME="disclaimer">1.3. Disclaimer</H1 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 + product, and are responsible for auditing it yourself to ensure your security needs are met. </P ></DIV diff --git a/docs/html/downloadlinks.html b/docs/html/downloadlinks.html deleted file mode 100644 index 768af187f..000000000 --- a/docs/html/downloadlinks.html +++ /dev/null @@ -1,237 +0,0 @@ -<HTML -><HEAD -><TITLE ->Software Download Links</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="PREVIOUS" -TITLE="The Bugzilla FAQ" -HREF="faq.html"><LINK -REL="NEXT" -TITLE="The Bugzilla Database" -HREF="database.html"></HEAD -><BODY -CLASS="appendix" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="faq.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" -></TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="database.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="appendix" -><H1 -><A -NAME="downloadlinks">Appendix B. Software Download Links</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="faq.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="database.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->The Bugzilla FAQ</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -> </TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->The Bugzilla Database</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/errata.html b/docs/html/errata.html deleted file mode 100644 index eb5dd9cc2..000000000 --- a/docs/html/errata.html +++ /dev/null @@ -1,279 +0,0 @@ -<HTML -><HEAD -><TITLE ->ERRATA</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Installation" -HREF="installation.html"><LINK -REL="PREVIOUS" -TITLE="Installation" -HREF="installation.html"><LINK -REL="NEXT" -TITLE="Step-by-step Install" -HREF="stepbystep.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="installation.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 3. Installation</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="stepbystep.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="errata">3.1. ERRATA</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.16 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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="installation.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="stepbystep.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Installation</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="installation.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Step-by-step Install</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/extraconfig.html b/docs/html/extraconfig.html new file mode 100644 index 000000000..fb8ceb445 --- /dev/null +++ b/docs/html/extraconfig.html @@ -0,0 +1,726 @@ +<HTML +><HEAD +><TITLE +>Optional Additional Configuration</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Installation" +HREF="installation.html"><LINK +REL="PREVIOUS" +TITLE="Step-by-step Install" +HREF="stepbystep.html"><LINK +REL="NEXT" +TITLE="Win32 Installation Notes" +HREF="win32.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="stepbystep.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 4. Installation</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="win32.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="extraconfig">4.2. Optional Additional Configuration</H1 +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN845">4.2.1. Dependency Charts</H2 +><P +>As well as the text-based dependency graphs, Bugzilla also + supports dependency graphing, using a package called 'dot'. + Exactly how this works is controlled by the 'webdotbase' parameter, + which can have one of three values: + </P +><P +> <P +></P +><OL +TYPE="1" +><LI +><P +> A complete file path to the command 'dot' (part of + <A +HREF="http://www.graphviz.org/" +TARGET="_top" +>GraphViz</A +>) + will generate the graphs locally + </P +></LI +><LI +><P +> A URL prefix pointing to an installation of the webdot package will + generate the graphs remotely + </P +></LI +><LI +><P +> A blank value will disable dependency graphing. + </P +></LI +></OL +> + </P +><P +>So, to get this working, install + <A +HREF="http://www.graphviz.org/" +TARGET="_top" +>GraphViz</A +>. If you + do that, you need to + <A +HREF="http://httpd.apache.org/docs/mod/mod_imap.html" +TARGET="_top" +>enable + server-side image maps</A +> in Apache. + Alternatively, you could set up a webdot server, or use the AT&T + public webdot server (the + default for the webdotbase param). Note that AT&T's server won't work + if Bugzilla is only accessible using HTTPS. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN860">4.2.2. Bug Graphs</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 + <TT +CLASS="filename" +>collectstats.pl</TT +> + 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" +><H2 +CLASS="section" +><A +NAME="AEN873">4.2.3. The Whining Cron</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 to complain at engineers + which leave their bugs in the NEW state without triaging them. + </P +><P +> 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" +><H2 +CLASS="section" +><A +NAME="bzldap">4.2.4. LDAP Authentication</H2 +><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 +>This information on using the LDAP + authentication options with Bugzilla is old, and the authors do + not know of anyone who has tested it. Approach with caution. + </P +></TD +></TR +></TABLE +></DIV +> + </P +><P +> The existing authentication + scheme for Bugzilla uses email addresses as the primary user ID, and a + password to authenticate that user. All places within Bugzilla where + you need to deal with user ID (e.g assigning a bug) use the email + address. The LDAP authentication builds on top of this scheme, rather + than replacing it. The initial log in is done with a username and + password for the LDAP directory. This then fetches the email address + from LDAP and authenticates seamlessly in the standard Bugzilla + authentication scheme using this email address. If an account for this + address already exists in your Bugzilla system, it will log in to that + account. If no account for that email address exists, one is created at + the time of login. (In this case, Bugzilla will attempt to use the + "displayName" or "cn" attribute to determine the user's full name.) + After authentication, all other user-related tasks are still handled by + email address, not LDAP username. You still assign bugs by email + address, query on users by email address, etc. + </P +><P +>Using LDAP for Bugzilla authentication requires the + Mozilla::LDAP (aka PerLDAP) Perl module. The + Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. + After you have installed the SDK, then install the PerLDAP module. + Mozilla::LDAP and the Directory SDK for C are both + <A +HREF="http://www.mozilla.org/directory/" +TARGET="_top" +>available for + download</A +> from mozilla.org. + </P +><P +> Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for + authentication. Be very careful when setting up this parameter; if you + set LDAP authentication, but do not have a valid LDAP directory set up, + you will not be able to log back in to Bugzilla once you log out. (If + this happens, you can get back in by manually editing the data/params + file, and setting useLDAP back to 0.) + </P +><P +>If using LDAP, you must set the + three additional parameters: Set LDAPserver to the name (and optionally + port) of your LDAP server. If no port is specified, it defaults to the + default port of 389. (e.g "ldap.mycompany.com" or + "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching + for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids + must be unique under the DN specified here. Set LDAPmailattribute to + the name of the attribute in your LDAP directory which contains the + primary email address. On most directory servers available, this is + "mail", but you may need to change this. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="content-type">4.2.5. Preventing untrusted Bugzilla content from executing malicious + Javascript code</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# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl + </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 +><P +>Note: using <meta> tags to set the charset is not + recommended, as there's a bug in Netscape 4.x which causes pages + marked up in this way to load twice.</P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="htaccess">4.2.6. <TT +CLASS="filename" +>.htaccess</TT +> + files and security</H2 +><P +>To enhance the security of your Bugzilla installation, Bugzilla's + <TT +CLASS="filename" +>checksetup.pl</TT +> script 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. + These .htaccess files will not work with Apache 1.2.x - but this + has security holes, so you shouldn't be using it anyway. + <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 (IIS) or another + 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" +><H2 +CLASS="section" +><A +NAME="mod-throttle">4.2.7. <TT +CLASS="filename" +>mod_throttle</TT +> + + and Security</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 +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="stepbystep.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="win32.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Step-by-step Install</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="installation.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Win32 Installation Notes</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/faq.html b/docs/html/faq.html index 50bccc40b..0b0dfcca5 100644 --- a/docs/html/faq.html +++ b/docs/html/faq.html @@ -10,11 +10,11 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="SourceForge" -HREF="variant-sourceforge.html"><LINK +TITLE="Integrating Bugzilla with Third-Party Tools" +HREF="integration.html"><LINK REL="NEXT" -TITLE="Software Download Links" -HREF="downloadlinks.html"></HEAD +TITLE="The Bugzilla Database" +HREF="database.html"></HEAD ><BODY CLASS="appendix" BGCOLOR="#FFFFFF" @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="variant-sourceforge.html" +HREF="integration.html" ACCESSKEY="P" >Prev</A ></TD @@ -56,7 +56,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="downloadlinks.html" +HREF="database.html" ACCESSKEY="N" >Next</A ></TD @@ -70,6 +70,9 @@ CLASS="appendix" ><H1 ><A NAME="faq">Appendix A. The Bugzilla FAQ</H1 +><P +> This FAQ includes questions not covered elsewhere in the Guide. + </P ><DIV CLASS="qandaset" ><DL @@ -82,207 +85,149 @@ HREF="faq.html#faq-general" ><DL ><DT >A.1.1. <A -HREF="faq.html#AEN1654" +HREF="faq.html#AEN1649" > Where can I find information about Bugzilla?</A ></DT ><DT >A.1.2. <A -HREF="faq.html#AEN1660" +HREF="faq.html#AEN1655" > What license is Bugzilla distributed under? </A ></DT ><DT >A.1.3. <A -HREF="faq.html#AEN1666" +HREF="faq.html#AEN1661" > How do I get commercial support for Bugzilla? </A ></DT ><DT >A.1.4. <A -HREF="faq.html#AEN1673" +HREF="faq.html#AEN1668" > What major companies or projects are currently using Bugzilla for bug-tracking? </A ></DT ><DT >A.1.5. <A -HREF="faq.html#AEN1698" +HREF="faq.html#AEN1693" > Who maintains Bugzilla? </A ></DT ><DT >A.1.6. <A -HREF="faq.html#AEN1704" +HREF="faq.html#AEN1699" > How does Bugzilla stack up against other bug-tracking databases? </A ></DT ><DT >A.1.7. <A -HREF="faq.html#AEN1711" -> How do I change my user name in Bugzilla? - </A -></DT -><DT ->A.1.8. <A -HREF="faq.html#AEN1716" +HREF="faq.html#AEN1705" > Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </A ></DT ><DT ->A.1.9. <A -HREF="faq.html#AEN1723" +>A.1.8. <A +HREF="faq.html#AEN1712" > Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </A ></DT ><DT ->A.1.10. <A -HREF="faq.html#AEN1741" +>A.1.9. <A +HREF="faq.html#AEN1717" > 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.html#faq-redhat" ->Red Hat Bugzilla</A -></DT -><DD -><DL -><DT ->A.2.1. <A -HREF="faq.html#AEN1758" -> What about Red Hat Bugzilla? - </A -></DT ><DT ->A.2.2. <A -HREF="faq.html#AEN1766" -> What are the primary benefits of Red Hat Bugzilla? - </A -></DT -><DT ->A.2.3. <A -HREF="faq.html#AEN1794" -> What's the current status of Red Hat Bugzilla? - </A -></DT -></DL -></DD -><DT ->3. <A -HREF="faq.html#faq-loki" ->Loki Bugzilla (AKA Fenris)</A -></DT -><DD -><DL -><DT ->A.3.1. <A -HREF="faq.html#AEN1807" -> What is Loki Bugzilla (Fenris)? +>A.1.10. <A +HREF="faq.html#AEN1723" +> Is there an easy way to change the Bugzilla cookie name? </A ></DT ></DL ></DD ><DT ->4. <A +>2. <A HREF="faq.html#faq-phb" ->Pointy-Haired-Boss Questions</A +>Managerial Questions</A ></DT ><DD ><DL ><DT ->A.4.1. <A -HREF="faq.html#AEN1818" -> Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? +>A.2.1. <A +HREF="faq.html#AEN1733" +> Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </A ></DT ><DT ->A.4.2. <A -HREF="faq.html#AEN1823" -> Has anyone you know of already done any Bugzilla integration with +>A.2.2. <A +HREF="faq.html#AEN1738" +> Can Bugzilla integrate with Perforce (SCM software)? </A ></DT ><DT ->A.4.3. <A -HREF="faq.html#AEN1828" +>A.2.3. <A +HREF="faq.html#AEN1743" > Does Bugzilla allow the user to track multiple projects? </A ></DT ><DT ->A.4.4. <A -HREF="faq.html#AEN1833" +>A.2.4. <A +HREF="faq.html#AEN1748" > 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="faq.html#AEN1838" -> Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, +>A.2.5. <A +HREF="faq.html#AEN1753" +> 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="faq.html#AEN1843" +>A.2.6. <A +HREF="faq.html#AEN1758" > 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="faq.html#AEN1850" -> 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="faq.html#AEN1872" +>A.2.7. <A +HREF="faq.html#AEN1765" > 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="faq.html#AEN1880" +>A.2.8. <A +HREF="faq.html#AEN1772" > 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? + email? </A ></DT ><DT ->A.4.10. <A -HREF="faq.html#AEN1885" +>A.2.9. <A +HREF="faq.html#AEN1777" > 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="faq.html#AEN1890" -> If there is email notification, do users have to have any particular +>A.2.10. <A +HREF="faq.html#AEN1782" +> Do users have to have any particular type of email application? </A ></DT ><DT ->A.4.12. <A -HREF="faq.html#AEN1897" -> 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="faq.html#AEN1902" +>A.2.11. <A +HREF="faq.html#AEN1789" > 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 @@ -290,68 +235,49 @@ HREF="faq.html#AEN1902" </A ></DT ><DT ->A.4.14. <A -HREF="faq.html#AEN1910" +>A.2.12. <A +HREF="faq.html#AEN1797" > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </A ></DT ><DT ->A.4.15. <A -HREF="faq.html#AEN1915" +>A.2.13. <A +HREF="faq.html#AEN1802" > Can a user create and save reports? Can they do this in Word format? Excel format? </A ></DT ><DT ->A.4.16. <A -HREF="faq.html#AEN1920" -> Can a user re-run a report with a new project, same query? - </A -></DT -><DT ->A.4.17. <A -HREF="faq.html#AEN1925" -> Can a user modify an existing report and then save it into another name? - </A -></DT -><DT ->A.4.18. <A -HREF="faq.html#AEN1930" +>A.2.14. <A +HREF="faq.html#AEN1807" > Does Bugzilla have the ability to search by word, phrase, compound search? </A ></DT ><DT ->A.4.19. <A -HREF="faq.html#AEN1935" -> Can the admin person establish separate group and individual user - privileges? - </A -></DT -><DT ->A.4.20. <A -HREF="faq.html#AEN1940" +>A.2.15. <A +HREF="faq.html#AEN1812" > 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="faq.html#AEN1945" +>A.2.16. <A +HREF="faq.html#AEN1817" > Are there any backup features provided? </A ></DT ><DT ->A.4.22. <A -HREF="faq.html#AEN1951" +>A.2.17. <A +HREF="faq.html#AEN1823" > Can users be on the system while a backup is in progress? </A ></DT ><DT ->A.4.23. <A -HREF="faq.html#AEN1956" +>A.2.18. <A +HREF="faq.html#AEN1828" > 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 @@ -360,8 +286,8 @@ HREF="faq.html#AEN1956" </A ></DT ><DT ->A.4.24. <A -HREF="faq.html#AEN1963" +>A.2.19. <A +HREF="faq.html#AEN1834" > 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 @@ -370,8 +296,8 @@ HREF="faq.html#AEN1963" </A ></DT ><DT ->A.4.25. <A -HREF="faq.html#AEN1968" +>A.2.20. <A +HREF="faq.html#AEN1839" > 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 @@ -379,55 +305,28 @@ HREF="faq.html#AEN1968" ></DL ></DD ><DT ->5. <A -HREF="faq.html#faq-install" ->Bugzilla Installation</A -></DT -><DD -><DL -><DT ->A.5.1. <A -HREF="faq.html#AEN1975" -> How do I download and install Bugzilla? - </A -></DT -><DT ->A.5.2. <A -HREF="faq.html#AEN1981" -> How do I install Bugzilla on Windows NT? - </A -></DT -><DT ->A.5.3. <A -HREF="faq.html#AEN1986" -> Is there an easy way to change the Bugzilla cookie name? - </A -></DT -></DL -></DD -><DT ->6. <A +>3. <A HREF="faq.html#faq-security" >Bugzilla Security</A ></DT ><DD ><DL ><DT ->A.6.1. <A -HREF="faq.html#AEN1993" +>A.3.1. <A +HREF="faq.html#AEN1846" > 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!)? + (I've followed the instructions in the installation section of this guide)? </A ></DT ><DT ->A.6.2. <A -HREF="faq.html#AEN1999" +>A.3.2. <A +HREF="faq.html#AEN1852" > Are there any security problems with Bugzilla? </A ></DT ><DT ->A.6.3. <A -HREF="faq.html#AEN2004" +>A.3.3. <A +HREF="faq.html#AEN1857" > 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. @@ -436,164 +335,138 @@ HREF="faq.html#AEN2004" ></DL ></DD ><DT ->7. <A +>4. <A HREF="faq.html#faq-email" >Bugzilla Email</A ></DT ><DD ><DL ><DT ->A.7.1. <A -HREF="faq.html#AEN2011" +>A.4.1. <A +HREF="faq.html#AEN1864" > 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="faq.html#AEN2016" +>A.4.2. <A +HREF="faq.html#AEN1869" > 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="faq.html#AEN2021" +>A.4.3. <A +HREF="faq.html#AEN1874" > 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="faq.html#AEN2027" +>A.4.4. <A +HREF="faq.html#AEN1880" > 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="faq.html#AEN2034" +>A.4.5. <A +HREF="faq.html#AEN1887" > How do I set up the email interface to submit/change bugs via email? </A ></DT ><DT ->A.7.6. <A -HREF="faq.html#AEN2039" -> Email takes FOREVER to reach me from bugzilla -- it's extremely slow. +>A.4.6. <A +HREF="faq.html#AEN1892" +> Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? </A ></DT ><DT ->A.7.7. <A -HREF="faq.html#AEN2046" -> How come email never reaches me from bugzilla changes? +>A.4.7. <A +HREF="faq.html#AEN1899" +> How come email from Bugzilla changes never reaches me? </A ></DT ></DL ></DD ><DT ->8. <A +>5. <A HREF="faq.html#faq-db" >Bugzilla Database</A ></DT ><DD ><DL ><DT ->A.8.1. <A -HREF="faq.html#AEN2054" +>A.5.1. <A +HREF="faq.html#AEN1907" > I've heard Bugzilla can be used with Oracle? </A ></DT ><DT ->A.8.2. <A -HREF="faq.html#AEN2059" -> 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="faq.html#AEN2064" +>A.5.2. <A +HREF="faq.html#AEN1912" > I think my database might be corrupted, or contain invalid entries. What do I do? </A ></DT ><DT ->A.8.4. <A -HREF="faq.html#AEN2072" +>A.5.3. <A +HREF="faq.html#AEN1920" > I want to manually edit some entries in my database. How? </A ></DT ><DT ->A.8.5. <A -HREF="faq.html#AEN2077" +>A.5.4. <A +HREF="faq.html#AEN1925" > 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="faq.html#AEN2082" -> I think I've set up MySQL permissions correctly, but bugzilla still can't +>A.5.5. <A +HREF="faq.html#AEN1930" +> I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </A ></DT ><DT ->A.8.7. <A -HREF="faq.html#AEN2087" +>A.5.6. <A +HREF="faq.html#AEN1935" > How do I synchronize bug information among multiple different Bugzilla databases? </A ></DT -><DT ->A.8.8. <A -HREF="faq.html#AEN2094" -> Why do I get bizarre errors when trying to submit data, particularly problems - with "groupset"? - </A -></DT -><DT ->A.8.9. <A -HREF="faq.html#AEN2099" -> How come even after I delete bugs, the long descriptions show up? - </A -></DT ></DL ></DD ><DT ->9. <A +>6. <A HREF="faq.html#faq-nt" >Bugzilla and Win32</A ></DT ><DD ><DL ><DT ->A.9.1. <A -HREF="faq.html#AEN2109" +>A.6.1. <A +HREF="faq.html#AEN1944" > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </A ></DT ><DT ->A.9.2. <A -HREF="faq.html#AEN2114" +>A.6.2. <A +HREF="faq.html#AEN1949" > Is there a "Bundle::Bugzilla" equivalent for Win32? </A ></DT ><DT ->A.9.3. <A -HREF="faq.html#AEN2119" +>A.6.3. <A +HREF="faq.html#AEN1954" > 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="faq.html#AEN2127" -> Can I have some general instructions on how to make Bugzilla on Win32 work? - </A -></DT -><DT ->A.9.5. <A -HREF="faq.html#AEN2133" +>A.6.4. <A +HREF="faq.html#AEN1962" > I'm having trouble with the perl modules for NT not being able to talk to to the database. </A @@ -601,70 +474,76 @@ HREF="faq.html#AEN2133" ></DL ></DD ><DT ->10. <A +>7. <A HREF="faq.html#faq-use" >Bugzilla Usage</A ></DT ><DD ><DL ><DT ->A.10.1. <A -HREF="faq.html#AEN2154" +>A.7.1. <A +HREF="faq.html#AEN1983" +> How do I change my user name (email address) in Bugzilla? + </A +></DT +><DT +>A.7.2. <A +HREF="faq.html#AEN1988" > The query page is very confusing. Isn't there a simpler way to query? </A ></DT ><DT ->A.10.2. <A -HREF="faq.html#AEN2160" +>A.7.3. <A +HREF="faq.html#AEN1993" > 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="faq.html#AEN2170" +>A.7.4. <A +HREF="faq.html#AEN2003" > 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="faq.html#AEN2175" +>A.7.5. <A +HREF="faq.html#AEN2008" > 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="faq.html#AEN2180" +>A.7.6. <A +HREF="faq.html#AEN2013" > How do I change a keyword in Bugzilla, once some bugs are using it? </A ></DT ></DL ></DD ><DT ->11. <A +>8. <A HREF="faq.html#faq-hacking" >Bugzilla Hacking</A ></DT ><DD ><DL ><DT ->A.11.1. <A -HREF="faq.html#AEN2187" +>A.8.1. <A +HREF="faq.html#AEN2020" > What bugs are in Bugzilla right now? </A ></DT ><DT ->A.11.2. <A -HREF="faq.html#AEN2196" +>A.8.2. <A +HREF="faq.html#AEN2029" > 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="faq.html#AEN2202" +>A.8.3. <A +HREF="faq.html#AEN2035" > What's the best way to submit patches? What guidelines should I follow? </A ></DT @@ -682,7 +561,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1654"><B +NAME="AEN1649"><B >A.1.1. </B > Where can I find information about Bugzilla?</P @@ -695,9 +574,9 @@ CLASS="answer" > You can stay up-to-date with the latest Bugzilla information at <A -HREF="http://www.mozilla.org/projects/bugzilla/" +HREF="http://www.bugzilla.org/" TARGET="_top" -> http://www.mozilla.org/projects/bugzilla/</A +> http://www.bugzilla.org/</A > </P ></DIV @@ -708,7 +587,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1660"><B +NAME="AEN1655"><B >A.1.2. </B > What license is Bugzilla distributed under? @@ -735,7 +614,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1666"><B +NAME="AEN1661"><B >A.1.3. </B > How do I get commercial support for Bugzilla? @@ -759,7 +638,7 @@ TARGET="_top" ><P > There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing - to whore themselves out for generous compensation. + to make themselves available for generous compensation. Try sending a message to the mailing list asking for a volunteer. </P ></DIV @@ -770,7 +649,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1673"><B +NAME="AEN1668"><B >A.1.4. </B > What major companies or projects are currently using Bugzilla @@ -802,15 +681,15 @@ BORDER="0" ></TR ><TR ><TD ->AtHome Corporation</TD +>NASA</TD ></TR ><TR ><TD ->Red Hat Software</TD +>AtHome Corporation</TD ></TR ><TR ><TD ->Loki Entertainment Software</TD +>Red Hat Software</TD ></TR ><TR ><TD @@ -822,10 +701,6 @@ BORDER="0" ></TR ><TR ><TD ->The Eazel Project</TD -></TR -><TR -><TD >AbiSource</TD ></TR ><TR @@ -858,6 +733,10 @@ BORDER="0" ></TR ><TR ><TD +>Ximian</TD +></TR +><TR +><TD >Linux-Mandrake</TD ></TR ></TBODY @@ -878,7 +757,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1698"><B +NAME="AEN1693"><B >A.1.5. </B > Who maintains Bugzilla? @@ -890,12 +769,13 @@ CLASS="answer" ><B > </B > - Bugzilla maintenance has been in a state of flux recently. - Please check <A -HREF="http://www.mozilla.org/projects/bugzilla/" + A + <A +HREF="http://www.bugzilla.org/who_we_are.html" TARGET="_top" ->the Bugzilla Project Page for the latest details. </A -> +>core team</A +>, + led by Dave Miller (justdave@syndicomm.com). </P ></DIV ></DIV @@ -905,7 +785,7 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1704"><B +NAME="AEN1699"><B >A.1.6. </B > How does Bugzilla stack up against other bug-tracking databases? @@ -917,11 +797,9 @@ CLASS="answer" ><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 + We can't find any head-to-head comparisons of Bugzilla against + other defect-tracking software. If you know of one, please + get in touch. However, from the author's personal experience with other bug-trackers, Bugzilla offers superior performance on commodity hardware, better price (free!), more developer- friendly features (such as stored @@ -931,10 +809,9 @@ CLASS="answer" </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. + step forward with a list of advantages your product has over + Bugzilla. We'd be happy to include it in the "Competitors" + section. </P ></DIV ></DIV @@ -944,32 +821,9 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1711"><B +NAME="AEN1705"><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="AEN1716"><B ->A.1.8. </B -> Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </P @@ -992,7 +846,7 @@ CLASS="answer" 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/" +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" TARGET="_top" >bugzilla.mozilla.org</A >. @@ -1005,11 +859,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1723"><B ->A.1.9. </B +NAME="AEN1712"><B +>A.1.8. </B > Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </P ></DIV ><DIV @@ -1017,74 +871,10 @@ CLASS="answer" ><P ><B > </B ->Terry Weissman answers, - <A -NAME="AEN1727"><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 > + There is DB-independence work afoot. PostgreSQL support is planned + for 2.18, and full DB-independence can't be far further on. </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 @@ -1093,8 +883,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1741"><B ->A.1.10. </B +NAME="AEN1717"><B +>A.1.9. </B > Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? @@ -1106,396 +896,28 @@ CLASS="answer" ><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="AEN1746"><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" + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally + Terry wanted a place to put a version of Perl and other tools + that was strictly under his control. + </P ><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 + as /usr/bonsaitools/bin/perl, and simply add symlink. + 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">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="AEN1758"><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="AEN1763"><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="AEN1766"><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="AEN1771"><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="AEN1794"><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="AEN1801"><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">3. Loki Bugzilla (AKA Fenris)</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN1807"><B ->A.3.1. </B +NAME="AEN1723"><B +>A.1.10. </B > - What is Loki Bugzilla (Fenris)? + Is there an easy way to change the Bugzilla cookie name? </P ></DIV ><DIV @@ -1504,12 +926,7 @@ CLASS="answer" ><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.16 rather than using a fork, but it's up to you. + At present, no. </P ></DIV ></DIV @@ -1518,7 +935,7 @@ TARGET="_top" CLASS="qandadiv" ><H3 ><A -NAME="faq-phb">4. Pointy-Haired-Boss Questions</H3 +NAME="faq-phb">2. Managerial Questions</H3 ><P > <DIV CLASS="note" @@ -1541,8 +958,7 @@ ALT="Note"></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 :) +> Questions likely to be asked by managers. :-) </P ></TD ></TR @@ -1556,11 +972,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1818"><B ->A.4.1. </B +NAME="AEN1733"><B +>A.2.1. </B > - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </P ></DIV ><DIV @@ -1580,10 +996,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1823"><B ->A.4.2. </B +NAME="AEN1738"><B +>A.2.2. </B > - Has anyone you know of already done any Bugzilla integration with + Can Bugzilla integrate with Perforce (SCM software)? </P ></DIV @@ -1604,8 +1020,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1828"><B ->A.4.3. </B +NAME="AEN1743"><B +>A.2.3. </B > Does Bugzilla allow the user to track multiple projects? </P @@ -1616,11 +1032,10 @@ CLASS="answer" ><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. + Absolutely! You can track any number of Products (although you + are limited to about 55 or so if + you are using Product-Based Groups), that can each be composed of any + number of Components. </P ></DIV ></DIV @@ -1630,8 +1045,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1833"><B ->A.4.4. </B +NAME="AEN1748"><B +>A.2.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? @@ -1653,10 +1068,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1838"><B ->A.4.5. </B +NAME="AEN1753"><B +>A.2.5. </B > - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, + Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? </P ></DIV @@ -1666,12 +1081,11 @@ CLASS="answer" ><B > </B > - Yes. There are many specific MIME-types that are pre-defined by Bugzilla, + Yes - any sort of attachment is allowed, although administrators can + configure a maximum size. + 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. + upload the file. </P ></DIV ></DIV @@ -1681,8 +1095,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1843"><B ->A.4.6. </B +NAME="AEN1758"><B +>A.2.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 @@ -1716,193 +1130,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1850"><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="AEN1872"><B ->A.4.8. </B +NAME="AEN1765"><B +>A.2.7. </B > Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -1919,7 +1148,7 @@ HREF="http://bugzilla.mozilla.org/reports.cgi" TARGET="_top" > http://bugzilla.mozilla.org/reports.cgi</A > for basic reporting - facilities. + and graphing facilities. </P ><P > For more advanced reporting, I recommend hooking up a professional @@ -1929,9 +1158,6 @@ TARGET="_top" 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 @@ -1940,11 +1166,11 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1880"><B ->A.4.9. </B +NAME="AEN1772"><B +>A.2.8. </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? + email? </P ></DIV ><DIV @@ -1953,8 +1179,8 @@ CLASS="answer" ><B > </B > - Email notification is user-configurable. The bug id and Topic - of the bug report accompany each email notification, along with + Email notification is user-configurable. By default, the bug id and + Summary of the bug report accompany each email notification, along with a list of the changes made. </P ></DIV @@ -1965,8 +1191,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1885"><B ->A.4.10. </B +NAME="AEN1777"><B +>A.2.9. </B > Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? @@ -1988,10 +1214,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1890"><B ->A.4.11. </B +NAME="AEN1782"><B +>A.2.10. </B > - If there is email notification, do users have to have any particular + Do users have to have any particular type of email application? </P ></DIV @@ -2045,35 +1271,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1897"><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="AEN1902"><B ->A.4.13. </B +NAME="AEN1789"><B +>A.2.11. </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 @@ -2117,8 +1316,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1910"><B ->A.4.14. </B +NAME="AEN1797"><B +>A.2.12. </B > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? @@ -2130,10 +1329,10 @@ CLASS="answer" ><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. + To a certain extent, yes. 2.16's templates mean that you can localise + the user-facing UI (and several projects are doing exactly that.) However, + error messages and the admin interface are currently not localisable. + This should be achieved by 2.18. </P ></DIV ></DIV @@ -2143,8 +1342,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1915"><B ->A.4.15. </B +NAME="AEN1802"><B +>A.2.13. </B > Can a user create and save reports? Can they do this in Word format? Excel format? @@ -2166,53 +1365,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1920"><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="AEN1925"><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="AEN1930"><B ->A.4.18. </B +NAME="AEN1807"><B +>A.2.14. </B > Does Bugzilla have the ability to search by word, phrase, compound search? @@ -2235,31 +1389,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1935"><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="AEN1940"><B ->A.4.20. </B +NAME="AEN1812"><B +>A.2.15. </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 @@ -2283,8 +1414,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1945"><B ->A.4.21. </B +NAME="AEN1817"><B +>A.2.16. </B > Are there any backup features provided? </P @@ -2311,8 +1442,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1951"><B ->A.4.22. </B +NAME="AEN1823"><B +>A.2.17. </B > Can users be on the system while a backup is in progress? </P @@ -2335,8 +1466,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1956"><B ->A.4.23. </B +NAME="AEN1828"><B +>A.2.18. </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 @@ -2351,20 +1482,14 @@ CLASS="answer" ><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". + If Bugzilla is set up correctly from the start, continuing maintenance + needs are minimal and can be done easily using the web interface. </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. + is available from skilled members of the newsgroup. Simple questions + are answered there and then. </P ></DIV ></DIV @@ -2374,8 +1499,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1963"><B ->A.4.24. </B +NAME="AEN1834"><B +>A.2.19. </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 @@ -2405,8 +1530,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1968"><B ->A.4.25. </B +NAME="AEN1839"><B +>A.2.20. </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? @@ -2428,96 +1553,18 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-install">5. Bugzilla Installation</H3 +NAME="faq-security">3. Bugzilla Security</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN1975"><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="AEN1981"><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="AEN1986"><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">6. Bugzilla Security</H3 -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN1993"><B ->A.6.1. </B +NAME="AEN1846"><B +>A.3.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!)? + (I've followed the instructions in the installation section of this guide)? </P ></DIV ><DIV @@ -2526,12 +1573,11 @@ CLASS="answer" ><B > </B > - Run mysql like this: "mysqld --skip-grant-tables". Please remember <EM + 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 + 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 @@ -2541,8 +1587,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN1999"><B ->A.6.2. </B +NAME="AEN1852"><B +>A.3.2. </B > Are there any security problems with Bugzilla? </P @@ -2553,8 +1599,9 @@ CLASS="answer" ><B > </B > - The Bugzilla code has not undergone a complete security audit. - It is recommended that you closely examine permissions on your Bugzilla + The Bugzilla code has undergone a reasonably complete security audit, + and user-facing CGIs run under Perl's taint mode. However, + it is recommended that you closely examine permissions on your Bugzilla installation, and follow the recommended security guidelines found in The Bugzilla Guide. </P @@ -2566,8 +1613,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2004"><B ->A.6.3. </B +NAME="AEN1857"><B +>A.3.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 @@ -2591,15 +1638,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-email">7. Bugzilla Email</H3 +NAME="faq-email">4. Bugzilla Email</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2011"><B ->A.7.1. </B +NAME="AEN1864"><B +>A.4.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? @@ -2611,8 +1658,8 @@ CLASS="answer" ><B > </B > - With the email changes to 2.12, the user should be able to set - this in user email preferences. + The user should be able to set + this in user email preferences (uncheck all boxes.) </P ></DIV ></DIV @@ -2622,8 +1669,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2016"><B ->A.7.2. </B +NAME="AEN1869"><B +>A.4.2. </B > I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? @@ -2635,8 +1682,8 @@ CLASS="answer" ><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)". + Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". </P ></DIV ></DIV @@ -2646,8 +1693,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2021"><B ->A.7.3. </B +NAME="AEN1874"><B +>A.4.3. </B > I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? @@ -2676,8 +1723,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2027"><B ->A.7.4. </B +NAME="AEN1880"><B +>A.4.4. </B > I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? @@ -2692,7 +1739,7 @@ CLASS="answer" You can call bug_email.pl directly from your aliases file, with an entry like this: <A -NAME="AEN2031"><BLOCKQUOTE +NAME="AEN1884"><BLOCKQUOTE CLASS="BLOCKQUOTE" ><P > bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" @@ -2711,8 +1758,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2034"><B ->A.7.5. </B +NAME="AEN1887"><B +>A.4.5. </B > How do I set up the email interface to submit/change bugs via email? </P @@ -2734,10 +1781,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2039"><B ->A.7.6. </B +NAME="AEN1892"><B +>A.4.6. </B > - Email takes FOREVER to reach me from bugzilla -- it's extremely slow. + Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? </P ></DIV @@ -2748,7 +1795,8 @@ CLASS="answer" > </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 + sendmail), make sure the options given in the "processmail" and other + scripts for all instances of "sendmail" are correct for your MTA. </P ><P @@ -2766,10 +1814,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2046"><B ->A.7.7. </B +NAME="AEN1899"><B +>A.4.7. </B > - How come email never reaches me from bugzilla changes? + How come email from Bugzilla changes never reaches me? </P ></DIV ><DIV @@ -2795,15 +1843,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-db">8. Bugzilla Database</H3 +NAME="faq-db">5. Bugzilla Database</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2054"><B ->A.8.1. </B +NAME="AEN1907"><B +>A.5.1. </B > I've heard Bugzilla can be used with Oracle? </P @@ -2814,10 +1862,10 @@ CLASS="answer" ><B > </B > - Red Hat Bugzilla, mentioned above, works with Oracle. The current version + Red Hat Bugzilla 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. + Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. </P ></DIV ></DIV @@ -2827,43 +1875,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2059"><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="AEN2064"><B ->A.8.3. </B +NAME="AEN1912"><B +>A.5.2. </B > I think my database might be corrupted, or contain invalid entries. What do I do? @@ -2907,8 +1920,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2072"><B ->A.8.4. </B +NAME="AEN1920"><B +>A.5.3. </B > I want to manually edit some entries in my database. How? </P @@ -2934,8 +1947,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2077"><B ->A.8.5. </B +NAME="AEN1925"><B +>A.5.4. </B > I try to add myself as a user, but Bugzilla always tells me my password is wrong. </P @@ -2958,10 +1971,10 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2082"><B ->A.8.6. </B +NAME="AEN1930"><B +>A.5.5. </B > - I think I've set up MySQL permissions correctly, but bugzilla still can't + I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </P ></DIV @@ -2985,8 +1998,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2087"><B ->A.8.7. </B +NAME="AEN1935"><B +>A.5.6. </B > How do I synchronize bug information among multiple different Bugzilla databases? @@ -3015,82 +2028,20 @@ CLASS="answer" </P ></DIV ></DIV -><DIV -CLASS="qandaentry" -><DIV -CLASS="question" -><P -><A -NAME="AEN2094"><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="AEN2099"><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.16 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">9. Bugzilla and Win32</H3 +NAME="faq-nt">6. Bugzilla and Win32</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2109"><B ->A.9.1. </B +NAME="AEN1944"><B +>A.6.1. </B > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </P @@ -3112,8 +2063,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2114"><B ->A.9.2. </B +NAME="AEN1949"><B +>A.6.2. </B > Is there a "Bundle::Bugzilla" equivalent for Win32? </P @@ -3136,8 +2087,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2119"><B ->A.9.3. </B +NAME="AEN1954"><B +>A.6.3. </B > CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? @@ -3157,7 +2108,7 @@ CLASS="answer" ><P > Microsoft has some advice on this matter, as well: <A -NAME="AEN2124"><BLOCKQUOTE +NAME="AEN1959"><BLOCKQUOTE CLASS="BLOCKQUOTE" ><P > "Set application mappings. In the ISM, map the extension for the script @@ -3180,120 +2131,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2127"><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="AEN2133"><B ->A.9.5. </B +NAME="AEN1962"><B +>A.6.4. </B > I'm having trouble with the perl modules for NT not being able to talk to to the database. @@ -3358,15 +2197,38 @@ TARGET="_top" CLASS="qandadiv" ><H3 ><A -NAME="faq-use">10. Bugzilla Usage</H3 +NAME="faq-use">7. Bugzilla Usage</H3 +><DIV +CLASS="qandaentry" +><DIV +CLASS="question" +><P +><A +NAME="AEN1983"><B +>A.7.1. </B +> + How do I change my user name (email address) in Bugzilla? + </P +></DIV +><DIV +CLASS="answer" +><P +><B +> </B +> + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + </P +></DIV +></DIV ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2154"><B ->A.10.1. </B +NAME="AEN1988"><B +>A.7.2. </B > The query page is very confusing. Isn't there a simpler way to query? </P @@ -3377,13 +2239,9 @@ CLASS="answer" ><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" + The interface was simplified by a UI designer for 2.16. Further + suggestions for improvement are welcome, but we won't sacrifice power for + simplicity. </P ></DIV ></DIV @@ -3393,8 +2251,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2160"><B ->A.10.2. </B +NAME="AEN1993"><B +>A.7.3. </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? @@ -3407,7 +2265,7 @@ CLASS="answer" > </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 + users. You have your choice of patches to change this behavior, however. <P ></P @@ -3435,8 +2293,8 @@ TARGET="_top" ><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. + Note that these patches are somewhat dated. You will need to apply + them manually. </P ></DIV ></DIV @@ -3446,8 +2304,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2170"><B ->A.10.3. </B +NAME="AEN2003"><B +>A.7.4. </B > I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? @@ -3471,8 +2329,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2175"><B ->A.10.4. </B +NAME="AEN2008"><B +>A.7.5. </B > Email submissions to Bugzilla that have attachments end up asking me to save it as a "cgi" file. @@ -3485,7 +2343,7 @@ CLASS="answer" > </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 + filename. This will not be fixed anytime soon, because it would cripple some other functionality. </P ></DIV @@ -3496,8 +2354,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2180"><B ->A.10.5. </B +NAME="AEN2013"><B +>A.7.6. </B > How do I change a keyword in Bugzilla, once some bugs are using it? </P @@ -3519,15 +2377,15 @@ CLASS="answer" CLASS="qandadiv" ><H3 ><A -NAME="faq-hacking">11. Bugzilla Hacking</H3 +NAME="faq-hacking">8. Bugzilla Hacking</H3 ><DIV CLASS="qandaentry" ><DIV CLASS="question" ><P ><A -NAME="AEN2187"><B ->A.11.1. </B +NAME="AEN2020"><B +>A.8.1. </B > What bugs are in Bugzilla right now? </P @@ -3546,13 +2404,13 @@ TARGET="_top" enhancement for Bugzilla. </P ><P -> You can view bugs marked for 2.16 release +> You can view bugs marked for 2.18 release <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16" +HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.18" TARGET="_top" >here</A >. - This list includes bugs for the 2.16 release that have already + This list includes bugs for the 2.18 release that have already been fixed and checked into CVS. Please consult the <A HREF="http://www.mozilla.org/projects/bugzilla/" @@ -3570,8 +2428,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2196"><B ->A.11.2. </B +NAME="AEN2029"><B +>A.8.2. </B > How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? @@ -3590,9 +2448,7 @@ TARGET="_top" >. 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... + "editparams.cgi". </P ></DIV ></DIV @@ -3602,8 +2458,8 @@ CLASS="qandaentry" CLASS="question" ><P ><A -NAME="AEN2202"><B ->A.11.3. </B +NAME="AEN2035"><B +>A.8.3. </B > What's the best way to submit patches? What guidelines should I follow? </P @@ -3632,21 +2488,21 @@ TARGET="_top" ></LI ><LI ><P -> Upload your patch as a unified DIFF (having used "diff -u" against +> 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! + ID you submitted in step #1. Be sure and click the "Patch" checkbox + 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 + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) 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 @@ -3689,7 +2545,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="variant-sourceforge.html" +HREF="integration.html" ACCESSKEY="P" >Prev</A ></TD @@ -3707,7 +2563,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="downloadlinks.html" +HREF="database.html" ACCESSKEY="N" >Next</A ></TD @@ -3717,7 +2573,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->SourceForge</TD +>Integrating Bugzilla with Third-Party Tools</TD ><TD WIDTH="34%" ALIGN="center" @@ -3727,7 +2583,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->Software Download Links</TD +>The Bugzilla Database</TD ></TR ></TABLE ></DIV diff --git a/docs/html/feedback.html b/docs/html/feedback.html deleted file mode 100644 index 2fec0aa05..000000000 --- a/docs/html/feedback.html +++ /dev/null @@ -1,161 +0,0 @@ -<HTML -><HEAD -><TITLE ->Feedback</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="About This Guide" -HREF="about.html"><LINK -REL="PREVIOUS" -TITLE="Contributors" -HREF="contributors.html"><LINK -REL="NEXT" -TITLE="Translations" -HREF="translations.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="contributors.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 1. About This Guide</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="translations.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="feedback">1.7. Feedback</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="contributors.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="translations.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Contributors</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="about.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Translations</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/geninstall.html b/docs/html/geninstall.html deleted file mode 100644 index b5cecc5fc..000000000 --- a/docs/html/geninstall.html +++ /dev/null @@ -1,489 +0,0 @@ -<HTML -><HEAD -><TITLE ->Installation General Notes</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Installation" -HREF="installation.html"><LINK -REL="PREVIOUS" -TITLE="BSD Installation Notes" -HREF="bsdinstall.html"><LINK -REL="NEXT" -TITLE="Win32 Installation Notes" -HREF="win32.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="bsdinstall.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 3. Installation</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="win32.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="geninstall">3.5. Installation General Notes</H1 -><DIV -CLASS="section" -><H2 -CLASS="section" -><A -NAME="AEN874">3.5.1. Modifying Your Running System</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" -><H2 -CLASS="section" -><A -NAME="AEN881">3.5.2. Upgrading From Previous Versions</H2 -><P -> A plain Bugzilla is fairly easy to upgrade from one version to a newer one. - However, things get a bit more complicated if you've made changes to - Bugzilla's code. In this case, you may have to re-make or reapply those - changes. - It is recommended that you take a backup of your database and your entire - Bugzilla installation before attempting an upgrade. You can upgrade a 'clean' - installation by untarring a new tarball over the old installation. If you - are upgrading from 2.12 or later, you can type <TT -CLASS="filename" ->cvs -z3 - update</TT ->, and resolve conflicts if there are any. - </P -><P -> Because the developers of Bugzilla are constantly adding new tables, columns - and fields, you'll probably get SQL errors if you just update the code and - attempt to use Bugzilla. Always run the checksetup.pl script whenever - you upgrade your installation. - </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" -><H2 -CLASS="section" -><A -NAME="htaccess">3.5.3. <TT -CLASS="filename" ->.htaccess</TT -> files and security</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. These .htaccess files - will not work with Apache 1.2.x - but this has security holes, so you - shouldn't be using it anyway. - - <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" -><H2 -CLASS="section" -><A -NAME="mod-throttle">3.5.4. <TT -CLASS="filename" ->mod_throttle</TT -> and Security</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" -><H2 -CLASS="section" -><A -NAME="content-type">3.5.5. Preventing untrusted Bugzilla content from executing malicious Javascript code</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" -><H2 -CLASS="section" -><A -NAME="unixhistory">3.5.6. UNIX Installation Instructions History</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="bsdinstall.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="win32.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->BSD Installation Notes</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="installation.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Win32 Installation Notes</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-0.html b/docs/html/gfdl-0.html deleted file mode 100644 index 044cd9c62..000000000 --- a/docs/html/gfdl-0.html +++ /dev/null @@ -1,165 +0,0 @@ -<HTML -><HEAD -><TITLE ->PREAMBLE</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="NEXT" -TITLE="APPLICABILITY AND DEFINITIONS" -HREF="gfdl-1.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-1.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-0">0. PREAMBLE</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-1.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->GNU Free Documentation License</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->APPLICABILITY AND DEFINITIONS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-1.html b/docs/html/gfdl-1.html deleted file mode 100644 index 5e4bb23c2..000000000 --- a/docs/html/gfdl-1.html +++ /dev/null @@ -1,206 +0,0 @@ -<HTML -><HEAD -><TITLE ->APPLICABILITY AND DEFINITIONS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="PREAMBLE" -HREF="gfdl-0.html"><LINK -REL="NEXT" -TITLE="VERBATIM COPYING" -HREF="gfdl-2.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-0.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-2.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-1">1. APPLICABILITY AND DEFINITIONS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-0.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-2.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->PREAMBLE</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->VERBATIM COPYING</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-10.html b/docs/html/gfdl-10.html deleted file mode 100644 index 52921c87d..000000000 --- a/docs/html/gfdl-10.html +++ /dev/null @@ -1,162 +0,0 @@ -<HTML -><HEAD -><TITLE ->FUTURE REVISIONS OF THIS LICENSE</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="TERMINATION" -HREF="gfdl-9.html"><LINK -REL="NEXT" -TITLE="How to use this License for your documents" -HREF="gfdl-howto.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-9.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-howto.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-10">10. FUTURE REVISIONS OF THIS LICENSE</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-9.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-howto.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->TERMINATION</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->How to use this License for your documents</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-2.html b/docs/html/gfdl-2.html deleted file mode 100644 index f0293721d..000000000 --- a/docs/html/gfdl-2.html +++ /dev/null @@ -1,156 +0,0 @@ -<HTML -><HEAD -><TITLE ->VERBATIM COPYING</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="APPLICABILITY AND DEFINITIONS" -HREF="gfdl-1.html"><LINK -REL="NEXT" -TITLE="COPYING IN QUANTITY" -HREF="gfdl-3.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-1.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-3.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-2">2. VERBATIM COPYING</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-1.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-3.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->APPLICABILITY AND DEFINITIONS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->COPYING IN QUANTITY</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-3.html b/docs/html/gfdl-3.html deleted file mode 100644 index e888a5eb2..000000000 --- a/docs/html/gfdl-3.html +++ /dev/null @@ -1,180 +0,0 @@ -<HTML -><HEAD -><TITLE ->COPYING IN QUANTITY</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="VERBATIM COPYING" -HREF="gfdl-2.html"><LINK -REL="NEXT" -TITLE="MODIFICATIONS" -HREF="gfdl-4.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-2.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-4.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-3">3. COPYING IN QUANTITY</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-2.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-4.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->VERBATIM COPYING</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->MODIFICATIONS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-4.html b/docs/html/gfdl-4.html deleted file mode 100644 index d9ce0e6e4..000000000 --- a/docs/html/gfdl-4.html +++ /dev/null @@ -1,286 +0,0 @@ -<HTML -><HEAD -><TITLE ->MODIFICATIONS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="COPYING IN QUANTITY" -HREF="gfdl-3.html"><LINK -REL="NEXT" -TITLE="COMBINING DOCUMENTS" -HREF="gfdl-5.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-3.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-5.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-4">4. MODIFICATIONS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-3.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-5.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->COPYING IN QUANTITY</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->COMBINING DOCUMENTS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-5.html b/docs/html/gfdl-5.html deleted file mode 100644 index c59182bba..000000000 --- a/docs/html/gfdl-5.html +++ /dev/null @@ -1,165 +0,0 @@ -<HTML -><HEAD -><TITLE ->COMBINING DOCUMENTS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="MODIFICATIONS" -HREF="gfdl-4.html"><LINK -REL="NEXT" -TITLE="COLLECTIONS OF DOCUMENTS" -HREF="gfdl-6.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-4.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-6.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-5">5. COMBINING DOCUMENTS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-4.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-6.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->MODIFICATIONS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->COLLECTIONS OF DOCUMENTS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-6.html b/docs/html/gfdl-6.html deleted file mode 100644 index c0a87bd0c..000000000 --- a/docs/html/gfdl-6.html +++ /dev/null @@ -1,155 +0,0 @@ -<HTML -><HEAD -><TITLE ->COLLECTIONS OF DOCUMENTS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="COMBINING DOCUMENTS" -HREF="gfdl-5.html"><LINK -REL="NEXT" -TITLE="AGGREGATION WITH INDEPENDENT WORKS" -HREF="gfdl-7.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-5.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-7.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-6">6. COLLECTIONS OF DOCUMENTS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-5.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-7.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->COMBINING DOCUMENTS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->AGGREGATION WITH INDEPENDENT WORKS</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-7.html b/docs/html/gfdl-7.html deleted file mode 100644 index c0b7bae36..000000000 --- a/docs/html/gfdl-7.html +++ /dev/null @@ -1,159 +0,0 @@ -<HTML -><HEAD -><TITLE ->AGGREGATION WITH INDEPENDENT WORKS</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="COLLECTIONS OF DOCUMENTS" -HREF="gfdl-6.html"><LINK -REL="NEXT" -TITLE="TRANSLATION" -HREF="gfdl-8.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-6.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-8.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-7">7. AGGREGATION WITH INDEPENDENT WORKS</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-6.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-8.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->COLLECTIONS OF DOCUMENTS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->TRANSLATION</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-8.html b/docs/html/gfdl-8.html deleted file mode 100644 index 81437e72e..000000000 --- a/docs/html/gfdl-8.html +++ /dev/null @@ -1,154 +0,0 @@ -<HTML -><HEAD -><TITLE ->TRANSLATION</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="AGGREGATION WITH INDEPENDENT WORKS" -HREF="gfdl-7.html"><LINK -REL="NEXT" -TITLE="TERMINATION" -HREF="gfdl-9.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-7.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-9.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-8">8. TRANSLATION</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-7.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-9.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->AGGREGATION WITH INDEPENDENT WORKS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->TERMINATION</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-9.html b/docs/html/gfdl-9.html deleted file mode 100644 index 6c2a3ee44..000000000 --- a/docs/html/gfdl-9.html +++ /dev/null @@ -1,151 +0,0 @@ -<HTML -><HEAD -><TITLE ->TERMINATION</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="TRANSLATION" -HREF="gfdl-8.html"><LINK -REL="NEXT" -TITLE="FUTURE REVISIONS OF THIS LICENSE" -HREF="gfdl-10.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-8.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-10.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-9">9. TERMINATION</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-8.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-10.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->TRANSLATION</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->FUTURE REVISIONS OF THIS LICENSE</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl-howto.html b/docs/html/gfdl-howto.html deleted file mode 100644 index 4a75706bd..000000000 --- a/docs/html/gfdl-howto.html +++ /dev/null @@ -1,171 +0,0 @@ -<HTML -><HEAD -><TITLE ->How to use this License for your documents</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"><LINK -REL="PREVIOUS" -TITLE="FUTURE REVISIONS OF THIS LICENSE" -HREF="gfdl-10.html"><LINK -REL="NEXT" -TITLE="Glossary" -HREF="glossary.html"></HEAD -><BODY -CLASS="sect1" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="gfdl-10.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix E. GNU Free Documentation License</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="glossary.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="sect1" -><H1 -CLASS="sect1" -><A -NAME="gfdl-howto">How to use this License for your documents</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="AEN2605"><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 -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="gfdl-10.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="glossary.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->FUTURE REVISIONS OF THIS LICENSE</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="gfdl.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Glossary</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/gfdl.html b/docs/html/gfdl.html deleted file mode 100644 index 86804257f..000000000 --- a/docs/html/gfdl.html +++ /dev/null @@ -1,214 +0,0 @@ -<HTML -><HEAD -><TITLE ->GNU Free Documentation License</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="PREVIOUS" -TITLE="Hacking Bugzilla" -HREF="bzhacking.html"><LINK -REL="NEXT" -TITLE="PREAMBLE" -HREF="gfdl-0.html"></HEAD -><BODY -CLASS="appendix" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="bzhacking.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" -></TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="gfdl-0.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="appendix" -><H1 -><A -NAME="gfdl">Appendix E. GNU Free Documentation License</H1 -><DIV -CLASS="TOC" -><DL -><DT -><B ->Table of Contents</B -></DT -><DT ->0. <A -HREF="gfdl-0.html" ->PREAMBLE</A -></DT -><DT ->1. <A -HREF="gfdl-1.html" ->APPLICABILITY AND DEFINITIONS</A -></DT -><DT ->2. <A -HREF="gfdl-2.html" ->VERBATIM COPYING</A -></DT -><DT ->3. <A -HREF="gfdl-3.html" ->COPYING IN QUANTITY</A -></DT -><DT ->4. <A -HREF="gfdl-4.html" ->MODIFICATIONS</A -></DT -><DT ->5. <A -HREF="gfdl-5.html" ->COMBINING DOCUMENTS</A -></DT -><DT ->6. <A -HREF="gfdl-6.html" ->COLLECTIONS OF DOCUMENTS</A -></DT -><DT ->7. <A -HREF="gfdl-7.html" ->AGGREGATION WITH INDEPENDENT WORKS</A -></DT -><DT ->8. <A -HREF="gfdl-8.html" ->TRANSLATION</A -></DT -><DT ->9. <A -HREF="gfdl-9.html" ->TERMINATION</A -></DT -><DT ->10. <A -HREF="gfdl-10.html" ->FUTURE REVISIONS OF THIS LICENSE</A -></DT -><DT -><A -HREF="gfdl-howto.html" ->How to use this License for your documents</A -></DT -></DL -></DIV -><P ->Version 1.1, March 2000</P -><A -NAME="AEN2515"><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 -><DIV -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="bzhacking.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="gfdl-0.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Hacking Bugzilla</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -> </TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->PREAMBLE</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/glossary.html b/docs/html/glossary.html index 3702edfef..c6251cb60 100644 --- a/docs/html/glossary.html +++ b/docs/html/glossary.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="How to use this License for your documents" -HREF="gfdl-howto.html"></HEAD +TITLE="SourceForge" +HREF="variant-sourceforge.html"></HEAD ><BODY CLASS="glossary" BGCOLOR="#FFFFFF" @@ -39,7 +39,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="gfdl-howto.html" +HREF="variant-sourceforge.html" ACCESSKEY="P" >Prev</A ></TD @@ -68,7 +68,7 @@ CLASS="glossdiv" ><H1 CLASS="glossdiv" ><A -NAME="AEN2610">0-9, high ascii</H1 +NAME="AEN2183">0-9, high ascii</H1 ><DL ><DT ><B @@ -76,24 +76,22 @@ NAME="AEN2610">0-9, high ascii</H1 ></DT ><DD ><P -> Apache web server, and other NCSA-compliant web servers, - observe the convention of using files in directories - called <TT +>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 +> + + to restrict access to certain files. In Bugzilla, they are used + to keep secret files which would otherwise + compromise your installation - e.g. 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 +> + file contains the password to your database. + curious.</P ></DD ></DL ></DIV @@ -110,23 +108,28 @@ NAME="gloss-a">A</H1 ></DT ><DD ><P ->In this context, Apache is the web server most - commonly used for serving up - <I +>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 +> + + 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 +> + + version of the original + <SPAN CLASS="acronym" >NCSA</SPAN -> world-wide-web server.</P +> + + world-wide-web server.</P ></DD ></DL ></DIV @@ -143,21 +146,24 @@ NAME="gloss-b">B</H1 ></DT ><DD ><P -> A <SPAN +>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 +>"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 +> + or + <SPAN CLASS="QUOTE" >"issues"</SPAN ->; in the - context of Bugzilla, they are synonymous. - </P +>; + in the context of Bugzilla, they are synonymous.</P ></DD ><DT ><B @@ -165,29 +171,10 @@ CLASS="QUOTE" ></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 +>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 @@ -195,9 +182,8 @@ CLASS="QUOTE" ></DT ><DD ><P -> Bugzilla is the industry-standard bug tracking system. It - is quite popular among Open Source enthusiasts. - </P +>Bugzilla is the world-leading free software bug tracking system. + </P ></DD ></DL ></DIV @@ -215,39 +201,39 @@ NAME="gloss-component"><B ></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 +>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 +> <SPAN CLASS="acronym" >CPAN</SPAN -></B +> + </B ></DT ><DD ><P -><SPAN +> <SPAN CLASS="acronym" >CPAN</SPAN -> stands for the - <SPAN +> + + stands for the + <SPAN CLASS="QUOTE" >"Comprehensive Perl Archive Network"</SPAN ->. CPAN - maintains a large number of extremely useful - <I +>. + 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 +> + modules - encapsulated chunks of code for performing a + particular task.</P ></DD ></DL ></DIV @@ -264,18 +250,19 @@ NAME="gloss-d">D</H1 ></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 +>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 +>, + the MySQL server, and + <I CLASS="glossterm" >apache</I ->, a web - server, are generally run as daemons.</P +>, + a web server, are generally run as daemons.</P ></DD ></DL ></DIV @@ -292,43 +279,25 @@ NAME="gloss-g"></H1 ></DT ><DD ><P ->The word <SPAN +>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 +> + + has a very special meaning to Bugzilla. Bugzilla's main security + mechanism comes by placing users in groups, and assigning those + groups certain privileges to view bugs in particular + <I CLASS="glossterm" >Products</I -> and - <I -CLASS="glossterm" ->Components</I -> in the - <I +> + in the + <I CLASS="glossterm" >Bugzilla</I -> database.</P -></DD -></DL -></DIV -><DIV -CLASS="glossdiv" -><H1 -CLASS="glossdiv" -><A -NAME="gloss-i">I</H1 -><DL -><DT -><A -NAME="gloss-infiniteloop"><B ->Infinite Loop</B -></DT -><DD -><P ->A loop of information that never ends; see recursion.</P +> + database.</P ></DD ></DL ></DIV @@ -345,15 +314,16 @@ NAME="gloss-m">M</H1 ></DT ><DD ><P ->mysqld is the name of the - <I +>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 +> + + 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 @@ -370,55 +340,11 @@ NAME="gloss-p">P</H1 ></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="AEN2701"><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 +>A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, + there are several Components to a Product. A Product may define a + group (used for security) for all bugs entered into + its Components.</P ></DD ><DT ><B @@ -426,15 +352,16 @@ CLASS="QUOTE" ></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 +>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 +> + + is maintained in Perl.</P ></DD ></DL ></DIV @@ -451,57 +378,33 @@ NAME="gloss-q">Q</H1 ></DT ><DD ><P -><SPAN +> <SPAN CLASS="QUOTE" >"QA"</SPAN ->, <SPAN +>, + <SPAN CLASS="QUOTE" >"Q/A"</SPAN ->, and - <SPAN +>, and + <SPAN CLASS="QUOTE" >"Q.A."</SPAN -> are short for <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 +>"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</H1 -><DL -><DT -><A -NAME="gloss-recursion"><B ->Recursion</B -></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 +> + + field in a bug.</P ></DD ></DL ></DIV @@ -514,57 +417,71 @@ NAME="gloss-s">S</H1 ><DL ><DT ><B -><SPAN +> <SPAN CLASS="acronym" >SGML</SPAN -></B +> + </B ></DT ><DD ><P -><SPAN +> <SPAN CLASS="acronym" >SGML</SPAN -> stands for <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 +>"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 +> + + has withstood the test of time as a robust, powerful language. + <I CLASS="glossterm" -><SPAN +> <SPAN CLASS="acronym" >XML</SPAN -></I -> is the - <SPAN +> + </I +> + + is the + <SPAN CLASS="QUOTE" >"baby brother"</SPAN -> of SGML; any valid - <SPAN +> + + of SGML; any valid + <SPAN CLASS="acronym" >XML</SPAN -> document it, by definition, a valid - <SPAN +> + + document it, by definition, a valid + <SPAN CLASS="acronym" >SGML</SPAN -> document. The document you are - reading is written and maintained in - <SPAN +> + + document. The document you are reading is written and maintained in + <SPAN CLASS="acronym" >SGML</SPAN ->, and is also valid - <SPAN +>, + and is also valid + <SPAN CLASS="acronym" >XML</SPAN -> if you modify the Document Type - Definition.</P +> + + if you modify the Document Type Definition.</P ></DD ></DL ></DIV @@ -582,18 +499,18 @@ NAME="gloss-target-milestone"><B ></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 +>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 +> + + 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 @@ -611,9 +528,9 @@ NAME="zarro-boogs-found"><B ></DT ><DD ><P ->This is the cryptic response sent by Bugzilla when a - query returned no results. It is just a goofy way of - saying "Zero Bugs Found".</P +>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 @@ -634,7 +551,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="gfdl-howto.html" +HREF="variant-sourceforge.html" ACCESSKEY="P" >Prev</A ></TD @@ -658,7 +575,7 @@ VALIGN="top" WIDTH="33%" ALIGN="left" VALIGN="top" ->How to use this License for your documents</TD +>SourceForge</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/granttables.html b/docs/html/granttables.html deleted file mode 100644 index d13bb87f8..000000000 --- a/docs/html/granttables.html +++ /dev/null @@ -1,351 +0,0 @@ -<HTML -><HEAD -><TITLE ->MySQL Permissions & Grant Tables</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="The Bugzilla Database" -HREF="database.html"><LINK -REL="PREVIOUS" -TITLE="MySQL Bugzilla Database Introduction" -HREF="dbdoc.html"><LINK -REL="NEXT" -TITLE="Useful Patches and Utilities for Bugzilla" -HREF="patches.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="dbdoc.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix C. The Bugzilla Database</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="patches.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="granttables">C.3. MySQL Permissions & Grant Tables</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 PRIVILEGES <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 -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="dbdoc.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="patches.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->MySQL Bugzilla Database Introduction</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="database.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Useful Patches and Utilities for Bugzilla</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/groups.html b/docs/html/groups.html new file mode 100644 index 000000000..37d58d046 --- /dev/null +++ b/docs/html/groups.html @@ -0,0 +1,276 @@ +<HTML +><HEAD +><TITLE +>Groups and Group Security</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="PREVIOUS" +TITLE="Voting" +HREF="voting.html"><LINK +REL="NEXT" +TITLE="Bugzilla Security" +HREF="security.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="voting.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Administering Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="security.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="groups">5.5. Groups and Group Security</H1 +><P +>Groups allow the administrator + to isolate bugs or products that should only be seen by certain people. + There are two types of group - Generic Groups, and Product-Based Groups. + </P +><P +> Product-Based Groups are matched with products, and allow you to restrict + access to bugs on a per-product basis. They are enabled using the + usebuggroups Param. Turning on the usebuggroupsentry + Param will mean bugs automatically get added to their product group when + filed. + </P +><P +> Generic Groups have no special relationship to products; + you create them, and put bugs in them + as required. One example of the use of Generic Groups + is Mozilla's "Security" group, + into which security-sensitive bugs are placed until fixed. Only the + Mozilla Security Team are members of this group. + </P +><P +>To create Generic Groups:</P +><P +></P +><OL +TYPE="1" +><LI +><P +>Select the "groups" + link in the footer.</P +></LI +><LI +><P +>Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.</P +></LI +><LI +><P +>Fill out the "New Name", "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. + When you have finished, click "Add".</P +></LI +></OL +><P +>To use Product-Based Groups:</P +><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 +>XXX is this still true? + "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 +>In future, when you create a Product, a matching group will be + automatically created. If you need to add a Product Group to + a Product which was created before you turned on usebuggroups, + then simply create a new group, as outlined above, with the + same name as the Product.</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 +>Bugzilla currently has a limit of 64 groups per installation. If + you have more than about 50 products, you should consider + running multiple Bugzillas. Ask in the newsgroup for other + suggestions for working around this restriction.</P +></TD +></TR +></TABLE +></DIV +><P +> Note that group permissions are such that you need to be a member + of <EM +>all</EM +> the groups a bug is in, for whatever + reason, to see that bug. + </P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="voting.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="security.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Voting</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Bugzilla Security</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/hintsandtips.html b/docs/html/hintsandtips.html new file mode 100644 index 000000000..c20131bd4 --- /dev/null +++ b/docs/html/hintsandtips.html @@ -0,0 +1,308 @@ +<HTML +><HEAD +><TITLE +>Hints and Tips</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Using Bugzilla" +HREF="using.html"><LINK +REL="PREVIOUS" +TITLE="How do I use Bugzilla?" +HREF="how.html"><LINK +REL="NEXT" +TITLE="User Preferences" +HREF="userpreferences.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="how.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 3. Using Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="userpreferences.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="hintsandtips">3.2. Hints and Tips</H1 +><P +>This section distills some Bugzilla tips and best practices + that have been developed.</P +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN434">3.2.1. Autolinkification</H2 +><P +>Bugzilla comments are plain text - so posting HTML will result + in literal HTML tags rather than being interpreted by a browser. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + http://www.bugzilla.org will be turned into + <A +HREF="http://www.bugzilla.org" +TARGET="_top" +>http://www.bugzilla.org</A +>. + Other strings which get linkified in the obvious manner are: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>bug 12345</TD +></TR +><TR +><TD +>bug 23456, comment 53</TD +></TR +><TR +><TD +>attachment 4321</TD +></TR +><TR +><TD +>mailto:george@example.com</TD +></TR +><TR +><TD +>george@example.com</TD +></TR +><TR +><TD +>ftp://ftp.mozilla.org</TD +></TR +><TR +><TD +>Most other sorts of URL</TD +></TR +></TBODY +></TABLE +><P +></P +> + </P +><P +>A corollary here is that if you type a bug number in a comment, + you should put the word "bug" before it, so it gets autolinkified + for the convenience of others. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="quicksearch">3.2.2. Quicksearch</H2 +><P +>Quicksearch is a single-text-box query tool which uses + metacharacters to indicate what is to be searched. For example, typing + "<TT +CLASS="filename" +>foo|bar</TT +>" + into Quicksearch would search for "foo" or "bar" in the + summary and status whiteboard of a bug; adding + "<TT +CLASS="filename" +>:BazProduct</TT +>" would + search only in that product. + </P +><P +>You'll find the Quicksearch box on Bugzilla's + front page, along with a + <A +HREF="../../quicksearch.html" +TARGET="_top" +>Help</A +> + link which details how to use it.</P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="commenting">3.2.3. Comments</H2 +><P +>If you are changing the fields on a bug, only comment if + either you have something pertinent to say, or Bugzilla requires it. + Otherwise, you may spam people unnecessarily with bug mail. + To take an example: a user can set up their account to filter out messages + where someone just adds themselves to the CC field of a bug + (which happens a lot.) If you come along, add yourself to the CC field, + and add a comment saying "Adding self to CC", then that person + gets a pointless piece of mail they would otherwise have avoided. + </P +><P +> Don't use sigs in comments. Signing your name ("Bill") is acceptable, + particularly if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="attachments">3.2.4. Attachments</H2 +><P +> Use attachments, rather than comments, for large chunks of ASCII data, + such as trace, debugging output files, or log files. That way, it doesn't + bloat the bug for everyone who wants to read it, and cause people to + receive fat, useless mails. + </P +><P +>Trim screenshots. There's no need to show the whole screen if + you are pointing out a single-pixel problem. + </P +><P +>Don't attach simple test cases (e.g. one HTML file, one + CSS file and an image) as a ZIP file. Instead, upload them in + reverse order and edit the referring file so that they point to the + attached files. This way, the test case works immediately + out of the bug. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN463">3.2.5. Filing Bugs</H2 +><P +>Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + </P +><P +> You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + </P +><P +>If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + </P +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="how.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="userpreferences.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>How do I use Bugzilla?</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="using.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>User Preferences</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/how.html b/docs/html/how.html index 802df4225..6d7018a0c 100644 --- a/docs/html/how.html +++ b/docs/html/how.html @@ -13,11 +13,11 @@ REL="UP" TITLE="Using Bugzilla" HREF="using.html"><LINK REL="PREVIOUS" -TITLE="Why Should We Use Bugzilla?" -HREF="why.html"><LINK +TITLE="Using Bugzilla" +HREF="using.html"><LINK REL="NEXT" -TITLE="Where can I find my user preferences?" -HREF="init4me.html"></HEAD +TITLE="Hints and Tips" +HREF="hintsandtips.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="why.html" +HREF="using.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 2. Using Bugzilla</TD +>Chapter 3. Using Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="init4me.html" +HREF="hintsandtips.html" ACCESSKEY="N" >Next</A ></TD @@ -73,62 +73,35 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="how">2.3. How do I use Bugzilla?</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 +NAME="how">3.1. How do I use Bugzilla?</H1 ><P -><I ->Hey! I'm Woody! Howdy, Howdy, Howdy!</I -></P -></I -></TD -></TR -></TABLE -><P -> This section contains information for end-users of Bugzilla. - If you are administering a Bugzilla installation, please consult the - Installing and Administering Bugzilla portions of this Guide. - </P -><P -> There is a Bugzilla test installation, called - <A -HREF="http://landfill.tequilarista.org/" +>This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + <A +HREF="http://landfill.bugzilla.org/" TARGET="_top" -> Landfill</A ->, which you are welcome to play with. - However, it does not necessarily have all Bugzilla features - enabled, and often runs cutting-edge versions of Bugzilla for - testing, so some things may work slightly differently than - mentioned here. - </P +>Landfill</A +>, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and often runs cutting-edge versions + of Bugzilla for testing, so some things may work slightly differently + than mentioned here.</P ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="myaccount">2.3.1. Create a Bugzilla Account</H2 -><P -> 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 Bugzilla, - use this URL: <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/" +NAME="myaccount">3.1.1. Create a Bugzilla Account</H2 +><P +>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 Bugzilla, use this URL: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" TARGET="_top" -> http://landfill.tequilarista.org/bugzilla-tip/</A +> http://landfill.bugzilla.org/bugzilla-tip/</A > </P ><P @@ -137,405 +110,313 @@ TARGET="_top" TYPE="1" ><LI ><P -> Click the <SPAN +>Click the + <SPAN CLASS="QUOTE" >"Open a new Bugzilla account"</SPAN -> link, enter your - email address and, optionally, your name in the spaces provided, - then click <SPAN +> + + link, enter your email address and, optionally, your name in the + spaces provided, then click + <SPAN CLASS="QUOTE" >"Create Account"</SPAN ->. - </P +> + + .</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 can be changed to something more memorable. - </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 can be + changed to something more memorable.</P ></LI ><LI ><P -> Click the <SPAN +>Click the + <SPAN CLASS="QUOTE" >"Log In"</SPAN -> link in the yellow area at - the bottom of the page in your browser, enter your - email address and password into the spaces provided, and click - <SPAN +> + link in the yellow area at the bottom of the page in your browser, + enter your email address and password into the spaces provided, and + click + <SPAN CLASS="QUOTE" >"Login"</SPAN >. - </P + </P ></LI ></OL ><P -> You are now logged in. Bugzilla uses cookies for authentication, so - (unless your IP address changes) you should not have to log in again. - </P +>You are now logged in. Bugzilla uses cookies for authentication + so, unless your IP address changes, you should not have to log in + again.</P ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="bug_page">2.3.2. Anatomy of a Bug</H2 +NAME="bug_page">3.1.2. Anatomy of a Bug</H2 ><P -> The core of Bugzilla is the screen which displays a particular bug. - It's a good place to explain some Bugzilla concepts. - <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1" +>The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1" TARGET="_top" ->Bug 1 on Landfill</A -> is a good example. Note that the names of most fields - are hyperlinks; clicking them will take you to context-sensitive - help on that particular field. - </P +> Bug 1 on Landfill</A +> + + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla.</P ><P ></P ><OL TYPE="1" ><LI ><P -> <EM +> <EM >Product and Component</EM ->: - Bugs are divided up by Product and Component, with a Product having one - or more Components in it. For example, bugzilla.mozilla.org's - "Bugzilla" Product is composed of several Components: - <P +>: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + 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 +> <EM +>Administration:</EM +> + Administration of a Bugzilla installation.</TD ></TR ><TR ><TD -><EM ->Bugzilla-General</EM ->, +> <EM +>Bugzilla-General:</EM +> Anything that doesn't fit in the other components, or spans - multiple components. - </TD + 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 +> <EM +>Creating/Changing Bugs:</EM +> + Creating, changing, and viewing bugs.</TD ></TR ><TR ><TD -><EM ->Documentation</EM ->, - The bugzilla documentation, including anything in the - <TT -CLASS="filename" ->docs/</TT -> directory and The Bugzilla Guide - - </TD +> <EM +>Documentation:</EM +> + The Bugzilla documentation, including The Bugzilla Guide.</TD ></TR ><TR ><TD -><EM ->Email</EM ->, - Anything to do with email sent by Bugzilla. - <TT -CLASS="filename" ->processmail</TT -> - </TD +> <EM +>Email:</EM +> + Anything to do with email sent by Bugzilla.</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 +> <EM +>Installation:</EM +> + The installation process of Bugzilla.</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 +> <EM +>Query/Buglist:</EM +> + Anything to do with searching for bugs and viewing the + buglists.</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 +> <EM +>Reporting/Charting:</EM +> + Getting reports from Bugzilla.</TD ></TR ><TR ><TD -><EM ->User Accounts</EM ->, +> <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 + Saved queries, creating accounts, changing passwords, logging in, + etc.</TD ></TR ><TR ><TD -><EM ->User Interface</EM ->, +> <EM +>User Interface:</EM +> General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, etc. - </TD + functionality) including cosmetic issues, HTML templates, + etc.</TD ></TR ></TBODY ></TABLE ><P ></P > - </P + </P ></LI ><LI ><P -> <EM ->Status and Resolution</EM ->: - A bug passes through several Statuses in its lifetime, and ends up in the - RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) - The different possible - values for Status and Resolution on your installation will be documented - in the context-sensitive help for those items. - </P +> <EM +>Status and Resolution:</EM +> + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items.</P ></LI ><LI ><P -> <EM ->Assigned To</EM ->: - The person responsible for fixing the bug. - </P +> <EM +>Assigned To:</EM +> + The person responsible for fixing the bug.</P ></LI ><LI ><P -> <EM ->URL</EM ->: - A URL associated with the bug, if any. - </P +> <EM +>*URL:</EM +> + A URL associated with the bug, if any.</P ></LI ><LI ><P -> <EM ->Summary</EM ->: - A one-sentence summary of the problem. - </P +> <EM +>Summary:</EM +> + A one-sentence summary of the problem.</P ></LI ><LI ><P -> <EM ->Status Whiteboard</EM ->: (a.k.a. Whiteboard) A - free-form text area for adding short notes and tags to a bug. - </P +> <EM +>*Status Whiteboard:</EM +> + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.</P ></LI ><LI ><P -> <EM ->Keywords</EM ->: - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression. - </P +> <EM +>*Keywords:</EM +> + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.</P ></LI ><LI ><P -> <EM ->Platform and OS</EM ->: - These indicate the computing environment where the bug was found. - </P +> <EM +>Platform and OS:</EM +> + These indicate the computing environment where the bug was + found.</P ></LI ><LI ><P -> <EM ->Version</EM ->: - The "Version" field is usually used for versions of a product which have - been released, and is set to indicate which versions of a Component - have the particular problem the bug report is about. - </P +> <EM +>Version:</EM +> + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about.</P ></LI ><LI ><P -> <EM ->Priority</EM ->: - The bug assignee uses this field to prioritise his or her bugs. It's - a good idea not to change this on other people's bugs. - </P +> <EM +>Priority:</EM +> + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs.</P ></LI ><LI ><P -> <EM ->Severity</EM ->: - This indicates how severe the problem is - from blocker ("application - unusable") to trivial ("minor cosmetic issue"). You can also use this - field to indicate whether a bug is an enhancement request. - </P +> <EM +>Severity:</EM +> + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request.</P ></LI ><LI ><P -> <EM ->Target</EM ->: - (a.k.a. Target Milestone) A future version by which the bug is to be - fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are - not restricted to numbers, thought - you can use any text strings, - such as dates. - </P +> <EM +>*Target:</EM +> + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates.</P ></LI ><LI ><P -> <EM ->Reporter</EM ->: - The person who filed the bug. - </P +> <EM +>Reporter:</EM +> + The person who filed the bug.</P ></LI ><LI ><P -> <EM ->CC list</EM ->: - A list of people who get mail when the bug changes. - </P +> <EM +>CC list:</EM +> + A list of people who get mail when the bug changes.</P ></LI ><LI ><P -> <EM ->Attachments</EM ->: - You can attach files (e.g. testcases or patches) to bugs. If there are - any attachments, they are listed in this section. - </P +> <EM +>Attachments:</EM +> + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.</P ></LI ><LI ><P -> <EM ->Dependencies</EM ->: - If this bug cannot be fixed unless other bugs are fixed (depends on), or - this bug stops other bugs being fixed (blocks), their numbers are - recorded here. - </P +> <EM +>*Dependencies:</EM +> + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here.</P ></LI ><LI ><P -> <EM ->Votes</EM ->: - Whether this bug has any votes. - </P +> <EM +>*Votes:</EM +> + Whether this bug has any votes.</P ></LI ><LI ><P -> <EM ->Additional Comments</EM ->: - You can add your two cents to the bug discussion here, if you have - something worthwhile to say. - </P +> <EM +>Additional Comments:</EM +> + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.</P ></LI ></OL ></DIV @@ -544,92 +425,98 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="query">2.3.3. Searching for Bugs</H2 +NAME="query">3.1.3. Searching for Bugs</H2 ><P -> The Bugzilla Search page is is the interface where you can - find any bug report, comment, or patch currently in the - Bugzilla system. You can play with it here: - <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/query.cgi" +>The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/query.cgi" TARGET="_top" -> landfill.tequilarista.org/bugzilla-tip/query.cgi</A ->. - </P +> landfill.bugzilla.org/bugzilla-tip/query.cgi</A +> + + .</P ><P -> The Search page has controls for selecting different possible values - for all of the fields in a bug, as described above. Once you've defined - a search, you can either run it, or save it as a Remembered Query, which - can optionally appear in the footer of your pages. - </P +>The Search page has controls for selecting different possible + values for all of the fields in a bug, as described above. Once you've + defined a search, you can either run it, or save it as a Remembered + Query, which can optionally appear in the footer of your pages.</P ><P -> Highly advanced querying is done using Boolean Charts, which have their - own <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html" +>Highly advanced querying is done using Boolean Charts, which have + their own + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html" TARGET="_top" ->context-sensitive help</A ->. - </P +> context-sensitive help</A +> + + .</P ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="list">2.3.4. Bug Lists</H2 +NAME="list">3.1.4. Bug Lists</H2 ><P -> If you run a search, a list of matching bugs will be returned. - The default search is to return all open bugs on the system - - don't try running this search on a Bugzilla installation with - a lot of bugs! - </P +>If you run a search, a list of matching bugs will be returned. + The default search is to return all open bugs on the system - don't try + running this search on a Bugzilla installation with a lot of + bugs!</P ><P -> The format of the list is configurable. For example, it can be - sorted by clicking the column headings. Other useful features - can be accessed using the links at the bottom of the list: - <P +>The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features can be + accessed using the links at the bottom of the list: + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -><EM ->Long Format</EM ->: this gives you a large page - with a non-editable summary of the fields of each bug.</TD +> <EM +>Long Format:</EM +> + + this gives you a large page with a non-editable summary of the fields + of each bug.</TD ></TR ><TR ><TD -><EM ->Change Columns</EM ->: change the bug - attributes which appear in the list.</TD +> <EM +>Change Columns:</EM +> + + change the bug attributes which appear in the list.</TD ></TR ><TR ><TD -><EM ->Change several bugs at once</EM ->: If - your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner.</TD +> <EM +>Change several bugs at once:</EM +> + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner.</TD ></TR ><TR ><TD -><EM ->Send mail to bug owners</EM ->: Sends mail - to the owners of all bugs on the list.</TD +> <EM +>Send mail to bug owners:</EM +> + + Sends mail to the owners of all bugs on the list.</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 +> <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 @@ -643,80 +530,56 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="bugreports">2.3.5. Filing Bugs</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 +NAME="bugreports">3.1.5. Filing Bugs</H2 ><P -><I ->And all this time, I thought we were taking bugs <EM ->out</EM ->...</I -></P -></I -></TD -></TR -></TABLE -><P -> Years of bug writing experience has been distilled for your reading - pleasure into the <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html" +>Years of bug writing experience has been distilled for your + reading pleasure into the + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html" TARGET="_top" -> Bug Writing Guidelines</A ->. -While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. - </P +> Bug Writing Guidelines</A +>. + While some of the advice is Mozilla-specific, the basic principles of + reporting Reproducible, Specific bugs, isolating the Product you are + using, the Version of the Product, the Component which failed, the + Hardware Platform, and Operating System you were using at the time of + the failure go a long way toward ensuring accurate, responsible fixes + for the bug that bit you.</P ><P -> The procedure for filing a test bug is as follows: - </P +>The procedure for filing a test bug is as follows:</P ><P ></P ><OL TYPE="1" ><LI ><P -> Go to <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/" +>Go to + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" TARGET="_top" ->Landfill</A -> - in your browser and click - <A -HREF="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi" +> Landfill</A +> + in your browser and click + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi" TARGET="_top" -> Enter a new bug report</A +> Enter a new bug report</A >. - </P + </P ></LI ><LI ><P -> Select a product - any one will do. - </P +>Select a product - any one will do.</P ></LI ><LI ><P -> Fill in the fields. - Bugzilla should have made reasonable guesses, based upon - your browser, for the "Platform" and "OS" drop-down - boxes. If they are wrong, change them. - </P +>Fill in the fields. Bugzilla should have made reasonable + guesses, based upon your browser, for the "Platform" and "OS" + drop-down boxes. If they are wrong, change them.</P ></LI ><LI ><P -> Select "Commit" and send in your bug report. - </P +>Select "Commit" and send in your bug report.</P ></LI ></OL ></DIV @@ -737,7 +600,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="why.html" +HREF="using.html" ACCESSKEY="P" >Prev</A ></TD @@ -755,7 +618,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="init4me.html" +HREF="hintsandtips.html" ACCESSKEY="N" >Next</A ></TD @@ -765,7 +628,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Why Should We Use Bugzilla?</TD +>Using Bugzilla</TD ><TD WIDTH="34%" ALIGN="center" @@ -779,7 +642,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Where can I find my user preferences?</TD +>Hints and Tips</TD ></TR ></TABLE ></DIV diff --git a/docs/html/index.html b/docs/html/index.html index c2d356d10..51024b628 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -47,32 +47,33 @@ NAME="AEN2">The Bugzilla Guide</H1 CLASS="author" ><A NAME="AEN5">Matthew P. Barnson</H3 -><DIV -CLASS="affiliation" -><DIV -CLASS="address" -><P -CLASS="address" ->mbarnson@sisna.com</P -></DIV -></DIV +><H3 +CLASS="author" +><A +NAME="AEN9">The Bugzilla Team</H3 ><DIV ><DIV CLASS="abstract" ><A -NAME="AEN12"><P +NAME="AEN13"><P ></P ><P -> This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. - Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. +> This is the documentation for Bugzilla, the mozilla.org + bug-tracking system. + Bugzilla is an enterprise-class piece of software + that powers issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. </P ><P -> This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or SGML diffs, attached - to a Bugzilla bug. +> + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or SGML diffs, attached + to a bug filed in + <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation" +TARGET="_top" +>mozilla.org's Bugzilla</A +>. </P ><P ></P @@ -95,36 +96,26 @@ HREF="about.html" ><DL ><DT >1.1. <A -HREF="aboutthisguide.html" ->Purpose and Scope of this Guide</A -></DT -><DT ->1.2. <A HREF="copyright.html" >Copyright Information</A ></DT ><DT ->1.3. <A +>1.2. <A HREF="disclaimer.html" >Disclaimer</A ></DT ><DT ->1.4. <A +>1.3. <A HREF="newversions.html" >New Versions</A ></DT ><DT ->1.5. <A +>1.4. <A HREF="credits.html" >Credits</A ></DT ><DT ->1.6. <A -HREF="translations.html" ->Translations</A -></DT -><DT ->1.7. <A +>1.5. <A HREF="conventions.html" >Document Conventions</A ></DT @@ -132,8 +123,8 @@ HREF="conventions.html" ></DD ><DT >2. <A -HREF="using.html" ->Using Bugzilla</A +HREF="introduction.html" +>Introduction</A ></DT ><DD ><DL @@ -147,157 +138,117 @@ HREF="whatis.html" HREF="why.html" >Why Should We Use Bugzilla?</A ></DT -><DT ->2.3. <A -HREF="how.html" ->How do I use Bugzilla?</A -></DT -><DT ->2.4. <A -HREF="init4me.html" ->Where can I find my user preferences?</A -></DT -><DT ->2.5. <A -HREF="usingbz-conc.html" ->Using Bugzilla-Conclusion</A -></DT ></DL ></DD ><DT >3. <A -HREF="installation.html" ->Installation</A +HREF="using.html" +>Using Bugzilla</A ></DT ><DD ><DL ><DT >3.1. <A -HREF="errata.html" ->ERRATA</A +HREF="how.html" +>How do I use Bugzilla?</A ></DT ><DT >3.2. <A -HREF="stepbystep.html" ->Step-by-step Install</A +HREF="hintsandtips.html" +>Hints and Tips</A ></DT ><DT >3.3. <A -HREF="osx.html" ->Mac OS X Installation Notes</A -></DT -><DT ->3.4. <A -HREF="bsdinstall.html" ->BSD Installation Notes</A -></DT -><DT ->3.5. <A -HREF="geninstall.html" ->Installation General Notes</A -></DT -><DT ->3.6. <A -HREF="win32.html" ->Win32 Installation Notes</A +HREF="userpreferences.html" +>User Preferences</A ></DT ></DL ></DD ><DT >4. <A -HREF="administration.html" ->Administering Bugzilla</A +HREF="installation.html" +>Installation</A ></DT ><DD ><DL ><DT >4.1. <A -HREF="postinstall-check.html" ->Post-Installation Checklist</A +HREF="stepbystep.html" +>Step-by-step Install</A ></DT ><DT >4.2. <A -HREF="useradmin.html" ->User Administration</A +HREF="extraconfig.html" +>Optional Additional Configuration</A ></DT ><DT >4.3. <A -HREF="programadmin.html" ->Product, Component, Milestone, and Version - Administration</A +HREF="win32.html" +>Win32 Installation Notes</A ></DT ><DT >4.4. <A -HREF="security.html" ->Bugzilla Security</A +HREF="osx.html" +>Mac OS X Installation Notes</A +></DT +><DT +>4.5. <A +HREF="troubleshooting.html" +>Troubleshooting</A ></DT ></DL ></DD ><DT >5. <A -HREF="integration.html" ->Integrating Bugzilla with Third-Party Tools</A +HREF="administration.html" +>Administering Bugzilla</A ></DT ><DD ><DL ><DT >5.1. <A -HREF="bonsai.html" ->Bonsai</A +HREF="parameters.html" +>Bugzilla Configuration</A ></DT ><DT >5.2. <A -HREF="cvs.html" ->CVS</A +HREF="useradmin.html" +>User Administration</A ></DT ><DT >5.3. <A -HREF="scm.html" ->Perforce SCM</A +HREF="programadmin.html" +>Product, Component, Milestone, and Version Administration</A ></DT ><DT >5.4. <A -HREF="tinderbox.html" ->Tinderbox/Tinderbox2</A +HREF="voting.html" +>Voting</A ></DT -></DL -></DD ><DT ->6. <A -HREF="variants.html" ->Bugzilla Variants and Competitors</A +>5.5. <A +HREF="groups.html" +>Groups and Group Security</A ></DT -><DD -><DL ><DT ->6.1. <A -HREF="rhbugzilla.html" ->Red Hat Bugzilla</A -></DT -><DT ->6.2. <A -HREF="variant-fenris.html" ->Loki Bugzilla (Fenris)</A -></DT -><DT ->6.3. <A -HREF="variant-issuezilla.html" ->Issuezilla</A +>5.6. <A +HREF="security.html" +>Bugzilla Security</A ></DT ><DT ->6.4. <A -HREF="variant-scarab.html" ->Scarab</A +>5.7. <A +HREF="cust-templates.html" +>Template Customisation</A ></DT ><DT ->6.5. <A -HREF="variant-perforce.html" ->Perforce SCM</A +>5.8. <A +HREF="upgrading.html" +>Upgrading to New Releases</A ></DT ><DT ->6.6. <A -HREF="variant-sourceforge.html" ->SourceForge</A +>5.9. <A +HREF="integration.html" +>Integrating Bugzilla with Third-Party Tools</A ></DT ></DL ></DD @@ -308,136 +259,84 @@ HREF="faq.html" ></DT ><DT >B. <A -HREF="downloadlinks.html" ->Software Download Links</A -></DT -><DT ->C. <A HREF="database.html" >The Bugzilla Database</A ></DT ><DD ><DL ><DT ->C.1. <A +>B.1. <A HREF="dbschema.html" >Database Schema Chart</A ></DT ><DT ->C.2. <A +>B.2. <A HREF="dbdoc.html" >MySQL Bugzilla Database Introduction</A ></DT -><DT ->C.3. <A -HREF="granttables.html" ->MySQL Permissions & Grant Tables</A -></DT ></DL ></DD ><DT ->D. <A +>C. <A HREF="patches.html" >Useful Patches and Utilities for Bugzilla</A ></DT ><DD ><DL ><DT ->D.1. <A +>C.1. <A HREF="rewrite.html" ->Apache <TT +>Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</A +> + + magic</A ></DT ><DT ->D.2. <A -HREF="setperl.html" ->The setperl.csh Utility</A -></DT -><DT ->D.3. <A +>C.2. <A HREF="cmdline.html" >Command-line Bugzilla Queries</A ></DT -><DT ->D.4. <A -HREF="quicksearch.html" ->The Quicksearch Utility</A -></DT -><DT ->D.5. <A -HREF="bzhacking.html" ->Hacking Bugzilla</A -></DT ></DL ></DD ><DT ->E. <A -HREF="gfdl.html" ->GNU Free Documentation License</A +>D. <A +HREF="variants.html" +>Bugzilla Variants and Competitors</A ></DT ><DD ><DL ><DT ->0. <A -HREF="gfdl-0.html" ->PREAMBLE</A -></DT -><DT ->1. <A -HREF="gfdl-1.html" ->APPLICABILITY AND DEFINITIONS</A -></DT -><DT ->2. <A -HREF="gfdl-2.html" ->VERBATIM COPYING</A -></DT -><DT ->3. <A -HREF="gfdl-3.html" ->COPYING IN QUANTITY</A -></DT -><DT ->4. <A -HREF="gfdl-4.html" ->MODIFICATIONS</A -></DT -><DT ->5. <A -HREF="gfdl-5.html" ->COMBINING DOCUMENTS</A -></DT -><DT ->6. <A -HREF="gfdl-6.html" ->COLLECTIONS OF DOCUMENTS</A +>D.1. <A +HREF="rhbugzilla.html" +>Red Hat Bugzilla</A ></DT ><DT ->7. <A -HREF="gfdl-7.html" ->AGGREGATION WITH INDEPENDENT WORKS</A +>D.2. <A +HREF="variant-fenris.html" +>Loki Bugzilla (Fenris)</A ></DT ><DT ->8. <A -HREF="gfdl-8.html" ->TRANSLATION</A +>D.3. <A +HREF="variant-issuezilla.html" +>Issuezilla</A ></DT ><DT ->9. <A -HREF="gfdl-9.html" ->TERMINATION</A +>D.4. <A +HREF="variant-scarab.html" +>Scarab</A ></DT ><DT ->10. <A -HREF="gfdl-10.html" ->FUTURE REVISIONS OF THIS LICENSE</A +>D.5. <A +HREF="variant-perforce.html" +>Perforce SCM</A ></DT ><DT -><A -HREF="gfdl-howto.html" ->How to use this License for your documents</A +>D.6. <A +HREF="variant-sourceforge.html" +>SourceForge</A ></DT ></DL ></DD @@ -457,76 +356,22 @@ CLASS="LOT" >List of Examples</B ></DT ><DT ->3-1. <A -HREF="stepbystep.html#AEN641" ->Setting up bonsaitools symlink</A -></DT -><DT ->3-2. <A -HREF="stepbystep.html#AEN732" ->Running checksetup.pl as the web user</A -></DT -><DT ->3-3. <A -HREF="win32.html#AEN985" ->Installing ActivePerl ppd Modules on Microsoft Windows</A -></DT -><DT ->3-4. <A -HREF="win32.html#AEN998" ->Installing OpenInteract ppd Modules manually on Microsoft - Windows</A -></DT -><DT ->3-5. <A -HREF="win32.html#AEN1180" ->Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</A -></DT -><DT >4-1. <A -HREF="programadmin.html#AEN1405" ->Creating some Components</A +HREF="win32.html#AEN989" +>Installing ActivePerl ppd Modules on Microsoft + Windows</A ></DT ><DT >4-2. <A -HREF="programadmin.html#AEN1434" ->Common Use of Versions</A +HREF="win32.html#AEN1002" +>Installing OpenInteract ppd Modules manually on Microsoft + Windows</A ></DT ><DT >4-3. <A -HREF="programadmin.html#AEN1438" ->A Different Use of Versions</A -></DT -><DT ->4-4. <A -HREF="programadmin.html#AEN1466" ->Using SortKey with Target Milestone</A -></DT -><DT ->4-5. <A -HREF="programadmin.html#AEN1502" ->When to Use Group Security</A -></DT -><DT ->4-6. <A -HREF="programadmin.html#AEN1519" ->Creating a New Group</A -></DT -><DT ->4-7. <A -HREF="programadmin.html#AEN1536" ->Bugzilla Groups</A -></DT -><DT ->D-1. <A -HREF="setperl.html#AEN2380" ->Using Setperl to set your perl path</A -></DT -><DT ->1. <A -HREF="glossary.html#AEN2701" ->A Sample Product</A +HREF="win32.html#AEN1184" +>Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</A ></DT ></DL ></DIV diff --git a/docs/html/init4me.html b/docs/html/init4me.html deleted file mode 100644 index 9b115e0f5..000000000 --- a/docs/html/init4me.html +++ /dev/null @@ -1,451 +0,0 @@ -<HTML -><HEAD -><TITLE ->Where can I find my user preferences?</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Using Bugzilla" -HREF="using.html"><LINK -REL="PREVIOUS" -TITLE="How do I use Bugzilla?" -HREF="how.html"><LINK -REL="NEXT" -TITLE="Using Bugzilla-Conclusion" -HREF="usingbz-conc.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="how.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 2. Using Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="usingbz-conc.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="init4me">2.4. Where can I find my user preferences?</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" -><H2 -CLASS="section" -><A -NAME="accountsettings">2.4.1. Account Settings</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" -><H2 -CLASS="section" -><A -NAME="emailsettings">2.4.2. Email Settings</H2 -><DIV -CLASS="section" -><H3 -CLASS="section" -><A -NAME="notification">2.4.2.1. Email Notification</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.html" ->Bonsai, the Mozilla automated CVS management system</A -> or <A -HREF="tinderbox.html" ->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" -><H3 -CLASS="section" -><A -NAME="newemailtech">2.4.2.2. New Email Technology</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" -><H3 -CLASS="section" -><A -NAME="watchsettings">2.4.2.3. "Watching" Users</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" -><H2 -CLASS="section" -><A -NAME="footersettings">2.4.3. Page Footer</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" -><H2 -CLASS="section" -><A -NAME="permissionsettings">2.4.4. Permissions</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="how.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="usingbz-conc.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->How do I use Bugzilla?</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="using.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Using Bugzilla-Conclusion</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/installation.html b/docs/html/installation.html index d450028a4..2f27feedf 100644 --- a/docs/html/installation.html +++ b/docs/html/installation.html @@ -10,11 +10,11 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="Using Bugzilla-Conclusion" -HREF="usingbz-conc.html"><LINK +TITLE="User Preferences" +HREF="userpreferences.html"><LINK REL="NEXT" -TITLE="ERRATA" -HREF="errata.html"></HEAD +TITLE="Step-by-step Install" +HREF="stepbystep.html"></HEAD ><BODY CLASS="chapter" BGCOLOR="#FFFFFF" @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="usingbz-conc.html" +HREF="userpreferences.html" ACCESSKEY="P" >Prev</A ></TD @@ -56,7 +56,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="errata.html" +HREF="stepbystep.html" ACCESSKEY="N" >Next</A ></TD @@ -69,7 +69,7 @@ WIDTH="100%"></DIV CLASS="chapter" ><H1 ><A -NAME="installation">Chapter 3. Installation</H1 +NAME="installation">Chapter 4. Installation</H1 ><DIV CLASS="TOC" ><DL @@ -78,205 +78,176 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->3.1. <A -HREF="errata.html" ->ERRATA</A -></DT -><DT ->3.2. <A +>4.1. <A HREF="stepbystep.html" >Step-by-step Install</A ></DT ><DD ><DL ><DT ->3.2.1. <A -HREF="stepbystep.html#AEN441" +>4.1.1. <A +HREF="stepbystep.html#AEN492" >Introduction</A ></DT ><DT ->3.2.2. <A -HREF="stepbystep.html#AEN447" ->Installing the Prerequisites</A +>4.1.2. <A +HREF="stepbystep.html#AEN496" +>Package List</A ></DT ><DT ->3.2.3. <A +>4.1.3. <A HREF="stepbystep.html#install-mysql" ->Installing MySQL Database</A +>MySQL</A ></DT ><DT ->3.2.4. <A +>4.1.4. <A HREF="stepbystep.html#install-perl" ->Perl (5.004 or greater)</A -></DT -><DT ->3.2.5. <A -HREF="stepbystep.html#AEN534" ->DBI Perl Module</A -></DT -><DT ->3.2.6. <A -HREF="stepbystep.html#AEN572" ->Data::Dumper Perl Module</A -></DT -><DT ->3.2.7. <A -HREF="stepbystep.html#AEN577" ->MySQL related Perl Module Collection</A -></DT -><DT ->3.2.8. <A -HREF="stepbystep.html#AEN586" ->TimeDate Perl Module Collection</A -></DT -><DT ->3.2.9. <A -HREF="stepbystep.html#AEN590" ->GD Perl Module (1.8.3)</A +>Perl</A ></DT ><DT ->3.2.10. <A -HREF="stepbystep.html#AEN599" ->Chart::Base Perl Module (0.99c)</A +>4.1.5. <A +HREF="stepbystep.html#perl-modules" +>Perl Modules</A ></DT ><DT ->3.2.11. <A -HREF="stepbystep.html#AEN603" ->DB_File Perl Module</A -></DT -><DT ->3.2.12. <A -HREF="stepbystep.html#AEN606" +>4.1.6. <A +HREF="stepbystep.html#AEN669" >HTTP Server</A ></DT ><DT ->3.2.13. <A -HREF="stepbystep.html#AEN625" ->Installing the Bugzilla Files</A +>4.1.7. <A +HREF="stepbystep.html#AEN688" +>Bugzilla</A ></DT ><DT ->3.2.14. <A -HREF="stepbystep.html#AEN654" +>4.1.8. <A +HREF="stepbystep.html#AEN705" >Setting Up the MySQL Database</A ></DT ><DT ->3.2.15. <A -HREF="stepbystep.html#AEN701" ->Tweaking <TT +>4.1.9. <A +HREF="stepbystep.html#AEN741" +><TT CLASS="filename" ->localconfig</TT +>checksetup.pl</TT ></A ></DT ><DT ->3.2.16. <A -HREF="stepbystep.html#AEN739" ->Setting Up Maintainers Manually (Optional)</A -></DT -><DT ->3.2.17. <A -HREF="stepbystep.html#AEN750" ->The Whining Cron (Optional)</A -></DT -><DT ->3.2.18. <A -HREF="stepbystep.html#AEN760" ->Bug Graphs (Optional)</A +>4.1.10. <A +HREF="stepbystep.html#AEN773" +>Securing MySQL</A ></DT ><DT ->3.2.19. <A -HREF="stepbystep.html#AEN772" ->Securing MySQL</A +>4.1.11. <A +HREF="stepbystep.html#AEN839" +>Configuring Bugzilla</A ></DT ></DL ></DD ><DT ->3.3. <A -HREF="osx.html" ->Mac OS X Installation Notes</A +>4.2. <A +HREF="extraconfig.html" +>Optional Additional Configuration</A ></DT +><DD +><DL ><DT ->3.4. <A -HREF="bsdinstall.html" ->BSD Installation Notes</A +>4.2.1. <A +HREF="extraconfig.html#AEN845" +>Dependency Charts</A ></DT ><DT ->3.5. <A -HREF="geninstall.html" ->Installation General Notes</A +>4.2.2. <A +HREF="extraconfig.html#AEN860" +>Bug Graphs</A ></DT -><DD -><DL ><DT ->3.5.1. <A -HREF="geninstall.html#AEN874" ->Modifying Your Running System</A +>4.2.3. <A +HREF="extraconfig.html#AEN873" +>The Whining Cron</A ></DT ><DT ->3.5.2. <A -HREF="geninstall.html#AEN881" ->Upgrading From Previous Versions</A +>4.2.4. <A +HREF="extraconfig.html#bzldap" +>LDAP Authentication</A ></DT ><DT ->3.5.3. <A -HREF="geninstall.html#htaccess" +>4.2.5. <A +HREF="extraconfig.html#content-type" +>Preventing untrusted Bugzilla content from executing malicious + Javascript code</A +></DT +><DT +>4.2.6. <A +HREF="extraconfig.html#htaccess" ><TT CLASS="filename" >.htaccess</TT -> files and security</A +> + files and security</A ></DT ><DT ->3.5.4. <A -HREF="geninstall.html#mod-throttle" +>4.2.7. <A +HREF="extraconfig.html#mod-throttle" ><TT CLASS="filename" >mod_throttle</TT -> and Security</A -></DT -><DT ->3.5.5. <A -HREF="geninstall.html#content-type" ->Preventing untrusted Bugzilla content from executing malicious Javascript code</A -></DT -><DT ->3.5.6. <A -HREF="geninstall.html#unixhistory" ->UNIX Installation Instructions History</A +> + + and Security</A ></DT ></DL ></DD ><DT ->3.6. <A +>4.3. <A HREF="win32.html" >Win32 Installation Notes</A ></DT ><DD ><DL ><DT ->3.6.1. <A +>4.3.1. <A HREF="win32.html#wininstall" >Win32 Installation: Step-by-step</A ></DT ><DT ->3.6.2. <A +>4.3.2. <A HREF="win32.html#addlwintips" >Additional Windows Tips</A ></DT +></DL +></DD +><DT +>4.4. <A +HREF="osx.html" +>Mac OS X Installation Notes</A +></DT +><DT +>4.5. <A +HREF="troubleshooting.html" +>Troubleshooting</A +></DT +><DD +><DL +><DT +>4.5.1. <A +HREF="troubleshooting.html#AEN1218" +>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</A +></DT ><DT ->3.6.3. <A -HREF="win32.html#bzldap" ->Bugzilla LDAP Integration</A +>4.5.2. <A +HREF="troubleshooting.html#AEN1223" +>DBD::Sponge::db prepare failed</A +></DT +><DT +>4.5.3. <A +HREF="troubleshooting.html#paranoid-security" +>cannot chdir(/var/spool/mqueue)</A ></DT ></DL ></DD ></DL ></DIV -><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 ><DIV CLASS="NAVFOOTER" @@ -294,7 +265,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="usingbz-conc.html" +HREF="userpreferences.html" ACCESSKEY="P" >Prev</A ></TD @@ -312,7 +283,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="errata.html" +HREF="stepbystep.html" ACCESSKEY="N" >Next</A ></TD @@ -322,7 +293,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Using Bugzilla-Conclusion</TD +>User Preferences</TD ><TD WIDTH="34%" ALIGN="center" @@ -332,7 +303,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->ERRATA</TD +>Step-by-step Install</TD ></TR ></TABLE ></DIV diff --git a/docs/html/integration.html b/docs/html/integration.html index 47447fbeb..9a7c1c432 100644 --- a/docs/html/integration.html +++ b/docs/html/integration.html @@ -9,14 +9,17 @@ CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK REL="PREVIOUS" -TITLE="Bugzilla Security" -HREF="security.html"><LINK +TITLE="Upgrading to New Releases" +HREF="upgrading.html"><LINK REL="NEXT" -TITLE="Bonsai" -HREF="bonsai.html"></HEAD +TITLE="The Bugzilla FAQ" +HREF="faq.html"></HEAD ><BODY -CLASS="chapter" +CLASS="section" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" @@ -42,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="security.html" +HREF="upgrading.html" ACCESSKEY="P" >Prev</A ></TD @@ -50,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" -></TD +>Chapter 5. Administering Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="bonsai.html" +HREF="faq.html" ACCESSKEY="N" >Next</A ></TD @@ -66,38 +69,112 @@ ACCESSKEY="N" ALIGN="LEFT" WIDTH="100%"></DIV ><DIV -CLASS="chapter" +CLASS="section" ><H1 +CLASS="section" ><A -NAME="integration">Chapter 5. Integrating Bugzilla with Third-Party Tools</H1 +NAME="integration">5.9. Integrating Bugzilla with Third-Party Tools</H1 ><DIV -CLASS="TOC" -><DL -><DT -><B ->Table of Contents</B -></DT -><DT ->5.1. <A -HREF="bonsai.html" ->Bonsai</A -></DT -><DT ->5.2. <A -HREF="cvs.html" ->CVS</A -></DT -><DT ->5.3. <A -HREF="scm.html" ->Perforce SCM</A -></DT -><DT ->5.4. <A -HREF="tinderbox.html" ->Tinderbox/Tinderbox2</A -></DT -></DL +CLASS="section" +><H2 +CLASS="section" +><A +NAME="bonsai">5.9.1. Bonsai</H2 +><P +>Bonsai is a web-based tool for managing + <A +HREF="integration.html#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. Bonsai + also integrates with + <A +HREF="integration.html#tinderbox" +>Tinderbox, the Mozilla automated build management system</A +>. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="cvs">5.9.2. CVS</H2 +><P +>CVS integration is best accomplished, at this point, using the + Bugzilla Email Gateway.</P +><P +>Follow the instructions in this Guide 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 CVSZilla 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 +>. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="scm">5.9.3. Perforce SCM</H2 +><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" +><H2 +CLASS="section" +><A +NAME="tinderbox">5.9.4. Tinderbox/Tinderbox2</H2 +><P +>We need Tinderbox integration information.</P ></DIV ></DIV ><DIV @@ -116,7 +193,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="security.html" +HREF="upgrading.html" ACCESSKEY="P" >Prev</A ></TD @@ -134,7 +211,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="bonsai.html" +HREF="faq.html" ACCESSKEY="N" >Next</A ></TD @@ -144,17 +221,21 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Bugzilla Security</TD +>Upgrading to New Releases</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" -> </TD +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ->Bonsai</TD +>The Bugzilla FAQ</TD ></TR ></TABLE ></DIV diff --git a/docs/html/tinderbox.html b/docs/html/introduction.html index 21d52bda0..5240be057 100644 --- a/docs/html/tinderbox.html +++ b/docs/html/introduction.html @@ -1,7 +1,7 @@ <HTML ><HEAD ><TITLE ->Tinderbox/Tinderbox2</TITLE +>Introduction</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ @@ -9,17 +9,14 @@ CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK -REL="UP" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"><LINK REL="PREVIOUS" -TITLE="Perforce SCM" -HREF="scm.html"><LINK +TITLE="Document Conventions" +HREF="conventions.html"><LINK REL="NEXT" -TITLE="Bugzilla Variants and Competitors" -HREF="variants.html"></HEAD +TITLE="What is Bugzilla?" +HREF="whatis.html"></HEAD ><BODY -CLASS="section" +CLASS="chapter" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" @@ -45,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="scm.html" +HREF="conventions.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +50,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 5. Integrating Bugzilla with Third-Party Tools</TD +></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="variants.html" +HREF="whatis.html" ACCESSKEY="N" >Next</A ></TD @@ -69,13 +66,29 @@ ACCESSKEY="N" ALIGN="LEFT" WIDTH="100%"></DIV ><DIV -CLASS="section" +CLASS="chapter" ><H1 -CLASS="section" ><A -NAME="tinderbox">5.4. Tinderbox/Tinderbox2</H1 -><P ->We need Tinderbox integration information.</P +NAME="introduction">Chapter 2. Introduction</H1 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +>2.1. <A +HREF="whatis.html" +>What is Bugzilla?</A +></DT +><DT +>2.2. <A +HREF="why.html" +>Why Should We Use Bugzilla?</A +></DT +></DL +></DIV ></DIV ><DIV CLASS="NAVFOOTER" @@ -93,7 +106,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="scm.html" +HREF="conventions.html" ACCESSKEY="P" >Prev</A ></TD @@ -111,7 +124,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="variants.html" +HREF="whatis.html" ACCESSKEY="N" >Next</A ></TD @@ -121,21 +134,17 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Perforce SCM</TD +>Document Conventions</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" -><A -HREF="integration.html" -ACCESSKEY="U" ->Up</A -></TD +> </TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ->Bugzilla Variants and Competitors</TD +>What is Bugzilla?</TD ></TR ></TABLE ></DIV diff --git a/docs/html/newversions.html b/docs/html/newversions.html index 7af6fee26..d9e4ba4be 100644 --- a/docs/html/newversions.html +++ b/docs/html/newversions.html @@ -73,9 +73,10 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="newversions">1.4. New Versions</H1 +NAME="newversions">1.3. New Versions</H1 ><P -> This is the 2.16 version of The Bugzilla Guide. If you are +> This is the 2.16 version of The Bugzilla Guide. It is so named + to match the current version of Bugzilla. 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. @@ -110,15 +111,27 @@ TARGET="_top" > </P ><P -> The latest version of this document can be checked out via CVS. - Please follow the instructions available at <A +> The latest version of this document can always 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 <TT +>, + and check out the <TT CLASS="filename" >mozilla/webtools/bugzilla/docs/</TT -> branch. +> + subtree. + </P +><P +> The Bugzilla Guide is currently only available in English. + If you would like to volunteer to translate it, please contact + <A +HREF="mailto:justdave@syndicomm.com" +TARGET="_top" +>Dave Miller</A +>. </P ></DIV ><DIV diff --git a/docs/html/osx.html b/docs/html/osx.html index b82342675..147cf3b6c 100644 --- a/docs/html/osx.html +++ b/docs/html/osx.html @@ -13,11 +13,11 @@ REL="UP" TITLE="Installation" HREF="installation.html"><LINK REL="PREVIOUS" -TITLE="Step-by-step Install" -HREF="stepbystep.html"><LINK +TITLE="Win32 Installation Notes" +HREF="win32.html"><LINK REL="NEXT" -TITLE="BSD Installation Notes" -HREF="bsdinstall.html"></HEAD +TITLE="Troubleshooting" +HREF="troubleshooting.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="stepbystep.html" +HREF="win32.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 3. Installation</TD +>Chapter 4. Installation</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="bsdinstall.html" +HREF="troubleshooting.html" ACCESSKEY="N" >Next</A ></TD @@ -73,151 +73,116 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="osx">3.3. Mac OS X Installation Notes</H1 +NAME="osx">4.4. Mac OS X Installation Notes</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 +>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 +>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 +>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 +>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 +>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, because 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 +>Instead of typing + <SPAN CLASS="QUOTE" >"install GD"</SPAN -> at the - <TT +> + at the + <TT CLASS="prompt" >cpan></TT -> prompt, type <B +> + 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 +>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 <A +HREF="../sgml/gd-makefile.patch" +TARGET="_top" +>this patch</A +> + to the Makefile.PL file (save the + patch into a file and use the command + <B CLASS="command" ->patch < - patchfile</B ->: +>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 +>Then, run these commands to finish the installation of the GD + module: + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -><B +> <B CLASS="command" >perl Makefile.PL</B -></TD +> + </TD ></TR ><TR ><TD -><B +> <B CLASS="command" >make</B -></TD +> + </TD ></TR ><TR ><TD -><B +> <B CLASS="command" >make test</B -></TD +> + </TD ></TR ><TR ><TD -><B +> <B CLASS="command" >make install</B -></TD +> + </TD ></TR ><TR ><TD ->And don't forget to run <B +>And don't forget to run + <B CLASS="command" >exit</B -> to get back to cpan.</TD +> + + to get back to CPAN.</TD ></TR ></TBODY ></TABLE @@ -225,9 +190,6 @@ CLASS="command" ></P > </P -><P -> Happy Hacking! - </P ></DIV ><DIV CLASS="NAVFOOTER" @@ -245,7 +207,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="stepbystep.html" +HREF="win32.html" ACCESSKEY="P" >Prev</A ></TD @@ -263,7 +225,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="bsdinstall.html" +HREF="troubleshooting.html" ACCESSKEY="N" >Next</A ></TD @@ -273,7 +235,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Step-by-step Install</TD +>Win32 Installation Notes</TD ><TD WIDTH="34%" ALIGN="center" @@ -287,7 +249,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->BSD Installation Notes</TD +>Troubleshooting</TD ></TR ></TABLE ></DIV diff --git a/docs/html/parameters.html b/docs/html/parameters.html new file mode 100644 index 000000000..59455a082 --- /dev/null +++ b/docs/html/parameters.html @@ -0,0 +1,435 @@ +<HTML +><HEAD +><TITLE +>Bugzilla Configuration</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="PREVIOUS" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="NEXT" +TITLE="User Administration" +HREF="useradmin.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="administration.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Administering Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="useradmin.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="parameters">5.1. Bugzilla Configuration</H1 +><P +>Bugzilla is configured by changing various parameters, accessed + from the "Edit parameters" link in the page footer. Here are + some of the key parameters on that page. You should run down this + list and set them appropriately after installing Bugzilla.</P +><DIV +CLASS="procedure" +><OL +TYPE="1" +><LI +><P +> + <B +CLASS="command" +>maintainer</B +>: + The maintainer parameter is the email address of the person + responsible for maintaining this + Bugzilla installation. The address need not be that of a valid Bugzilla + account.</P +></LI +><LI +><P +> <B +CLASS="command" +>urlbase</B +>: + This 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 + <TT +CLASS="filename" +>http://www.foo.com/bugzilla/query.cgi</TT +>, + set your <SPAN +CLASS="QUOTE" +>"urlbase"</SPAN +> + to <TT +CLASS="filename" +>http://www.foo.com/bugzilla/</TT +>.</P +></LI +><LI +><P +> <B +CLASS="command" +>usebuggroups</B +>: + This dictates whether or not to implement group-based security for + Bugzilla. If set, Bugzilla bugs can have an associated 'group', + defining which 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 particular bugs to certain + groups of users. I suggest leaving + this parameter <EM +>off</EM +> + while initially testing your Bugzilla.</P +></LI +><LI +><P +> <B +CLASS="command" +>usebuggroupsentry</B +>: + Bugzilla Products can have a group associated with them, so that + certain users can only see bugs in certain products. When this parameter + is set to <SPAN +CLASS="QUOTE" +>"on"</SPAN +>, this places all newly-created bugs in the + group for their product immediately.</P +></LI +><LI +><P +> <B +CLASS="command" +>shadowdb</B +>: + 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 +> As a guide, 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 +>The value of the parameter defines the name of the + shadow bug database. + Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. + <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 +> + </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 +> <B +CLASS="command" +>shutdownhtml</B +>: + + If you need to shut down Bugzilla to perform administration, enter + some descriptive HTML here and anyone who tries to use Bugzilla will + receive a page to that effect. Obviously, editparams.cgi will + still be accessible so you can remove the HTML and re-enable Bugzilla. + :-) + </P +></LI +><LI +><P +> <B +CLASS="command" +>passwordmail</B +>: + + Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along with + their password message.</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 +> <B +CLASS="command" +>useqacontact</B +>: + + This allows you to define an email address for each component, in + addition + to that of the default owner, who will be sent carbon copies of + incoming bugs.</P +></LI +><LI +><P +> <B +CLASS="command" +>usestatuswhiteboard</B +>: + This defines whether you wish to have a free-form, overwritable field + associated with each bug. The advantage of the Status Whiteboard is + that it can be deleted or modified with ease, and provides an + easily-searchable field for indexing some bugs that have some trait + in common. + </P +></LI +><LI +><P +> <B +CLASS="command" +>whinedays</B +>: + Set this to the number of days you want to let bugs go + in the NEW or REOPENED state before notifying people they have + untouched new bugs. If you do not plan to use this feature, simply do + not set up the whining cron job described in the installation + instructions, or set this value to "0" (never whine).</P +></LI +><LI +><P +> <B +CLASS="command" +>commenton*</B +>: + All these + fields allow you to dictate what changes can pass without comment, + and which must have a comment from the person who changed them. + Often, administrators will allow users to add themselves to the CC + list, accept bugs, or change the Status Whiteboard without adding a + comment as to their reasons for the change, yet require that most + other changes come with an explanation.</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 +> <B +CLASS="command" +>supportwatchers</B +>: + + Turning on this option allows users to ask to receive copies of + all a particular other user's bug email. 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 privileges. They would still only receive email + updates for those bugs she could normally view.</P +></LI +></OL +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="useradmin.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Administering Bugzilla</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>User Administration</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/patches.html b/docs/html/patches.html index dc63e0391..c2637937b 100644 --- a/docs/html/patches.html +++ b/docs/html/patches.html @@ -10,10 +10,13 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="MySQL Permissions & Grant Tables" -HREF="granttables.html"><LINK +TITLE="MySQL Bugzilla Database Introduction" +HREF="dbdoc.html"><LINK REL="NEXT" -TITLE="Apache mod_rewrite magic" +TITLE="Apache + mod_rewrite + + magic" HREF="rewrite.html"></HEAD ><BODY CLASS="appendix" @@ -42,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="granttables.html" +HREF="dbdoc.html" ACCESSKEY="P" >Prev</A ></TD @@ -69,7 +72,7 @@ WIDTH="100%"></DIV CLASS="appendix" ><H1 ><A -NAME="patches">Appendix D. Useful Patches and Utilities for Bugzilla</H1 +NAME="patches">Appendix C. Useful Patches and Utilities for Bugzilla</H1 ><DIV CLASS="TOC" ><DL @@ -78,51 +81,26 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->D.1. <A +>C.1. <A HREF="rewrite.html" ->Apache <TT +>Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</A +> + + magic</A ></DT ><DT ->D.2. <A -HREF="setperl.html" ->The setperl.csh Utility</A -></DT -><DT ->D.3. <A +>C.2. <A HREF="cmdline.html" >Command-line Bugzilla Queries</A ></DT -><DT ->D.4. <A -HREF="quicksearch.html" ->The Quicksearch Utility</A -></DT -><DT ->D.5. <A -HREF="bzhacking.html" ->Hacking Bugzilla</A -></DT -><DD -><DL -><DT ->D.5.1. <A -HREF="bzhacking.html#AEN2436" ->Things that have caused problems and should be avoided</A -></DT -><DT ->D.5.2. <A -HREF="bzhacking.html#AEN2450" ->Coding Style for Bugzilla</A -></DT -></DL -></DD ></DL ></DIV ><P ->Are you looking for a way to put your Bugzilla into overdrive? Catch some of the niftiest tricks here in this section.</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 ><DIV CLASS="NAVFOOTER" @@ -140,7 +118,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="granttables.html" +HREF="dbdoc.html" ACCESSKEY="P" >Prev</A ></TD @@ -168,7 +146,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->MySQL Permissions & Grant Tables</TD +>MySQL Bugzilla Database Introduction</TD ><TD WIDTH="34%" ALIGN="center" @@ -178,10 +156,13 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->Apache <TT +>Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</TD +> + + magic</TD ></TR ></TABLE ></DIV diff --git a/docs/html/postinstall-check.html b/docs/html/postinstall-check.html deleted file mode 100644 index f6a2e9310..000000000 --- a/docs/html/postinstall-check.html +++ /dev/null @@ -1,565 +0,0 @@ -<HTML -><HEAD -><TITLE ->Post-Installation Checklist</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Administering Bugzilla" -HREF="administration.html"><LINK -REL="PREVIOUS" -TITLE="Administering Bugzilla" -HREF="administration.html"><LINK -REL="NEXT" -TITLE="User Administration" -HREF="useradmin.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="administration.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 4. Administering Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="useradmin.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="postinstall-check">4.1. Post-Installation Checklist</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 privileges. 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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="administration.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="useradmin.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Administering Bugzilla</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="administration.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->User Administration</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/programadmin.html b/docs/html/programadmin.html index 4f2b7be40..f047dbcad 100644 --- a/docs/html/programadmin.html +++ b/docs/html/programadmin.html @@ -1,8 +1,7 @@ <HTML ><HEAD ><TITLE ->Product, Component, Milestone, and Version - Administration</TITLE +>Product, Component, Milestone, and Version Administration</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ @@ -17,8 +16,8 @@ REL="PREVIOUS" TITLE="User Administration" HREF="useradmin.html"><LINK REL="NEXT" -TITLE="Bugzilla Security" -HREF="security.html"></HEAD +TITLE="Voting" +HREF="voting.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -54,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 4. Administering Bugzilla</TD +>Chapter 5. Administering Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="security.html" +HREF="voting.html" ACCESSKEY="N" >Next</A ></TD @@ -74,64 +73,33 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="programadmin">4.3. Product, Component, Milestone, and Version - Administration</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 +NAME="programadmin">5.3. Product, Component, Milestone, and Version Administration</H1 ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="products">4.3.1. Products</H2 -><FONT -COLOR="RED" ->Formerly, and in some spots still, called - "Programs"</FONT +NAME="products">5.3.1. Products</H2 ><P -> <A +> <A HREF="glossary.html#gloss-product" ><I CLASS="glossterm" ->Products</I +> 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 +> + + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...)</P +><P +>Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes + required to move a bug automatically from the UNCONFIRMED status to the + NEW status.</P ><P >To create a new product:</P ><P @@ -140,227 +108,76 @@ CLASS="glossterm" 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 +>Select "products" from the footer</P ></LI ><LI ><P -> Select the "Add" link to the right of "Add a new product". - </P +>Select the "Add" link in the bottom right</P ></LI ><LI ><P -> Enter the name of the product and a description. The - Description field is free-form. - </P +>Enter the name of the product and a description. The + Description field may contain HTML.</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 +>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 ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="components">4.3.2. Components</H2 -><P -> Components are subsections of a Product. - - <DIV -CLASS="example" -><A -NAME="AEN1405"><P -><B ->Example 4-1. Creating some Components</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1407"><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 +NAME="components">5.3.2. Components</H2 +><P +>Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.</P +><P +> 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 +>; + these can be changed on bug submission, or at any later point in + a bug's life.</P ><P -> To create a new Component: - </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 +>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 +>Select the "Add" link in the bottom right.</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 +>Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. + </P ></LI ></OL ></DIV @@ -369,108 +186,32 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="versions">4.3.3. Versions</H2 +NAME="versions">5.3.3. Versions</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="AEN1434"><P -><B ->Example 4-2. Common Use of Versions</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1436"><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="AEN1438"><P -><B ->Example 4-3. A Different Use of Versions</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1440"><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: +>Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the most recent version with + the bug. </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 +>From the "Edit product" screen, select "Edit Versions"</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 +>You will notice that the product already has the default + version "undefined". Click the "Add" link in the bottom right.</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 +>Enter the name of the Version. This field takes text only. + Then click the "Add" button.</P ></LI ></OL ></DIV @@ -479,14 +220,11 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="milestones">4.3.4. Milestones</H2 +NAME="milestones">5.3.4. Milestones</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 +>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.</P ><DIV CLASS="note" ><P @@ -508,200 +246,44 @@ ALT="Note"></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 +>Milestone options will only appear for a Product if you turned + on the "usetargetmilestone" Param in the "Edit Parameters" screen. + </P ></TD ></TR ></TABLE ></DIV ><P -> To create new Milestones, set Default Milestones, and set - Milestone URL: - </P +>To create new Milestones, set Default Milestones, and set + Milestone URL:</P ><P ></P ><OL TYPE="1" ><LI ><P -> Select "edit milestones" - </P +>Select "Edit milestones" from the "Edit product" page.</P ></LI ><LI ><P -> Select "Add" to the right of the "Add a new milestone" - text - </P +>Select "Add" in the bottom right corner. + 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="AEN1466"><P -><B ->Example 4-4. Using SortKey with Target Milestone</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1468"><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 +>Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this particular + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add".</P ></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 +>From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean. </P ><DIV -CLASS="section" -><H2 -CLASS="section" -><A -NAME="voting">4.3.5. Voting</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 @@ -722,397 +304,16 @@ ALT="Tip"></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" -><H2 -CLASS="section" -><A -NAME="groups">4.3.6. Groups and Group Security</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="AEN1502"><P -><B ->Example 4-5. When to Use Group Security</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1504"><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 +>If you want your milestone document to be restricted so + that it can only be viewed by people in a particular Bugzilla + group, the best way is to attach the document to a bug in that + group, and make the URL the URL of that attachment.</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="AEN1519"><P -><B ->Example 4-6. Creating a New Group</B -></P -><DIV -CLASS="informalexample" -><A -NAME="AEN1521"><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="AEN1536"><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 privileges, 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 @@ -1149,7 +350,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="security.html" +HREF="voting.html" ACCESSKEY="N" >Next</A ></TD @@ -1173,7 +374,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Bugzilla Security</TD +>Voting</TD ></TR ></TABLE ></DIV diff --git a/docs/html/quicksearch.html b/docs/html/quicksearch.html deleted file mode 100644 index d070204e8..000000000 --- a/docs/html/quicksearch.html +++ /dev/null @@ -1,197 +0,0 @@ -<HTML -><HEAD -><TITLE ->The Quicksearch Utility</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Useful Patches and Utilities for Bugzilla" -HREF="patches.html"><LINK -REL="PREVIOUS" -TITLE="Command-line Bugzilla Queries" -HREF="cmdline.html"><LINK -REL="NEXT" -TITLE="Hacking Bugzilla" -HREF="bzhacking.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="cmdline.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix D. Useful Patches and Utilities for Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="bzhacking.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="quicksearch">D.4. The Quicksearch Utility</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="cmdline.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="bzhacking.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Command-line Bugzilla Queries</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="patches.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Hacking Bugzilla</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/rewrite.html b/docs/html/rewrite.html index b32ab9446..a64240d98 100644 --- a/docs/html/rewrite.html +++ b/docs/html/rewrite.html @@ -1,7 +1,10 @@ <HTML ><HEAD ><TITLE ->Apache mod_rewrite magic</TITLE +>Apache + mod_rewrite + + magic</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ @@ -16,8 +19,8 @@ REL="PREVIOUS" TITLE="Useful Patches and Utilities for Bugzilla" HREF="patches.html"><LINK REL="NEXT" -TITLE="The setperl.csh Utility" -HREF="setperl.html"></HEAD +TITLE="Command-line Bugzilla Queries" +HREF="cmdline.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -53,13 +56,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Appendix D. Useful Patches and Utilities for Bugzilla</TD +>Appendix C. Useful Patches and Utilities for Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="setperl.html" +HREF="cmdline.html" ACCESSKEY="N" >Next</A ></TD @@ -73,30 +76,37 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="rewrite">D.1. Apache <TT +NAME="rewrite">C.1. Apache + <TT CLASS="filename" >mod_rewrite</TT -> magic</H1 +> + + magic</H1 ><P ->Apache's <TT +>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 +> + + 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 +>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 +> + + , 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" @@ -107,13 +117,11 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -<VirtualHost 12.34.56.78> +> <VirtualHost 12.34.56.78> RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </VirtualHost> - - </PRE +</PRE ></FONT ></TD ></TR @@ -121,14 +129,14 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] ></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 +>There are many, many more things you can do with mod_rewrite. + Please refer to the mod_rewrite documentation at + <A HREF="http://www.apache.org" TARGET="_top" >http://www.apache.org</A -></P +>. + </P ></LI ></OL ></DIV @@ -166,7 +174,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="setperl.html" +HREF="cmdline.html" ACCESSKEY="N" >Next</A ></TD @@ -190,7 +198,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->The setperl.csh Utility</TD +>Command-line Bugzilla Queries</TD ></TR ></TABLE ></DIV diff --git a/docs/html/rhbugzilla.html b/docs/html/rhbugzilla.html index 4940de702..fb1eb3c9a 100644 --- a/docs/html/rhbugzilla.html +++ b/docs/html/rhbugzilla.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,22 +73,22 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="rhbugzilla">6.1. Red Hat Bugzilla</H1 +NAME="rhbugzilla">D.1. Red Hat Bugzilla</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 +>Red Hat Bugzilla is a fork of Bugzilla 2.8. + One of its major benefits is the ability + to work with Oracle, MySQL, and PostGreSQL databases serving as the + back-end, instead of just MySQL. Dave Lawrence of Red Hat is + active in the Bugzilla community, and we hope to see a reunification + of the fork before too long.</P ><P ->URL: <A +>URL: + <A HREF="http://bugzilla.redhat.com/bugzilla/" TARGET="_top" ->http://bugzilla.redhat.com/bugzilla/</A -></P +> http://bugzilla.redhat.com/bugzilla/</A +> + </P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/scm.html b/docs/html/scm.html deleted file mode 100644 index 8b0a3241b..000000000 --- a/docs/html/scm.html +++ /dev/null @@ -1,166 +0,0 @@ -<HTML -><HEAD -><TITLE ->Perforce SCM</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"><LINK -REL="PREVIOUS" -TITLE="CVS" -HREF="cvs.html"><LINK -REL="NEXT" -TITLE="Tinderbox/Tinderbox2" -HREF="tinderbox.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="cvs.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 5. Integrating Bugzilla with Third-Party Tools</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="tinderbox.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="scm">5.3. Perforce SCM</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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="cvs.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="tinderbox.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->CVS</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="integration.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Tinderbox/Tinderbox2</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/security.html b/docs/html/security.html index 49a2d10a4..a7433f67c 100644 --- a/docs/html/security.html +++ b/docs/html/security.html @@ -13,12 +13,11 @@ REL="UP" TITLE="Administering Bugzilla" HREF="administration.html"><LINK REL="PREVIOUS" -TITLE="Product, Component, Milestone, and Version - Administration" -HREF="programadmin.html"><LINK +TITLE="Groups and Group Security" +HREF="groups.html"><LINK REL="NEXT" -TITLE="Integrating Bugzilla with Third-Party Tools" -HREF="integration.html"></HEAD +TITLE="Template Customisation" +HREF="cust-templates.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -46,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="programadmin.html" +HREF="groups.html" ACCESSKEY="P" >Prev</A ></TD @@ -54,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 4. Administering Bugzilla</TD +>Chapter 5. Administering Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="integration.html" +HREF="cust-templates.html" ACCESSKEY="N" >Next</A ></TD @@ -74,38 +73,13 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="security">4.4. Bugzilla Security</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 +NAME="security">5.6. Bugzilla Security</H1 ><DIV -CLASS="note" +CLASS="warning" ><P ></P ><TABLE -CLASS="note" +CLASS="warning" WIDTH="100%" BORDER="0" ><TR @@ -114,26 +88,23 @@ WIDTH="25" ALIGN="CENTER" VALIGN="TOP" ><IMG -SRC="../images/note.gif" +SRC="../images/warning.gif" HSPACE="5" -ALT="Note"></TD +ALT="Warning"></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 +>Poorly-configured MySQL and Bugzilla 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 +><DIV CLASS="note" ><P ></P @@ -154,68 +125,65 @@ ALT="Note"></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 +>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 +> mozilla-webtools@mozilla.org</A > - </P + </P ></TD ></TR ></TABLE ></DIV -> - <P +><P +>To secure your installation: + + <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 +>Ensure you are running at least MysQL version 3.22.32 or newer. + Earlier versions had notable security holes and (from a security + point of view) poor 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" +> <EM +>There is no substitute for understanding the tools on your + system!</EM +> + + Read + <A +HREF="http://www.mysql.com/doc/P/r/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 +> The MySQL Privilege System</A +> + until you can recite it from memory!</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 +>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 +>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 +> + + . 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 @@ -236,102 +204,77 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> <SPAN +> <SPAN CLASS="QUOTE" >"nobody"</SPAN -> is a real user on UNIX systems. - Having a process run as user id <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 + + 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 + </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" +>Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. + The localconfig file stores your "bugs" database account password. + In addition, some + files under $BUGZILLA_HOME/data/ store sensitive information. + </P ><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 +>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 +>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 +> 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 ><P -> When you run checksetup.pl, the script will attempt to modify various - permissions on files which Bugzilla uses. If you do not have a - webservergroup set in the localconfig file, then Bugzilla will have to - make certain files world readable and/or writable. <EM ->THIS IS - INSECURE!</EM ->. This means that anyone who can get access to - your system can do whatever they want to your Bugzilla installation. - </P +>When you run checksetup.pl, the script will attempt to modify + various permissions on files which Bugzilla uses. If you do not have + a webservergroup set in the localconfig file, then Bugzilla will have + to make certain files world readable and/or writable. + <EM +>THIS IS INSECURE!</EM +> + + . This means that anyone who can get access to your system can do + whatever they want to your Bugzilla installation.</P ><DIV CLASS="note" ><P @@ -353,58 +296,56 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> This also means that if your webserver runs all cgi scripts as the - same user/group, anyone on the system who can run cgi scripts will - be able to take control of your Bugzilla installation. - </P +>This also means that if your webserver runs all cgi scripts + as the same user/group, anyone on the system who can run cgi + scripts will be able to take control of your Bugzilla + installation.</P ></TD ></TR ></TABLE ></DIV ><P -> On Apache, you can use .htaccess files to protect access - to these directories, as outlined in <A +>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 +>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 +>Bug + 65572</A > - </P + + for adequate protection in your data/ directory.</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/ - directory. <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 localconfig> deny<br> - from all </Files> allow from all </P +><Files comments> allow from all </Files><br> + deny from all</P > - </P + </P ><P -> Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/shadow - directory. <P +>Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/ directory. + <P CLASS="literallayout" -> deny from all </P +><Files localconfig> deny from all </Files><br> + allow from all</P > - </P + </P ></LI ></OL > @@ -426,7 +367,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="programadmin.html" +HREF="groups.html" ACCESSKEY="P" >Prev</A ></TD @@ -444,7 +385,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="integration.html" +HREF="cust-templates.html" ACCESSKEY="N" >Next</A ></TD @@ -454,8 +395,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Product, Component, Milestone, and Version - Administration</TD +>Groups and Group Security</TD ><TD WIDTH="34%" ALIGN="center" @@ -469,7 +409,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Integrating Bugzilla with Third-Party Tools</TD +>Template Customisation</TD ></TR ></TABLE ></DIV diff --git a/docs/html/setperl.html b/docs/html/setperl.html deleted file mode 100644 index 6ed8f17a6..000000000 --- a/docs/html/setperl.html +++ /dev/null @@ -1,312 +0,0 @@ -<HTML -><HEAD -><TITLE ->The setperl.csh Utility</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Useful Patches and Utilities for Bugzilla" -HREF="patches.html"><LINK -REL="PREVIOUS" -TITLE="Apache mod_rewrite magic" -HREF="rewrite.html"><LINK -REL="NEXT" -TITLE="Command-line Bugzilla Queries" -HREF="cmdline.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="rewrite.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Appendix D. Useful Patches and Utilities for Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="cmdline.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="setperl">D.2. The setperl.csh Utility</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="AEN2380"><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="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="rewrite.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="cmdline.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Apache <TT -CLASS="filename" ->mod_rewrite</TT -> magic</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="patches.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Command-line Bugzilla Queries</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/stepbystep.html b/docs/html/stepbystep.html index ef605ba91..6d4de5a21 100644 --- a/docs/html/stepbystep.html +++ b/docs/html/stepbystep.html @@ -13,11 +13,11 @@ REL="UP" TITLE="Installation" HREF="installation.html"><LINK REL="PREVIOUS" -TITLE="ERRATA" -HREF="errata.html"><LINK +TITLE="Installation" +HREF="installation.html"><LINK REL="NEXT" -TITLE="Mac OS X Installation Notes" -HREF="osx.html"></HEAD +TITLE="Optional Additional Configuration" +HREF="extraconfig.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="errata.html" +HREF="installation.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 3. Installation</TD +>Chapter 4. Installation</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="osx.html" +HREF="extraconfig.html" ACCESSKEY="N" >Next</A ></TD @@ -73,42 +73,31 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="stepbystep">3.2. Step-by-step Install</H1 +NAME="stepbystep">4.1. Step-by-step Install</H1 ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN441">3.2.1. Introduction</H2 +NAME="AEN492">4.1.1. Introduction</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 +>Bugzilla has been successfully installed under Solaris, Linux, + and Win32. Win32 is not yet officially supported, but many people + have got it working fine. + Please see the + <A HREF="win32.html" >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 +> + for further advice on getting Bugzilla to work on Microsoft + Windows.</P ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN447">3.2.2. Installing the Prerequisites</H2 +NAME="AEN496">4.1.2. Package List</H2 ><DIV CLASS="note" ><P @@ -130,84 +119,204 @@ ALT="Note"></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 +> If you are running the very most recent + version of Perl and MySQL (both the executables and development + libraries) on your system, you can skip these manual installation + steps for the Perl modules by using Bundle::Bugzilla; see + <A HREF="stepbystep.html#bundlebugzilla" >Using Bundle::Bugzilla instead of manually installing Perl modules</A -></P +>. + </P ></TD ></TR ></TABLE ></DIV ><P -> The software packages necessary for the proper running of bugzilla are: - <P +>The software packages necessary for the proper running of + Bugzilla (with download links) are: + <P ></P ><OL TYPE="1" ><LI ><P -> MySQL database server and the mysql client (3.22.5 or greater) - </P +> <A +HREF="http://www.mysql.com/" +TARGET="_top" +>MySQL database server</A +> + (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 +> <A +HREF="http://www.perl.org" +TARGET="_top" +>Perl</A +> + (5.005 or greater, 5.6.1 is recommended if you wish to + use Bundle::Bugzilla) + </P ></LI ><LI ><P -> DBI Perl module - </P +>Perl Modules (minimum version): + <P +></P +><OL +TYPE="a" +><LI +><P +> <A +HREF="http://www.template-toolkit.org" +TARGET="_top" +>Template</A +> + (v2.07) + </P ></LI ><LI ><P -> Data::Dumper Perl module - </P +> <A +HREF="http://www.cpan.org/modules/by-module/AppConfig/" +TARGET="_top" +>AppConfig + </A +> + (v1.52) + </P ></LI ><LI ><P -> Bundle::Mysql Perl module collection - </P +> <A +HREF="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz" +TARGET="_top" +>Text::Wrap</A +> + (v2001.0131) + </P ></LI ><LI ><P -> TimeDate Perl module collection - </P +> <A +HREF="http://search.cpan.org/search?dist=File-Spec" +TARGET="_top" +>File::Spec + </A +> + (v0.8.2) + </P ></LI ><LI ><P -> GD perl module (1.8.3) (optional, for bug charting) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Data/" +TARGET="_top" +>Data::Dumper + </A +> + (any) + </P ></LI ><LI ><P -> Chart::Base Perl module (0.99c) (optional, for bug charting) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Mysql/" +TARGET="_top" +>DBD::mysql + </A +> + (v1.2209) + </P ></LI ><LI ><P -> DB_File Perl module (optional, for bug charting) - </P +> <A +HREF="http://www.cpan.org/modules/by-module/DBI/" +TARGET="_top" +>DBI</A +> + (v1.13) + </P ></LI ><LI ><P -> The web server of your choice. Apache is recommended. - </P +> <A +HREF="http://www.cpan.org/modules/by-module/Date/" +TARGET="_top" +>Date::Parse + </A +> + (any) + </P ></LI ><LI ><P -> MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </P +> CGI::Carp + (any) + </P +></LI +></OL +> + and, optionally: + <P +></P +><OL +TYPE="a" +><LI +><P +> <A +HREF="http://www.cpan.org/modules/by-module/GD/" +TARGET="_top" +>GD</A +> + (v1.19) for bug charting + </P +></LI +><LI +><P +> <A +HREF="http://www.cpan.org/modules/by-module/Chart/" +TARGET="_top" +>Chart::Base + </A +> + (v0.99c) for bug charting + </P +></LI +><LI +><P +> XML::Parser + (any) for the XML interface + </P +></LI +><LI +><P +> MIME::Parser + (any) for the email interface + </P +></LI +></OL +> + </P +></LI +><LI +><P +> The web server of your choice. + <A +HREF="http://www.apache.org/" +TARGET="_top" +>Apache</A +> + is highly recommended. + </P ></LI ></OL > - <DIV + <DIV CLASS="warning" ><P ></P @@ -228,24 +337,20 @@ ALT="Warning"></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 +>It is a good idea, while installing Bugzilla, to ensure that there + is some kind of firewall between you and the rest of the Internet, + because your machine may be insecure for periods during the install. + 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 + + <DIV CLASS="note" ><P ></P @@ -266,20 +371,23 @@ ALT="Note"></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 +>Linux-Mandrake 8.0 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 +> + + 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 +> + + should not complain about any missing libraries. You may already have + some of these installed.</P ><P ></P ><TABLE @@ -287,59 +395,69 @@ BORDER="0" ><TBODY ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-mysql</B -></TD +>urpmi perl-mysql</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-chart</B -></TD +>urpmi perl-chart</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-gd</B -></TD +>urpmi perl-gd</B +> + </TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - perl-MailTools</B -> (for Bugzilla email - integration)</TD +>urpmi perl-MailTools</B +> + + (for Bugzilla email integration)</TD ></TR ><TR ><TD -><TT +> <TT CLASS="prompt" >bash#</TT -><B +> + + <B CLASS="command" -> urpmi - apache-modules</B -></TD +>urpmi apache-modules</B +> + </TD ></TR ></TBODY ></TABLE @@ -350,7 +468,6 @@ CLASS="command" ></TABLE ></DIV > - </P ></DIV ><DIV @@ -358,31 +475,17 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="install-mysql">3.2.3. Installing MySQL Database</H2 +NAME="install-mysql">4.1.3. MySQL</H2 ><P -> Visit MySQL homepage at <A +>Visit the 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 ->. +> + to grab and install the latest stable release of the server. </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 +><DIV CLASS="note" ><P ></P @@ -403,138 +506,91 @@ ALT="Note"></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 +> Many of the binary + versions of MySQL store their data files in + <TT CLASS="filename" ->mysqld</TT -> (or - <TT +>/var</TT +>. + On some Unix systems, this is part of a smaller root partition, + and may not have room for your bug database. You can set the data + directory as an option to <TT CLASS="filename" ->safe_mysqld</TT ->), then you will be able - to have attachments up to about 1 megabyte.</P +>configure</TT +> + if you build MySQL from source yourself.</P ></TD ></TR ></TABLE ></DIV +><P +>If you install from something other than an RPM or Debian + package, you will need to add <TT +CLASS="filename" +>mysqld</TT > - + 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. </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 +>Change your init script to start + <TT +CLASS="filename" +>mysqld</TT +> + 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. + There is a Bugzilla parameter for maximum attachment size; + you should configure it to match the value you choose here.</P +><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 + option in the init script. This enhances security by preventing + network access to MySQL.</P ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="install-perl">3.2.4. Perl (5.004 or greater)</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" +NAME="install-perl">4.1.4. Perl</H2 ><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 +>Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from + <A +HREF="http://www.perl.com" +TARGET="_top" +>perl.com</A +> for the rare + *nix systems which don't have it. + Although Bugzilla runs with all post-5.005 + 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 ><DIV CLASS="tip" ><A @@ -557,43 +613,42 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can skip the following Perl module installation steps by - installing <SPAN +>You can skip the following Perl module installation steps by + installing + <SPAN CLASS="productname" >Bundle::Bugzilla</SPAN -> from - <A +> + + from + <A HREF="glossary.html#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 +>, + which installs all required modules for you.</P +><P +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT -> <B +> + + <B CLASS="command" ->perl -MCPAN - -e 'install "Bundle::Bugzilla"'</B +>perl -MCPAN -e 'install "Bundle::Bugzilla"'</B > - </TT + </TT > - </P + </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 +>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 @@ -604,282 +659,240 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN534">3.2.5. DBI Perl Module</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.html" ->Appendix B</A ->. - </P +NAME="perl-modules">4.1.5. Perl Modules</H2 ><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. +> + All Perl modules can be found on the + <A +HREF="http://www.cpan.org" +TARGET="_top" +>Comprehensive Perl + Archive Network</A +> (CPAN). The + CPAN servers have a real tendency to bog down, so please use mirrors. + </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. + To use the CPAN shell to install a module: </P ><P -> To use the CPAN shell to install DBI: - <DIV -CLASS="informalexample" -><A -NAME="AEN541"><P -></P -><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + <B CLASS="command" ->perl -MCPAN -e 'install "DBI"'</B +>perl -MCPAN -e 'install "<modulename>"'</B > - </TT + </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 -></P -></DIV -> - To do it the hard way: - <DIV -CLASS="informalexample" -><A -NAME="AEN548"><P -></P +> To do it the hard way: + </P ><P -> Untar the module tarball -- it should create its own directory - </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 +>CD to the directory just created, and enter the following + commands: + <P ></P ><OL TYPE="1" ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >perl Makefile.PL</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make test</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >make install</B > - </TT + </TT > - </P + </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 +><DIV +CLASS="warning" ><P ></P -></DIV +><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 error 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 > - </P + 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="section" -><H2 +><H3 CLASS="section" ><A -NAME="AEN572">3.2.6. Data::Dumper Perl Module</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 +NAME="AEN642">4.1.5.1. DBI</H3 ><P -> Data::Dumper is used by the MySQL-related Perl modules. It - can be found on CPAN (see <A -HREF="downloadlinks.html" ->Appendix B</A ->) and - can be - installed by following the same four step make sequence used - for the DBI module. - </P +>The DBI module is a generic Perl module used 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 ></DIV ><DIV CLASS="section" -><H2 +><H3 CLASS="section" ><A -NAME="AEN577">3.2.7. MySQL related Perl Module Collection</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 +NAME="AEN645">4.1.5.2. Data::Dumper</H3 ><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. +>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 +></DIV +><DIV +CLASS="section" +><H3 +CLASS="section" +><A +NAME="AEN648">4.1.5.3. MySQL-related modules</H3 +><P +>The Perl/MySQL interface requires a few mutually-dependent Perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package.</P +><P +>The MakeMaker process will ask you a few questions about the + desired compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if your + desired target is the MySQL or mSQL packages, you should + 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' + with a null password should find itself with sufficient access to run + tests on the 'test' database which MySQL created upon installation. </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" -><H2 +><H3 CLASS="section" ><A -NAME="AEN586">3.2.8. TimeDate Perl Module Collection</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.html" ->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 +NAME="AEN653">4.1.5.4. TimeDate modules</H3 +><P +>Many of the more common date/time/calendar related Perl modules + have been grouped into a bundle similar to the MySQL modules bundle. + This bundle is stored on the CPAN under the name TimeDate. + The component module we're most interested in is the Date::Format + module, but installing all of them is probably a good idea anyway. + </P ></DIV ><DIV CLASS="section" -><H2 +><H3 CLASS="section" ><A -NAME="AEN590">3.2.9. GD Perl Module (1.8.3)</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.html" ->Appendix B</A ->. - </P +NAME="AEN656">4.1.5.5. GD (optional)</H3 +><P +>The GD library was written by Thomas Boutell a long while ago to + programatically generate images in C. Since then it's become 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 ><DIV CLASS="note" ><P @@ -901,20 +914,20 @@ ALT="Note"></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 +>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 +> + 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 +>. + The full requirements are listed in the Perl GD library README. + If compiling GD fails, it's probably because you're + missing a required library.</P ></TD ></TR ></TABLE @@ -922,52 +935,49 @@ CLASS="classname" ></DIV ><DIV CLASS="section" -><H2 +><H3 CLASS="section" ><A -NAME="AEN599">3.2.10. Chart::Base Perl Module (0.99c)</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.html" ->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 +NAME="AEN663">4.1.5.6. Chart::Base (optional)</H3 +><P +>The Chart module provides Bugzilla with on-the-fly charting + abilities. It can be installed in the usual fashion after it has been + fetched from CPAN. + Note that earlier versions that 0.99c used GIFs, which are no longer + supported by the latest versions of GD.</P ></DIV ><DIV CLASS="section" -><H2 +><H3 CLASS="section" ><A -NAME="AEN603">3.2.11. DB_File Perl Module</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 +NAME="AEN666">4.1.5.7. Template Toolkit</H3 +><P +>When you install Template Toolkit, you'll get asked various + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. However, there are + known problems with XS Stash and Perl 5.005_02 and lower. If you + wish to use these older versions of Perl, please use the regular + stash.</P +></DIV ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN606">3.2.12. HTTP Server</H2 +NAME="AEN669">4.1.6. HTTP Server</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 +>You have a freedom of choice here - Apache, Netscape or any other + server on UNIX would do. You can 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 +> + user permissions accordingly. + <DIV CLASS="note" ><P ></P @@ -988,24 +998,22 @@ ALT="Note"></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 +>We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us.</P ></TD ></TR ></TABLE ></DIV > - </P + </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 +>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 httpd.conf + file: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1015,18 +1023,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> AddHandler cgi-script .cgi - </PRE +>AddHandler cgi-script .cgi</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> With apache you'll also want to make sure that within the - access.conf file the line: - <TABLE +>With Apache you'll also want to make sure that within the + httpd.conf file the line: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1036,18 +1043,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> Options ExecCGI -AllowOverride Limit -</PRE +>Options ExecCGI AllowOverride Limit</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 + + is in the stanza that covers the directories into which you intend to + put the bugzilla .html and .cgi files. + + <DIV CLASS="note" ><P ></P @@ -1068,18 +1074,17 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> AllowOverride Limit allows the use of a Deny statement in the - .htaccess file generated by checksetup.pl - </P +>AllowOverride Limit allows the use of a Deny statement in the + .htaccess file generated by checksetup.pl</P ><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 +>Users of older versions of Apache may find the above lines + in the srm.conf and access.conf files, respecitvely.</P ></TD ></TR ></TABLE ></DIV +> + </P ><DIV CLASS="warning" ><P @@ -1101,28 +1106,31 @@ ALT="Warning"></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 +>There are important files and directories that should not be a + served by the HTTP server - most files in the + <SPAN CLASS="QUOTE" >"data"</SPAN -> and <SPAN +> + and + <SPAN CLASS="QUOTE" >"shadow"</SPAN -> directories - and the <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="geninstall.html#htaccess" +> + file. You should configure your HTTP server to not serve + these files. Failure to do so will expose critical passwords and + other data. Please see + <A +HREF="extraconfig.html#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 +> + for details on how to do this for Apache; the checksetup.pl + script should create appropriate .htaccess files for you.</P ></TD ></TR ></TABLE @@ -1133,24 +1141,22 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN625">3.2.13. Installing the Bugzilla Files</H2 +NAME="AEN688">4.1.7. Bugzilla</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 +>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 +>). + You may decide to put the files in the main web space for your + web server or perhaps in + <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 +> + with a symbolic link in the web space that points to the Bugzilla + directory.</P ><DIV CLASS="tip" ><P @@ -1172,102 +1178,50 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> If you symlink the bugzilla directory into your Apache's - HTML heirarchy, you may receive - <SPAN +>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 +> + errors unless you add the + <SPAN CLASS="QUOTE" >"FollowSymLinks"</SPAN -> directive to the - <Directory> entry for the HTML root. - </P +> + directive to the <Directory> entry for the HTML root + in httpd.conf.</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 +>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 +> + script, which locks down your installation.</P ><P -> Lastly, you'll need to set up a symbolic link to - <TT +>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 +> + 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.html" ->The setperl.csh Utility</A ->, found in - <A -HREF="patches.html" ->Useful Patches and Utilities for Bugzilla</A ->. I suggest using the symlink - approach for future release compatability. - <DIV -CLASS="example" -><A -NAME="AEN641"><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 +>). + Otherwise you must hack all the .cgi files to change where they look + for Perl. This can be done using the following Perl one-liner, but + I suggest using the symlink approach to avoid upgrade hassles. + </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 +> + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1277,244 +1231,185 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm -processmail syncshadowdb - </PRE +>perl -pi -e + 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm + processmail syncshadowdb</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.html" ->The setperl.csh Utility</A ->, listed in <A -HREF="patches.html" ->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 + + Change <TT +CLASS="filename" +>/usr/bin/perl</TT +> to match the location + of Perl on your machine. + </P ></DIV ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN654">3.2.14. Setting Up the MySQL Database</H2 +NAME="AEN705">4.1.8. Setting Up the MySQL Database</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 +>After you've gotten all the software installed and working you're + ready to start preparing the database for its life as 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 +>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 -> +>, and will have minimal permissions. </P ><P -> Give the MySQL root user a password. MySQL passwords are - limited to 16 characters. - <P +>Begin by giving the MySQL root user a password. MySQL passwords are limited + to 16 characters. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT -> <B +> + + <B CLASS="command" ->mysql - -u root mysql</B -> </TT +>mysql -u root mysql</B > - </TD + </TT +> + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT -> <B +> + + <B CLASS="command" -> UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root'; </B -> </TT +>UPDATE user SET Password=PASSWORD('<new_password'>) + WHERE user='root';</B > - </TD + </TT +> + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT -> <B +> + + <B CLASS="command" ->FLUSH - PRIVILEGES;</B -> </TT +>FLUSH PRIVILEGES;</B +> + </TT > - </TD + </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 +> + + 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 +> + + and enter <new_password>. Remember that MySQL user names have + nothing to do with Unix user names (login names).</P ><P -> Next, we create the <SPAN +>Next, we use an SQL <B +CLASS="command" +>GRANT</B +> command to create a + <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 +> + + 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 +> + user to operations within a database called + <SPAN CLASS="QUOTE" >"bugs"</SPAN ->, and only allows the account to - connect from <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 +>. + 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 +>Remember to set <bugs_password> to some unique password. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, - ALTER,CREATE,DROP,REFERENCES - ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</B + ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '<bugs_password>';</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" -> mysql> - </TT +>mysql></TT > - <B + + <B CLASS="command" -> FLUSH PRIVILEGES; - </B +>FLUSH PRIVILEGES;</B > - </TT + </TT > - </TD + </TD ></TR ></TBODY ></TABLE @@ -1522,219 +1417,129 @@ CLASS="command" ></P > </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN741">4.1.9. <TT +CLASS="filename" +>checksetup.pl</TT +></H2 ><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 +>Next, run the magic checksetup.pl script. (Many thanks to + <A +HREF="mailto:holgerschurig@nikocity.de" +TARGET="_top" +>Holger Schurig </A +> + for writing this script!) + This script is designed to make sure your MySQL database and other + configuration options are consistent with the Bugzilla CGI files. + 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 +> + directory, and create all the MySQL tables. + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >./checksetup.pl</B -> </TT > - </TD + </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" -><H2 -CLASS="section" -><A -NAME="AEN701">3.2.15. Tweaking <TT +> + + The first time you run it, it will create a file called + <TT CLASS="filename" >localconfig</TT -></H2 +>.</P ><P -> This file contains a variety of settings you may need to tweak including - how Bugzilla should connect to the MySQL database. - </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 +>The connection settings include: + <P ></P ><OL TYPE="1" ><LI ><P -> server's host: just use <SPAN +>server's host: just use + <SPAN CLASS="QUOTE" >"localhost"</SPAN -> if the - MySQL server is local - </P +> + if the MySQL server is local</P ></LI ><LI ><P -> database name: <SPAN +>database name: + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> if you're following - these directions - </P +> + if you're following these directions</P ></LI ><LI ><P -> MySQL username: <SPAN +>MySQL username: + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> if you're following - these directions - </P +> + if you're following these directions</P ></LI ><LI ><P -> Password for the <SPAN +>Password for the + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> MySQL account above - </P +> + MySQL account; (<bugs_password>) 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="geninstall.html#htaccess" ->.htaccess files and security</A ->. - </P -><P -> Once you are happy with the settings, re-run - <TT +>Once you are happy with the settings, + <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 +>su</TT +> to the user + your web server runs as, and re-run + <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="AEN732"><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 +>checksetup.pl</TT +>. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) + On this second run, it will create the database and an administrator + account for which you will be prompted to provide information.</P ><DIV CLASS="note" ><P @@ -1756,142 +1561,9 @@ ALT="Note"></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" -><H2 -CLASS="section" -><A -NAME="AEN739">3.2.16. Setting Up Maintainers Manually (Optional)</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" -><H2 -CLASS="section" -><A -NAME="AEN750">3.2.17. The Whining Cron (Optional)</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 +>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 @@ -1902,71 +1574,16 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="AEN760">3.2.18. Bug Graphs (Optional)</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" -><H2 -CLASS="section" -><A -NAME="AEN772">3.2.19. Securing MySQL</H2 +NAME="AEN773">4.1.10. Securing MySQL</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 +>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 +>Most MySQL installs have "interesting" default security + parameters: + <P ></P ><TABLE BORDER="0" @@ -1998,96 +1615,100 @@ BORDER="0" > </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 +>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 +>To see your permissions do: + <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >bash#</TT > - <B + + <B CLASS="command" >mysql -u root -p</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >use mysql;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >show tables;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >select * from user;</B > - </TT + </TT > - </TD + </TD ></TR ><TR ><TD -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >select * from db;</B > - </TT + </TT > - </TD + </TD ></TR ></TBODY ></TABLE @@ -2096,8 +1717,8 @@ CLASS="command" > </P ><P -> To fix the gaping holes: - <P +>To fix the gaping holes: + <P ></P ><TABLE BORDER="0" @@ -2108,11 +1729,12 @@ BORDER="0" ></TR ><TR ><TD ->UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</TD +>UPDATE user SET Password=PASSWORD('new_password') WHERE + user='root';</TD ></TR ><TR ><TD -> FLUSH PRIVILEGES;</TD +>FLUSH PRIVILEGES;</TD ></TR ></TBODY ></TABLE @@ -2121,8 +1743,8 @@ BORDER="0" > </P ><P -> If you're not running "mit-pthreads" you can use: - <P +>If you're not running "mit-pthreads" you can use: + <P ></P ><TABLE BORDER="0" @@ -2150,10 +1772,10 @@ BORDER="0" > </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 +>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" @@ -2181,61 +1803,63 @@ BORDER="0" > </P ><P -> Use .htaccess files with the Apache webserver to secure your - bugzilla install. See <A -HREF="geninstall.html#htaccess" ->.htaccess files and security</A -> - </P -><P -> Consider also: - <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 +>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 +>using the --user= option to mysqld to run it as an + unprivileged user.</P ></LI ><LI ><P -> starting MySQL in a chroot jail - </P +>running MySQL in a chroot jail</P ></LI ><LI ><P -> running the httpd in a "chrooted" jail - </P +>running the httpd in a chroot 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 +>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 +>running MySQL on a separate untrusted machine</P ></LI ><LI ><P -> making backups ;-) - </P +>making backups ;-)</P ></LI ></OL > </P ></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN839">4.1.11. Configuring Bugzilla</H2 +><P +> You should run through the parameters on the Edit Parameters page + (link in the footer) and set them all to appropriate values. + They key parameters are documented in <A +HREF="parameters.html" +>Section 5.1</A +>. + </P +></DIV ></DIV ><DIV CLASS="NAVFOOTER" @@ -2253,7 +1877,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="errata.html" +HREF="installation.html" ACCESSKEY="P" >Prev</A ></TD @@ -2271,7 +1895,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="osx.html" +HREF="extraconfig.html" ACCESSKEY="N" >Next</A ></TD @@ -2281,7 +1905,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->ERRATA</TD +>Installation</TD ><TD WIDTH="34%" ALIGN="center" @@ -2295,7 +1919,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Mac OS X Installation Notes</TD +>Optional Additional Configuration</TD ></TR ></TABLE ></DIV diff --git a/docs/html/translations.html b/docs/html/translations.html deleted file mode 100644 index dac9b1c7a..000000000 --- a/docs/html/translations.html +++ /dev/null @@ -1,156 +0,0 @@ -<HTML -><HEAD -><TITLE ->Translations</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="About This Guide" -HREF="about.html"><LINK -REL="PREVIOUS" -TITLE="Credits" -HREF="credits.html"><LINK -REL="NEXT" -TITLE="Document Conventions" -HREF="conventions.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="credits.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 1. About This Guide</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="conventions.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="translations">1.6. Translations</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 - The Bugzilla Team to check it into CVS. - </P -></DIV -><DIV -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="credits.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="conventions.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Credits</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="about.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Document Conventions</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/troubleshooting.html b/docs/html/troubleshooting.html new file mode 100644 index 000000000..7a4a32d7d --- /dev/null +++ b/docs/html/troubleshooting.html @@ -0,0 +1,309 @@ +<HTML +><HEAD +><TITLE +>Troubleshooting</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Installation" +HREF="installation.html"><LINK +REL="PREVIOUS" +TITLE="Mac OS X Installation Notes" +HREF="osx.html"><LINK +REL="NEXT" +TITLE="Administering Bugzilla" +HREF="administration.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="osx.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 4. Installation</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="administration.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="troubleshooting">4.5. Troubleshooting</H1 +><P +>This section gives solutions to common Bugzilla installation + problems. + </P +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1218">4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2 +><P +> Try executing <B +CLASS="command" +>perl -MCPAN -e 'install CPAN'</B +> + and then continuing. + </P +><P +> Certain older versions of the CPAN toolset were somewhat naive about how + to upgrade Perl modules. When a couple of modules got rolled into the core + Perl distribution for 5.6.1, CPAN thought that the best way to get those + modules up to date was to haul down the Perl distribution itself and + build it. Needless to say, this has caused headaches for just about + everybody. Upgrading to a newer version of CPAN with the + commandline above should fix things. + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="AEN1223">4.5.2. DBD::Sponge::db prepare failed</H2 +><P +> The following error message may appear due to a bug in DBD::mysql + (over which the Bugzilla team have no control): + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248. + SV = NULL(0x0) at 0x20fc444 + REFCNT = 1 + FLAGS = (PADBUSY,PADMY) +</PRE +></FONT +></TD +></TR +></TABLE +><P +> To fix this, go to + <TT +CLASS="filename" +><path-to-perl>/lib/DBD/sponge.pm</TT +> + in your Perl installation and replace + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; +</PRE +></FONT +></TD +></TR +></TABLE +><P +> by + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; +</PRE +></FONT +></TD +></TR +></TABLE +><P +> (note the S added to NAME.) + </P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="paranoid-security">4.5.3. cannot chdir(/var/spool/mqueue)</H2 +><P +>If you are installing Bugzilla on SuSE 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: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>cannot chdir(/var/spool/mqueue): Permission denied +</PRE +></FONT +></TD +></TR +></TABLE +> + </P +><P +> 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. + </P +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="osx.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Mac OS X Installation Notes</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="installation.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Administering Bugzilla</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/upgrading.html b/docs/html/upgrading.html new file mode 100644 index 000000000..445154030 --- /dev/null +++ b/docs/html/upgrading.html @@ -0,0 +1,178 @@ +<HTML +><HEAD +><TITLE +>Upgrading to New Releases</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="PREVIOUS" +TITLE="Template Customisation" +HREF="cust-templates.html"><LINK +REL="NEXT" +TITLE="Integrating Bugzilla with Third-Party Tools" +HREF="integration.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="cust-templates.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Administering Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="integration.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="upgrading">5.8. Upgrading to New Releases</H1 +><P +>A plain Bugzilla is fairly easy to upgrade from one version to a + newer one. Always read the release notes to see if there are any issues + that you might need to take note of. It is recommended that you take a + backup of your database and your entire Bugzilla installation before attempting an + upgrade. You can upgrade a 'clean' installation by untarring a new + tarball over the old installation. If you are upgrading from 2.12 or + later, and have cvs installed, you can type <TT +CLASS="filename" +>cvs -z3 update</TT +>, + and resolve conflicts if there are any. + </P +><P +>However, things get a bit more complicated if you've made + changes to Bugzilla's code. In this case, you may have to re-make or + reapply those changes. One good method is to take a diff of your customised + version against the original, so you can survey all that you've changed. + Hopefully, templatisation will reduce the need for + this in the future.</P +><P +>From version 2.8 onwards, Bugzilla databases can be automatically + carried forward during an upgrade. However, because the developers of + Bugzilla are constantly adding new + tables, columns and fields, you'll probably get SQL errors if you just + update the code and attempt to use Bugzilla. Always run the + <TT +CLASS="filename" +>checksetup.pl</TT +> + script whenever you upgrade your installation.</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="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="cust-templates.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="integration.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Template Customisation</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Integrating Bugzilla with Third-Party Tools</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/useradmin.html b/docs/html/useradmin.html index 34005682f..00893687e 100644 --- a/docs/html/useradmin.html +++ b/docs/html/useradmin.html @@ -13,11 +13,10 @@ REL="UP" TITLE="Administering Bugzilla" HREF="administration.html"><LINK REL="PREVIOUS" -TITLE="Post-Installation Checklist" -HREF="postinstall-check.html"><LINK +TITLE="Bugzilla Configuration" +HREF="parameters.html"><LINK REL="NEXT" -TITLE="Product, Component, Milestone, and Version - Administration" +TITLE="Product, Component, Milestone, and Version Administration" HREF="programadmin.html"></HEAD ><BODY CLASS="section" @@ -46,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="postinstall-check.html" +HREF="parameters.html" ACCESSKEY="P" >Prev</A ></TD @@ -54,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 4. Administering Bugzilla</TD +>Chapter 5. Administering Bugzilla</TD ><TD WIDTH="10%" ALIGN="right" @@ -74,26 +73,19 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="useradmin">4.2. User Administration</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 +NAME="useradmin">5.2. User Administration</H1 ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="defaultuser">4.2.1. Creating the Default User</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 +NAME="defaultuser">5.2.1. Creating the Default User</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 delete + the "super user" account, re-running checksetup.pl will again prompt + you for this username and password.</P ><DIV CLASS="tip" ><P @@ -115,36 +107,60 @@ ALT="Tip"></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 +>If you wish to add more administrative users, you must use the + MySQL interface. Run "mysql" from the command line, and use these + commands: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +> <TT CLASS="prompt" >mysql></TT -> use bugs;</B > - <B + <B CLASS="command" -><TT +>use bugs;</B +> + </TD +></TR +><TR +><TD +> <TT CLASS="prompt" >mysql></TT -> update profiles set - groupset=0x7ffffffffffffff where login_name = "(user's - login name)"; </B > - </P + + <B +CLASS="command" +> update profiles set groupset=0x7ffffffffffffff where login_name = + "(user's login name)"; + </B +> + </TD +></TR +></TBODY +></TABLE +><P +></P +> + </P ><P ->Yes, that is <EM +>Yes, that is + <EM >fourteen</EM > - <SPAN + + <SPAN CLASS="QUOTE" >"f"</SPAN ->'s. A whole lot of f-ing going on if you - want to create a new administator.</P +> + + 's. A whole lot of f-ing going on if you want to create a new + administator.</P ></TD ></TR ></TABLE @@ -155,125 +171,32 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="manageusers">4.2.2. Managing Other Users</H2 +NAME="manageusers">5.2.2. Managing Other Users</H2 ><DIV CLASS="section" ><H3 CLASS="section" ><A -NAME="login">4.2.2.1. Logging In</H3 -><P -></P -><OL -TYPE="1" -><LI +NAME="createnewusers">5.2.2.1. Creating new users</H3 ><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" -><H3 -CLASS="section" -><A -NAME="createnewusers">4.2.2.2. Creating new users</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 +>Your users can create their own user accounts by clicking the + "New Account" link at the bottom of each page (assuming they + aren't logged in as someone else already.) However, should you + desire to create user accounts ahead of time, here is how you do + it.</P ><P ></P ><OL TYPE="1" ><LI ><P -> After logging in, click the "Users" link at the footer - of the query page. - </P +>After logging in, click the "Users" link at the footer of + the query page, and then click "Add a new user".</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 +>Fill out the form presented. This page is self-explanatory. + When done, click "Submit".</P ><DIV CLASS="note" ><P @@ -295,22 +218,24 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Adding a user this way will <EM +>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 + + 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 +> + + 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 @@ -323,133 +248,73 @@ CLASS="section" ><H3 CLASS="section" ><A -NAME="disableusers">4.2.2.3. Disabling Users</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" +NAME="modifyusers">5.2.2.2. Modifying Users</H3 ><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" +>To see a specific user, search for their login name + in the box provided on the "Edit Users" page. To see all users, + leave the box blank.</P ><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 +>You can search in different ways the listbox to the right + of the text entry box. You can match by + case-insensitive substring (the default), + regular expression, or a + <EM +>reverse</EM > - </P -></DIV -><DIV -CLASS="section" -><H3 -CLASS="section" -><A -NAME="modifyusers">4.2.2.4. Modifying Users</H3 + regular expression match, which finds every user name which does NOT + match the regular expression. (Please see + the <B +CLASS="command" +>man regexp</B +> + manual page for details on regular expression syntax.) + </P ><P -> Here I will attempt to describe the function of each option - on the Edit User screen. - </P +>Once you have found your user, you can change the following + fields:</P ><P ></P ><UL ><LI ><P -> <EM +> <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 +>: + This is generally the user's full email address. However, if you + have are using the emailsuffix Param, this may just be the user's + login name. Note that users can now change their login names + themselves (to any valid email address.) + </P ></LI ><LI ><P -> <EM +> <EM >Real Name</EM ->: Duh! - </P +>: The user's real name. Note that + Bugzilla does not require this to create an account.</P ></LI ><LI ><P -> <EM +> <EM >Password</EM ->: You can change the user - password here. It is normal to only see asterisks. - </P +>: + You can change the user's password here. Users can automatically + request a new password, so you shouldn't need to do this often. + If you want to disable an account, see Disable Text below. + </P ></LI ><LI ><P -> <EM +> <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 +>: + If you type anything in this box, including just a space, the + user is prevented from logging in, or making any changes to + bugs via the web interface. + The HTML you type in this box is presented to the user when + they attempt to perform these actions, and should explain + why the account was disabled. + <DIV CLASS="warning" ><P ></P @@ -476,7 +341,8 @@ VALIGN="TOP" ></TABLE ></DIV > - <DIV + + <DIV CLASS="note" ><P ></P @@ -497,143 +363,110 @@ ALT="Note"></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 +>The user can still submit bugs via + the e-mail gateway, if you set it up, even if the disabled text + field is filled in. The e-mail gateway should + <EM >not</EM -> be enabled for secure - installations of Bugzilla. - </P +> + be enabled for secure installations of Bugzilla.</P ></TD ></TR ></TABLE ></DIV > - </P + </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 +> <EM +><groupname></EM +>: + If you have created some groups, e.g. "securitysensitive", then + checkboxes will appear here to allow you to add users to, or + remove them from, these groups. + </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 +> <EM +>canconfirm</EM +>: + This field is only used if you have enabled the "unconfirmed" + status. If you enable this for a user, + that user can then move bugs from "Unconfirmed" to a "Confirmed" + status (e.g.: "New" status).</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" +> <EM +>creategroups</EM +>: + This option will allow a user to create and destroy groups in + Bugzilla.</P +></LI +><LI ><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" +> <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. Even if this + option is unchecked, users can still add comments to bugs. + </P +></LI +><LI ><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 +> <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. + </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 +> <EM +>editkeywords</EM +>: + If you use Bugzilla's keyword functionality, enabling this + feature allows a user to create and destroy keywords. As always, + the keywords for existing bugs containing the keyword the user + wishes to destroy must be changed before Bugzilla will allow it + to die.</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 +> <EM +>editusers</EM +>: + This flag allows a user to do what you're doing right now: edit + other users. This will allow those with the right to do so to + remove administrator privileges from other users or grant them to + themselves. Enable with care.</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 privileges from other users or grant them - to themselves. Enable with care. - </P +> <EM +>tweakparams</EM +>: + This flag allows a user to change Bugzilla's Params + (using <TT +CLASS="filename" +>editparams.cgi</TT +>.)</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 +> <EM +><productname></EM +>: + This allows an administrator to specify the products in which + a user can see bugs. The user must still have the + "editbugs" privilege to edit bugs in these products.</P ></LI ></UL ></DIV @@ -655,7 +488,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="postinstall-check.html" +HREF="parameters.html" ACCESSKEY="P" >Prev</A ></TD @@ -683,7 +516,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Post-Installation Checklist</TD +>Bugzilla Configuration</TD ><TD WIDTH="34%" ALIGN="center" @@ -697,8 +530,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Product, Component, Milestone, and Version - Administration</TD +>Product, Component, Milestone, and Version Administration</TD ></TR ></TABLE ></DIV diff --git a/docs/html/userpreferences.html b/docs/html/userpreferences.html new file mode 100644 index 000000000..a782877f3 --- /dev/null +++ b/docs/html/userpreferences.html @@ -0,0 +1,240 @@ +<HTML +><HEAD +><TITLE +>User Preferences</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Using Bugzilla" +HREF="using.html"><LINK +REL="PREVIOUS" +TITLE="Hints and Tips" +HREF="hintsandtips.html"><LINK +REL="NEXT" +TITLE="Installation" +HREF="installation.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="hintsandtips.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 3. Using Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="installation.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="userpreferences">3.3. User Preferences</H1 +><P +>Once you have logged in, you can customise various aspects of + Bugzilla via the "Edit prefs" link in the page footer. + The preferences are split into four tabs:</P +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="accountsettings">3.3.1. Account Settings</H2 +><P +>On this tab, you can change your basic account information, + including your password, email address and real 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" +>"Password"</SPAN +> + field at the top of the page. + If you attempt to change your email address, a confirmation + email is sent to both the old and new addresses, with a link to use to + confirm the change. This helps to prevent account hijacking.</P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="emailsettings">3.3.2. Email Settings</H2 +><P +>On this tab you can reduce or increase the amount of email sent + you from Bugzilla, opting in our out depending on your relationship to + the bug and the change that was made to it. (Note that you can also do + client-side filtering using the X-Bugzilla-Reason header which Bugzilla + adds to all bugmail.)</P +><P +>By entering user email names, delineated by commas, into the + "Users to watch" text entry box you can receive a copy of all the + bugmail of other users (security settings permitting.) This powerful + functionality enables seamless transitions as developers change + projects or users go on holiday.</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 ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator.</P +></TD +></TR +></TABLE +></DIV +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="footersettings">3.3.3. Page Footer</H2 +><P +>On the Search page, you can store queries in Bugzilla, so if you + regularly run a particular query it is just a drop-down menu away. + Once you have a stored query, you can come + here to request that it also be displayed in your page footer.</P +></DIV +><DIV +CLASS="section" +><H2 +CLASS="section" +><A +NAME="permissionsettings">3.3.4. Permissions</H2 +><P +>This is a purely informative page which outlines your current + permissions on this installation of Bugzilla - what product groups you + are in, and whether you can edit bugs or perform various administration + functions.</P +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="hintsandtips.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="installation.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Hints and Tips</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="using.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Installation</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/using.html b/docs/html/using.html index 95c04c1d7..0d1231589 100644 --- a/docs/html/using.html +++ b/docs/html/using.html @@ -10,11 +10,11 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="Document Conventions" -HREF="conventions.html"><LINK +TITLE="Why Should We Use Bugzilla?" +HREF="why.html"><LINK REL="NEXT" -TITLE="What is Bugzilla?" -HREF="whatis.html"></HEAD +TITLE="How do I use Bugzilla?" +HREF="how.html"></HEAD ><BODY CLASS="chapter" BGCOLOR="#FFFFFF" @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="conventions.html" +HREF="why.html" ACCESSKEY="P" >Prev</A ></TD @@ -56,7 +56,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="whatis.html" +HREF="how.html" ACCESSKEY="N" >Next</A ></TD @@ -69,30 +69,7 @@ WIDTH="100%"></DIV CLASS="chapter" ><H1 ><A -NAME="using">Chapter 2. Using Bugzilla</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 +NAME="using">Chapter 3. Using Bugzilla</H1 ><DIV CLASS="TOC" ><DL @@ -101,83 +78,102 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->2.1. <A -HREF="whatis.html" ->What is Bugzilla?</A -></DT -><DT ->2.2. <A -HREF="why.html" ->Why Should We Use Bugzilla?</A -></DT -><DT ->2.3. <A +>3.1. <A HREF="how.html" >How do I use Bugzilla?</A ></DT ><DD ><DL ><DT ->2.3.1. <A +>3.1.1. <A HREF="how.html#myaccount" >Create a Bugzilla Account</A ></DT ><DT ->2.3.2. <A +>3.1.2. <A HREF="how.html#bug_page" >Anatomy of a Bug</A ></DT ><DT ->2.3.3. <A +>3.1.3. <A HREF="how.html#query" >Searching for Bugs</A ></DT ><DT ->2.3.4. <A +>3.1.4. <A HREF="how.html#list" >Bug Lists</A ></DT ><DT ->2.3.5. <A +>3.1.5. <A HREF="how.html#bugreports" >Filing Bugs</A ></DT ></DL ></DD ><DT ->2.4. <A -HREF="init4me.html" ->Where can I find my user preferences?</A +>3.2. <A +HREF="hintsandtips.html" +>Hints and Tips</A ></DT ><DD ><DL ><DT ->2.4.1. <A -HREF="init4me.html#accountsettings" +>3.2.1. <A +HREF="hintsandtips.html#AEN434" +>Autolinkification</A +></DT +><DT +>3.2.2. <A +HREF="hintsandtips.html#quicksearch" +>Quicksearch</A +></DT +><DT +>3.2.3. <A +HREF="hintsandtips.html#commenting" +>Comments</A +></DT +><DT +>3.2.4. <A +HREF="hintsandtips.html#attachments" +>Attachments</A +></DT +><DT +>3.2.5. <A +HREF="hintsandtips.html#AEN463" +>Filing Bugs</A +></DT +></DL +></DD +><DT +>3.3. <A +HREF="userpreferences.html" +>User Preferences</A +></DT +><DD +><DL +><DT +>3.3.1. <A +HREF="userpreferences.html#accountsettings" >Account Settings</A ></DT ><DT ->2.4.2. <A -HREF="init4me.html#emailsettings" +>3.3.2. <A +HREF="userpreferences.html#emailsettings" >Email Settings</A ></DT ><DT ->2.4.3. <A -HREF="init4me.html#footersettings" +>3.3.3. <A +HREF="userpreferences.html#footersettings" >Page Footer</A ></DT ><DT ->2.4.4. <A -HREF="init4me.html#permissionsettings" +>3.3.4. <A +HREF="userpreferences.html#permissionsettings" >Permissions</A ></DT ></DL ></DD -><DT ->2.5. <A -HREF="usingbz-conc.html" ->Using Bugzilla-Conclusion</A -></DT ></DL ></DIV ></DIV @@ -197,7 +193,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="conventions.html" +HREF="why.html" ACCESSKEY="P" >Prev</A ></TD @@ -215,7 +211,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="whatis.html" +HREF="how.html" ACCESSKEY="N" >Next</A ></TD @@ -225,7 +221,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Document Conventions</TD +>Why Should We Use Bugzilla?</TD ><TD WIDTH="34%" ALIGN="center" @@ -235,7 +231,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->What is Bugzilla?</TD +>How do I use Bugzilla?</TD ></TR ></TABLE ></DIV diff --git a/docs/html/usingbz-conc.html b/docs/html/usingbz-conc.html deleted file mode 100644 index 71fbc3045..000000000 --- a/docs/html/usingbz-conc.html +++ /dev/null @@ -1,152 +0,0 @@ -<HTML -><HEAD -><TITLE ->Using Bugzilla-Conclusion</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK -REL="HOME" -TITLE="The Bugzilla Guide" -HREF="index.html"><LINK -REL="UP" -TITLE="Using Bugzilla" -HREF="using.html"><LINK -REL="PREVIOUS" -TITLE="Where can I find my user preferences?" -HREF="init4me.html"><LINK -REL="NEXT" -TITLE="Installation" -HREF="installation.html"></HEAD -><BODY -CLASS="section" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><DIV -CLASS="NAVHEADER" -><TABLE -SUMMARY="Header navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TH -COLSPAN="3" -ALIGN="center" ->The Bugzilla Guide</TH -></TR -><TR -><TD -WIDTH="10%" -ALIGN="left" -VALIGN="bottom" -><A -HREF="init4me.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="80%" -ALIGN="center" -VALIGN="bottom" ->Chapter 2. Using Bugzilla</TD -><TD -WIDTH="10%" -ALIGN="right" -VALIGN="bottom" -><A -HREF="installation.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -></TABLE -><HR -ALIGN="LEFT" -WIDTH="100%"></DIV -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="usingbz-conc">2.5. Using Bugzilla-Conclusion</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 -CLASS="NAVFOOTER" -><HR -ALIGN="LEFT" -WIDTH="100%"><TABLE -SUMMARY="Footer navigation table" -WIDTH="100%" -BORDER="0" -CELLPADDING="0" -CELLSPACING="0" -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" -><A -HREF="init4me.html" -ACCESSKEY="P" ->Prev</A -></TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="index.html" -ACCESSKEY="H" ->Home</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" -><A -HREF="installation.html" -ACCESSKEY="N" ->Next</A -></TD -></TR -><TR -><TD -WIDTH="33%" -ALIGN="left" -VALIGN="top" ->Where can I find my user preferences?</TD -><TD -WIDTH="34%" -ALIGN="center" -VALIGN="top" -><A -HREF="using.html" -ACCESSKEY="U" ->Up</A -></TD -><TD -WIDTH="33%" -ALIGN="right" -VALIGN="top" ->Installation</TD -></TR -></TABLE -></DIV -></BODY -></HTML ->
\ No newline at end of file diff --git a/docs/html/variant-fenris.html b/docs/html/variant-fenris.html index 35b35f09b..69be49b6b 100644 --- a/docs/html/variant-fenris.html +++ b/docs/html/variant-fenris.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,13 +73,12 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="variant-fenris">6.2. Loki Bugzilla (Fenris)</H1 +NAME="variant-fenris">D.2. Loki Bugzilla (Fenris)</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 +>Fenris was a fork from Bugzilla made by Loki Games; when + Loki went into receivership, it died. While Loki's other code lives on, + its custodians recommend Bugzilla for future bug-tracker deployments. + </P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/variant-issuezilla.html b/docs/html/variant-issuezilla.html index 3a75b029c..e14cc0794 100644 --- a/docs/html/variant-issuezilla.html +++ b/docs/html/variant-issuezilla.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,24 +73,15 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="variant-issuezilla">6.3. Issuezilla</H1 +NAME="variant-issuezilla">D.3. Issuezilla</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 +>Issuezilla was another fork from Bugzilla, made by collab.net and + hosted at tigris.org. It is also dead; the primary focus of bug-tracking + at tigris.org is their Java-based bug-tracker, + <A HREF="variant-scarab.html" ->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 +>Scarab</A +>.</P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/variant-perforce.html b/docs/html/variant-perforce.html index 6fe293481..6bcfc5eed 100644 --- a/docs/html/variant-perforce.html +++ b/docs/html/variant-perforce.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,19 +73,23 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="variant-perforce">6.5. Perforce SCM</H1 +NAME="variant-perforce">D.5. Perforce SCM</H1 ><P ->Although Perforce isn't really a bug tracker, it can be used - as such through the <SPAN +>Although Perforce isn't really a bug tracker, it can be used as + such through the <SPAN CLASS="QUOTE" >"jobs"</SPAN -> functionality.</P +> + functionality.</P ><P -><A +>URL: + <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 +> http://www.perforce.com/perforce/technotes/note052.html + </A +> + </P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/variant-scarab.html b/docs/html/variant-scarab.html index 4a447fda6..14cd54afa 100644 --- a/docs/html/variant-scarab.html +++ b/docs/html/variant-scarab.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" @@ -73,19 +73,18 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="variant-scarab">6.4. Scarab</H1 +NAME="variant-scarab">D.4. Scarab</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 +>Scarab is a new open source bug-tracking system built using Java + Serlet technology. It is currently at version 1.0 beta 8.</P ><P ->URL: <A +>URL: + <A HREF="http://scarab.tigris.org/" TARGET="_top" >http://scarab.tigris.org</A -></P +> + </P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/variant-sourceforge.html b/docs/html/variant-sourceforge.html index 70d37059b..1e4891f4a 100644 --- a/docs/html/variant-sourceforge.html +++ b/docs/html/variant-sourceforge.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="Perforce SCM" HREF="variant-perforce.html"><LINK REL="NEXT" -TITLE="The Bugzilla FAQ" -HREF="faq.html"></HEAD +TITLE="Glossary" +HREF="glossary.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 6. Bugzilla Variants and Competitors</TD +>Appendix D. Bugzilla Variants and Competitors</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="faq.html" +HREF="glossary.html" ACCESSKEY="N" >Next</A ></TD @@ -73,19 +73,19 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="variant-sourceforge">6.6. SourceForge</H1 +NAME="variant-sourceforge">D.6. SourceForge</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 +>SourceForge is a way of coordinating geographically + distributed free software and open source projects over the Internet. + It has a built-in bug tracker, but it's not highly thought of.</P ><P ->URL: <A +>URL: + <A HREF="http://www.sourceforge.net" TARGET="_top" ->http://www.sourceforge.net</A -></P +> http://www.sourceforge.net</A +> + </P ></DIV ><DIV CLASS="NAVFOOTER" @@ -121,7 +121,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="faq.html" +HREF="glossary.html" ACCESSKEY="N" >Next</A ></TD @@ -145,7 +145,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->The Bugzilla FAQ</TD +>Glossary</TD ></TR ></TABLE ></DIV diff --git a/docs/html/variants.html b/docs/html/variants.html index c9d5d92ca..f5bd22fde 100644 --- a/docs/html/variants.html +++ b/docs/html/variants.html @@ -10,13 +10,13 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="Tinderbox/Tinderbox2" -HREF="tinderbox.html"><LINK +TITLE="Command-line Bugzilla Queries" +HREF="cmdline.html"><LINK REL="NEXT" TITLE="Red Hat Bugzilla" HREF="rhbugzilla.html"></HEAD ><BODY -CLASS="chapter" +CLASS="appendix" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" @@ -42,7 +42,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="tinderbox.html" +HREF="cmdline.html" ACCESSKEY="P" >Prev</A ></TD @@ -66,10 +66,10 @@ ACCESSKEY="N" ALIGN="LEFT" WIDTH="100%"></DIV ><DIV -CLASS="chapter" +CLASS="appendix" ><H1 ><A -NAME="variants">Chapter 6. Bugzilla Variants and Competitors</H1 +NAME="variants">Appendix D. Bugzilla Variants and Competitors</H1 ><DIV CLASS="TOC" ><DL @@ -78,46 +78,48 @@ CLASS="TOC" >Table of Contents</B ></DT ><DT ->6.1. <A +>D.1. <A HREF="rhbugzilla.html" >Red Hat Bugzilla</A ></DT ><DT ->6.2. <A +>D.2. <A HREF="variant-fenris.html" >Loki Bugzilla (Fenris)</A ></DT ><DT ->6.3. <A +>D.3. <A HREF="variant-issuezilla.html" >Issuezilla</A ></DT ><DT ->6.4. <A +>D.4. <A HREF="variant-scarab.html" >Scarab</A ></DT ><DT ->6.5. <A +>D.5. <A HREF="variant-perforce.html" >Perforce SCM</A ></DT ><DT ->6.6. <A +>D.6. <A HREF="variant-sourceforge.html" >SourceForge</A ></DT ></DL ></DIV ><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 +>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 +> http://linas.org/linux/pm.html</A +> + </P ></DIV ><DIV CLASS="NAVFOOTER" @@ -135,7 +137,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="tinderbox.html" +HREF="cmdline.html" ACCESSKEY="P" >Prev</A ></TD @@ -163,7 +165,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Tinderbox/Tinderbox2</TD +>Command-line Bugzilla Queries</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/voting.html b/docs/html/voting.html new file mode 100644 index 000000000..47b05647f --- /dev/null +++ b/docs/html/voting.html @@ -0,0 +1,195 @@ +<HTML +><HEAD +><TITLE +>Voting</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Administering Bugzilla" +HREF="administration.html"><LINK +REL="PREVIOUS" +TITLE="Product, Component, Milestone, and Version Administration" +HREF="programadmin.html"><LINK +REL="NEXT" +TITLE="Groups and Group Security" +HREF="groups.html"></HEAD +><BODY +CLASS="section" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="programadmin.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Administering Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="groups.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="voting">5.4. Voting</H1 +><P +>Voting allows users to be given a pot of votes which they can allocate + to bugs, to indicate that they'd like them fixed. + This allows developers to gauge + user need for a particular enhancement or bugfix. By allowing bugs with + a certain number of votes to automatically move from "UNCONFIRMED" to + "NEW", users of the bug system can help high-priority bugs garner + attention so they don't sit for a long time awaiting triage.</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 +><EM +>Maximum Votes per person</EM +>: + Setting this field to "0" disables voting.</P +></LI +><LI +><P +><EM +>Maximum Votes a person can put on a single + bug"</EM +>: + It should probably be some number lower than the + "Maximum votes per person". Don't set this field to "0" if + "Maximum votes per person" is non-zero; that doesn't make + any sense.</P +></LI +><LI +><P +><EM +>Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state</EM +>: + Setting this field to "0" disables the automatic move of + bugs from UNCONFIRMED to NEW. + </P +></LI +><LI +><P +>Once you have adjusted the values to your preference, click + "Update".</P +></LI +></OL +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="programadmin.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="groups.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Product, Component, Milestone, and Version Administration</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="administration.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Groups and Group Security</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/whatis.html b/docs/html/whatis.html index 9b7791a9d..85ec72202 100644 --- a/docs/html/whatis.html +++ b/docs/html/whatis.html @@ -10,11 +10,11 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="UP" -TITLE="Using Bugzilla" -HREF="using.html"><LINK +TITLE="Introduction" +HREF="introduction.html"><LINK REL="PREVIOUS" -TITLE="Using Bugzilla" -HREF="using.html"><LINK +TITLE="Introduction" +HREF="introduction.html"><LINK REL="NEXT" TITLE="Why Should We Use Bugzilla?" HREF="why.html"></HEAD @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 2. Using Bugzilla</TD +>Chapter 2. Introduction</TD ><TD WIDTH="10%" ALIGN="right" @@ -75,23 +75,22 @@ CLASS="section" ><A NAME="whatis">2.1. What is Bugzilla?</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 by -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. +> Bugzilla is a bug- or issue-tracking system. Bug-tracking + systems allow individual or groups of developers effectively to keep track + of outstanding problems with their product. + Bugzilla was originally + written by Terry Weissman in a programming language called TCL, to + replace a rudimentary bug-tracking database used internally by 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 +>Bugzilla boasts many advanced features. These include: + <P ></P ><UL ><LI @@ -132,7 +131,8 @@ system against which all others are measured. ></LI ><LI ><P ->Completely customisable and/or localisable web user interface</P +>Completely customisable and/or localisable web user + interface</P ></LI ><LI ><P @@ -162,7 +162,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="P" >Prev</A ></TD @@ -190,13 +190,13 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Using Bugzilla</TD +>Introduction</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="U" >Up</A ></TD diff --git a/docs/html/why.html b/docs/html/why.html index 403ad58c6..1baa4042e 100644 --- a/docs/html/why.html +++ b/docs/html/why.html @@ -10,14 +10,14 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="UP" -TITLE="Using Bugzilla" -HREF="using.html"><LINK +TITLE="Introduction" +HREF="introduction.html"><LINK REL="PREVIOUS" TITLE="What is Bugzilla?" HREF="whatis.html"><LINK REL="NEXT" -TITLE="How do I use Bugzilla?" -HREF="how.html"></HEAD +TITLE="Using Bugzilla" +HREF="using.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 2. Using Bugzilla</TD +>Chapter 2. Introduction</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="how.html" +HREF="using.html" ACCESSKEY="N" >Next</A ></TD @@ -74,86 +74,71 @@ CLASS="section" CLASS="section" ><A NAME="why">2.2. Why Should We Use Bugzilla?</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 +>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 +>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 +>But why should + <EM >you</EM -> use Bugzilla? - </P +> + + 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 +>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, NASA, Linux-Mandrake, and VA Systems. + Combined with systems such as + <A +HREF="http://www.cvshome.org" +TARGET="_top" +>CVS</A +>, + <A +HREF="http://www.mozilla.org/bonsai.html" +TARGET="_top" +>Bonsai</A +>, or + <A +HREF="http://www.perforce.com" +TARGET="_top" +>Perforce SCM</A +>, 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 +>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 +> + 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 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 +>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="NAVFOOTER" @@ -189,7 +174,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="how.html" +HREF="using.html" ACCESSKEY="N" >Next</A ></TD @@ -205,7 +190,7 @@ WIDTH="34%" ALIGN="center" VALIGN="top" ><A -HREF="using.html" +HREF="introduction.html" ACCESSKEY="U" >Up</A ></TD @@ -213,7 +198,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->How do I use Bugzilla?</TD +>Using Bugzilla</TD ></TR ></TABLE ></DIV diff --git a/docs/html/win32.html b/docs/html/win32.html index 1a669f2b6..575bf8f4b 100644 --- a/docs/html/win32.html +++ b/docs/html/win32.html @@ -13,11 +13,11 @@ REL="UP" TITLE="Installation" HREF="installation.html"><LINK REL="PREVIOUS" -TITLE="Installation General Notes" -HREF="geninstall.html"><LINK +TITLE="Optional Additional Configuration" +HREF="extraconfig.html"><LINK REL="NEXT" -TITLE="Administering Bugzilla" -HREF="administration.html"></HEAD +TITLE="Mac OS X Installation Notes" +HREF="osx.html"></HEAD ><BODY CLASS="section" BGCOLOR="#FFFFFF" @@ -45,7 +45,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="geninstall.html" +HREF="extraconfig.html" ACCESSKEY="P" >Prev</A ></TD @@ -53,13 +53,13 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 3. Installation</TD +>Chapter 4. Installation</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="administration.html" +HREF="osx.html" ACCESSKEY="N" >Next</A ></TD @@ -73,33 +73,84 @@ CLASS="section" ><H1 CLASS="section" ><A -NAME="win32">3.6. Win32 Installation Notes</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 +NAME="win32">4.3. Win32 Installation Notes</H1 +><P +>This section covers installation on Microsoft Windows. + Bugzilla has been made to work on Win32 platforms, but the Bugzilla team + wish to emphasise that 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="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 +>After that warning, here's the situation for 2.16 + and Windows. It doesn't work at all out of the box. + You are almost certainly better off getting + the 2.17 version from CVS (after consultation with the Bugzilla Team to + make sure you are pulling on a stable day) because we'll be doing a load + of work to make the Win32 experience more pleasant than it is now. + </P +></TD +></TR +></TABLE +></DIV +><P +> If you still want to try this, to have any hope of getting it to work, + you'll need to apply the + <A +HREF="" +TARGET="_top" +>mail patch</A +> from + <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=124174" +TARGET="_top" +>bug 124174</A +>. + After that, you'll need to read the (outdated) installation + instructions below, some (probably a lot better) <A +HREF="http://bugzilla.mozilla.org/attachment.cgi?id=84430&action=view" +TARGET="_top" +>more + recent ones</A +> kindly provided by Toms Baugis and Jean-Sebastien + Guay, and also check the + <A +HREF="http://www.bugzilla.org/releases/2.16/docs/win32.html" +TARGET="_top" +>Bugzilla 2.16 Win32 update page + </A +>. If we get time, + we'll write some better installation instructions for 2.16 and put + them up there. But no promises. + </P ><DIV CLASS="section" ><H2 CLASS="section" ><A -NAME="wininstall">3.6.1. Win32 Installation: Step-by-step</H2 +NAME="wininstall">4.3.1. Win32 Installation: Step-by-step</H2 ><DIV CLASS="note" ><P @@ -121,31 +172,33 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You should be familiar with, and cross-reference, the rest - of the - <A +>You should be familiar with, and cross-reference, the rest of + the + <A HREF="installation.html" >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 +> + + 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 +> + + 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.html" >Appendix A</A ->. - </P +> + + .</P ></TD ></TR ></TABLE @@ -156,27 +209,34 @@ CLASS="procedure" TYPE="1" ><LI ><P -> Install <A +>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 +>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.html" >Bugzilla Installation</A > - regarding your Apache configuration, particularly - instructions regarding the <SPAN + + regarding your Apache configuration, particularly instructions + regarding the + <SPAN CLASS="QUOTE" >"AddHandler"</SPAN > - parameter and <SPAN + + parameter and + <SPAN CLASS="QUOTE" >"ExecCGI"</SPAN ->. - </P +> + + .</P ><DIV CLASS="note" ><P @@ -198,20 +258,20 @@ ALT="Note"></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 +>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.html" >Appendix A</A ->. - </P +> + + .</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 +>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 @@ -219,46 +279,54 @@ HREF="faq.html" ></LI ><LI ><P -> Install <A +>Install + <A HREF="http://www.activestate.com/" TARGET="_top" >ActivePerl</A -> for Windows. Check <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 +> 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 +>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 +> 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 +> Perl on Win32 FAQ</A > - </P + </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, - GD, AppConfig, and Template. You may need to extract them from - .zip format using Winzip or other unzip program first. Most of - these additional ppm modules can be downloaded from ActiveState, - but AppConfig and Template should be obtained from OpenInteract - using <A +>Use ppm from your perl\bin directory to install the following + packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using + <A HREF="http://openinteract.sourceforge.net/" TARGET="_top" ->the instructions on - the Template Toolkit web site</A ->. - </P +>the + instructions on the Template Toolkit web site</A +> + + .</P ><DIV CLASS="note" ><P @@ -280,116 +348,129 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can find a list of modules at - <A +>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 +> http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</A > - or <A + + or + <A HREF="http://www.activestate.com/PPMPackages/5.6plus" TARGET="_top" ->http://www.activestate.com/PPMPackages/5.6plus</A +> http://www.activestate.com/PPMPackages/5.6plus</A > - </P + </P ></TD ></TR ></TABLE ></DIV ><P -> The syntax for ppm is: - <TT +>The syntax for ppm is: + <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" ->C:> </TT -><B +>C:></TT +> + + <B CLASS="command" >ppm <modulename></B > - </TT + </TT > - </P + </P ><DIV CLASS="example" ><A -NAME="AEN985"><P +NAME="AEN989"><P ><B ->Example 3-3. Installing ActivePerl ppd Modules on Microsoft Windows</B +>Example 4-1. Installing ActivePerl ppd Modules on Microsoft + Windows</B ></P ><P -><TT +> <TT CLASS="prompt" >C:></TT -><B +> + + <B CLASS="command" ->ppm - <TT +>ppm + <TT CLASS="option" >DBD-Mysql</TT -></B -></P +> + </B +> + </P ><P >Watch your capitalization!</P ></DIV ><P -> ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the - version at OpenInteract: - </P +>ActiveState's 5.6Plus directory also contains an AppConfig + ppm, so you might see the following error when trying to install + the version at OpenInteract:</P ><P > <TT CLASS="computeroutput" -> Error installing package 'AppConfig': Read a PPD for - 'AppConfig', but it is not intended for this build of Perl - (MSWin32-x86-multi-thread) - </TT +>Error installing package 'AppConfig': Read a PPD + for 'AppConfig', but it is not intended for this build of Perl + (MSWin32-x86-multi-thread)</TT > - </P + </P ><P -> If so, download both <A +>If so, download both + <A HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz" TARGET="_top" ->the - tarball</A -> and <A +> the tarball</A +> + + and + <A HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd" TARGET="_top" ->the - ppd</A -> directly from OpenInteract, then run ppm from within - the same directory to which you downloaded those files and - install the package by referencing the ppd file explicitly via in - the install command, f.e.: - <DIV +> the ppd</A +> + + directly from OpenInteract, then run ppm from within the same + directory to which you downloaded those files and install the + package by referencing the ppd file explicitly via in the install + command, f.e.: + <DIV CLASS="example" ><A -NAME="AEN998"><P +NAME="AEN1002"><P ><B ->Example 3-4. Installing OpenInteract ppd Modules manually on Microsoft - Windows</B +>Example 4-2. Installing OpenInteract ppd Modules manually on Microsoft + Windows</B ></P ><P -> <TT +> <TT CLASS="computeroutput" -><B +> <B CLASS="command" ->install +>install <TT CLASS="filename" >C:\AppConfig.ppd</TT -></B -></TT > - </P + </B +> + </TT +> + </P ></DIV > </P ></LI ><LI ><P -> Install MySQL for NT. - <DIV +>Install MySQL for NT. + <DIV CLASS="note" ><P ></P @@ -410,193 +491,211 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You can download MySQL for Windows NT from <A +>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 +> + + . Some find it helpful to use the WinMySqlAdmin utility, included + with the download, to set up the database.</P ></TD ></TR ></TABLE ></DIV > - </P + </P ></LI ><LI ><P -> Setup MySQL - </P +>Setup MySQL</P ><OL CLASS="SUBSTEPS" TYPE="a" ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" ->C:> </TT +>C:></TT > - <B + + <B CLASS="command" >C:\mysql\bin\mysql -u root mysql</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" ->DELETE FROM user WHERE Host='localhost' AND User='';</B +>DELETE FROM user WHERE Host='localhost' AND + User='';</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</B + WHERE user='root';</B > - </TT + </TT > - </P + </P ><P -><SPAN +> <SPAN CLASS="QUOTE" >"new_password"</SPAN ->, above, indicates - whatever password you wish to use for your - <SPAN +> + + , above, indicates whatever password you wish to use for your + <SPAN CLASS="QUOTE" >"root"</SPAN -> user.</P +> + + user.</P ></LI ><LI ><A NAME="ntbugs-password" ></A ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" ->GRANT SELECT, INSERT, UPDATE, DELETE, - INDEX, ALTER, CREATE, DROP, REFERENCES - ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</B +>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, + ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost + IDENTIFIED BY 'bugs_password';</B > - </TT + </TT > - </P + </P ><P -><SPAN +> <SPAN CLASS="QUOTE" >"bugs_password"</SPAN ->, above, indicates - whatever password you wish to use for your - <SPAN +> + + , above, indicates whatever password you wish to use for your + <SPAN CLASS="QUOTE" >"bugs"</SPAN -> user.</P +> + + user.</P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >FLUSH PRIVILEGES;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >create database bugs;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >mysql></TT > - <B + + <B CLASS="command" >exit;</B > - </TT + </TT > - </P + </P ></LI ><LI ><P -> <TT +> <TT CLASS="computeroutput" -> <TT +> <TT CLASS="prompt" >C:></TT > - <B + + <B CLASS="command" ->C:\mysql\bin\mysqladmin -u root -p reload</B +>C:\mysql\bin\mysqladmin -u root -p + reload</B > - </TT + </TT > - </P + </P ></LI ></OL ></LI ><LI ><P -> Edit <TT +>Edit + <TT CLASS="filename" >checksetup.pl</TT -> in your Bugzilla directory. Change - this line: - </P +> + + in your Bugzilla directory. Change this line:</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -606,19 +705,18 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = getgrnam($my_webservergroup); - </PRE +>my $webservergid = + getgrnam($my_webservergroup);</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> to - </P +>to</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -628,15 +726,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = $my_webservergroup; - </PRE +>my $webservergid = + $my_webservergroup;</PRE ></FONT ></TD ></TR ></TABLE > -or the name of the group you wish to own the files explicitly: - <TABLE + + or the name of the group you wish to own the files explicitly: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -646,46 +745,64 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> my $webservergid = 'Administrators' - </PRE +>my $webservergid = + 'Administrators'</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></LI ><LI ><P -> Run <TT +>Run + <TT CLASS="filename" >checksetup.pl</TT -> from the Bugzilla directory. - </P +> + + from the Bugzilla directory.</P ></LI ><LI ><P ->Edit <TT +>Edit + <TT CLASS="filename" >localconfig</TT -> to suit your - requirements. Set <TT +> + + to suit your requirements. Set + <TT CLASS="varname" >$db_pass</TT -> to your - <SPAN +> + + to your + <SPAN CLASS="QUOTE" >"bugs_password"</SPAN -> from <A +> + + from + <A HREF="win32.html#ntbugs-password" >step 5.d</A ->, and <TT +> + + , and + <TT CLASS="varname" >$webservergroup</TT -> to <SPAN +> + + to + <SPAN CLASS="QUOTE" >"8"</SPAN ->.</P +> + + .</P ><DIV CLASS="note" ><P @@ -707,15 +824,19 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->Not sure on the <SPAN +>Not sure on the + <SPAN CLASS="QUOTE" >"8"</SPAN -> for - <TT +> + + for + <TT CLASS="varname" >$webservergroup</TT -> above. If it's - wrong, please send corrections.</P +> + + above. If it's wrong, please send corrections.</P ></TD ></TR ></TABLE @@ -723,21 +844,24 @@ CLASS="varname" ></LI ><LI ><P -> Edit <TT +>Edit + <TT CLASS="filename" >defparams.pl</TT -> to suit your - requirements. Particularly, set - <TT +> + + to suit your requirements. Particularly, set + <TT CLASS="varname" >DefParam("maintainer")</TT -> and - <TT +> + + and + <TT CLASS="varname" ->DefParam("urlbase") to match your - install.</TT +>DefParam("urlbase") to match your install.</TT > - </P + </P ><DIV CLASS="note" ><P @@ -760,9 +884,9 @@ 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 + 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 @@ -790,30 +914,38 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <EM +>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 +> + + , not a requirement. Some other mail packages that can work + include + <A HREF="http://www.blat.net/" TARGET="_top" >BLAT</A ->, - <A +> + + , + <A HREF="http://www.geocel.com/windmail/" TARGET="_top" >Windmail</A ->, - <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 +>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 @@ -824,12 +956,16 @@ CLASS="procedure" TYPE="1" ><LI ><P -> Download NTsendmail, available from<A +>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 +> 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 @@ -848,12 +984,11 @@ WIDTH="100%" 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 +># 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 @@ -879,28 +1014,34 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Some mention to also edit - <TT +>Some mention to also edit + <TT CLASS="varname" >$db_pass</TT -> in - <TT +> + + in + <TT CLASS="filename" >globals.pl</TT -> to be your - <SPAN +> + + 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 +> + + . 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 +> + + , your database password is exposed to whoever uses your web + server.</P ></TD ></TR ></TABLE @@ -908,16 +1049,19 @@ CLASS="filename" ></LI ><LI ><P -> Find and comment out all occurences of - <SPAN +>Find and comment out all occurences of + <SPAN CLASS="QUOTE" ->"<B +>" + <B CLASS="command" >open(SENDMAIL</B ->"</SPAN -> in - your Bugzilla directory. Then replace them with: - <TABLE +> + "</SPAN +> + + in your Bugzilla directory. Then replace them with: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -927,19 +1071,16 @@ WIDTH="100%" 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 +># 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 + </P ><DIV CLASS="note" ><P @@ -961,13 +1102,14 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Some have found success using the commercial product, - <SPAN +>Some have found success using the commercial product, + <SPAN CLASS="productname" >Windmail</SPAN ->. - You could try replacing your sendmail calls with: - <TABLE +> + + . You could try replacing your sendmail calls with: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -977,15 +1119,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </PRE +>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 + + or something to that effect.</P ></TD ></TR ></TABLE @@ -996,24 +1139,31 @@ CLASS="programlisting" ></LI ><LI ><P -> Change all references in all files from - <TT +>Change all references in all files from + <TT CLASS="filename" >processmail</TT -> to - <TT +> + + to + <TT CLASS="filename" >processmail.pl</TT ->, and - rename <TT +> + + , and rename + <TT CLASS="filename" >processmail</TT -> to - <TT +> + + to + <TT CLASS="filename" >processmail.pl</TT ->. - </P +> + + .</P ><DIV CLASS="note" ><P @@ -1035,10 +1185,9 @@ ALT="Note"></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 +>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 @@ -1064,8 +1213,10 @@ ALT="Note"></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 +>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%" @@ -1088,14 +1239,15 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } -</PRE + </PRE ></FONT ></TD ></TR ></TABLE > -here is a test mail program for Net::SMTP: -<TABLE + + here is a test mail program for Net::SMTP: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1122,13 +1274,13 @@ recipient's address exit; -</PRE + </PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></TD ></TR ></TABLE @@ -1156,50 +1308,58 @@ ALT="Note"></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 +>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 +> + + 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 +>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 +> + + 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 + + utility to speed part of this procedure, available in the + <A HREF="patches.html" >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 +> + + 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 +> + + 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 +>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%" @@ -1209,50 +1369,61 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> +> system ("./processmail",@ARGLIST); - </programlisting> to - <programlisting> + </programlisting> to + <programlisting> system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); - </PRE + + </PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ></LI ><LI ><P -> Add <TT +>Add + <TT CLASS="function" >binmode()</TT -> calls so attachments - will work (<A +> + + calls so attachments will work ( + <A HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" TARGET="_top" ->bug 62000</A ->). - </P +>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 +>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 +> + + and + <TT CLASS="filename" >showattachment.cgi</TT -> before the - <TT +> + + before the + <TT CLASS="function" >require 'CGI.pl';</TT -> line. -</P +> + + line.</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1266,7 +1437,7 @@ CLASS="programlisting" binmode(STDIN); binmode(STDOUT); -</PRE + </PRE ></FONT ></TD ></TR @@ -1294,28 +1465,35 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> According to <A +>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 +> 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 +> + + 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 +> + + at the beginning of the attachment files, there should be logic + to determine if + <TT CLASS="function" >binmode()</TT -> is needed or not. - </P +> + + is needed or not.</P ></TD ></TR ></TABLE @@ -1344,13 +1522,12 @@ ALT="Tip"></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 +>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 +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1360,19 +1537,16 @@ WIDTH="100%" 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 +>.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 +> + + Change the path to Perl to match your install, of course.</P ></TD ></TR ></TABLE @@ -1383,7 +1557,7 @@ CLASS="section" ><H2 CLASS="section" ><A -NAME="addlwintips">3.6.2. Additional Windows Tips</H2 +NAME="addlwintips">4.3.2. Additional Windows Tips</H2 ><DIV CLASS="tip" ><P @@ -1405,25 +1579,25 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> From Andrew Pearson: - <A -NAME="AEN1168"><BLOCKQUOTE +>From Andrew Pearson: + <A +NAME="AEN1172"><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" +>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 +> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</A > - </P + </P ><P -> Basically you need to add two String Keys in the - registry at the following location: - </P +>Basically you need to add two String Keys in the registry at + the following location:</P ><P -> <TABLE +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1433,29 +1607,27 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </PRE +> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</PRE ></FONT ></TD ></TR ></TABLE > - </P + </P ><P -> The keys should be called ".pl" and ".cgi", and both - should have a value something like: - <B +>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 ><P -> The KB article only talks about .pl, but it goes into - more detail and provides a perl test script. - </P +>The KB article only talks about .pl, but it goes into more + detail and provides a perl test script.</P ></BLOCKQUOTE > - </P + </P ></TD ></TR ></TABLE @@ -1481,24 +1653,25 @@ ALT="Tip"></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 +>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.16. - <DIV +> + + for Bugzilla 2.13 and later, which includes the current release, + Bugzilla &bz-ver;. + <DIV CLASS="example" ><A -NAME="AEN1180"><P +NAME="AEN1184"><P ><B ->Example 3-5. Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</B +>Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</B ></P ><P -> Replace this: - <TABLE +>Replace this: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1508,17 +1681,17 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </PRE +>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . + ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my + $enteredcryptpwd = FetchOneColumn();</PRE ></FONT ></TD ></TR ></TABLE -> -with this: - <TABLE +> + + with this: + <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1528,104 +1701,22 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> -my $enteredcryptpwd = $enteredpwd - </PRE +>my $enteredcryptpwd = $enteredpwd</PRE ></FONT ></TD ></TR ></TABLE -> - in cgi.pl. - </P +> + + in cgi.pl.</P ></DIV > - </P + </P ></TD ></TR ></TABLE ></DIV ></DIV -><DIV -CLASS="section" -><H2 -CLASS="section" -><A -NAME="bzldap">3.6.3. Bugzilla LDAP Integration</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 CLASS="NAVFOOTER" @@ -1643,7 +1734,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="geninstall.html" +HREF="extraconfig.html" ACCESSKEY="P" >Prev</A ></TD @@ -1661,7 +1752,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="administration.html" +HREF="osx.html" ACCESSKEY="N" >Next</A ></TD @@ -1671,7 +1762,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Installation General Notes</TD +>Optional Additional Configuration</TD ><TD WIDTH="34%" ALIGN="center" @@ -1685,7 +1776,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Administering Bugzilla</TD +>Mac OS X Installation Notes</TD ></TR ></TABLE ></DIV diff --git a/docs/sgml/Bugzilla-Guide.sgml b/docs/sgml/Bugzilla-Guide.sgml index bd0b3a4a1..b8868a618 100644 --- a/docs/sgml/Bugzilla-Guide.sgml +++ b/docs/sgml/Bugzilla-Guide.sgml @@ -16,7 +16,7 @@ <!ENTITY database SYSTEM "database.sgml"> <!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY variants SYSTEM "variants.sgml"> -<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> +<!ENTITY introduction SYSTEM "introduction.sgml"> <!ENTITY revhistory SYSTEM "revhistory.sgml"> <!ENTITY bz "http://www.bugzilla.org/"> @@ -61,33 +61,35 @@ try to avoid clutter and feel free to waste space in the code to make it more re <title>The Bugzilla Guide</title> <authorgroup> - <author> - <firstname>Matthew</firstname> - <othername>P.</othername> - <surname>Barnson</surname> - <affiliation> - <address><email>mbarnson@sisna.com</email></address> - </affiliation> + <firstname>Matthew</firstname> + <othername>P.</othername> + <surname>Barnson</surname> + </author> + <author> + <firstname>The</firstname> + <othername>Bugzilla</othername> + <surname>Team</surname> </author> </authorgroup> <abstract> <para> - This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. - Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. + This is the documentation for Bugzilla, the mozilla.org + bug-tracking system. + Bugzilla is an enterprise-class piece of software + that powers issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. </para> - <para> - This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or SGML diffs, attached - to a Bugzilla bug. + + <para> + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or SGML diffs, attached + to a bug filed in + <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">mozilla.org's Bugzilla</ulink>. </para> </abstract> - <keywordset> <keyword>Bugzilla</keyword> <keyword>Guide</keyword> @@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- About This Guide --> &about; +<!-- Introduction --> +&introduction; + <!-- Using Bugzilla --> &using; @@ -113,26 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- Administering Bugzilla --> &administration; -<!-- Integrating Bugzilla with Third-Party Tools --> -&integration; - -<!-- Major Bugzilla Variants --> -&variants; - <!-- Appendix: The Frequently Asked Questions --> &faq; -<!-- Appendix: Required Bugzilla Software Links --> -&requiredsoftware; - <!-- Appendix: The Database Schema --> &database; <!-- Appendix: Custom Patches --> &patches; -<!-- Appendix: The GNU Free Documentation License --> -&gfdl; +<!-- Appendix: Major Bugzilla Variants --> +&variants; <!-- Glossary --> &glossary; diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml index 62e486573..b4349644a 100644 --- a/docs/sgml/about.sgml +++ b/docs/sgml/about.sgml @@ -4,40 +4,6 @@ <chapter id="about"> <title>About This Guide</title> - <section id="aboutthisguide"> - <title>Purpose and Scope of this Guide</title> - <para> - 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. - </para> - <para> - This release of the Bugzilla Guide is the - <emphasis>&bzg-ver;</emphasis> 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 <emphasis>even-numbered</emphasis> point releases (1.2, - 1.14, etc.) are considered "stable releases", intended for - public consumption; on the other hand, - <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09, - etc.) are considered unstable <emphasis>development</emphasis> - releases intended for advanced users, systems administrators, - developers, and those who enjoy a lot of pain. - </para> - <para> - Newer revisions of the Bugzilla Guide follow the numbering - conventions of the main-tree Bugzilla releases, available at - <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have - a minor revision number following a period. The current version - of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if - something were seriously wrong with that edition of the Guide, - subsequent releases would receive an additional dotted-decimal - digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.). - Got it? Good. - </para> - </section> - <section id="copyright"> <title>Copyright Information</title> <blockquote> @@ -48,8 +14,7 @@ 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". + the license is included below. </para> </blockquote> <para> @@ -57,6 +22,11 @@ copyright, or publishing this document in non-electronic form, please contact &bzg-auth;. </para> + + + <!-- The GNU Free Documentation License --> + &gfdl; + </section> <section id="disclaimer"> @@ -64,12 +34,11 @@ <para> 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. + This document may contain errors + and inaccuracies that may damage your system, cause your partner + to leave you, your boss to fire you, your cats to + pee on your furniture and clothing, and global thermonuclear + war. Proceed with caution. </para> <para> All copyrights are held by their respective owners, unless @@ -100,7 +69,7 @@ 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 + product, and are responsible for auditing it yourself to ensure your security needs are met. </para> </section> @@ -110,7 +79,8 @@ <section id="newversions"> <title>New Versions</title> <para> - This is the &bzg-ver; version of The Bugzilla Guide. If you are + This is the &bzg-ver; version of The Bugzilla Guide. It is so named + to match the current version of Bugzilla. 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. @@ -134,9 +104,16 @@ </itemizedlist> </para> <para> - The latest version of this document can be checked out via CVS. - Please follow the instructions available at <ulink - url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch. + The latest version of this document can always be checked out via CVS. + Please follow the instructions available at + <ulink url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, + and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> + subtree. + </para> + <para> + The Bugzilla Guide is currently only available in English. + If you would like to volunteer to translate it, please contact + <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>. </para> </section> @@ -144,13 +121,14 @@ <title>Credits</title> <para> The people listed below have made enormous contributions to the - creation of this Guide, through their dedicated hacking efforts, + creation of this Guide, through their writing, dedicated hacking efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: </para> <para> <ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink> - for pulling together the Bugzilla Guide and shepherding it to 2.14. + for the Herculaean task of pulling together the Bugzilla Guide and + shepherding it to 2.14. </para> <para> <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink> @@ -158,13 +136,13 @@ README upon which the UNIX installation documentation is largely based. </para> <para> - <ulink url="mailto://tara@tequilarista.org">Tara - Hernandez</ulink> for keeping Bugzilla development going - strong after Terry left Mozilla.org + <ulink url="mailto://tara@tequilarista.org">Tara Hernandez</ulink> + for keeping Bugzilla development going + strong after Terry left mozilla.org </para> <para> - <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for - providing insight into the key differences between Red Hat's + <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> + for providing insight into the key differences between Red Hat's customized Bugzilla, and being largely responsible for the "Red Hat Bugzilla" appendix </para> @@ -174,8 +152,8 @@ questions and arguments on irc.mozilla.org in #mozwebtools </para> <para> - Last but not least, all the members of the <ulink - url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. + Last but not least, all the members of the + <ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. </para> <para> Thanks also go to the following people for significant contributions @@ -183,19 +161,7 @@ </para> <para> Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, - Ron Teitelbaum, Jacob Steenhagen, Joe Robins. - </para> - </section> - - <section id="translations"> - <title>Translations</title> - <para> - 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 - <email>mozilla-webtools@mozilla.org</email>, and arrange with - &bzg-auth; to check it into CVS. + Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham. </para> </section> diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml index cf52999e4..f932beb25 100644 --- a/docs/sgml/administration.sgml +++ b/docs/sgml/administration.sgml @@ -2,28 +2,13 @@ <chapter id="administration"> <title>Administering Bugzilla</title> - <subtitle>Or, I just got this cool thing installed. Now what the heck do I - do with it?</subtitle> + <section id="parameters"> + <title>Bugzilla Configuration</title> - <para>So you followed - <quote> - <xref linkend="installation" /> - </quote> - - 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.</para> - - <section id="postinstall-check"> - <title>Post-Installation Checklist</title> - - <para>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.</para> + <para>Bugzilla is configured by changing various parameters, accessed + from the "Edit parameters" link in the page footer. Here are + some of the key parameters on that page. You should run down this + list and set them appropriately after installing Bugzilla.</para> <indexterm> <primary>checklist</primary> @@ -31,185 +16,112 @@ <procedure> <step> - <para>Bring up - <filename>editparams.cgi</filename> - - in your web browser. This should be available as the - <quote>edit parameters</quote> - - link from any Bugzilla screen once you have logged in.</para> - </step> - - <step> - <para>The - <quote>maintainer</quote> - - 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.</para> - - <para>Set - <quote>maintainer</quote> - - to - <emphasis>your</emphasis> - - email address. This allows Bugzilla's error messages to display your - email address and allow people to contact you for help.</para> + <para> + <command>maintainer</command>: + The maintainer parameter is the email address of the person + responsible for maintaining this + Bugzilla installation. The address need not be that of a valid Bugzilla + account.</para> </step> <step> - <para>The - <quote>urlbase</quote> - - parameter defines the fully qualified domain name and web server path - to your Bugzilla installation.</para> - - <para>For example, if your bugzilla query page is - http://www.foo.com/bugzilla/query.cgi, set your - <quote>urlbase</quote> - - is http://www.foo.com/bugzilla/.</para> + <para> + <command>urlbase</command>: + This parameter defines the fully qualified domain name and web + server path to your Bugzilla installation.</para> + + <para>For example, if your Bugzilla query page is + <filename>http://www.foo.com/bugzilla/query.cgi</filename>, + set your <quote>urlbase</quote> + to <filename>http://www.foo.com/bugzilla/</filename>.</para> </step> <step> <para> - <quote>usebuggroups</quote> - - 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 + <command>usebuggroups</command>: + This dictates whether or not to implement group-based security for + Bugzilla. If set, Bugzilla bugs can have an associated 'group', + defining which users are allowed to see and edit the bug.</para> <para>Set "usebuggroups" to "on" <emphasis>only</emphasis> - - if you may wish to restrict access to products. I suggest leaving - this parameter - <emphasis>off</emphasis> - + if you may wish to restrict access to particular bugs to certain + groups of users. I suggest leaving + this parameter <emphasis>off</emphasis> while initially testing your Bugzilla.</para> </step> <step> <para> - <quote>usebuggroupsentry</quote> - - , when set to - <quote>on</quote> - - , requires that all bugs have an associated groupmask when submitted. - This parameter is made for those installations where product - isolation is a necessity.</para> - - <para>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.</para> + <command>usebuggroupsentry</command>: + Bugzilla Products can have a group associated with them, so that + certain users can only see bugs in certain products. When this parameter + is set to <quote>on</quote>, this places all newly-created bugs in the + group for their product immediately.</para> </step> <step> - <para>You run into an interesting problem when Bugzilla reaches a + <para> + <command>shadowdb</command>: + 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 <quote>shadowdb</quote> - parameter was designed to get around this limitation. While only a single user is allowed to write to a table at a time, reads can continue unimpeded on a read-only shadow copy of the database. Although your database size will double, a shadow database can cause an enormous performance improvement when implemented on extremely high-traffic Bugzilla databases.</para> + + <para> + As a guide, mozilla.org began needing + <quote>shadowdb</quote> + when they reached around 40,000 Bugzilla users with several hundred + Bugzilla bug changes and comments per day.</para> - <para>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. + <para>The value of the parameter defines the name of the + shadow bug database. + Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. <note> <para>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 - <quote>cron</quote> - - .</para> + <quote>cron</quote>. + </para> </note> - - Once again, in testing you should avoid this option -- use it if or - when you - <emphasis>need</emphasis> - - 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 - <quote>shadowdb</quote> - - when they reached around 40,000 Bugzilla users with several hundred - Bugzilla bug changes and comments per day.</para> - + </para> + <para>If you use the "shadowdb" option, it is only natural that you - should turn the "queryagainstshadowdb" option "On" as well. Otherwise + should turn the "queryagainstshadowdb" option on as well. Otherwise you are replicating data into a shadow database for no reason!</para> + </step> <step> <para> - <quote>headerhtml</quote> - - , - <quote>footerhtml</quote> - - , - <quote>errorhtml</quote> - - , - <quote>bannerhtml</quote> - - , and - <quote>blurbhtml</quote> - - 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 - <filename>data/params</filename> - - 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 - <filename>data/params</filename> - - file.</para> - - <para>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. - <note> - <para>The "headerhtml" text box is the HTML printed out - <emphasis>before</emphasis> + <command>shutdownhtml</command>: - 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.</para> - </note> + If you need to shut down Bugzilla to perform administration, enter + some descriptive HTML here and anyone who tries to use Bugzilla will + receive a page to that effect. Obviously, editparams.cgi will + still be accessible so you can remove the HTML and re-enable Bugzilla. + :-) </para> </step> <step> <para> - <quote>passwordmail</quote> + <command>passwordmail</command>: - 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 + Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along with their password message.</para> <para>Add any text you wish to the "passwordmail" parameter box. For @@ -219,45 +131,29 @@ <step> <para> - <quote>useqacontact</quote> + <command>useqacontact</command>: - allows you to define an email address for each component, in addition + This allows you to define an email address for each component, in + addition to that of the default owner, who will be sent carbon copies of - incoming bugs. 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.</para> - + incoming bugs.</para> + </step> + <step> <para> - <quote>usestatuswhiteboard</quote> - - defines whether you wish to have a free-form, overwritable field + <command>usestatuswhiteboard</command>: + This defines whether you wish to have a free-form, overwritable field associated with each bug. The advantage of the Status Whiteboard is that it can be deleted or modified with ease, and provides an easily-searchable field for indexing some bugs that have some trait - in common. Many people will put - <quote>help wanted</quote> - - , - <quote>stalled</quote> - - , or - <quote>waiting on reply from somebody</quote> - - 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.</para> - - <para>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.</para> + in common. + </para> </step> <step> - <para>Set "whinedays" to the amount of days you want to let bugs go - in the "New" or "Reopened" state before notifying people they have + <para> + <command>whinedays</command>: + Set this to the number of days you want to let bugs go + in the NEW or REOPENED state before notifying people they have untouched new bugs. If you do not plan to use this feature, simply do not set up the whining cron job described in the installation instructions, or set this value to "0" (never whine).</para> @@ -265,8 +161,8 @@ <step> <para> - <quote>commenton</quote> - + <command>commenton*</command>: + All these fields allow you to dictate what changes can pass without comment, and which must have a comment from the person who changed them. Often, administrators will allow users to add themselves to the CC @@ -288,30 +184,17 @@ </step> <step> - <para>The - <quote>supportwatchers</quote> + <para> + <command>supportwatchers</command>: - 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 + Turning on this option allows users to ask to receive copies of + all a particular other user's bug email. This is, of course, subject to the groupset restrictions on the bug; if the <quote>watcher</quote> - 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 privileges. She would still only receive email - updates for those bugs she could normally view.</para> - - <para>For Bugzilla sites which require strong inter-Product security - to prevent snooping, watchers are not a good idea.</para> - - <para>However, for most sites you should set - <quote>supportwatchers</quote> - - 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.</para> + with bugs outside her privileges. They would still only receive email + updates for those bugs she could normally view.</para> </step> </procedure> </section> @@ -319,34 +202,34 @@ <section id="useradmin"> <title>User Administration</title> - <para>User administration is one of the easiest parts of Bugzilla. - Keeping it from getting out of hand, however, can become a - challenge.</para> - <section id="defaultuser"> <title>Creating the Default User</title> <para>When you first run checksetup.pl after installing Bugzilla, it will prompt you for the administrative username (email address) and - password for this "super user". If for some reason you were to delete + password for this "super user". If for some reason you delete the "super user" account, re-running checksetup.pl will again prompt you for this username and password.</para> <tip> <para>If you wish to add more administrative users, 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): - <command> - <prompt>mysql></prompt> - - use bugs;</command> - - <command> - <prompt>mysql></prompt> - - update profiles set groupset=0x7ffffffffffffff where login_name = - "(user's login name)";</command> + commands: + <simplelist> + <member> + <prompt>mysql></prompt> + <command>use bugs;</command> + </member> + + <member> + <prompt>mysql></prompt> + + <command> + update profiles set groupset=0x7ffffffffffffff where login_name = + "(user's login name)"; + </command> + </member> + </simplelist> </para> <para>Yes, that is @@ -362,77 +245,24 @@ <section id="manageusers"> <title>Managing Other Users</title> - <section id="login"> - <title>Logging In</title> - - <orderedlist> - <listitem> - <para>Open the index.html page for your Bugzilla installation in - your browser window.</para> - </listitem> - - <listitem> - <para>Click the "Query Existing Bug Reports" link.</para> - </listitem> - - <listitem> - <para>Click the "Log In" link at the foot of the page.</para> - </listitem> - - <listitem> - <para>Type your email address, and the password which was emailed - to you when you created your Bugzilla account, into the spaces - provided.</para> - </listitem> - </orderedlist> - - <para>Congratulations, you are logged in!</para> - </section> - <section id="createnewusers"> <title>Creating new users</title> <para>Your users can create their own user accounts by clicking the - "New Account" link at the bottom of each page. However, should you + "New Account" link at the bottom of each page (assuming they + aren't logged in as someone else already.) However, should you desire to create user accounts ahead of time, here is how you do it.</para> <orderedlist> <listitem> <para>After logging in, click the "Users" link at the footer of - the query page.</para> - </listitem> - - <listitem> - <para>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.</para> - - <tip> - <para>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 - <command>man regexp</command> - - manual page for details on regular expression syntax), or a - <emphasis>reverse</emphasis> - - regular expression match, where every user name which does NOT - match the regular expression is selected.</para> - </tip> - </listitem> - - <listitem> - <para>Click the "Add New User" link at the bottom of the user - list</para> + the query page, and then click "Add a new user".</para> </listitem> <listitem> <para>Fill out the form presented. This page is self-explanatory. - When done, click "submit".</para> + When done, click "Submit".</para> <note> <para>Adding a user this way will @@ -453,84 +283,71 @@ </orderedlist> </section> - <section id="disableusers"> - <title>Disabling Users</title> - - <para>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. - <warning> - <para>Don't disable your own administrative account, or you will - hate life!</para> - - <para>At this time, - <quote>Disabled Text</quote> - - 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.</para> - </warning> - </para> - </section> - <section id="modifyusers"> <title>Modifying Users</title> - <para>Here I will attempt to describe the function of each option on - the Edit User screen.</para> + <para>To see a specific user, search for their login name + in the box provided on the "Edit Users" page. To see all users, + leave the box blank.</para> + + <para>You can search in different ways the listbox to the right + of the text entry box. You can match by + case-insensitive substring (the default), + regular expression, or a + <emphasis>reverse</emphasis> + regular expression match, which finds every user name which does NOT + match the regular expression. (Please see + the <command>man regexp</command> + manual page for details on regular expression syntax.) + </para> + + <para>Once you have found your user, you can change the following + fields:</para> <itemizedlist> <listitem> <para> - <emphasis>Login Name</emphasis> - - : This is generally the user's email address. However, if you - have edited your system parameters, this may just be the user's - login name or some other identifier. - <tip> - <para>For compatability reasons, you should probably stick with - email addresses as user login names. It will make your life - easier.</para> - </tip> + <emphasis>Login Name</emphasis>: + This is generally the user's full email address. However, if you + have are using the emailsuffix Param, this may just be the user's + login name. Note that users can now change their login names + themselves (to any valid email address.) </para> </listitem> <listitem> <para> - <emphasis>Real Name</emphasis> - - : Duh!</para> + <emphasis>Real Name</emphasis>: The user's real name. Note that + Bugzilla does not require this to create an account.</para> </listitem> <listitem> <para> - <emphasis>Password</emphasis> - - : You can change the user password here. It is normal to only see - asterisks.</para> + <emphasis>Password</emphasis>: + You can change the user's password here. Users can automatically + request a new password, so you shouldn't need to do this often. + If you want to disable an account, see Disable Text below. + </para> </listitem> <listitem> <para> - <emphasis>Disable Text</emphasis> - - : If you type anything in this box, including just a space, the - user 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. + <emphasis>Disable Text</emphasis>: + If you type anything in this box, including just a space, the + user is prevented from logging in, or making any changes to + bugs via the web interface. + The HTML you type in this box is presented to the user when + they attempt to perform these actions, and should explain + why the account was disabled. <warning> <para>Don't disable the administrator account!</para> </warning> <note> - <para>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 + <para>The user can still submit bugs via + the e-mail gateway, if you set it up, even if the disabled text + field is filled in. The e-mail gateway should <emphasis>not</emphasis> - be enabled for secure installations of Bugzilla.</para> </note> </para> @@ -538,90 +355,82 @@ <listitem> <para> - <emphasis>CanConfirm</emphasis> - - : 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.</para> + <emphasis><groupname></emphasis>: + If you have created some groups, e.g. "securitysensitive", then + checkboxes will appear here to allow you to add users to, or + remove them from, these groups. + </para> </listitem> <listitem> <para> - <emphasis>Creategroups</emphasis> - - : 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.</para> + <emphasis>canconfirm</emphasis>: + This field is only used if you have enabled the "unconfirmed" + status. If you enable this for a user, + that user can then move bugs from "Unconfirmed" to a "Confirmed" + status (e.g.: "New" status).</para> </listitem> <listitem> <para> - <emphasis>Editbugs</emphasis> + <emphasis>creategroups</emphasis>: + This option will allow a user to create and destroy groups in + Bugzilla.</para> + </listitem> - : Unless a user has this bit set, they can only edit those bugs - for which they are the assignee or the reporter. - <note> - <para>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.</para> - </note> + <listitem> + <para> + <emphasis>editbugs</emphasis>: + Unless a user has this bit set, they can only edit those bugs + for which they are the assignee or the reporter. Even if this + option is unchecked, users can still add comments to bugs. </para> </listitem> <listitem> <para> - <emphasis>Editcomponents</emphasis> - - : This flag allows a user to create new products and components, + <emphasis>editcomponents</emphasis>: + This flag allows a user to create new products and components, as well as modify and destroy those that have no bugs associated with them. If a product or component has bugs associated with it, those bugs must be moved to a different product or component - before Bugzilla will allow them to be destroyed. 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.</para> + before Bugzilla will allow them to be destroyed. + </para> </listitem> <listitem> <para> - <emphasis>Editkeywords</emphasis> - - : If you use Bugzilla's keyword functionality, enabling this - feature allows a user can create and destroy keywords. As always, + <emphasis>editkeywords</emphasis>: + If you use Bugzilla's keyword functionality, enabling this + feature allows a user to create and destroy keywords. As always, the keywords for existing bugs containing the keyword the user wishes to destroy must be changed before Bugzilla will allow it - to die. 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.</para> + to die.</para> </listitem> <listitem> <para> - <emphasis>Editusers</emphasis> - - : This flag allows a user do what you're doing right now: edit + <emphasis>editusers</emphasis>: + This flag allows a user to do what you're doing right now: edit other users. This will allow those with the right to do so to remove administrator privileges from other users or grant them to themselves. Enable with care.</para> </listitem> + + <listitem> + <para> + <emphasis>tweakparams</emphasis>: + This flag allows a user to change Bugzilla's Params + (using <filename>editparams.cgi</filename>.)</para> + </listitem> + <listitem> <para> - <emphasis>PRODUCT</emphasis> - - : 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.</para> + <emphasis><productname></emphasis>: + This allows an administrator to specify the products in which + a user can see bugs. The user must still have the + "editbugs" privilege to edit bugs in these products.</para> </listitem> </itemizedlist> </section> @@ -631,83 +440,63 @@ <section id="programadmin"> <title>Product, Component, Milestone, and Version Administration</title> - <epigraph> - <para>Dear Lord, we have to get our users to do WHAT?</para> - </epigraph> - <section id="products"> <title>Products</title> - <subtitle>Formerly, and in some spots still, called - "Programs"</subtitle> - <para> <glossterm linkend="gloss-product" baseform="product"> Products</glossterm> - 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...)</para> + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...)</para> - <para>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 + <para>Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes required to move a bug automatically from the UNCONFIRMED status to the - NEW status. One can close a Product for further bug entry and define - various Versions available from the Edit product screen.</para> + NEW status.</para> <para>To create a new product:</para> <orderedlist> <listitem> - <para>Select "components" from the yellow footer</para> + <para>Select "products" from the footer</para> - <tip> - <para>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...</para> - </tip> </listitem> <listitem> - <para>Select the "Add" link to the right of "Add a new - product".</para> + <para>Select the "Add" link in the bottom right</para> </listitem> <listitem> <para>Enter the name of the product and a description. The - Description field is free-form.</para> + Description field may contain HTML.</para> </listitem> </orderedlist> - <tip> - <para>Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get out - of the UNCOMFIRMED state", and "Version" options yet. We'll cover - those in a few moments.</para> - </tip> + <para>Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single bug", + "Number of votes a bug in this Product needs to automatically get out + of the UNCOMFIRMED state", and "Version" options yet. We'll cover + those in a few moments. + </para> </section> <section id="components"> <title>Components</title> - <para>Components are subsections of a Product. - <example> - <title>Creating some Components</title> - - <informalexample> - <para>The computer game you are designing may have a "UI" - component, an "API" component, a "Sound System" component, and a - "Plugins" component, each overseen by a different programmer. It - often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or - company.</para> - </informalexample> - </example> - + <para>Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.</para> + + <para> Each component has a owner and (if you turned it on in the parameters), a QA Contact. The owner should be the primary person who fixes bugs in that component. The QA Contact should be the person who will ensure @@ -715,10 +504,9 @@ will get email when new bugs are created in this Component and when these bugs change. Default Owner and Default QA Contact fields only dictate the - <emphasis>default assignments</emphasis> - - ; the Owner and QA Contact fields in a bug are otherwise unrelated to - the Component.</para> + <emphasis>default assignments</emphasis>; + these can be changed on bug submission, or at any later point in + a bug's life.</para> <para>To create a new Component:</para> @@ -729,53 +517,17 @@ </listitem> <listitem> - <para>Select the "Add" link to the right of the "Add a new - component" text on the "Select Component" page.</para> + <para>Select the "Add" link in the bottom right.</para> </listitem> <listitem> - <para>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. - <tip> - <para>Is your "Default Owner" a user who is not yet in the - database? No problem. - <orderedlist> - <listitem> - <para>Select the "Log out" link on the footer of the - page.</para> - </listitem> - - <listitem> - <para>Select the "New Account" link on the footer of the - "Relogin" page</para> - </listitem> - - <listitem> - <para>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.</para> - </listitem> - - <listitem> - <para>Now select "Log in" again, type in your login - information, and you can modify the product to use the - Default Owner information you require.</para> - </listitem> - </orderedlist> - </para> - </tip> + <para>Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. </para> </listitem> - - <listitem> - <para>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.</para> - </listitem> </orderedlist> </section> @@ -783,36 +535,9 @@ <title>Versions</title> <para>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. - <example> - <title>Common Use of Versions</title> - - <informalexample> - <para>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</para> - </informalexample> - </example> - - <example> - <title>A Different Use of Versions</title> - - <informalexample> - <para>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.</para> - </informalexample> - </example> + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the most recent version with + the bug. </para> <para>To create and edit Versions:</para> @@ -824,27 +549,14 @@ <listitem> <para>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.</para> - - <para>Otherwise, click the "Add" button to the right of the "Add a - new version" text.</para> + version "undefined". Click the "Add" link in the bottom right.</para> </listitem> <listitem> - <para>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.</para> + <para>Enter the name of the Version. This field takes text only. + Then click the "Add" button.</para> </listitem> - <listitem> - <para>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.</para> - </listitem> </orderedlist> </section> @@ -853,13 +565,12 @@ <para>Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it - would be assigned the milestone of 3.0. Or, you have a bug that you - plan to fix for 2.8, this would have a milestone of 2.8.</para> + would be assigned the milestone of 3.0.</para> <note> <para>Milestone options will only appear for a Product if you turned - the "usetargetmilestone" field in the "Edit Parameters" screen - "On".</para> + on the "usetargetmilestone" Param in the "Edit Parameters" screen. + </para> </note> <para>To create new Milestones, set Default Milestones, and set @@ -867,345 +578,188 @@ <orderedlist> <listitem> - <para>Select "edit milestones"</para> + <para>Select "Edit milestones" from the "Edit product" page.</para> </listitem> <listitem> - <para>Select "Add" to the right of the "Add a new milestone" + <para>Select "Add" in the bottom right corner. text</para> </listitem> <listitem> <para>Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "Sortkey", which is a positive or negative + 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".</para> - - <example> - <title>Using SortKey with Target Milestone</title> - - <informalexample> - <para>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"</para> - </informalexample> - </example> + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add".</para> </listitem> <listitem> - <para>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. - <note> - <para>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.</para> - </note> - </para> - </listitem> - - <listitem> - <para>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"</para> - - <para>Some common uses of this field include product descriptions, - product roadmaps, and of course a simple description of the meaning - of each milestone.</para> - </listitem> - - <listitem> - <para>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.</para> - - <para>Select the "Update" button when you are done.</para> + <para>From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean. </para> + + <tip> + <para>If you want your milestone document to be restricted so + that it can only be viewed by people in a particular Bugzilla + group, the best way is to attach the document to a bug in that + group, and make the URL the URL of that attachment.</para> + </tip> </listitem> </orderedlist> </section> + </section> + + <section id="voting"> + <title>Voting</title> - <section id="voting"> - <title>Voting</title> - - <para>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.</para> - - <para>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.</para> - - <para>To modify Voting settings:</para> - - <orderedlist> - <listitem> - <para>Navigate to the "Edit product" screen for the Product you - wish to modify</para> - </listitem> + <para>Voting allows users to be given a pot of votes which they can allocate + to bugs, to indicate that they'd like them fixed. + This allows developers to gauge + user need for a particular enhancement or bugfix. By allowing bugs with + a certain number of votes to automatically move from "UNCONFIRMED" to + "NEW", users of the bug system can help high-priority bugs garner + attention so they don't sit for a long time awaiting triage.</para> - <listitem> - <para>Set "Maximum Votes per person" to your calculated value. - Setting this field to "0" disables voting.</para> - </listitem> + <para>To modify Voting settings:</para> - <listitem> - <para>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.</para> - </listitem> + <orderedlist> + <listitem> + <para>Navigate to the "Edit product" screen for the Product you + wish to modify</para> + </listitem> - <listitem> - <para>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? - <tip> - <para>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 - <emphasis>really</emphasis> - - bad bug!</para> - </tip> - </para> - </listitem> + <listitem> + <para><emphasis>Maximum Votes per person</emphasis>: + Setting this field to "0" disables voting.</para> + </listitem> - <listitem> - <para>Once you have adjusted the values to your preference, select - the "Update" button.</para> - </listitem> - </orderedlist> - </section> + <listitem> + <para><emphasis>Maximum Votes a person can put on a single + bug"</emphasis>: + It should probably be some number lower than the + "Maximum votes per person". Don't set this field to "0" if + "Maximum votes per person" is non-zero; that doesn't make + any sense.</para> + </listitem> - <section id="groups"> - <title>Groups and Group Security</title> - - <para>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. - <example> - <title>When to Use Group Security</title> - - <informalexample> - <para>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.</para> - </informalexample> - </example> - - 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.</para> + <listitem> + <para><emphasis>Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state</emphasis>: + Setting this field to "0" disables the automatic move of + bugs from UNCONFIRMED to NEW. + </para> + </listitem> - <note> - <para>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.</para> - - <para>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.</para> - </note> + <listitem> + <para>Once you have adjusted the values to your preference, click + "Update".</para> + </listitem> + </orderedlist> + </section> - <para>To enable Generic Group Security ("usebuggroups"):</para> + <section id="groups"> + <title>Groups and Group Security</title> - <orderedlist> - <listitem> - <para>Turn "On" "usebuggroups" in the "Edit Parameters" - screen.</para> - </listitem> + <para>Groups allow the administrator + to isolate bugs or products that should only be seen by certain people. + There are two types of group - Generic Groups, and Product-Based Groups. + </para> + + <para> + Product-Based Groups are matched with products, and allow you to restrict + access to bugs on a per-product basis. They are enabled using the + usebuggroups Param. Turning on the usebuggroupsentry + Param will mean bugs automatically get added to their product group when + filed. + </para> + + <para> + Generic Groups have no special relationship to products; + you create them, and put bugs in them + as required. One example of the use of Generic Groups + is Mozilla's "Security" group, + into which security-sensitive bugs are placed until fixed. Only the + Mozilla Security Team are members of this group. + </para> + + <para>To create Generic Groups:</para> - <listitem> - <para>You will generally have no groups set up. Select the "groups" - link in the footer.</para> - </listitem> + <orderedlist> + <listitem> + <para>Select the "groups" + link in the footer.</para> + </listitem> - <listitem> - <para>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.</para> - </listitem> + <listitem> + <para>Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.</para> + </listitem> - <listitem> - <para>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. - <example> - <title>Creating a New Group</title> - - <informalexample> - <para>I created a group called DefaultGroup with a description - of - <quote>This is simply a group to play with</quote> - - , and a New User RegExp of - <quote>.*@mydomain.tld</quote> - - . 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.</para> - </informalexample> - </example> - - When you have finished, select the Add button.</para> - </listitem> - </orderedlist> + <listitem> + <para>Fill out the "New Name", "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. + When you have finished, click "Add".</para> + </listitem> + </orderedlist> - <para>To enable Product-Based Group Security - (usebuggroupsentry):</para> + <para>To use Product-Based Groups:</para> - <warning> - <para>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.</para> - </warning> + <orderedlist> + <listitem> + <para>Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit + Parameters" screen.</para> - <orderedlist> - <listitem> - <para>Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen.</para> - - <warning> - <para>"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.</para> - </warning> - </listitem> + <warning> + <para>XXX is this still true? + "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.</para> + </warning> + </listitem> - <listitem> - <para>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.</para> - </listitem> - </orderedlist> + <listitem> + <para>In future, when you create a Product, a matching group will be + automatically created. If you need to add a Product Group to + a Product which was created before you turned on usebuggroups, + then simply create a new group, as outlined above, with the + same name as the Product.</para> + </listitem> + </orderedlist> - <para>You may find this example illustrative for how bug groups work. - <example> - <title>Bugzilla Groups</title> - - <literallayout>Bugzilla Groups example ----------------------- For - this example, let us suppose we have four groups, call them Group1, - Group2, Group3, and Group4. We have 5 users, User1, User2, User3, - User4, User5. We have 8 bugs, Bug1, ..., Bug8. Group membership is - defined by this chart: (X denotes that user is in that group.) (I - apologize for the nasty formatting of this table. Try viewing it in a - text-based browser or something for now. -MPB) G G G G r r r r o o o - o u u u u p p p p 1 2 3 4 +-+-+-+-+ User1|X| | | | +-+-+-+-+ User2| - |X| | | +-+-+-+-+ User3|X| |X| | +-+-+-+-+ User4|X|X|X| | +-+-+-+-+ - User5| | | | | +-+-+-+-+ Bug restrictions are defined by this chart: - (X denotes that bug is restricted to that group.) G G G G r r r r o o - o o u u u u p p p p 1 2 3 4 +-+-+-+-+ Bug1| | | | | +-+-+-+-+ Bug2| - |X| | | +-+-+-+-+ Bug3| | |X| | +-+-+-+-+ Bug4| | | |X| +-+-+-+-+ - Bug5|X|X| | | +-+-+-+-+ Bug6|X| |X| | +-+-+-+-+ Bug7|X|X|X| | - +-+-+-+-+ Bug8|X|X|X|X| +-+-+-+-+ Who can see each bug? Bug1 has no - group restrictions. Therefore, Bug1 can be seen by any user, whatever - their group membership. This is going to be the only bug that User5 - can see, because User5 isn't in any groups. Bug2 can be seen by - anyone in Group2, that is User2 and User4. Bug3 can be seen by anyone - in Group3, that is User3 and User4. Bug4 can be seen by anyone in - Group4. Nobody is in Group4, so none of these users can see Bug4. - Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This - is only User4. User1 cannot see it because he is not in Group2, and - User2 cannot see it because she is not in Group1. Bug6 can be seen by - anyone who is in both Group1 and Group3. This would include User3 and - User4. Similar to Bug5, User1 cannot see Bug6 because he is not in - Group3. Bug7 can be seen by anyone who is in Group1, Group2, and - Group3. This is only User4. All of the others are missing at least - one of those group privileges, and thus cannot see the bug. Bug8 can - be seen by anyone who is in Group1, Group2, Group3, and Group4. There - is nobody in all four of these groups, so nobody can see Bug8. It - doesn't matter that User4 is in Group1, Group2, and Group3, since he - isn't in Group4.</literallayout> - </example> - </para> - </section> + <warning> + <para>Bugzilla currently has a limit of 64 groups per installation. If + you have more than about 50 products, you should consider + running multiple Bugzillas. Ask in the newsgroup for other + suggestions for working around this restriction.</para> + </warning> + + <para> + Note that group permissions are such that you need to be a member + of <emphasis>all</emphasis> the groups a bug is in, for whatever + reason, to see that bug. + </para> </section> + <section id="security"> <title>Bugzilla Security</title> - <epigraph> - <para>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.</para> - </epigraph> - - <note> - <para>Poorly-configured MySQL, Bugzilla, and FTP installations have + <warning> + <para>Poorly-configured MySQL and Bugzilla 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.</para> - </note> + </warning> - <para>Secure your installation. <note> <para>These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different platforms. If you have refinements @@ -1215,11 +769,13 @@ </para> </note> + <para>To secure your installation: + <orderedlist> <listitem> <para>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.</para> + Earlier versions had notable security holes and (from a security + point of view) poor default configuration choices.</para> </listitem> <listitem> @@ -1228,18 +784,9 @@ system!</emphasis> Read - <ulink - url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> + <ulink url="http://www.mysql.com/doc/P/r/Privilege_system.html"> The MySQL Privilege System</ulink> - until you can recite it from memory!</para> - - <para>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 : )</para> </listitem> <listitem> @@ -1273,42 +820,35 @@ <listitem> <para>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.</para> + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. + The localconfig file stores your "bugs" database account password. + In addition, some + files under $BUGZILLA_HOME/data/ store sensitive information. + </para> - <note> - <para>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.</para> - - <para>If you are using a web server that does not support the - .htaccess control method, - <emphasis>you are at risk!</emphasis> - - After installing, check to see if you can view the file - "localconfig" in your web browser (e.g.: - <ulink url="http://bugzilla.mozilla.org/localconfig"> - http://bugzilla.mozilla.org/localconfig</ulink> - - ). 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.</para> - </note> + <para>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.</para> + + <para>If you are using a web server that does not support the + .htaccess control method, + <emphasis>you are at risk!</emphasis> + + After installing, check to see if you can view the file + "localconfig" in your web browser (e.g.: + <ulink url="http://bugzilla.mozilla.org/localconfig"> + http://bugzilla.mozilla.org/localconfig</ulink> + + ). 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.</para> <para>When you run checksetup.pl, the script will attempt to modify various permissions on files which Bugzilla uses. If you do not have @@ -1335,7 +875,7 @@ <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572">Bug 65572</ulink> - for adequate protection in your data/ and shadow/ directories.</para> + for adequate protection in your data/ directory.</para> <para>Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other non-Apache web servers, please consult @@ -1354,15 +894,325 @@ allow from all</literallayout> </para> - <para>Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/shadow directory. - - <literallayout>deny from all</literallayout> - </para> </listitem> </orderedlist> </para> </section> + + <section id="cust-templates"> + <title>Template Customisation</title> + + <para> + One of the large changes for 2.16 was the templatisation of the + entire user-facing UI, using the + <ulink url="http://www.template-toolkit.org">Template Toolkit</ulink>. + Administrators can now configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + </para> + + <para> + Templatisation also makes localised versions of Bugzilla possible, + for the first time. In the future, a Bugzilla installation may + have templates installed for multiple localisations, and select + which ones to use based on the user's browser language setting. + </para> + + <section> + <title>What to Edit</title> + <para> + There are two different ways of editing of Bugzilla's templates, + and which you use depends mainly on how you upgrade Bugzilla. The + template directory structure is that there's a top level directory, + <filename>template</filename>, which contains a directory for + each installed localisation. The default English templates are + therefore in <filename>en</filename>. Underneath that, there + is the <filename>default</filename> directory and optionally the + <filename>custom</filename> directory. The <filename>default</filename> + directory contains all the templates shipped with Bugzilla, whereas + the <filename>custom</filename> directory does not exist at first and + must be created if you want to use it. + </para> + + <para> + The first method of making customisations is to directly edit the + templates in <filename>template/en/default</filename>. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + <command>cvs update</command>, any template fixes will get + automagically merged into your modified versions. + </para> + + <para> + If you use this method, your installation will break if CVS conflicts + occur. + </para> + + <para> + The other method is to copy the templates into a mirrored directory + structure under <filename>template/en/custom</filename>. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. + </para> + + <para> + If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. + </para> + + <note> + <para> + Don't directly edit the compiled templates in + <filename class="directory">data/template/*</filename> - your + changes will be lost when Template Toolkit recompiles them. + </para> + </note> + </section> + + <section> + <title>How To Edit Templates</title> + + <para> + The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + <ulink url="http://www.template-toolkit.org">Template Toolkit home + page</ulink>. However, you should particularly remember (for security + reasons) to always HTML filter things which come from the database or + user input, to prevent cross-site scripting attacks. + </para> + + <para> + However, one thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you fail to do this, you may open up + your installation to cross-site scripting attacks. + </para> + + <para> + Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. + </para> + + <para> + Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + </para> + + <note> + <para> + If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + <ulink url="http://www.bugzilla.org/developerguide.html">Developers' + Guide</ulink>. + </para> + </note> + </section> + + + <section> + <title>Template Formats</title> + + <para> + Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending <filename>&format=simple</filename> to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. + </para> + + <para> + To see if a CGI supports multiple output formats, grep the + CGI for "ValidateOutputFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs. + </para> + + <para> + To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. + </para> + + <para> + Write your template in whatever markup or text style is appropriate. + </para> + + <para> + You now need to decide what content type you want your template + served as. Open up the <filename>localconfig</filename> file and find the + <filename>$contenttypes</filename> + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. + </para> + + <para> + Save the template as <filename><stubname>-<formatname>.<contenttypetag>.tmpl</filename>. + Try out the template by calling the CGI as + <filename><cginame>.cgi?format=<formatname></filename> . + </para> + </section> + + + <section> + <title>Particular Templates</title> + + <para> + There are a few templates you may be particularly interested in + customising for your installation. + </para> + + <para> + <command>index.html.tmpl</command>: + This is the Bugzilla front page. + </para> + + <para> + <command>global/header.html.tmpl</command>: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + </para> + + <para> + <command>global/banner.html.tmpl</command>: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customise this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + </para> + + <para> + <command>global/footer.html.tmpl</command>: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + </para> + + <para> + <command>bug/create/user-message.html.tmpl</command>: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + </para> + + <para> + <command>bug/create/create.html.tmpl</command> and + <command>bug/create/comment.txt.tmpl</command>: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided">guided + bug submission form</ulink>. + </para> + + <para> + To make this work, create a custom template for + <filename>enter_bug.cgi</filename> (the default template, on which you + could base it, is <filename>create.html.tmpl</filename>), + and either call it <filename>create.html.tmpl</filename> or use a format and + call it <filename>create-<formatname>.html.tmpl</filename>. + Put it in the <filename class="directory">custom/bug/create</filename> + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + </para> + + <para> + Then, create a template like + <filename>custom/bug/create/comment.txt.tmpl</filename>, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + </para> + + <para> + For example, if your enter_bug template had a field + <programlisting><input type="text" name="buildid" size="30"></programlisting> + and then your comment.txt.tmpl had + <programlisting>BuildID: [% form.buildid %]</programlisting> + then + <programlisting>BuildID: 20020303</programlisting> + would appear in the initial checkin comment. + </para> + </section> + + </section> + + <section id="upgrading"> + <title>Upgrading to New Releases</title> + + <para>A plain Bugzilla is fairly easy to upgrade from one version to a + newer one. Always read the release notes to see if there are any issues + that you might need to take note of. It is recommended that you take a + backup of your database and your entire Bugzilla installation before attempting an + upgrade. You can upgrade a 'clean' installation by untarring a new + tarball over the old installation. If you are upgrading from 2.12 or + later, and have cvs installed, you can type <filename>cvs -z3 update</filename>, + and resolve conflicts if there are any. + </para> + + <para>However, things get a bit more complicated if you've made + changes to Bugzilla's code. In this case, you may have to re-make or + reapply those changes. One good method is to take a diff of your customised + version against the original, so you can survey all that you've changed. + Hopefully, templatisation will reduce the need for + this in the future.</para> + + <para>From version 2.8 onwards, Bugzilla databases can be automatically + carried forward during an upgrade. However, because the developers of + Bugzilla are constantly adding new + tables, columns and fields, you'll probably get SQL errors if you just + update the code and attempt to use Bugzilla. Always run the + <filename>checksetup.pl</filename> + script whenever you upgrade your installation.</para> + + <para>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.</para> + </section> + + <!-- Integrating Bugzilla with Third-Party Tools --> + &integration; + </chapter> <!-- Keep this comment at the end of the file diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml index f6aa00338..7334b02b8 100644 --- a/docs/sgml/conventions.sgml +++ b/docs/sgml/conventions.sgml @@ -6,7 +6,7 @@ <primary>conventions</primary> </indexterm> - <para>This document uses the following conventions</para> + <para>This document uses the following conventions:</para> <informaltable frame="none"> <tgroup cols="2"> @@ -34,7 +34,7 @@ <entry> <tip> - <para>Warm jar lids under the hot tap to loosen them.</para> + <para>Would you like a breath mint?</para> </tip> </entry> </row> @@ -63,7 +63,7 @@ <entry>File Names</entry> <entry> - <filename>file.extension</filename> + <filename>filename</filename> </entry> </row> @@ -138,12 +138,9 @@ <entry>Code Example</entry> <entry> - <programlisting> - <sgmltag class="starttag">para</sgmltag> - - Beginning and end of paragraph - <sgmltag class="endtag">para</sgmltag> - </programlisting> + <programlisting><sgmltag class="starttag">para</sgmltag> +Beginning and end of paragraph +<sgmltag class="endtag">para</sgmltag></programlisting> </entry> </row> </tbody> diff --git a/docs/sgml/database.sgml b/docs/sgml/database.sgml index 4cba46a48..d758259da 100644 --- a/docs/sgml/database.sgml +++ b/docs/sgml/database.sgml @@ -123,10 +123,10 @@ ! 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 - .</para> + "Security"), or more robust security generalities in the + <ulink url="http://www.mysql.com/php/manual.php3?section=Privilege_system">MySQL + searchable documentation</ulink>. + </para> </listitem> <listitem> @@ -150,13 +150,6 @@ <command>use bugs;</command> </para> - <note> - <para>Don't forget the - <quote>;</quote> - - at the end of each line, or you'll be kicking yourself - later.</para> - </note> </listitem> </orderedlist> </para> @@ -169,273 +162,212 @@ <para> <prompt>mysql></prompt> - <command>show tables from bugs;</command> </para> - <para>you'll be able to see all the + <para>you'll be able to see the names of all the <quote>spreadsheets</quote> + (tables) in your database.</para> + + <para>From the command issued above, ou should have some + output that looks like this: +<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 | ++-------------------+ +</programlisting> +</para> + +<literallayout> + Here's an overview of what each table does. Most columns in each table have +descriptive names that make it fairly trivial to figure out their jobs. + +attachments: This table stores all attachments to bugs. It tends to be your +largest table, yet also generally has the fewest entries because file +attachments are so (relatively) large. + +bugs: This is the core of your system. The bugs table stores most of the +current information about a bug, with the exception of the info stored in the +other tables. + +bugs_activity: This stores information regarding what changes are made to bugs +when -- a history file. + +cc: This tiny table simply stores all the CC information for any bug which has +any entries in the CC field of the bug. Note that, like most other tables in +Bugzilla, it does not refer to users by their user names, but by their unique +userid, stored as a primary key in the profiles table. + +components: This stores the programs and components (or products and +components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program" +(product) field is the full name of the product, rather than some other unique +identifier, like bug_id and user_id are elsewhere in the database. + +dependencies: Stores data about those cool dependency trees. + +fielddefs: A nifty table that defines other tables. For instance, when you +submit a form that changes the value of "AssignedTo" this table allows +translation to the actual field name "assigned_to" for entry into MySQL. + +groups: defines bitmasks for groups. A bitmask is a number that can uniquely +identify group memberships. For instance, say the group that is allowed to +tweak parameters is assigned a value of "1", the group that is allowed to edit +users is assigned a "2", and the group that is allowed to create new groups is +assigned the bitmask of "4". By uniquely combining the group bitmasks (much +like the chmod command in UNIX,) you can identify a user is allowed to tweak +parameters and create groups, but not edit users, by giving him a bitmask of +"5", or a user allowed to edit users and create groups, but not tweak +parameters, by giving him a bitmask of "6" Simple, huh? + If this makes no sense to you, try this at the mysql prompt: +mysql> select * from groups; + You'll see the list, it makes much more sense that way. + +keyworddefs: Definitions of keywords to be used + +keywords: Unlike what you'd think, this table holds which keywords are +associated with which bug id's. + +logincookies: This stores every login cookie ever assigned to you for every +machine you've ever logged into Bugzilla from. Curiously, it never does any +housecleaning -- I see cookies in this file I've not used for months. However, +since Bugzilla never expires your cookie (for convenience' sake), it makes +sense. + +longdescs: The meat of bugzilla -- here is where all user comments are stored! +You've only got 2^24 bytes per comment (it's a mediumtext field), so speak +sparingly -- that's only the amount of space the Old Testament from the Bible +would take (uncompressed, 16 megabytes). Each comment is keyed to the +bug_id to which it's attached, so the order is necessarily chronological, for +comments are played back in the order in which they are received. + +milestones: Interesting that milestones are associated with a specific product +in this table, but Bugzilla does not yet support differing milestones by +product through the standard configuration interfaces. + +namedqueries: This is where everybody stores their "custom queries". Very +cool feature; it beats the tar out of having to bookmark each cool query you +construct. + +products: What products you have, whether new bug entries are allowed for the +product, what milestone you're working toward on that product, votes, etc. It +will be nice when the components table supports these same features, so you +could close a particular component for bug entry without having to close an +entire product... + +profiles: Ahh, so you were wondering where your precious user information was +stored? Here it is! With the passwords in plain text for all to see! (but +sshh... don't tell your users!) + +profiles_activity: Need to know who did what when to who's profile? This'll +tell you, it's a pretty complete history. + +shadowlog: I could be mistaken here, but I believe this table tells you when +your shadow database is updated and what commands were used to update it. We +don't use a shadow database at our site yet, so it's pretty empty for us. + +versions: Version information for every product + +votes: Who voted for what when + +watch: Who (according to userid) is watching who's bugs (according to their +userid). - (tables) in your database. It is similar to a file system, only - faster and more robust for certain types of operations.</para> - - <para>From the command issued above, ou should have some output that - looks like this: - <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 | +-------------------+</programlisting> - </para> - <literallayout>Here's an overview of what each table does. Most - columns in each table have descriptive names that make it fairly - trivial to figure out their jobs. attachments: This table stores all - attachments to bugs. It tends to be your largest table, yet also - generally has the fewest entries because file attachments are so - (relatively) large. bugs: This is the core of your system. The bugs - table stores most of the current information about a bug, with the - exception of the info stored in the other tables. bugs_activity: This - stores information regarding what changes are made to bugs when -- a - history file. cc: This tiny table simply stores all the CC - information for any bug which has any entries in the CC field of the - bug. Note that, like most other tables in Bugzilla, it does not refer - to users by their user names, but by their unique userid, stored as a - primary key in the profiles table. components: This stores the - programs and components (or products and components, in newer - Bugzilla parlance) for Bugzilla. Curiously, the "program" (product) - field is the full name of the product, rather than some other unique - identifier, like bug_id and user_id are elsewhere in the database. - dependencies: Stores data about those cool dependency trees. - fielddefs: A nifty table that defines other tables. For instance, - when you submit a form that changes the value of "AssignedTo" this - table allows translation to the actual field name "assigned_to" for - entry into MySQL. groups: defines bitmasks for groups. A bitmask is a - number that can uniquely identify group memberships. For instance, - say the group that is allowed to tweak parameters is assigned a value - of "1", the group that is allowed to edit users is assigned a "2", - and the group that is allowed to create new groups is assigned the - bitmask of "4". By uniquely combining the group bitmasks (much like - the chmod command in UNIX,) you can identify a user is allowed to - tweak parameters and create groups, but not edit users, by giving him - a bitmask of "5", or a user allowed to edit users and create groups, - but not tweak parameters, by giving him a bitmask of "6" Simple, huh? - If this makes no sense to you, try this at the mysql prompt: - mysql> select * from groups; You'll see the list, it makes much - more sense that way. keyworddefs: Definitions of keywords to be used - keywords: Unlike what you'd think, this table holds which keywords - are associated with which bug id's. logincookies: This stores every - login cookie ever assigned to you for every machine you've ever - logged into Bugzilla from. Curiously, it never does any housecleaning - -- I see cookies in this file I've not used for months. However, - since Bugzilla never expires your cookie (for convenience' sake), it - makes sense. longdescs: The meat of bugzilla -- here is where all - user comments are stored! You've only got 2^24 bytes per comment - (it's a mediumtext field), so speak sparingly -- that's only the - amount of space the Old Testament from the Bible would take - (uncompressed, 16 megabytes). Each comment is keyed to the bug_id to - which it's attached, so the order is necessarily chronological, for - comments are played back in the order in which they are received. - milestones: Interesting that milestones are associated with a - specific product in this table, but Bugzilla does not yet support - differing milestones by product through the standard configuration - interfaces. namedqueries: This is where everybody stores their - "custom queries". Very cool feature; it beats the tar out of having - to bookmark each cool query you construct. products: What products - you have, whether new bug entries are allowed for the product, what - milestone you're working toward on that product, votes, etc. It will - be nice when the components table supports these same features, so - you could close a particular component for bug entry without having - to close an entire product... profiles: Ahh, so you were wondering - where your precious user information was stored? Here it is! With the - passwords in plain text for all to see! (but sshh... don't tell your - users!) profiles_activity: Need to know who did what when to who's - profile? This'll tell you, it's a pretty complete history. shadowlog: - I could be mistaken here, but I believe this table tells you when - your shadow database is updated and what commands were used to update - it. We don't use a shadow database at our site yet, so it's pretty - empty for us. versions: Version information for every product votes: - Who voted for what when watch: Who (according to userid) is watching - who's bugs (according to their userid). === THE DETAILS === Ahh, so - you're wondering just what to do with the information above? At the - mysql prompt, you can view any information about the columns in a - table with this command (where "table" is the name of the table you - wish to view): mysql> show columns from table; You can also view - all the data in a table with this command: mysql> select * from - table; -- note: this is a very bad idea to do on, for instance, the - "bugs" table if you have 50,000 bugs. You'll be sitting there a while - until you ctrl-c or 50,000 bugs play across your screen. You can - limit the display from above a little with the command, where - "column" is the name of the column for which you wish to restrict - information: mysql> select * from table where (column = "some - info"); -- or the reverse of this mysql> select * from table where - (column != "some info"); Let's take our example from the - introduction, and assume you need to change the word "verified" to - "approved" in the resolution field. We know from the above - information that the resolution is likely to be stored in the "bugs" - table. Note we'll need to change a little perl code as well as this - database change, but I won't plunge into that in this document. Let's - verify the information is stored in the "bugs" table: mysql> show - columns from bugs (exceedingly long output truncated here) | - bug_status| - enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL - | UNCONFIRMED|| Sorry about that long line. We see from this that the - "bug status" column is an "enum field", which is a MySQL peculiarity - where a string type field can only have certain types of entries. - While I think this is very cool, it's not standard SQL. Anyway, we - need to add the possible enum field entry 'APPROVED' by altering the - "bugs" table. mysql> ALTER table bugs CHANGE bug_status bug_status - -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED", - -> "VERIFIED", "APPROVED", "CLOSED") not null; (note we can take - three lines or more -- whatever you put in before the semicolon is - evaluated as a single expression) Now if you do this: mysql> show - columns from bugs; you'll see that the bug_status field has an extra - "APPROVED" enum that's available! Cool thing, too, is that this is - reflected on your query page as well -- you can query by the new - status. But how's it fit into the existing scheme of things? Looks - like you need to go back and look for instances of the word - "verified" in the perl code for Bugzilla -- wherever you find - "verified", change it to "approved" and you're in business (make sure - that's a case-insensitive search). Although you can query by the enum - field, you can't give something a status of "APPROVED" until you make - the perl changes. Note that this change I mentioned can also be done - by editing checksetup.pl, which automates a lot of this. But you need - to know this stuff anyway, right? I hope this database tutorial has - been useful for you. If you have comments to add, questions, - concerns, etc. please direct them to mbarnson@excitehome.net. Please - direct flames to /dev/null :) Have a nice day! === LINKS === Great - MySQL tutorial site: - http://www.devshed.com/Server_Side/MySQL/</literallayout> +=== +THE DETAILS +=== + + Ahh, so you're wondering just what to do with the information above? At the +mysql prompt, you can view any information about the columns in a table with +this command (where "table" is the name of the table you wish to view): + +mysql> show columns from table; + + You can also view all the data in a table with this command: + +mysql> select * from table; + + -- note: this is a very bad idea to do on, for instance, the "bugs" table if +you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or +50,000 bugs play across your screen. + + You can limit the display from above a little with the command, where +"column" is the name of the column for which you wish to restrict information: + +mysql> select * from table where (column = "some info"); + + -- or the reverse of this + +mysql> select * from table where (column != "some info"); + + Let's take our example from the introduction, and assume you need to change +the word "verified" to "approved" in the resolution field. We know from the +above information that the resolution is likely to be stored in the "bugs" +table. Note we'll need to change a little perl code as well as this database +change, but I won't plunge into that in this document. Let's verify the +information is stored in the "bugs" table: + +mysql> show columns from bugs + + (exceedingly long output truncated here) +| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED|| + + Sorry about that long line. We see from this that the "bug status" column is +an "enum field", which is a MySQL peculiarity where a string type field can +only have certain types of entries. While I think this is very cool, it's not +standard SQL. Anyway, we need to add the possible enum field entry +'APPROVED' by altering the "bugs" table. + +mysql> ALTER table bugs CHANGE bug_status bug_status + -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED", + -> "VERIFIED", "APPROVED", "CLOSED") not null; + + (note we can take three lines or more -- whatever you put in before the +semicolon is evaluated as a single expression) + +Now if you do this: + +mysql> show columns from bugs; + + you'll see that the bug_status field has an extra "APPROVED" enum that's +available! Cool thing, too, is that this is reflected on your query page as +well -- you can query by the new status. But how's it fit into the existing +scheme of things? + Looks like you need to go back and look for instances of the word "verified" +in the perl code for Bugzilla -- wherever you find "verified", change it to +"approved" and you're in business (make sure that's a case-insensitive search). +Although you can query by the enum field, you can't give something a status +of "APPROVED" until you make the perl changes. Note that this change I +mentioned can also be done by editing checksetup.pl, which automates a lot of +this. But you need to know this stuff anyway, right? + </literallayout> </section> </section> </section> - <section id="granttables"> - <title>MySQL Permissions & Grant Tables</title> - - <note> - <para>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.</para> - - <para>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.</para> - </note> - - <literallayout>From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 - Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson - matt_barnson@singletrac.com To: keystone-users@homeport.org Subject: - [keystone-users] Grant Tables FAQ [The following text is in the - "iso-8859-1" character set] [Your display is set for the "US-ASCII" - character set] [Some characters may be displayed incorrectly] Maybe we - can include this rambling message in the Keystone FAQ? It gets asked a - lot, and the only option current listed in the FAQ is - "--skip-grant-tables". Really, you can't go wrong by reading section 6 of - the MySQL manual, at http://www.mysql.com/Manual/manual.html. I am sure - their description is better than mine. MySQL runs fine without - permissions set up correctly if you run the mysql daemon with the - "--skip-grant-tables" option. Running this way denies access to nobody. - Unfortunately, unless you've got yourself firewalled it also opens the - potential for abuse if someone knows you're running it. Additionally, the - default permissions for MySQL allow anyone at localhost access to the - database if the database name begins with "test_" or is named "test" - (i.e. "test_keystone"). You can change the name of your database in the - keystone.conf file ($sys_dbname). This is the way I am doing it for some - of my databases, and it works fine. The methods described below assume - you're running MySQL on the same box as your webserver, and that you - don't mind if your $sys_dbuser for Keystone has superuser access. See - near the bottom of this message for a description of what each field - does. Method #1: 1. cd /var/lib #location where you'll want to run - /usr/bin/mysql_install_db shell script from to get it to work. 2. ln -s - mysql data # soft links the "mysql" directory to "data", which is what - mysql_install_db expects. Alternately, you can edit mysql_install_db and - change all the "./data" references to "./mysql". 3. Edit - /usr/bin/mysql_install_db with your favorite text editor (vi, emacs, jot, - pico, etc.) A) Copy the "INSERT INTO db VALUES - ('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately - after itself. Chage the 'test\_%' value to 'keystone', or the value of - $sys_dbname in keystone.conf. B) If you are running your keystone - database with any user, you'll need to copy the "INSERT INTO user VALUES - ('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line - after itself and change 'root' to the name of the keystone database user - ($sys_dbuser) in keystone.conf. # adds entries to the script to create - grant tables for specific hosts and users. The user you set up has - super-user access ($sys_dbuser) -- you may or may not want this. The - layout of mysql_install_db is really very uncomplicated. 4. - /usr/bin/mysqladmin shutdown # ya gotta shut it down before you can - reinstall the grant tables! 5. rm -i /var/lib/mysql/mysql/*.IS?' and - answer 'Y' to the deletion questions. # nuke your current grant tables. - This WILL NOT delete any other databases than your grant tables. 6. - /usr/bin/mysql_install_db # run the script you just edited to install - your new grant tables. 7. mysqladmin -u root password (new_password) # - change the root MySQL password, or else anyone on localhost can login to - MySQL as root and make changes. You can skip this step if you want - keystone to connect as root with no password. 8. mysqladmin -u - (webserver_user_name) password (new_password) # change the password of - the $sys_dbuser. Note that you will need to change the password in the - keystone.conf file as well in $sys_dbpasswd, and if your permissions are - set up incorrectly anybody can type the URL to your keystone.conf file - and get the password. Not that this will help them much if your - permissions are set to @localhost. Method #2: easier, but a pain - reproducing if you have to delete your grant tables. This is the - "recommended" method for altering grant tables in MySQL. I don't use it - because I like the other way :) shell> mysql --user=root keystone - mysql> GRANT - SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS, - FILE, ON keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY - '(password)' WITH GRANT OPTION; OR mysql> GRANT ALL PRIVILEGES ON - keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY - '(password)' WITH GRANT OPTION; # this grants the required permissions to - the keystone ($sys_dbuser) account defined in keystone.conf. However, if - you are runnning many different MySQL-based apps, as we are, it's - generally better to edit the mysql_install_db script to be able to - quickly reproduce your permissions structure again. Note that the FILE - privelege and WITH GRANT OPTION may not be in your best interest to - include. GRANT TABLE FIELDS EXPLANATION: Quick syntax summary: "%" in - MySQL is a wildcard. I.E., if you are defining your DB table and in the - 'host' field and enter '%', that means that any host can access that - database. Of course, that host must also have a valid db user in order to - do anything useful. 'db'=name of database. In our case, it should be - "keystone". "user" should be your "$sys_dbuser" defined in keystone.conf. - Note that you CANNOT add or change a password by using the "INSERT INTO - db (X)" command -- you must change it with the mysql -u command as - defined above. Passwords are stored encrypted in the MySQL database, and - if you try to enter it directly into the table they will not match. - TABLE: USER. Everything after "password" is a privelege granted (Y/N). - This table controls individual user global access rights. - 'host','user','password','select','insert','update','delete','index','alter' - ,'create','drop','grant','reload','shutdown','process','file' TABLE: DB. - This controls access of USERS to databases. - 'host','db','user','select','insert','update','delete','index','alter','crea - te','drop','grant' TABLE: HOST. This controls which HOSTS are allowed - what global access rights. Note that the HOST table, USER table, and DB - table are very closely connected -- if an authorized USER attempts an SQL - request from an unauthorized HOST, she's denied. If a request from an - authorized HOST is not an authorized USER, it is denied. If a globally - authorized USER does not have rights to a certain DB, she's denied. Get - the picture? - 'host','db','select','insert','update','delete','index','alter','create','dr - op','grant' You should now have a working knowledge of MySQL grant - tables. If there is anything I've left out of this answer that you feel - is pertinent, or if my instructions don't work for you, please let me - know and I'll re-post this letter again, corrected. I threw it together - one night out of exasperation for all the newbies who don't know squat - about MySQL yet, so it is almost guaranteed to have errors. Once again, - you can't go wrong by reading section 6 of the MySQL manual. It is more - detailed than I! http://www.mysql.com/Manual/manual.html.</literallayout> - </section> </appendix> <!-- Keep this comment at the end of the file diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml index f7fafd3e8..91380863f 100644 --- a/docs/sgml/faq.sgml +++ b/docs/sgml/faq.sgml @@ -3,6 +3,10 @@ <appendix id="faq"> <title>The Bugzilla FAQ</title> + <para> + This FAQ includes questions not covered elsewhere in the Guide. + </para> + <qandaset> @@ -121,9 +125,9 @@ </question> <answer> <para> - A year has gone by, and I <emphasis>still</emphasis> can't - find any head-to-head comparisons of Bugzilla against - other defect-tracking software. However, from my personal + We can't find any head-to-head comparisons of Bugzilla against + other defect-tracking software. If you know of one, please + get in touch. However, from the author's personal experience with other bug-trackers, Bugzilla offers superior performance on commodity hardware, better price (free!), more developer- friendly features (such as stored @@ -133,24 +137,9 @@ </para> <para> 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. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I change my user name (email address) in Bugzilla? - </para> - </question> - <answer> - <para> - New in 2.16 - go to the Account section of the Preferences. You will - be emailed at both addresses for confirmation. + step forward with a list of advantages your product has over + Bugzilla. We'd be happy to include it in the "Competitors" + section. </para> </answer> </qandaentry> @@ -184,7 +173,7 @@ <question> <para> Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </para> </question> <answer> @@ -204,42 +193,41 @@ </question> <answer> <para> - 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. - </para> - <para> - Here's Terry Weissman's comment, for some historical context: - <blockquote> - <para> - [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. - </para> - <note> + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally + Terry wanted a place to put a version of Perl and other tools + that was strictly under his control. + </para> <para> 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 + as /usr/bonsaitools/bin/perl, and simply add symlink. + This will make upgrading your Bugzilla much easier in the future. </para> - </note> - </blockquote> - </para> </answer> </qandaentry> + + <qandaentry> + <question> + <para> + Is there an easy way to change the Bugzilla cookie name? + </para> + </question> + <answer> + <para> + At present, no. + </para> + </answer> + </qandaentry> + </qandadiv> <qandadiv id="faq-phb"> - <title>Pointy-Haired-Boss Questions</title> + <title>Managerial Questions</title> <para> <note> <para> - 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 :) + Questions likely to be asked by managers. :-) </para> </note> </para> @@ -247,8 +235,8 @@ <qandaentry> <question> <para> - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </para> </question> <answer> @@ -262,7 +250,7 @@ <qandaentry> <question> <para> - Has anyone you know of already done any Bugzilla integration with + Can Bugzilla integrate with Perforce (SCM software)? </para> </question> @@ -282,11 +270,10 @@ </question> <answer> <para> - 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. + Absolutely! You can track any number of Products (although you + are limited to about 55 or so if + you are using Product-Based Groups), that can each be composed of any + number of Components. </para> </answer> </qandaentry> @@ -308,7 +295,7 @@ <qandaentry> <question> <para> - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, + Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? </para> </question> @@ -346,19 +333,6 @@ </answer> </qandaentry> - - <qandaentry> - <question> - <para> - 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. - </para> - </question> - <answer> - <para>If you upgrade to 2.16, the index page has a footer. - </para> - </answer> - </qandaentry> <qandaentry> <question> <para> @@ -370,7 +344,7 @@ <para> Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi"> http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting - facilities. + and graphing facilities. </para> <para> For more advanced reporting, I recommend hooking up a professional @@ -387,7 +361,7 @@ <question> <para> 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? + email? </para> </question> <answer> @@ -416,7 +390,7 @@ <qandaentry> <question> <para> - If there is email notification, do users have to have any particular + Do users have to have any particular type of email application? </para> </question> @@ -441,24 +415,6 @@ <qandaentry> <question> <para> - 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.? - </para> - </question> - <answer> - <para> - 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. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> 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 @@ -523,33 +479,6 @@ <qandaentry> <question> <para> - Can a user re-run a report with a new project, same query? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Can a user modify an existing report and then save it into another name? - </para> - </question> - <answer> - <para> - You can save an unlimited number of queries in Bugzilla. You are free - to modify them and rename them to your heart's desire. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> Does Bugzilla have the ability to search by word, phrase, compound search? </para> @@ -565,20 +494,6 @@ <qandaentry> <question> <para> - Can the admin person establish separate group and individual user - privileges? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> 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? @@ -635,9 +550,8 @@ </question> <answer> <para> - 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". + If Bugzilla is set up correctly from the start, continuing maintenance + needs are minimal and can be done easily using the web interface. </para> <para> Commercial Bug-tracking software typically costs somewhere upwards @@ -686,52 +600,6 @@ </qandaentry> </qandadiv> - <qandadiv id="faq-install"> - <title>Bugzilla Installation</title> - <qandaentry> - <question> - <para> - How do I download and install Bugzilla? - </para> - </question> - <answer> - <para> - Check <ulink url="http://www.bugzilla.org/"> - http://www.bugzilla.org/</ulink> for details. - Read the other parts of this Guide for installation instructions. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I install Bugzilla on Windows NT? - </para> - </question> - <answer> - <para> - Installation on Windows NT has its own section in - this document. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Is there an easy way to change the Bugzilla cookie name? - </para> - </question> - <answer> - <para> - At present, no. - </para> - </answer> - </qandaentry> - - </qandadiv> - <qandadiv id="faq-security"> <title>Bugzilla Security</title> @@ -739,15 +607,14 @@ <question> <para> 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!)? + (I've followed the instructions in the installation section of this guide)? </para> </question> <answer> <para> Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this makes MySQL as secure as taping a $100 to the floor of a football stadium - bathroom for safekeeping.</emphasis> Please read the Security section of the - Administration chapter of "The Bugzilla Guide" before proceeding. + bathroom for safekeeping.</emphasis> </para> </answer> </qandaentry> @@ -815,8 +682,8 @@ </question> <answer> <para> - Edit the "changedmail" param. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)". + Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". </para> </answer> </qandaentry> @@ -1002,7 +869,7 @@ <qandaentry> <question> <para> - I think I've set up MySQL permissions correctly, but bugzilla still can't + I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </para> </question> @@ -1162,6 +1029,20 @@ <qandaentry> <question> <para> + How do I change my user name (email address) in Bugzilla? + </para> + </question> + <answer> + <para> + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> The query page is very confusing. Isn't there a simpler way to query? </para> </question> @@ -1184,7 +1065,7 @@ <answer> <para> The current behavior is acceptable to bugzilla.mozilla.org and most - users. I personally don't like it. You have your choice of patches + users. You have your choice of patches to change this behavior, however. <simplelist> <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> @@ -1192,8 +1073,8 @@ <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> "Accept" button automatically assigns to you</ulink></member> </simplelist> - 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. + Note that these patches are somewhat dated. You will need to apply + them manually. </para> </answer> </qandaentry> @@ -1224,7 +1105,7 @@ <answer> <para> 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 + filename. This will not be fixed anytime soon, because it would cripple some other functionality. </para> </answer> @@ -1288,9 +1169,7 @@ http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your localconfig file in the appropriate area, re-running checksetup.pl, and then changing the default priority in your browser using - "editparams.cgi". 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... + "editparams.cgi". </para> </answer> </qandaentry> @@ -1325,7 +1204,7 @@ <listitem> <para> Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) 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 diff --git a/docs/sgml/gfdl.sgml b/docs/sgml/gfdl.sgml index d9e18de38..047646411 100644 --- a/docs/sgml/gfdl.sgml +++ b/docs/sgml/gfdl.sgml @@ -1,10 +1,10 @@ <!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="gfdl"> +<section id="gfdl"> <title>GNU Free Documentation License</title> <!-- - GNU Project - Free Software Foundation (FSF) --> <!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" --> -<!-- sect1> +<!-- section> <title>GNU Free Documentation License</title --> <para>Version 1.1, March 2000</para> @@ -15,7 +15,7 @@ not allowed.</para> </blockquote> - <sect1 label="0" id="gfdl-0"> + <section label="0" id="gfdl-0"> <title>PREAMBLE</title> <para>The purpose of this License is to make a manual, textbook, or other @@ -38,9 +38,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="1" id="gfdl-1"> + <section label="1" id="gfdl-1"> <title>APPLICABILITY AND DEFINITIONS</title> <para>This License applies to any manual or other work that contains a @@ -98,9 +98,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="2" id="gfdl-2"> + <section label="2" id="gfdl-2"> <title>VERBATIM COPYING</title> <para>You may copy and distribute the Document in any medium, either @@ -115,9 +115,9 @@ <para>You may also lend copies, under the same conditions stated above, and you may publicly display copies.</para> - </sect1> + </section> - <sect1 label="3" id="gfdl-3"> + <section label="3" id="gfdl-3"> <title>COPYING IN QUANTITY</title> <para>If you publish printed copies of the Document numbering more than @@ -154,9 +154,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="4" id="gfdl-4"> + <section label="4" id="gfdl-4"> <title>MODIFICATIONS</title> <para>You may copy and distribute a Modified Version of the Document @@ -284,9 +284,9 @@ <para>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.</para> - </sect1> + </section> - <sect1 label="5" id="gfdl-5"> + <section label="5" id="gfdl-5"> <title>COMBINING DOCUMENTS</title> <para>You may combine the Document with other documents released under @@ -310,9 +310,9 @@ "History"; likewise combine any sections entitled "Acknowledgements", and any sections entitled "Dedications". You must delete all sections entitled "Endorsements."</para> - </sect1> + </section> - <sect1 label="6" id="gfdl-6"> + <section label="6" id="gfdl-6"> <title>COLLECTIONS OF DOCUMENTS</title> <para>You may make a collection consisting of the Document and other @@ -326,9 +326,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="7" id="gfdl-7"> + <section label="7" id="gfdl-7"> <title>AGGREGATION WITH INDEPENDENT WORKS</title> <para>A compilation of the Document or its derivatives with other @@ -345,9 +345,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="8" id="gfdl-8"> + <section label="8" id="gfdl-8"> <title>TRANSLATION</title> <para>Translation is considered a kind of modification, so you may @@ -360,9 +360,9 @@ License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.</para> - </sect1> + </section> - <sect1 label="9" id="gfdl-9"> + <section label="9" id="gfdl-9"> <title>TERMINATION</title> <para>You may not copy, modify, sublicense, or distribute the Document @@ -372,9 +372,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="10" id="gfdl-10"> + <section label="10" id="gfdl-10"> <title>FUTURE REVISIONS OF THIS LICENSE</title> <para>The Free Software Foundation may publish new, revised versions of @@ -394,9 +394,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="" id="gfdl-howto"> + <section label="" id="gfdl-howto"> <title>How to use this License for your documents</title> <para>To use this License in a document you have written, include a copy @@ -422,8 +422,8 @@ 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.</para> - </sect1> -</appendix> + </section> +</section> <!-- Keep this comment at the end of the file Local variables: diff --git a/docs/sgml/glossary.sgml b/docs/sgml/glossary.sgml index 3e40df58a..cc5d4fb69 100644 --- a/docs/sgml/glossary.sgml +++ b/docs/sgml/glossary.sgml @@ -15,10 +15,7 @@ to keep secret files which would otherwise compromise your installation - e.g. the <filename>localconfig</filename> - - 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 + file contains the password to your database. curious.</para> </glossdef> </glossentry> @@ -56,7 +53,7 @@ <glossdef> <para>A - <quote>Bug</quote> + <quote>bug</quote> in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Some also refer to a @@ -71,33 +68,19 @@ <glossterm>Bug Number</glossterm> <glossdef> - <para>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 + <para>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.</para> </glossdef> </glossentry> <glossentry> - <glossterm>Bug Life Cycle</glossterm> - - <glossdef> - <para>A Bug has stages through which it must pass before becoming a - <quote>closed bug</quote>, - including acceptance, resolution, and verification. The - <quote>Bug Life Cycle</quote> - - is moderately flexible according to the needs of the organization - using it, though.</para> - </glossdef> - </glossentry> - - <glossentry> <glossterm>Bugzilla</glossterm> <glossdef> - <para>Bugzilla is the industry-standard bug tracking system. It is - quite popular among Open Source enthusiasts.</para> + <para>Bugzilla is the world-leading free software bug tracking system. + </para> </glossdef> </glossentry> </glossdiv> @@ -127,14 +110,11 @@ <acronym>CPAN</acronym> stands for the - <quote>Comprehensive Perl Archive Network</quote> - - . CPAN maintains a large number of extremely useful + <quote>Comprehensive Perl Archive Network</quote>. + CPAN maintains a large number of extremely useful <glossterm>Perl</glossterm> - - modules. By themselves, Perl modules generally do nothing, but when - used as part of a larger program, they provide much-needed algorithms - and functionality.</para> + modules - encapsulated chunks of code for performing a + particular task.</para> </glossdef> </glossentry> </glossdiv> @@ -169,33 +149,16 @@ <quote>Groups</quote> 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 + mechanism comes by placing users in groups, and assigning those + groups certain privileges to view bugs in particular <glossterm>Products</glossterm> - - and - <glossterm>Components</glossterm> - in the <glossterm>Bugzilla</glossterm> - database.</para> </glossdef> </glossentry> </glossdiv> - <glossdiv id="gloss-i"> - <title>I</title> - - <glossentry id="gloss-infiniteloop"> - <glossterm>Infinite Loop</glossterm> - - <glossdef> - <para>A loop of information that never ends; see recursion.</para> - </glossdef> - </glossentry> - </glossdiv> - <glossdiv id="gloss-m"> <title>M</title> @@ -221,10 +184,11 @@ <glossterm id="gloss-product">Product</glossterm> <glossdef> - <para>A Product is a broad category of types of bugs. In general, - there are several Components to a Product. A Product may also define a + <para>A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, + there are several Components to a Product. A Product may define a group (used for security) for all bugs entered into - components beneath it.</para> + its Components.</para> </glossdef> </glossentry> @@ -262,24 +226,7 @@ bugs over their life cycle, thus the need for the <quote>QA Contact</quote> - field in a Bug.</para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss-r"> - <title>R</title> - - <glossentry id="gloss-recursion" xreflabel="Recursion"> - <glossterm>Recursion</glossterm> - - <glossdef> - <para>The property of a function looking back at itself for - something. - <quote>GNU</quote>, for instance, stands for - <quote>GNU's Not UNIX</quote>, - thus recursing upon itself for definition. For further clarity, see - Infinite Loop.</para> + field in a bug.</para> </glossdef> </glossentry> </glossdiv> diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml index 8cadbdd58..0433b4b52 100644 --- a/docs/sgml/installation.sgml +++ b/docs/sgml/installation.sgml @@ -1,1729 +1,1766 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> +<chapter id="installation" xreflabel="Bugzilla Installation"> + <title>Installation</title> - <chapter id="installation" xreflabel="Bugzilla Installation"> - <title>Installation</title> - <para> - 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. - </para> - <section id="errata"> - <title>ERRATA</title> - <para>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.</para> - - <simplelist> - <member> - If you are installing Bugzilla on S.u.S.e. Linux, or some - other distributions with <quote>paranoid</quote> security - options, it is possible that the checksetup.pl script may fail - with the error: <errorname>cannot chdir(/var/spool/mqueue): - Permission denied</errorname> This is because your - <filename>/var/spool/mqueue</filename> directory has a mode of - <quote>drwx------</quote>. Type <command>chmod 755 - <filename>/var/spool/mqueue</filename></command> as root to - fix this problem. - </member> - - <member> - 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 - </member> - - <member> - Release Notes for Bugzilla &bz-ver; are available at - <filename>docs/rel_notes.txt</filename> in your Bugzilla - source distribution. - </member> - - <member> - 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. - </member> - - </simplelist> - - <warning> - <para> - 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. - </para> - </warning> - - <warning> - <para> - 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. - </para> - </warning> - </section> - <section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step"> <title>Step-by-step Install</title> + <section> <title>Introduction</title> - <para> - 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. - </para> - - <para> - 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 <xref linkend="win32" /> for further advice - on getting Bugzilla to work on Microsoft Windows. - </para> - - <para> - 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). - </para> + + <para>Bugzilla has been successfully installed under Solaris, Linux, + and Win32. Win32 is not yet officially supported, but many people + have got it working fine. + Please see the + <xref linkend="win32" /> + for further advice on getting Bugzilla to work on Microsoft + Windows.</para> + </section> + <section> - <title>Installing the Prerequisites</title> + <title>Package List</title> + <note> - <para>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 <xref linkend="bundlebugzilla" /></para> + <para> If you are running the very most recent + version of Perl and MySQL (both the executables and development + libraries) on your system, you can skip these manual installation + steps for the Perl modules by using Bundle::Bugzilla; see + <xref linkend="bundlebugzilla" />. + </para> </note> + + <para>The software packages necessary for the proper running of + Bugzilla (with download links) are: + <orderedlist> + + +<listitem> + <para> + <ulink url="http://www.mysql.com/">MySQL database server</ulink> + (3.22.5 or greater) + </para> +</listitem> + +<listitem> + <para> + <ulink url="http://www.perl.org">Perl</ulink> + (5.005 or greater, 5.6.1 is recommended if you wish to + use Bundle::Bugzilla) + </para> +</listitem> + +<listitem> + <para>Perl Modules (minimum version): + <orderedlist> + <listitem> <para> - The software packages necessary for the proper running of bugzilla are: - <orderedlist> - <listitem> - <para> - MySQL database server and the mysql client (3.22.5 or greater) - </para> - </listitem> - <listitem> - <para> - Perl (5.004 or greater, 5.6.1 is recommended if you wish - to use Bundle::Bugzilla) - </para> - </listitem> - <listitem> - <para> - DBI Perl module - </para> - </listitem> - <listitem> - <para> - Data::Dumper Perl module - </para> - </listitem> - <listitem> - <para> - Bundle::Mysql Perl module collection - </para> - </listitem> - <listitem> - <para> - TimeDate Perl module collection - </para> - </listitem> - <listitem> - <para> - GD perl module (1.8.3) (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - Chart::Base Perl module (0.99c) (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - DB_File Perl module (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - The web server of your choice. Apache is recommended. - </para> - </listitem> - <listitem> - <para> - MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </para> - </listitem> - </orderedlist> - - <warning> - <para> - It is a good idea, while installing Bugzilla, to ensure it - is not <emphasis>accessible</emphasis> 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. - </para> - </warning> - <note> - <para>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 - <filename>urpmi</filename> utility. If you follow these - commands, you should have everything you need for - Bugzilla, and <filename>checksetup.pl</filename> should - not complain about any missing libraries. You may already - have some of these installed.</para> - <simplelist> - <member><prompt>bash#</prompt><command> urpmi - perl-mysql</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-chart</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-gd</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-MailTools</command> (for Bugzilla email - integration)</member> - <member><prompt>bash#</prompt><command> urpmi - apache-modules</command></member> - </simplelist> - </note> - + <ulink url="http://www.template-toolkit.org">Template</ulink> + (v2.07) </para> - </section> - <section id="install-mysql"> - <title>Installing MySQL Database</title> + </listitem> + + <listitem> <para> - Visit MySQL homepage at <ulink - url="http://www.mysql.com">www.mysql.com</ulink> and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in <filename>/var</filename> 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 <filename>configure</filename>. + <ulink url="http://www.cpan.org/modules/by-module/AppConfig/">AppConfig + </ulink> + (v1.52) </para> - <para> - If you install from source or non-package (RPM, deb, etc.) - binaries you need to add - <firstterm>mysqld</firstterm> 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. - <note> - <para>You should have your init script start - <glossterm>mysqld</glossterm> with the ability to accept - large packets. By default, <filename>mysqld</filename> - only accepts packets up to 64K long. This limits the size - of attachments you may put on bugs. If you add <option>-O - max_allowed_packet=1M</option> to the command that starts - <filename>mysqld</filename> (or - <filename>safe_mysqld</filename>), then you will be able - to have attachments up to about 1 megabyte.</para> - </note> + </listitem> - </para> - <note> - <para> - If you plan on running Bugzilla and MySQL on the same - machine, consider using the <option>--skip-networking</option> - option in the init script. This enhances security by - preventing network access to MySQL. - </para> - </note> - </section> - - <section id="install-perl"> - <title>Perl (5.004 or greater)</title> + <listitem> <para> - 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 &perl-ver;. + <ulink url="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz">Text::Wrap</ulink> + (v2001.0131) </para> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://search.cpan.org/search?dist=File-Spec">File::Spec + </ulink> + (v0.8.2) </para> - <warning> - <para>Many people complain that Perl modules will not install - for them. Most times, the error messages complain that they - are missing a file in <quote>@INC</quote>. 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 - <emphasis>are</emphasis> the local UNIX sysadmin, please - consult the newsgroup/mailing list for further assistance or - hire someone to help you out. - </para> - </warning> - <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> - <para> - You can skip the following Perl module installation steps by - installing <productname>Bundle::Bugzilla</productname> from - <glossterm linkend="gloss-cpan">CPAN</glossterm>, 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 &perl-ver;) - </para> - <para> - <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN - -e 'install "Bundle::Bugzilla"'</command> - </computeroutput> - </para> - <para> - 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. - </para> - </tip> - </section> - - <section> - <title>DBI Perl Module</title> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/Data/">Data::Dumper + </ulink> + (any) </para> + </listitem> + + <listitem> <para> - 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 <xref linkend="downloadlinks" />. + <ulink url="http://www.cpan.org/modules/by-module/Mysql/">DBD::mysql + </ulink> + (v1.2209) </para> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/DBI/">DBI</ulink> + (v1.13) </para> + </listitem> + + <listitem> <para> - To use the CPAN shell to install DBI: - <informalexample> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>perl -MCPAN -e 'install "DBI"'</command> - </computeroutput> - <note> - <para>Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc.</para> - </note> - </para> - </informalexample> - To do it the hard way: - <informalexample> - <para> - Untar the module tarball -- it should create its own directory - </para> - <para> - CD to the directory just created, and enter the following commands: - <orderedlist> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>perl Makefile.PL</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make test</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make install</command> - </computeroutput> - </para> - </listitem> - </orderedlist> - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. - </para> - </informalexample> + <ulink url="http://www.cpan.org/modules/by-module/Date/">Date::Parse + </ulink> + (any) </para> - </section> - <section> - <title>Data::Dumper Perl Module</title> + </listitem> + + <listitem> <para> - 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. + CGI::Carp + (any) </para> + </listitem> + + </orderedlist> + and, optionally: + <orderedlist> + <listitem> <para> - Data::Dumper is used by the MySQL-related Perl modules. It - can be found on CPAN (see <xref linkend="downloadlinks" />) and - can be - installed by following the same four step make sequence used - for the DBI module. + <ulink url="http://www.cpan.org/modules/by-module/GD/">GD</ulink> + (v1.19) for bug charting </para> - </section> - - <section> - <title>MySQL related Perl Module Collection</title> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/Chart/">Chart::Base + </ulink> + (v0.99c) for bug charting </para> + </listitem> + + <listitem> <para> - The MySQL modules are all built using one make file which is generated - by running: - <prompt>bash#</prompt> - <command>perl Makefile.pl</command> + XML::Parser + (any) for the XML interface </para> + </listitem> + + <listitem> <para> - 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. + MIME::Parser + (any) for the email interface </para> - <para> - 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. - </para> - <para> - 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. - </para> - </section> - - <section> - <title>TimeDate Perl Module Collection</title> - <para> - 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: <xref linkend="downloadlinks" />). 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. - </para> - </section> - <section> - <title>GD Perl Module (1.8.3)</title> - <para> - 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. - </para> - <para> - 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 <xref linkend="downloadlinks" />. - </para> - <note> - <para> - The Perl GD library requires some other libraries that may - or may not be installed on your system, including - <classname>libpng</classname> and - <classname>libgd</classname>. 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. - </para> - </note> - </section> - - <section> - <title>Chart::Base Perl Module (0.99c)</title> - <para> - 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 <xref linkend="downloadlinks" />. 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. - </para> - </section> - - <section> - <title>DB_File Perl Module</title> - <para> - 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. - </para> - </section> - - <section> - <title>HTTP Server</title> - <para> - 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 <quote>bugs</quote> user permissions accordingly. - <note> - <para>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.</para> - </note> - </para> - <para> - 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: - <programlisting> -AddHandler cgi-script .cgi - </programlisting> - </para> - <para> - With apache you'll also want to make sure that within the - access.conf file the line: - <programlisting> -Options ExecCGI -AllowOverride Limit -</programlisting> - is in the stanza that covers the directories into which - you intend to put the bugzilla .html and .cgi files. - </para> + </listitem> + </orderedlist> + </para> +</listitem> + + +<listitem> + <para> + The web server of your choice. + <ulink url="http://www.apache.org/">Apache</ulink> + is highly recommended. + </para> +</listitem> + + + </orderedlist> + + <warning> + <para>It is a good idea, while installing Bugzilla, to ensure that there + is some kind of firewall between you and the rest of the Internet, + because your machine may be insecure for periods during the install. + 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.</para> + </warning> + <note> - <para> - AllowOverride Limit allows the use of a Deny statement in the - .htaccess file generated by checksetup.pl - </para> - <para> - 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. - </para> + <para>Linux-Mandrake 8.0 includes every + required and optional library for Bugzilla. The easiest way to + install them is by using the + <filename>urpmi</filename> + + utility. If you follow these commands, you should have everything you + need for Bugzilla, and + <filename>checksetup.pl</filename> + + should not complain about any missing libraries. You may already have + some of these installed.</para> + + <simplelist> + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-mysql</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-chart</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-gd</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-MailTools</command> + + (for Bugzilla email integration)</member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi apache-modules</command> + </member> + </simplelist> </note> - <warning> - <para> - There are important files and directories that should not - be a served by the HTTP server. These are most files in the - <quote>data</quote> and <quote>shadow</quote> directories - and the <quote>localconfig</quote> 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 <xref linkend="htaccess" /> for details - on how to do this for Apache. I appreciate notes on how to - get this same functionality using other webservers. - </para> - </warning> - </section> - - <section> - <title>Installing the Bugzilla Files</title> - <para> - You should untar the Bugzilla files into a directory that - you're willing to make writable by the default web server user - (probably <quote>nobody</quote>). You may decide to put the - files off of the main web space for your web server or perhaps - off of <filename>/usr/local</filename> 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. - </para> - <tip> - <para> - If you symlink the bugzilla directory into your Apache's - HTML heirarchy, you may receive - <errorname>Forbidden</errorname> errors unless you add the - <quote>FollowSymLinks</quote> directive to the - <Directory> entry for the HTML root. - </para> - </tip> - <para> - 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 - <filename>checksetup.pl</filename> script, which locks down your - installation. </para> - <para> - Lastly, you'll need to set up a symbolic link to - <filename>/usr/bonsaitools/bin/perl</filename> for the correct - location of your perl executable (probably - <filename>/usr/bin/perl</filename>). Otherwise you must hack - all the .cgi files to change where they look for perl, or use - <xref linkend="setperl" />, found in - <xref linkend="patches" />. I suggest using the symlink - approach for future release compatability. - <example> - <title>Setting up bonsaitools symlink</title> - <para> - 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 - <quote>/usr/local/bin/perl</quote> for - <quote>/usr/bin/perl</quote> below; if on certain other - UNIX systems, Perl may live in weird places like - <quote>/opt/perl</quote>. As root, run these commands: - <programlisting> -bash# mkdir /usr/bonsaitools -bash# mkdir /usr/bonsaitools/bin -bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl - </programlisting> - </para> - <para> - Alternately, you can simply run this perl one-liner to - change your path to perl in all the files in your Bugzilla - installation: - <programlisting> -perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm -processmail syncshadowdb - </programlisting> - Change the second path to perl to match your installation. - </para> - </example> - <tip> - <para> - If you don't have root access to set this symlink up, - check out the - <xref linkend="setperl" />, listed in <xref - linkend="patches" />. It will change the path to perl in all your Bugzilla files for you. - </para> - </tip> - </para> - </section> - - <section> - <title>Setting Up the MySQL Database</title> - <para> - 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. - </para> - <para> - 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 <quote>bugs</quote>, and will - have minimal permissions. - - <warning> - <para> - 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 <command>DROP - DATABASE mysql</command>. - </para> - <para>That would be bad.</para> - </warning> + </section> + + <section id="install-mysql"> + <title>MySQL</title> + + <para>Visit the MySQL homepage at + <ulink url="http://www.mysql.com">www.mysql.com</ulink> + to grab and install the latest stable release of the server. </para> - <para> - Give the MySQL root user a password. MySQL passwords are - limited to 16 characters. - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> <command>mysql - -u root mysql</command> </computeroutput> - </member> - <member> - <computeroutput> <prompt>mysql></prompt> <command> - UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root'; </command> </computeroutput> - </member> - <member> - <computeroutput> <prompt>mysql></prompt> <command>FLUSH - PRIVILEGES;</command> </computeroutput> - </member> - </simplelist> From this point on, if you need to access - MySQL as the MySQL root user, you will need to use - <command>mysql -u root -p</command> and enter your - new_password. Remember that MySQL user names have nothing to - do with Unix user names (login names). - </para> - <para> - Next, we create the <quote>bugs</quote> user, and grant - sufficient permissions for checksetup.pl, which we'll use - later, to work its magic. This also restricts the - <quote>bugs</quote> user to operations within a database - called <quote>bugs</quote>, and only allows the account to - connect from <quote>localhost</quote>. Modify it to reflect - your setup if you will be connecting from another machine or - as a different user. - </para> - <para> - Remember to set bugs_password to some unique password. - <simplelist> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, - ALTER,CREATE,DROP,REFERENCES - ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt> - mysql> - </prompt> - <command> - FLUSH PRIVILEGES; - </command> - </computeroutput> - </member> - </simplelist> - </para> - <para> - 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 - <filename>data</filename> directory, and create all the MySQL - tables. - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> - <command>./checksetup.pl</command> </computeroutput> - </member> - </simplelist> The first time you run it, it will create a - file called <filename>localconfig</filename>. + <note> + <para> Many of the binary + versions of MySQL store their data files in + <filename>/var</filename>. + On some Unix systems, this is part of a smaller root partition, + and may not have room for your bug database. You can set the data + directory as an option to <filename>configure</filename> + if you build MySQL from source yourself.</para> + </note> + + <para>If you install from something other than an RPM or Debian + package, you will need to add <filename>mysqld</filename> + 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. </para> + + <para>Change your init script to start + <filename>mysqld</filename> + with the ability to accept large packets. By default, + <filename>mysqld</filename> + only accepts packets up to 64K long. This limits the size of + attachments you may put on bugs. If you add + <option>-O max_allowed_packet=1M</option> + to the command that starts + <filename>mysqld</filename> + (or <filename>safe_mysqld</filename>), + then you will be able to have attachments up to about 1 megabyte. + There is a Bugzilla parameter for maximum attachment size; + you should configure it to match the value you choose here.</para> + + <para>If you plan on running Bugzilla and MySQL on the same machine, + consider using the + <option>--skip-networking</option> + option in the init script. This enhances security by preventing + network access to MySQL.</para> + </section> + + <section id="install-perl"> + <title>Perl</title> + + <para>Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from + <ulink url="http://www.perl.com">perl.com</ulink> for the rare + *nix systems which don't have it. + Although Bugzilla runs with all post-5.005 + 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 &perl-ver;.</para> + + <tip id="bundlebugzilla" + xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> + + <para>You can skip the following Perl module installation steps by + installing + <productname>Bundle::Bugzilla</productname> + + from + <glossterm linkend="gloss-cpan">CPAN</glossterm>, + which installs all required modules for you.</para> + + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>perl -MCPAN -e 'install "Bundle::Bugzilla"'</command> + </computeroutput> + </para> + + <para>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.</para> + </tip> + </section> + + <section id="perl-modules"> + <title>Perl Modules</title> + + <para> + All Perl modules can be found on the + <ulink url="http://www.cpan.org">Comprehensive Perl + Archive Network</ulink> (CPAN). The + CPAN servers have a real tendency to bog down, so please use mirrors. + </para> - <section> - <title>Tweaking <filename>localconfig</filename></title> - <para> - This file contains a variety of settings you may need to tweak including - how Bugzilla should connect to the MySQL database. - </para> - <para> - The connection settings include: - <orderedlist> - <listitem> - <para> - server's host: just use <quote>localhost</quote> if the - MySQL server is local - </para> - </listitem> - <listitem> - <para> - database name: <quote>bugs</quote> if you're following - these directions - </para> - </listitem> - <listitem> - <para> - MySQL username: <quote>bugs</quote> if you're following - these directions - </para> - </listitem> - <listitem> - <para> - Password for the <quote>bugs</quote> MySQL account above - </para> - </listitem> - </orderedlist> + <para>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. + To use the CPAN shell to install a module: </para> + <para> - You should also install .htaccess files that the Apache - webserver will use to restrict access to Bugzilla data files. - See <xref - linkend="htaccess" />. + <computeroutput> + <prompt>bash#</prompt> + <command>perl -MCPAN -e 'install "<modulename>"'</command> + </computeroutput> </para> + <para> - Once you are happy with the settings, re-run - <filename>checksetup.pl</filename>. On this second run, it will - create the database and an administrator account for which - you will be prompted to provide information. + To do it the hard way: </para> - <para> - 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 <quote>edit parameters</quote> option - that is filled with editable treats. + + <para>Untar the module tarball -- it should create its own + directory</para> + + <para>CD to the directory just created, and enter the following + commands: + <orderedlist> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>perl Makefile.PL</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make test</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make install</command> + </computeroutput> + </para> + </listitem> + </orderedlist> </para> - <para> - Should everything work, you will have a nearly empty Bugzilla - database and a newly-created <filename>localconfig</filename> - file in your Bugzilla root directory. + + <warning> + <para>Many people complain that Perl modules will not install for + them. Most times, the error messages complain that they are missing a + file in + <quote>@INC</quote>. + Virtually every time, this error 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 + <emphasis>are</emphasis> + the local UNIX sysadmin, please consult the newsgroup/mailing list + for further assistance or hire someone to help you out.</para> + </warning> + + + <section> + <title>DBI</title> + + <para>The DBI module is a generic Perl module used 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.</para> + </section> + + <section> + <title>Data::Dumper</title> + + <para>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.</para> + </section> + + <section> + <title>MySQL-related modules</title> + + <para>The Perl/MySQL interface requires a few mutually-dependent Perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package.</para> + + <para>The MakeMaker process will ask you a few questions about the + desired compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if your + desired target is the MySQL or mSQL packages, you should + 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.</para> + + <para>A host of 'localhost' should be fine and a testing user of 'test' + with a null password should find itself with sufficient access to run + tests on the 'test' database which MySQL created upon installation. </para> - <para> - <note> - <para> - 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 <quote>webservergroup</quote> 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 <quote>webserveruser</quote> parameter in - localconfig as well. - <example> - <title>Running checksetup.pl as the web user</title> - <para> - 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 <emphasis>second run</emphasis> of - checksetup.pl, do this: - <programlisting> -bash# chown -R apache:apache /usr/local/bugzilla -bash# su - apache -bash# cd /usr/local/bugzilla -bash# ./checksetup.pl - </programlisting> - </para> - </example> - </para> - </note> + </section> + + <section> + <title>TimeDate modules</title> + + <para>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. + The component module we're most interested in is the Date::Format + module, but installing all of them is probably a good idea anyway. </para> + </section> + + <section> + <title>GD (optional)</title> + + <para>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.</para> + <note> - <para> - 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. - </para> + <para>The Perl GD library requires some other libraries that may or + may not be installed on your system, including + <classname>libpng</classname> + and + <classname>libgd</classname>. + The full requirements are listed in the Perl GD library README. + If compiling GD fails, it's probably because you're + missing a required library.</para> </note> </section> + + <section> + <title>Chart::Base (optional)</title> + + <para>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. + Note that earlier versions that 0.99c used GIFs, which are no longer + supported by the latest versions of GD.</para> + </section> <section> - <title>Setting Up Maintainers Manually (Optional)</title> - <para> - If you want to add someone else to every group by hand, you - can do it by typing the appropriate MySQL commands. Run - <command> mysql -u root -p bugs</command> You - may need different parameters, depending on your security - settings. Then: - <simplelist> - <member> - <computeroutput> <prompt>mysql></prompt> <command>update - profiles set groupset=0x7fffffffffffffff where - login_name = 'XXX';</command> </computeroutput> (yes, that's <emphasis>fifteen</emphasis><quote>f</quote>'s. - </member> - </simplelist> replacing XXX with the Bugzilla email address. - </para> - </section> - - <section> - <title>The Whining Cron (Optional)</title> - <para> - 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): - <simplelist> - <member> - <computeroutput> <command>cd - <your-bugzilla-directory> ; - ./whineatnews.pl</command> </computeroutput> - </member> - </simplelist> + <title>Template Toolkit</title> + + <para>When you install Template Toolkit, you'll get asked various + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. However, there are + known problems with XS Stash and Perl 5.005_02 and lower. If you + wish to use these older versions of Perl, please use the regular + stash.</para> + </section> + + + </section> + + <section> + <title>HTTP Server</title> + + <para>You have a freedom of choice here - Apache, Netscape or any other + server on UNIX would do. You can run the web server on a + different machine than MySQL, but need to adjust the MySQL + <quote>bugs</quote> + user permissions accordingly. + <note> + <para>We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us.</para> + </note> + </para> + + <para>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 httpd.conf + file: + <programlisting>AddHandler cgi-script .cgi</programlisting> + </para> + + <para>With Apache you'll also want to make sure that within the + httpd.conf file the line: + <programlisting>Options ExecCGI AllowOverride Limit</programlisting> + + is in the stanza that covers the directories into which you intend to + put the bugzilla .html and .cgi files. + + <note> + <para>AllowOverride Limit allows the use of a Deny statement in the + .htaccess file generated by checksetup.pl</para> + + <para>Users of older versions of Apache may find the above lines + in the srm.conf and access.conf files, respecitvely.</para> + </note> </para> + + <warning> + <para>There are important files and directories that should not be a + served by the HTTP server - most files in the + <quote>data</quote> + and + <quote>shadow</quote> + directories and the + <quote>localconfig</quote> + file. You should configure your HTTP server to not serve + these files. Failure to do so will expose critical passwords and + other data. Please see + <xref linkend="htaccess" /> + for details on how to do this for Apache; the checksetup.pl + script should create appropriate .htaccess files for you.</para> + </warning> + </section> + + <section> + <title>Bugzilla</title> + + <para>You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + <quote>nobody</quote>). + You may decide to put the files in the main web space for your + web server or perhaps in + <filename>/usr/local</filename> + with a symbolic link in the web space that points to the Bugzilla + directory.</para> + <tip> - <para> - Depending on your system, crontab may have several manpages. - The following command should lead you to the most useful - page for this purpose: - <programlisting> - man 5 crontab - </programlisting> - </para> + <para>If you symlink the bugzilla directory into your Apache's HTML + heirarchy, you may receive + <errorname>Forbidden</errorname> + errors unless you add the + <quote>FollowSymLinks</quote> + directive to the <Directory> entry for the HTML root + in httpd.conf.</para> </tip> + + <para>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 + <filename>checksetup.pl</filename> + script, which locks down your installation.</para> + + <para>Lastly, you'll need to set up a symbolic link to + <filename>/usr/bonsaitools/bin/perl</filename> + for the correct location of your Perl executable (probably + <filename>/usr/bin/perl</filename>). + Otherwise you must hack all the .cgi files to change where they look + for Perl. This can be done using the following Perl one-liner, but + I suggest using the symlink approach to avoid upgrade hassles. + </para> + + <para> + <programlisting>perl -pi -e + 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm + processmail syncshadowdb</programlisting> + + Change <filename>/usr/bin/perl</filename> to match the location + of Perl on your machine. + </para> </section> - + <section> - <title>Bug Graphs (Optional)</title> - <para> - As long as you installed the GD and Graph::Base Perl modules - you might as well turn on the nifty bugzilla bug reporting - graphs. + <title>Setting Up the MySQL Database</title> + + <para>After you've gotten all the software installed and working you're + ready to start preparing the database for its life as the back end to + a high quality bug tracker.</para> + + <para>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 + <quote>bugs</quote>, and will have minimal permissions. </para> - <para> - Add a cron entry like this to run collectstats daily at 5 - after midnight: - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> <command>crontab - -e</command> </computeroutput> - </member> - <member> - <computeroutput> 5 0 * * * cd - <your-bugzilla-directory> ; ./collectstats.pl - </computeroutput> - </member> - </simplelist> + + <para>Begin by giving the MySQL root user a password. MySQL passwords are limited + to 16 characters. + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>mysql -u root mysql</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>UPDATE user SET Password=PASSWORD('<new_password'>) + WHERE user='root';</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> + + From this point on, if you need to access MySQL as the MySQL root user, + you will need to use + <command>mysql -u root -p</command> + + and enter <new_password>. Remember that MySQL user names have + nothing to do with Unix user names (login names).</para> + + <para>Next, we use an SQL <command>GRANT</command> command to create a + <quote>bugs</quote> + + user, and grant sufficient permissions for checksetup.pl, which we'll + use later, to work its magic. This also restricts the + <quote>bugs</quote> + user to operations within a database called + <quote>bugs</quote>, and only allows the account to connect from + <quote>localhost</quote>. + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.</para> + + <para>Remember to set <bugs_password> to some unique password. + <simplelist> + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, + ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '<bugs_password>';</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> </para> - <para> - After two days have passed you'll be able to view bug graphs - from the Bug Reports page. + </section> + + <section> + <title> + <filename>checksetup.pl</filename> + </title> + + <para>Next, run the magic checksetup.pl script. (Many thanks to + <ulink url="mailto:holgerschurig@nikocity.de">Holger Schurig </ulink> + for writing this script!) + This script is designed to make sure your MySQL database and other + configuration options are consistent with the Bugzilla CGI files. + It will make sure Bugzilla files and directories have reasonable + permissions, set up the + <filename>data</filename> + directory, and create all the MySQL tables. + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>./checksetup.pl</command> + </computeroutput> + </member> + </simplelist> + + The first time you run it, it will create a file called + <filename>localconfig</filename>.</para> + + <para>This file contains a variety of settings you may need to tweak + including how Bugzilla should connect to the MySQL database.</para> + + <para>The connection settings include: + <orderedlist> + <listitem> + <para>server's host: just use + <quote>localhost</quote> + if the MySQL server is local</para> + </listitem> + + <listitem> + <para>database name: + <quote>bugs</quote> + if you're following these directions</para> + </listitem> + + <listitem> + <para>MySQL username: + <quote>bugs</quote> + if you're following these directions</para> + </listitem> + + <listitem> + <para>Password for the + <quote>bugs</quote> + MySQL account; (<bugs_password>) above</para> + </listitem> + </orderedlist> </para> + + <para>Once you are happy with the settings, + <filename>su</filename> to the user + your web server runs as, and re-run + <filename>checksetup.pl</filename>. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) + On this second run, it will create the database and an administrator + account for which you will be prompted to provide information.</para> + + <note> + <para>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.</para> + </note> </section> - + <section> <title>Securing MySQL</title> - <para> - 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. - </para> - <para> - Most MySQL installs have "interesting" default security parameters: - <simplelist> - <member>mysqld defaults to running as root</member> - <member>it defaults to allowing external network connections</member> - <member>it has a known port number, and is easy to detect</member> - <member>it defaults to no passwords whatsoever</member> - <member>it defaults to allowing "File_Priv"</member> - </simplelist> - </para> - <para> - 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. + + <para>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.</para> + + <para>Most MySQL installs have "interesting" default security + parameters: + <simplelist> + <member>mysqld defaults to running as root</member> + + <member>it defaults to allowing external network connections</member> + + <member>it has a known port number, and is easy to detect</member> + + <member>it defaults to no passwords whatsoever</member> + + <member>it defaults to allowing "File_Priv"</member> + </simplelist> </para> - <para> - To see your permissions do: - <simplelist> - <member> - <computeroutput> - <prompt>bash#</prompt> - <command>mysql -u root -p</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>use mysql;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>show tables;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>select * from user;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>select * from db;</command> - </computeroutput> - </member> - </simplelist> + + <para>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.</para> + + <para>To see your permissions do: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>mysql -u root -p</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>use mysql;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>show tables;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>select * from user;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>select * from db;</command> + </computeroutput> + </member> + </simplelist> </para> - <para> - To fix the gaping holes: - <simplelist> - <member>DELETE FROM user WHERE User='';</member> - <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member> - <member> FLUSH PRIVILEGES;</member> - </simplelist> + + <para>To fix the gaping holes: + <simplelist> + <member>DELETE FROM user WHERE User='';</member> + + <member>UPDATE user SET Password=PASSWORD('new_password') WHERE + user='root';</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - If you're not running "mit-pthreads" you can use: - <simplelist> - <member>GRANT USAGE ON *.* TO bugs@localhost;</member> - <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> - <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> - <member>FLUSH PRIVILEGES;</member> - </simplelist> + + <para>If you're not running "mit-pthreads" you can use: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@localhost;</member> + + <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> + + <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - 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: - <simplelist> - <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> - <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> - <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> - <member>FLUSH PRIVILEGES;</member> - </simplelist> + + <para>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: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> + + <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> + + <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - Use .htaccess files with the Apache webserver to secure your - bugzilla install. See <xref linkend="htaccess" /> + + <para>Consider also: + <orderedlist> + <listitem> + <para>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.</para> + </listitem> + + <listitem> + <para>using the --user= option to mysqld to run it as an + unprivileged user.</para> + </listitem> + + <listitem> + <para>running MySQL in a chroot jail</para> + </listitem> + + <listitem> + <para>running the httpd in a chroot jail</para> + </listitem> + + <listitem> + <para>making sure the MySQL passwords are different from the OS + passwords (MySQL "root" has nothing to do with system + "root").</para> + </listitem> + + <listitem> + <para>running MySQL on a separate untrusted machine</para> + </listitem> + + <listitem> + <para>making backups ;-)</para> + </listitem> + </orderedlist> </para> + </section> + + <section> + <title>Configuring Bugzilla</title> <para> - Consider also: - <orderedlist> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - using the --user= option to mysqld to run it as an unprivileged - user. - </para> - </listitem> - <listitem> - <para> - starting MySQL in a chroot jail - </para> - </listitem> - <listitem> - <para> - running the httpd in a "chrooted" jail - </para> - </listitem> - <listitem> - <para> - making sure the MySQL passwords are different from the OS - passwords (MySQL "root" has nothing to do with system "root"). - </para> - </listitem> - <listitem> - <para> - running MySQL on a separate untrusted machine - </para> - </listitem> - <listitem> - <para> - making backups ;-) - </para> - </listitem> - </orderedlist> + You should run through the parameters on the Edit Parameters page + (link in the footer) and set them all to appropriate values. + They key parameters are documented in <xref linkend="parameters" />. </para> </section> - </section> - <section id="osx"> - <title>Mac OS X Installation Notes</title> - <para> - 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. - </para> - <para> - 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/>. - </para> - <para> - Follow the instructions for setting up Fink. Once it's - installed, you'll want to run the following as root: - <command>fink install gd</command> - </para> - <para> - It will prompt you for a number of dependencies, type 'y' and - hit enter to install all of the dependencies. Then watch it - work. - </para> - <para> - 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 - :-) - </para> - <para> - Instead of typing <quote>install GD</quote> at the - <prompt>cpan></prompt> prompt, type <command>look - GD</command>. 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 <command>patch < - patchfile</command>: - </para> - <para> - <programlisting> -<![CDATA[ - ---- 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') { - -]]> - </programlisting> - </para> - <para> - Then, run these commands to finish the installation of the perl module: - <simplelist> - <member><command>perl Makefile.PL</command></member> - <member><command>make</command></member> - <member><command>make test</command></member> - <member><command>make install</command></member> - <member>And don't forget to run <command>exit</command> to get back to cpan.</member> - </simplelist> - </para> - <para> - Happy Hacking! - </para> - </section> - - <section id="bsdinstall" xreflabel="BSD Installation Notes"> - <title>BSD Installation Notes</title> - <para> - For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please - consult <xref linkend="osx" />. - </para> </section> - - <section id="geninstall" xreflabel="Installation General Notes"> - <title>Installation General Notes</title> + <section id="extraconfig"> + <title>Optional Additional Configuration</title> + <section> - <title>Modifying Your Running System</title> - <para> - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory. + <title>Dependency Charts</title> + + <para>As well as the text-based dependency graphs, Bugzilla also + supports dependency graphing, using a package called 'dot'. + Exactly how this works is controlled by the 'webdotbase' parameter, + which can have one of three values: </para> + <para> - If you make a change to the structural data in your database - (the versions table for example), or to the - <quote>constants</quote> encoded in defparams.pl, you will - need to remove the cached content from the data directory - (by doing a <quote>rm data/versioncache</quote>), or your - changes won't show up. + <orderedlist> + <listitem> + <para> + A complete file path to the command 'dot' (part of + <ulink url="http://www.graphviz.org/">GraphViz</ulink>) + will generate the graphs locally + </para> + </listitem> + <listitem> + <para> + A URL prefix pointing to an installation of the webdot package will + generate the graphs remotely + </para> + </listitem> + <listitem> + <para> + A blank value will disable dependency graphing. + </para> + </listitem> + </orderedlist> </para> - <para> - 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. + + <para>So, to get this working, install + <ulink url="http://www.graphviz.org/">GraphViz</ulink>. If you + do that, you need to + <ulink url="http://httpd.apache.org/docs/mod/mod_imap.html">enable + server-side image maps</ulink> in Apache. + Alternatively, you could set up a webdot server, or use the AT&T + public webdot server (the + default for the webdotbase param). Note that AT&T's server won't work + if Bugzilla is only accessible using HTTPS. </para> + </section> + + <section> + <title>Bug Graphs</title> + + <para>As long as you installed the GD and Graph::Base Perl modules you + might as well turn on the nifty Bugzilla bug reporting graphs.</para> + + <para>Add a cron entry like this to run + <filename>collectstats.pl</filename> + daily at 5 after midnight: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>crontab -e</command> + </computeroutput> + </member> + + <member> + <computeroutput>5 0 * * * cd <your-bugzilla-directory> ; + ./collectstats.pl</computeroutput> + </member> + </simplelist> + </para> + + <para>After two days have passed you'll be able to view bug graphs from + the Bug Reports page.</para> </section> + <section> - <title>Upgrading From Previous Versions</title> + <title>The Whining Cron</title> + + <para>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 to complain at engineers + which leave their bugs in the NEW state without triaging them. + </para> + <para> + This can be done by + adding the following command as a daily crontab entry (for help on that + see that crontab man page): + <simplelist> + <member> + <computeroutput> + <command>cd <your-bugzilla-directory> ; + ./whineatnews.pl</command> + </computeroutput> + </member> + </simplelist> + </para> + + <tip> + <para>Depending on your system, crontab may have several manpages. + The following command should lead you to the most useful page for + this purpose: + <programlisting>man 5 crontab</programlisting> + </para> + </tip> + </section> + + <section id="bzldap"> + <title>LDAP Authentication</title> <para> - A plain Bugzilla is fairly easy to upgrade from one version to a newer one. - However, things get a bit more complicated if you've made changes to - Bugzilla's code. In this case, you may have to re-make or reapply those - changes. - It is recommended that you take a backup of your database and your entire - Bugzilla installation before attempting an upgrade. You can upgrade a 'clean' - installation by untarring a new tarball over the old installation. If you - are upgrading from 2.12 or later, you can type <filename>cvs -z3 - update</filename>, and resolve conflicts if there are any. + <warning> + <para>This information on using the LDAP + authentication options with Bugzilla is old, and the authors do + not know of anyone who has tested it. Approach with caution. + </para> + </warning> </para> + <para> - Because the developers of Bugzilla are constantly adding new tables, columns - and fields, you'll probably get SQL errors if you just update the code and - attempt to use Bugzilla. Always run the checksetup.pl script whenever - you upgrade your installation. + The existing authentication + scheme for Bugzilla uses email addresses as the primary user ID, and a + password to authenticate that user. All places within Bugzilla where + you need to deal with user ID (e.g assigning a bug) use the email + address. The LDAP authentication builds on top of this scheme, rather + than replacing it. The initial log in is done with a username and + password for the LDAP directory. This then fetches the email address + from LDAP and authenticates seamlessly in the standard Bugzilla + authentication scheme using this email address. If an account for this + address already exists in your Bugzilla system, it will log in to that + account. If no account for that email address exists, one is created at + the time of login. (In this case, Bugzilla will attempt to use the + "displayName" or "cn" attribute to determine the user's full name.) + After authentication, all other user-related tasks are still handled by + email address, not LDAP username. You still assign bugs by email + address, query on users by email address, etc. + </para> + + <para>Using LDAP for Bugzilla authentication requires the + Mozilla::LDAP (aka PerLDAP) Perl module. The + Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. + After you have installed the SDK, then install the PerLDAP module. + Mozilla::LDAP and the Directory SDK for C are both + <ulink url="http://www.mozilla.org/directory/">available for + download</ulink> from mozilla.org. </para> + <para> - 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. + Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for + authentication. Be very careful when setting up this parameter; if you + set LDAP authentication, but do not have a valid LDAP directory set up, + you will not be able to log back in to Bugzilla once you log out. (If + this happens, you can get back in by manually editing the data/params + file, and setting useLDAP back to 0.) </para> + + <para>If using LDAP, you must set the + three additional parameters: Set LDAPserver to the name (and optionally + port) of your LDAP server. If no port is specified, it defaults to the + default port of 389. (e.g "ldap.mycompany.com" or + "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching + for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids + must be unique under the DN specified here. Set LDAPmailattribute to + the name of the attribute in your LDAP directory which contains the + primary email address. On most directory servers available, this is + "mail", but you may need to change this. + </para> </section> + + <section id="content-type" + xreflabel="Preventing untrusted Bugzilla content from executing malicious Javascript code"> + + <title>Preventing untrusted Bugzilla content from executing malicious + Javascript code</title> + + <para>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 + <ulink + url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3"> + http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>. + 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.</para> - <section id="htaccess" xreflabel=".htaccess files and security"> - <title><filename>.htaccess</filename> files and security</title> <para> - To enhance the security of your Bugzilla installation, - Bugzilla will generate - <glossterm><filename>.htaccess</filename></glossterm> files - which the Apache webserver can use to restrict access to - the bugzilla data files. The checksetup script will - generate the <filename>.htaccess</filename> files. These .htaccess files - will not work with Apache 1.2.x - but this has security holes, so you - shouldn't be using it anyway. - - <note> - <para> - If you are using an alternate provider of - <productname>webdot</productname> services for graphing - (as described when viewing - <filename>editparams.cgi</filename> in your web - browser), you will need to change the ip address in - <filename>data/webdot/.htaccess</filename> to the ip - address of the webdot server that you are using. - </para> - </note> - + <programlisting>bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl + </programlisting> </para> - <para> - 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 <filename>.htaccess</filename> - file is allowed to override web server defaults. For instance, - let's assume your installation of Bugzilla is installed to - <filename>/usr/local/bugzilla</filename>. You should have - this <Directory> entry in your <filename>httpd.conf</filename> - file: + <para>All this one-liner command does is search for all instances of + <quote>Content-type: text/html</quote> + + and replaces it with + <quote>Content-Type: text/html; charset=ISO-8859-1</quote> + + . 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 + <quote>ISO-8859-1</quote>, above, to + <quote>UTF-8</quote>.</para> + + <para>Note: using <meta> tags to set the charset is not + recommended, as there's a bug in Netscape 4.x which causes pages + marked up in this way to load twice.</para> + </section> + + <section id="htaccess" xreflabel=".htaccess files and security"> + <title> + <filename>.htaccess</filename> + files and security</title> + + <para>To enhance the security of your Bugzilla installation, Bugzilla's + <filename>checksetup.pl</filename> script will generate + <glossterm> + <filename>.htaccess</filename> + </glossterm> + + files which the Apache webserver can use to restrict access to the + bugzilla data files. + These .htaccess files will not work with Apache 1.2.x - but this + has security holes, so you shouldn't be using it anyway. + <note> + <para>If you are using an alternate provider of + <productname>webdot</productname> + + services for graphing (as described when viewing + <filename>editparams.cgi</filename> + + in your web browser), you will need to change the ip address in + <filename>data/webdot/.htaccess</filename> + + to the ip address of the webdot server that you are using.</para> + </note> </para> + <para>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 + <filename>.htaccess</filename> + + file is allowed to override web server defaults. For instance, let's + assume your installation of Bugzilla is installed to + <filename>/usr/local/bugzilla</filename> + + . You should have this <Directory> entry in your + <filename>httpd.conf</filename> + + file:</para> + <para> - <programlisting> -<![CDATA[ -<Directory /usr/local/bugzilla/> + +<programlisting><![CDATA[ + <Directory /usr/local/bugzilla/> Options +FollowSymLinks +Indexes +Includes +ExecCGI AllowOverride All </Directory> -]]> - </programlisting> - </para> +]]></programlisting> - <para> - The important part above is <quote>AllowOverride All</quote>. - Without that, the <filename>.htaccess</filename> file created by - <filename>checksetup.pl</filename> will not have sufficient - permissions to protect your Bugzilla installation. </para> - <para> - If you are using Internet Information Server or other web - server which does not observe <filename>.htaccess</filename> - conventions, you can disable their creation by editing - <filename>localconfig</filename> and setting the - <varname>$create_htaccess</varname> variable to - <parameter>0</parameter>. - </para> - </section> + <para>The important part above is + <quote>AllowOverride All</quote> - <section id="mod-throttle" xreflabel="Using mod_throttle to prevent Denial of Service attacks"> - <title><filename>mod_throttle</filename> and Security</title> - <para> - 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 <filename>mod_throttle</filename> which can limit - connections by ip-address. You may download this module at - <ulink - url="http://www.snert.com/Software/Throttle/">http://www.snert.com/Software/Throttle/</ulink>. Follow the instructions to install into your Apache install. <emphasis>This module only functions with the Apache web server!</emphasis>. You may use the <command>ThrottleClientIP</command> command provided by this module to accomplish this goal. See the <ulink url="http://www.snert.com/Software/Throttle/">Module Instructions</ulink> for more information. </para> - </section> - - <section id="content-type" xreflabel="Preventing untrusted Bugzilla contentfrom executing malicious Javascript code"> - <title>Preventing untrusted Bugzilla content from executing malicious Javascript code</title> - <para>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 <ulink - url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3">http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>. 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. </para> - <para><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 - </programlisting></para> - <para> - All this one-liner command does is search for all instances of - <quote>Content-type: text/html</quote> and replaces it with - <quote>Content-Type: text/html; charset=ISO-8859-1</quote>. - 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 - <quote>ISO-8859-1</quote>, above, to <quote>UTF-8</quote>. + . Without that, the + <filename>.htaccess</filename> + + file created by + <filename>checksetup.pl</filename> + + will not have sufficient permissions to protect your Bugzilla + installation.</para> + + <para>If you are using Internet Information Server (IIS) or another + web server which does not observe + <filename>.htaccess</filename> + conventions, you can disable their creation by editing + <filename>localconfig</filename> + and setting the + <varname>$create_htaccess</varname> + variable to + <parameter>0</parameter>. </para> </section> - - <section id="unixhistory"> - <title>UNIX Installation Instructions History</title> - <para> - This document was originally adapted from the Bonsai - installation instructions by Terry Weissman - <terry@mozilla.org>. - </para> - <para> - 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 <ulink - url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ). - </para> - <para> - 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. - </para> - <para> - 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. - </para> - <para> - Comments from people using this Guide for the first time are - particularly welcome. - </para> + <section id="mod-throttle" + xreflabel="Using mod_throttle to prevent Denial of Service attacks"> + <title> + <filename>mod_throttle</filename> + + and Security</title> + + <para>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 + <filename>mod_throttle</filename> + + which can limit connections by ip-address. You may download this module + at + <ulink url="http://www.snert.com/Software/Throttle/"> + http://www.snert.com/Software/Throttle/</ulink>. + Follow the instructions to install into your Apache install. + <emphasis>This module only functions with the Apache web + server!</emphasis> + You may use the + <command>ThrottleClientIP</command> + + command provided by this module to accomplish this goal. See the + <ulink url="http://www.snert.com/Software/Throttle/">Module + Instructions</ulink> + for more information.</para> </section> </section> - + <section id="win32" xreflabel="Win32 Installation Notes"> <title>Win32 Installation Notes</title> - <para>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 <emphasis>best</emphasis> - and <emphasis>easiest</emphasis> 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.</para> - <para>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.</para> + <para>This section covers installation on Microsoft Windows. + Bugzilla has been made to work on Win32 platforms, but the Bugzilla team + wish to emphasise that 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.</para> + + <warning> + <para>After that warning, here's the situation for 2.16 + and Windows. It doesn't work at all out of the box. + You are almost certainly better off getting + the 2.17 version from CVS (after consultation with the Bugzilla Team to + make sure you are pulling on a stable day) because we'll be doing a load + of work to make the Win32 experience more pleasant than it is now. + </para> + </warning> + + <para> + If you still want to try this, to have any hope of getting it to work, + you'll need to apply the + <ulink url="">mail patch</ulink> from + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=124174">bug 124174</ulink>. + After that, you'll need to read the (outdated) installation + instructions below, some (probably a lot better) <ulink url="http://bugzilla.mozilla.org/attachment.cgi?id=84430&action=view">more + recent ones</ulink> kindly provided by Toms Baugis and Jean-Sebastien + Guay, and also check the + <ulink url="http://www.bugzilla.org/releases/2.16/docs/win32.html">Bugzilla 2.16 Win32 update page + </ulink>. If we get time, + we'll write some better installation instructions for 2.16 and put + them up there. But no promises. + </para> + <section id="wininstall" xreflabel="Win32 Installation: Step-by-step"> <title>Win32 Installation: Step-by-step</title> + <note> - <para> - You should be familiar with, and cross-reference, the rest - of the - <xref linkend="installation" /> section while performing your - Win32 installation. - </para> - <para> 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 <emphasis>very</emphasis> 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 - <xref linkend="faq" />. - </para> + <para>You should be familiar with, and cross-reference, the rest of + the + <xref linkend="installation" /> + + section while performing your Win32 installation.</para> + + <para>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 + <emphasis>very</emphasis> + + 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 + <xref linkend="faq" /> + + .</para> </note> - + <procedure> - <step> - <para> - Install <ulink url="http://www.apache.org/">Apache Web - Server</ulink> for Windows, and copy the Bugzilla files - somewhere Apache can serve them. Please follow all the - instructions referenced in <xref linkend="installation" /> - regarding your Apache configuration, particularly - instructions regarding the <quote>AddHandler</quote> - parameter and <quote>ExecCGI</quote>. - </para> - <note> - <para> - 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 <xref linkend="faq" />. - </para> - <para> - 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. - </para> - </note> - </step> - <step> - <para> - Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary. - </para> - <para> - Please also check the following links to fully understand the status - of ActivePerl on Win32: - <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> - Perl Porting</ulink>, and - <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> - Perl on Win32 FAQ</ulink> - </para> - </step> - <step> - <para> - Use ppm from your perl\bin directory to install the following - packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, - GD, AppConfig, and Template. You may need to extract them from - .zip format using Winzip or other unzip program first. Most of - these additional ppm modules can be downloaded from ActiveState, - but AppConfig and Template should be obtained from OpenInteract - using <ulink type="http" - url="http://openinteract.sourceforge.net/">the instructions on - the Template Toolkit web site</ulink>. + <step> + <para>Install + <ulink url="http://www.apache.org/">Apache Web Server</ulink> + + for Windows, and copy the Bugzilla files somewhere Apache can serve + them. Please follow all the instructions referenced in + <xref linkend="installation" /> + + regarding your Apache configuration, particularly instructions + regarding the + <quote>AddHandler</quote> + + parameter and + <quote>ExecCGI</quote> + + .</para> + + <note> + <para>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 + <xref linkend="faq" /> + + .</para> + + <para>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.</para> + </note> + </step> + + <step> + <para>Install + <ulink url="http://www.activestate.com/">ActivePerl</ulink> + + for Windows. Check + <ulink + url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/"> + http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> + + for a current compiled binary.</para> + + <para>Please also check the following links to fully understand the + status of ActivePerl on Win32: + <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> + Perl Porting</ulink> + + , and + <ulink + url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> + Perl on Win32 FAQ</ulink> </para> - <note> - <para> - You can find a list of modules at - <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> - http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> - or <ulink - url="http://www.activestate.com/PPMPackages/5.6plus">http://www.activestate.com/PPMPackages/5.6plus</ulink> - </para> - </note> - <para> - The syntax for ppm is: - <computeroutput> - <prompt>C:> </prompt><command>ppm <modulename></command> - </computeroutput> - </para> - - <example> - <title>Installing ActivePerl ppd Modules on Microsoft Windows</title> - <para><prompt>C:></prompt><command>ppm - <option>DBD-Mysql</option></command></para> - <para>Watch your capitalization!</para> - </example> - - <para> - ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the - version at OpenInteract: + </step> + + <step> + <para>Use ppm from your perl\bin directory to install the following + packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using + <ulink type="http" url="http://openinteract.sourceforge.net/">the + instructions on the Template Toolkit web site</ulink> + + .</para> + + <note> + <para>You can find a list of modules at + <ulink + url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> + + or + <ulink url="http://www.activestate.com/PPMPackages/5.6plus"> + http://www.activestate.com/PPMPackages/5.6plus</ulink> + </para> + </note> + + <para>The syntax for ppm is: + <computeroutput> + <prompt>C:></prompt> + + <command>ppm <modulename></command> + </computeroutput> </para> + + <example> + <title>Installing ActivePerl ppd Modules on Microsoft + Windows</title> + + <para> + <prompt>C:></prompt> + + <command>ppm + <option>DBD-Mysql</option> + </command> + </para> + + <para>Watch your capitalization!</para> + </example> + + <para>ActiveState's 5.6Plus directory also contains an AppConfig + ppm, so you might see the following error when trying to install + the version at OpenInteract:</para> + <para> - <computeroutput> - Error installing package 'AppConfig': Read a PPD for - 'AppConfig', but it is not intended for this build of Perl - (MSWin32-x86-multi-thread) - </computeroutput> - </para> - <para> - If so, download both <ulink - url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz">the - tarball</ulink> and <ulink - url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd">the - ppd</ulink> directly from OpenInteract, then run ppm from within - the same directory to which you downloaded those files and - install the package by referencing the ppd file explicitly via in - the install command, f.e.: - <example> - <title>Installing OpenInteract ppd Modules manually on Microsoft - Windows</title> + <computeroutput>Error installing package 'AppConfig': Read a PPD + for 'AppConfig', but it is not intended for this build of Perl + (MSWin32-x86-multi-thread)</computeroutput> + </para> + + <para>If so, download both + <ulink + url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz"> + the tarball</ulink> + + and + <ulink + url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd"> + the ppd</ulink> + + directly from OpenInteract, then run ppm from within the same + directory to which you downloaded those files and install the + package by referencing the ppd file explicitly via in the install + command, f.e.: + <example> + <title>Installing OpenInteract ppd Modules manually on Microsoft + Windows</title> + + <para> + <computeroutput> + <command>install + <filename>C:\AppConfig.ppd</filename> + </command> + </computeroutput> + </para> + </example> + </para> + </step> + + <step> + <para>Install MySQL for NT. + <note> + <para>You can download MySQL for Windows NT from + <ulink url="http://www.mysql.com/">MySQL.com</ulink> + + . Some find it helpful to use the WinMySqlAdmin utility, included + with the download, to set up the database.</para> + </note> + </para> + </step> + + <step> + <para>Setup MySQL</para> + + <substeps> + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + + <command>C:\mysql\bin\mysql -u root mysql</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>DELETE FROM user WHERE Host='localhost' AND + User='';</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>UPDATE user SET Password=PASSWORD ('new_password') + WHERE user='root';</command> + </computeroutput> + </para> + + <para> + <quote>new_password</quote> + + , above, indicates whatever password you wish to use for your + <quote>root</quote> + + user.</para> + </step> + + <step id="ntbugs-password"> <para> - <computeroutput><command>install - <filename>C:\AppConfig.ppd</filename></command></computeroutput> + <computeroutput> + <prompt>mysql></prompt> + + <command>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, + ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> </para> - </example> + + <para> + <quote>bugs_password</quote> + + , above, indicates whatever password you wish to use for your + <quote>bugs</quote> + + user.</para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>create database bugs;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>exit;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + + <command>C:\mysql\bin\mysqladmin -u root -p + reload</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + + <step> + <para>Edit + <filename>checksetup.pl</filename> + + in your Bugzilla directory. Change this line:</para> + + <para> + <programlisting>my $webservergid = + getgrnam($my_webservergroup);</programlisting> </para> - </step> - - <step> - <para> - Install MySQL for NT. - <note> - <para> - You can download MySQL for Windows NT from <ulink url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database. - </para> - </note> - </para> - </step> - <step> - <para> - Setup MySQL - </para> - <substeps> - <step> - <para> - <computeroutput> - <prompt>C:> </prompt> - <command>C:\mysql\bin\mysql -u root mysql</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>DELETE FROM user WHERE Host='localhost' AND User='';</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</command> - </computeroutput> - </para> - <para><quote>new_password</quote>, above, indicates - whatever password you wish to use for your - <quote>root</quote> user.</para> - </step> - <step id="ntbugs-password"> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>GRANT SELECT, INSERT, UPDATE, DELETE, - INDEX, ALTER, CREATE, DROP, REFERENCES - ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</command> - </computeroutput> - </para> - <para><quote>bugs_password</quote>, above, indicates - whatever password you wish to use for your - <quote>bugs</quote> user.</para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>FLUSH PRIVILEGES;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>create database bugs;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>exit;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>C:></prompt> - <command>C:\mysql\bin\mysqladmin -u root -p reload</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para> - Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change - this line: - </para> - <para> - <programlisting> -my $webservergid = getgrnam($my_webservergroup); - </programlisting> - </para> - <para> - to - </para> - <para> - <programlisting> -my $webservergid = $my_webservergroup; - </programlisting> -or the name of the group you wish to own the files explicitly: - <programlisting> -my $webservergid = 'Administrators' - </programlisting> - </para> - </step> - - <step> - <para> - Run <filename>checksetup.pl</filename> from the Bugzilla directory. - </para> - </step> - - <step> - <para>Edit <filename>localconfig</filename> to suit your - requirements. Set <varname>$db_pass</varname> to your - <quote>bugs_password</quote> from <xref linkend="ntbugs-password" />, and <varname>$webservergroup</varname> to <quote>8</quote>.</para> - <note> - <para>Not sure on the <quote>8</quote> for - <varname>$webservergroup</varname> above. If it's - wrong, please send corrections.</para> - </note> - </step> - - <step> - <para> - Edit <filename>defparams.pl</filename> to suit your - requirements. Particularly, set - <varname>DefParam("maintainer")</varname> and - <varname>DefParam("urlbase") to match your - install.</varname> - </para> - <note> - <para>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.</para> - </note> - </step> - - <step> - <note> - <para> - There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <emphasis>suggestion</emphasis>, not - a requirement. Some other mail packages that can work include - <ulink url="http://www.blat.net/">BLAT</ulink>, - <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>, - <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>, - 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. - </para> - </note> - - <procedure> - <step> - <para> - Download NTsendmail, available from<ulink url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. 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) - </para> - </step> - - <step> - <para>Put ntsendmail.pm into your .\perl\lib directory.</para> - </step> - - <step> - <para>Add to globals.pl:</para> - <programlisting> -# these settings configure the NTsendmail process -use NTsendmail; -$ENV{"NTsendmail"}="your.smtpserver.box"; -$ENV{"NTsendmail_debug"}=1; -$ENV{"NTsendmail_max_tries"}=5; - </programlisting> - <note> - <para> - Some mention to also edit - <varname>$db_pass</varname> in - <filename>globals.pl</filename> to be your - <quote>bugs_password</quote>. Although this may get - you around some problem authenticating to your - database, since globals.pl is not normally - restricted by <filename>.htaccess</filename>, your - database password is exposed to whoever uses your - web server. - </para> - </note> - </step> - - <step> - <para> - Find and comment out all occurences of - <quote><command>open(SENDMAIL</command></quote> in - your Bugzilla directory. Then replace them with: - <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); - </programlisting> - </para> - <note> - <para> - Some have found success using the commercial product, - <productname>Windmail</productname>. - You could try replacing your sendmail calls with: - <programlisting> -open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </programlisting> - or something to that effect. - </para> - </note> - </step> - </procedure> - </step> - - <step> - <para> - Change all references in all files from - <filename>processmail</filename> to - <filename>processmail.pl</filename>, and - rename <filename>processmail</filename> to - <filename>processmail.pl</filename>. - </para> - <note> - <para> - 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. - </para> - </note> - <note> - <para> - 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. - <programlisting> + + <para>to</para> + + <para> + <programlisting>my $webservergid = + $my_webservergroup;</programlisting> + + or the name of the group you wish to own the files explicitly: + <programlisting>my $webservergid = + 'Administrators'</programlisting> + </para> + </step> + + <step> + <para>Run + <filename>checksetup.pl</filename> + + from the Bugzilla directory.</para> + </step> + + <step> + <para>Edit + <filename>localconfig</filename> + + to suit your requirements. Set + <varname>$db_pass</varname> + + to your + <quote>bugs_password</quote> + + from + <xref linkend="ntbugs-password" /> + + , and + <varname>$webservergroup</varname> + + to + <quote>8</quote> + + .</para> + + <note> + <para>Not sure on the + <quote>8</quote> + + for + <varname>$webservergroup</varname> + + above. If it's wrong, please send corrections.</para> + </note> + </step> + + <step> + <para>Edit + <filename>defparams.pl</filename> + + to suit your requirements. Particularly, set + <varname>DefParam("maintainer")</varname> + + and + <varname>DefParam("urlbase") to match your install.</varname> + </para> + + <note> + <para>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.</para> + </note> + </step> + + <step> + <note> + <para>There are several alternatives to Sendmail that will work + on Win32. The one mentioned here is a + <emphasis>suggestion</emphasis> + + , not a requirement. Some other mail packages that can work + include + <ulink url="http://www.blat.net/">BLAT</ulink> + + , + <ulink url="http://www.geocel.com/windmail/">Windmail</ulink> + + , + <ulink url="http://www.dynamicstate.com/">Mercury + Sendmail</ulink> + + , 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.</para> + </note> + + <procedure> + <step> + <para>Download NTsendmail, available from + <ulink url="http://www.ntsendmail.com/"> + www.ntsendmail.com</ulink> + + . 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)</para> + </step> + + <step> + <para>Put ntsendmail.pm into your .\perl\lib directory.</para> + </step> + + <step> + <para>Add to globals.pl:</para> + + <programlisting># these settings configure the NTsendmail + process use NTsendmail; + $ENV{"NTsendmail"}="your.smtpserver.box"; + $ENV{"NTsendmail_debug"}=1; + $ENV{"NTsendmail_max_tries"}=5;</programlisting> + + <note> + <para>Some mention to also edit + <varname>$db_pass</varname> + + in + <filename>globals.pl</filename> + + to be your + <quote>bugs_password</quote> + + . Although this may get you around some problem + authenticating to your database, since globals.pl is not + normally restricted by + <filename>.htaccess</filename> + + , your database password is exposed to whoever uses your web + server.</para> + </note> + </step> + + <step> + <para>Find and comment out all occurences of + <quote> + <command>open(SENDMAIL</command> + </quote> + + in your Bugzilla directory. Then replace them with: + <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);</programlisting> + </para> + + <note> + <para>Some have found success using the commercial product, + <productname>Windmail</productname> + + . You could try replacing your sendmail calls with: + <programlisting>open SENDMAIL, + "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > + mail.log";</programlisting> + + or something to that effect.</para> + </note> + </step> + </procedure> + </step> + + <step> + <para>Change all references in all files from + <filename>processmail</filename> + + to + <filename>processmail.pl</filename> + + , and rename + <filename>processmail</filename> + + to + <filename>processmail.pl</filename> + + .</para> + + <note> + <para>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.</para> + </note> + + <note> + <para>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. + <programlisting> <![CDATA[ my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server @@ -1737,9 +1774,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } ]]> -</programlisting> -here is a test mail program for Net::SMTP: -<programlisting> + </programlisting> + + here is a test mail program for Net::SMTP: + <programlisting> <![CDATA[ use Net::SMTP; @@ -1757,241 +1795,352 @@ recipient's address exit; ]]> -</programlisting> - </para> - </note> - </step> - <step> - <note> - <para> - 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 - <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl) - </para> - </note> - <para> - Modify the path to perl on the first line (#!) of all - files to point to your Perl installation, and add - <quote>perl</quote> 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 <quote>setperl.csh</quote> - utility to speed part of this procedure, available in the - <xref linkend="patches" /> section of The Bugzilla Guide. - However, it requires the Cygwin GNU-compatible environment - for Win32 be set up in order to work. See <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin. - </para> - </step> - - <step> - <para> - 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: - <programlisting><![CDATA[ + </programlisting> + </para> + </note> + </step> + + <step> + <note> + <para>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 + <quote>shebang</quote> + + line (#/usr/bonsaitools/bin/perl)</para> + </note> + + <para>Modify the path to perl on the first line (#!) of all files + to point to your Perl installation, and add + <quote>perl</quote> + + 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 + <quote>setperl.csh</quote> + + utility to speed part of this procedure, available in the + <xref linkend="patches" /> + + section of The Bugzilla Guide. However, it requires the Cygwin + GNU-compatible environment for Win32 be set up in order to work. + See + <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> + + for details on obtaining Cygwin.</para> + </step> + + <step> + <para>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: + <programlisting> +<![CDATA[ system ("./processmail",@ARGLIST); - </programlisting> to - <programlisting> + </programlisting> to + <programlisting> system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); -]]> </programlisting> - </para> - </step> - <step> - <para> - Add <function>binmode()</function> calls so attachments - will work (<ulink - url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>). +]]> + </programlisting> </para> + </step> + + <step> + <para>Add + <function>binmode()</function> + + calls so attachments will work ( + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug + 62000</ulink> + + ).</para> + + <para>Because Microsoft Windows based systems handle binary files + different than Unix based systems, you need to add the following + lines to + <filename>createattachment.cgi</filename> + + and + <filename>showattachment.cgi</filename> + + before the + <function>require 'CGI.pl';</function> + + line.</para> + <para> - Because Microsoft Windows based systems handle binary - files different than Unix based systems, you need to add - the following lines to - <filename>createattachment.cgi</filename> and - <filename>showattachment.cgi</filename> before the - <function>require 'CGI.pl';</function> line. -</para> -<para> -<programlisting> + <programlisting> <![CDATA[ binmode(STDIN); binmode(STDOUT); ]]> -</programlisting> + </programlisting> </para> + <note> - <para> - According to <ulink - url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, - the perl documentation says that you should always use - <function>binmode()</function> when dealing with binary - files, but never when dealing with text files. That seems - to suggest that rather than arbitrarily putting - <function>binmode()</function> at the beginning of the - attachment files, there should be logic to determine if - <function>binmode()</function> is needed or not. - </para> + <para>According to + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000"> + bug 62000</ulink> + + , the perl documentation says that you should always use + <function>binmode()</function> + + when dealing with binary files, but never when dealing with text + files. That seems to suggest that rather than arbitrarily putting + + <function>binmode()</function> + + at the beginning of the attachment files, there should be logic + to determine if + <function>binmode()</function> + + is needed or not.</para> </note> </step> </procedure> <tip> - <para> - 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: - </para> - <para> - <programlisting> -.cgi to: <perl install directory>\perl.exe %s %s -.pl to: <perl install directory>\perl.exe %s %s -GET,HEAD,POST - </programlisting> - Change the path to Perl to match your - install, of course. - </para> + <para>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:</para> + + <para> + <programlisting>.cgi to: <perl install directory>\perl.exe %s + %s .pl to: <perl install directory>\perl.exe %s %s + GET,HEAD,POST</programlisting> + + Change the path to Perl to match your install, of course.</para> </tip> </section> <section id="addlwintips"> <title>Additional Windows Tips</title> + <tip> - <para> - From Andrew Pearson: - <blockquote> - <para> - 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 <ulink url=" - http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> - </para> - <para> - Basically you need to add two String Keys in the - registry at the following location: - </para> - <para> - <programlisting> -HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </programlisting> - </para> - <para> - The keys should be called ".pl" and ".cgi", and both - should have a value something like: - <command>c:/perl/bin/perl.exe "%s" "%s"</command> - </para> - <para> - The KB article only talks about .pl, but it goes into - more detail and provides a perl test script. - </para> - </blockquote> - </para> + <para>From Andrew Pearson: + <blockquote> + <para>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 + <ulink + url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> + http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> + </para> + + <para>Basically you need to add two String Keys in the registry at + the following location:</para> + + <para> + <programlisting> + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</programlisting> + </para> + + <para>The keys should be called ".pl" and ".cgi", and both should + have a value something like: + <command>c:/perl/bin/perl.exe "%s" "%s"</command> + </para> + + <para>The KB article only talks about .pl, but it goes into more + detail and provides a perl test script.</para> + </blockquote> + </para> </tip> + <tip> - <para> - If attempting to run Bugzilla 2.12 or older, you will need - to remove encrypt() calls from the Perl source. This is - <emphasis>not necessary</emphasis> for Bugzilla 2.13 and - later, which includes the current release, Bugzilla - &bz-ver;. - <example> - <title>Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</title> - <para> - Replace this: - <programlisting> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </programlisting> -with this: - <programlisting> -my $enteredcryptpwd = $enteredpwd - </programlisting> - in cgi.pl. - </para> - </example> - </para> + <para>If attempting to run Bugzilla 2.12 or older, you will need to + remove encrypt() calls from the Perl source. This is + <emphasis>not necessary</emphasis> + + for Bugzilla 2.13 and later, which includes the current release, + Bugzilla &bz-ver;. + <example> + <title>Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</title> + + <para>Replace this: + <programlisting>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . + ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my + $enteredcryptpwd = FetchOneColumn();</programlisting> + + with this: + <programlisting>my $enteredcryptpwd = $enteredpwd</programlisting> + + in cgi.pl.</para> + </example> + </para> </tip> </section> + </section> + + <section id="osx"> + <title>Mac OS X Installation Notes</title> + + <para>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.</para> + + <para>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/>.</para> + + <para>Follow the instructions for setting up Fink. Once it's installed, + you'll want to run the following as root: + <command>fink install gd</command> + </para> + + <para>It will prompt you for a number of dependencies, type 'y' and hit + enter to install all of the dependencies. Then watch it work.</para> + + <para>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, because it + looks for the specific paths instead of getting them from your + environment. But there's a way around that :-)</para> + + <para>Instead of typing + <quote>install GD</quote> + at the + <prompt>cpan></prompt> + prompt, type + <command>look GD</command>. + 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 <ulink url="../sgml/gd-makefile.patch">this patch</ulink> + to the Makefile.PL file (save the + patch into a file and use the command + <command>patch < patchfile</command>.) + </para> - <section id="bzldap"> - <title>Bugzilla LDAP Integration</title> + <para>Then, run these commands to finish the installation of the GD + module: + <simplelist> + <member> + <command>perl Makefile.PL</command> + </member> + + <member> + <command>make</command> + </member> + + <member> + <command>make test</command> + </member> + + <member> + <command>make install</command> + </member> + + <member>And don't forget to run + <command>exit</command> + + to get back to CPAN.</member> + </simplelist> + </para> + + </section> + + <section id="troubleshooting"> + <title>Troubleshooting</title> + + <para>This section gives solutions to common Bugzilla installation + problems. + </para> + + <section> + <title>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</title> + <para> - 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. + Try executing <command>perl -MCPAN -e 'install CPAN'</command> + and then continuing. + </para> + + <para> + Certain older versions of the CPAN toolset were somewhat naive about how + to upgrade Perl modules. When a couple of modules got rolled into the core + Perl distribution for 5.6.1, CPAN thought that the best way to get those + modules up to date was to haul down the Perl distribution itself and + build it. Needless to say, this has caused headaches for just about + everybody. Upgrading to a newer version of CPAN with the + commandline above should fix things. </para> - <literallayout> -Mozilla::LDAP module - -The Mozilla::LDAP module allows you to use LDAP for authentication to -the Bugzilla system. This module is not required if you are not using -LDAP. - -Mozilla::LDAP (aka PerLDAP) is available for download from -http://www.mozilla.org/directory. - -NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. -Follow the link for "Directory SDK for C" on that same page to -download the SDK first. After you have installed this SDK, then -install the PerLDAP module. ----------------------------------------------------------------------- - -Post-Installation Checklist ----------------------------------------------------------------------- -Set useLDAP to "On" **only** if you will be using an LDAP directory -for authentication. Be very careful when setting up this parameter; -if you set LDAP authentication, but do not have a valid LDAP directory -set up, you will not be able to log back in to Bugzilla once you log -out. (If this happens, you can get back in by manually editing the -data/params file, and setting useLDAP back to 0.) - -If using LDAP, you must set the three additional parameters: - -Set LDAPserver to the name (and optionally port) of your LDAP server. -If no port is specified, it defaults to the default port of 389. (e.g -"ldap.mycompany.com" or "ldap.mycompany.com:1234") - -Set LDAPBaseDN to the base DN for searching for users in your LDAP -directory. (e.g. "ou=People,o=MyCompany") uids must be unique under -the DN specified here. - -Set LDAPmailattribute to the name of the attribute in your LDAP -directory which contains the primary email address. On most directory -servers available, this is "mail", but you may need to change this. ----------------------------------------------------------------------- - -(Not sure where this bit should go, but it's important that it be in -there somewhere...) ----------------------------------------------------------------------- -Using LDAP authentication for Bugzilla: - -The existing authentication scheme for Bugzilla uses email addresses -as the primary user ID, and a password to authenticate that user. All -places within Bugzilla where you need to deal with user ID (e.g -assigning a bug) use the email address. - -The LDAP authentication builds on top of this scheme, rather than -replacing it. The initial log in is done with a username and password -for the LDAP directory. This then fetches the email address from LDAP -and authenticates seamlessly in the standard Bugzilla authentication -scheme using this email address. If an account for this address -already exists in your Bugzilla system, it will log in to that -account. If no account for that email address exists, one is created -at the time of login. (In this case, Bugzilla will attempt to use the -"displayName" or "cn" attribute to determine the user's full name.) - -After authentication, all other user-related tasks are still handled -by email address, not LDAP username. You still assign bugs by email -address, query on users by email address, etc. ----------------------------------------------------------------------- - </literallayout> </section> + + + <section> + <title>DBD::Sponge::db prepare failed</title> + + <para> + The following error message may appear due to a bug in DBD::mysql + (over which the Bugzilla team have no control): + </para> + +<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248. + SV = NULL(0x0) at 0x20fc444 + REFCNT = 1 + FLAGS = (PADBUSY,PADMY) +]]></programlisting> + + <para> + To fix this, go to + <filename><path-to-perl>/lib/DBD/sponge.pm</filename> + in your Perl installation and replace + </para> + +<programlisting><![CDATA[ my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; +]]></programlisting> + + <para> + by + </para> + +<programlisting><![CDATA[ my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; +]]></programlisting> + + <para> + (note the S added to NAME.) + </para> + </section> + + <section id="paranoid-security"> + <title>cannot chdir(/var/spool/mqueue)</title> + + <para>If you are installing Bugzilla on SuSE Linux, or some other + distributions with + <quote>paranoid</quote> + security options, it is possible that the checksetup.pl script may fail + with the error: +<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied +]]></programlisting> + </para> + + <para> + This is because your + <filename>/var/spool/mqueue</filename> + directory has a mode of + <quote>drwx------</quote>. Type + <command>chmod 755 + <filename>/var/spool/mqueue</filename> + </command> + as root to fix this problem. + </para> + </section> </section> </chapter> - <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -2012,3 +2161,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/sgml/integration.sgml b/docs/sgml/integration.sgml index e801847d6..68054ee13 100644 --- a/docs/sgml/integration.sgml +++ b/docs/sgml/integration.sgml @@ -1,6 +1,6 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- Keep these tools listings in alphabetical order please. -MPB --> -<chapter id="integration"> +<section id="integration"> <title>Integrating Bugzilla with Third-Party Tools</title> <section id="bonsai" @@ -13,43 +13,32 @@ . 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 - <quote>on the hook</quote> - - (include cool URL link here for Hook policies at mozilla.org). Bonsai - also includes gateways to - <xref linkend="tinderbox" /> - - and Bugzilla</para> + closed. Bonsai + also integrates with + <xref linkend="tinderbox" />. + </para> </section> <section id="cvs" xreflabel="CVS, the Concurrent Versioning System"> <title>CVS</title> <para>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.</para> + Bugzilla Email Gateway.</para> - <para>Follow the instructions in the FAQ for enabling Bugzilla e-mail + <para>Follow the instructions in this Guide 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 - <quote>[Bug XXXX]</quote> - - , and you can have CVS check-in comments append to your Bugzilla bug. If + <quote>[Bug XXXX]</quote>, + 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.</para> - <para>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: + <para>There is also a CVSZilla project, based upon somewhat dated + Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"> - http://homepages.kcbbs.gen.nz/~tonyg/</ulink> - - , under the - <quote>cvszilla</quote> - - link.</para> + http://homepages.kcbbs.gen.nz/~tonyg/</ulink>. + </para> </section> <section id="scm" @@ -86,7 +75,7 @@ <para>We need Tinderbox integration information.</para> </section> -</chapter> +</section> <!-- Keep this comment at the end of the file Local variables: diff --git a/docs/sgml/patches.sgml b/docs/sgml/patches.sgml index 540109feb..43f816758 100644 --- a/docs/sgml/patches.sgml +++ b/docs/sgml/patches.sgml @@ -26,160 +26,54 @@ setting up your VirtualHost section for Bugzilla with a rule like this:</para> - <programlisting> -<![CDATA[ + <programlisting><![CDATA[ <VirtualHost 12.34.56.78> RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </VirtualHost> -]]> - </programlisting> +]]></programlisting> </listitem> <listitem> <para>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 - <ulink url="http://www.apache.org">http://www.apache.org</ulink> + Please refer to the mod_rewrite documentation at + <ulink url="http://www.apache.org">http://www.apache.org</ulink>. </para> </listitem> </orderedlist> </section> - <section id="setperl" xreflabel="The setperl.csh Utility"> - <title>The setperl.csh Utility</title> - - <para>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!</para> - - <procedure> - <step> - <para>Download the "setperl.csh" utility to your Bugzilla directory - and make it executable.</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>cd /your/path/to/bugzilla</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>wget -O setperl.csh - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+x setperl.csh</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Prepare (and fix) Bugzilla file permissions.</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+w *</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+x duplicates.cgi</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod a-x bug_status.html</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Run the script:</para> - - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>./setperl.csh /your/path/to/perl</command> - </computeroutput> - - <example> - <title>Using Setperl to set your perl path</title> - - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>./setperl.csh /usr/bin/perl</command> - </computeroutput> - </para> - </example> - </para> - </step> - </procedure> - </section> - <section id="cmdline"> <title>Command-line Bugzilla Queries</title> - <para>Users can query Bugzilla from the command line using this suite of - utilities.</para> - - <para>The query.conf file contains the mapping from options to field + <para>There are a suite of Unix utilities for querying Bugzilla from the + command line. They live in the + <filename class="directory">contrib/cmdline</filename> + directory. However, they + have not yet been updated to work with 2.16 (post-templatisation.). + There are three files - <filename>query.conf</filename>, + <filename>buglist</filename> and <filename>bugs</filename>.</para> + + <para><filename>query.conf</filename> + 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"</para> + make sure these lines do not contain any quoted "option".</para> - <para>buglist is a shell script which submits a Bugzilla query and writes + <para><filename>buglist</filename> + 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=".</para> - <para>The columlist is taken from the COLUMNLIST environment variable. + <para>The column list 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 - <command>grep COLUMLIST ~/.netscape/cookies</command> - - to see your current COLUMNLIST setting.</para> + buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST + in your cookies file to see your current COLUMNLIST setting.</para> - <para>bugs is a simple shell script which calls buglist and extracts the + <para><filename>bugs</filename> is a simple shell script which calls + <filename>buglist</filename> 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 @@ -187,100 +81,13 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> </para> - <para>Akkana says she has good results piping buglist output through + <para>Akkana Peck says she has good results piping + <filename>buglist</filename> output through <command>w3m -T text/html -dump</command> </para> - <procedure> - <step> - <para>Download three files:</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash$</prompt> - - <command>wget -O query.conf - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash$</prompt> - - <command>wget -O buglist - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>wget -O bugs - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Make your utilities executable: - <computeroutput> - <prompt>bash$</prompt> - - <command>chmod u+x buglist bugs</command> - </computeroutput> - </para> - </step> - </procedure> </section> - <section id="quicksearch"> - <title>The Quicksearch Utility</title> - - <para>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"</para> - - <para>The index.html page has been updated to include the QuickSearch - text box.</para> - - <para>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.</para> - - <para>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".</para> - - <para>Workarounds for Bugzilla users: - <simplelist> - <member>search for '!foo' (this will find only bugs with the keyword - "foo"</member> - - <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> - </simplelist> - </para> - - <para>When this tool is ported from client-side JavaScript to server-side - Perl, the requirement for hard-coding keywords can be fixed. - <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This - bug</ulink> - - has details.</para> - </section> </appendix> <!-- Keep this comment at the end of the file diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml index b447ef9c0..a3986c27d 100644 --- a/docs/sgml/using.sgml +++ b/docs/sgml/using.sgml @@ -1,167 +1,16 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<!-- TOC -Chapter: Using Bugzilla - Create an account - Logging in - Setting up preferences - Account Settings - Email Settings - Page Footer - Permissions - Life cycle of a bug - Creating a bug - Checking for duplicates - Overview of all bug fields - Setting bug permissions - The Query Interface - Standard Queries - Email Queries - Boolean Queries - Regexp Queries - The Query Results - Changing Columns - Changing sorting order - Mass changes - Miscellaneous usage hints ---> <chapter id="using"> <title>Using Bugzilla</title> - <section id="whatis"> - <title>What is Bugzilla?</title> - - <para>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 by 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.</para> - - <para>Bugzilla has matured immensely, and now boasts many advanced - features. These include: - <itemizedlist> - <listitem> - <para>Powerful searching</para> - </listitem> - - <listitem> - <para>User-configurable email notifications of bug changes</para> - </listitem> - - <listitem> - <para>Full change history</para> - </listitem> - - <listitem> - <para>Inter-bug dependency tracking and graphing</para> - </listitem> - - <listitem> - <para>Excellent attachment management</para> - </listitem> - - <listitem> - <para>Integrated, product-based, granular security schema</para> - </listitem> - - <listitem> - <para>Fully security-audited, and runs under Perl's taint mode</para> - </listitem> - - <listitem> - <para>A robust, stable RDBMS back-end</para> - </listitem> - - <listitem> - <para>Web, XML, email and console interfaces</para> - </listitem> - - <listitem> - <para>Completely customisable and/or localisable web user - interface</para> - </listitem> - - <listitem> - <para>Extensive configurability</para> - </listitem> - - <listitem> - <para>Smooth upgrade pathway between versions</para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="why"> - <title>Why Should We Use Bugzilla?</title> - - <para>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.</para> - - <para>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.</para> - - <para>But why should - <emphasis>you</emphasis> - - use Bugzilla?</para> - - <para>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</para> - - <para>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 - <emphasis>something</emphasis> - - 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.</para> - - <para>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.</para> - </section> - <section id="how"> <title>How do I use Bugzilla?</title> - <para>This section contains information for end-users of Bugzilla. If you - are administering a Bugzilla installation, please consult the Installing - and Administering Bugzilla portions of this Guide.</para> - - <para>There is a Bugzilla test installation, called - <ulink url="http://landfill.tequilarista.org/">Landfill</ulink> - - , which you are welcome to play with. However, it does not necessarily + <para>This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + <ulink url="http://landfill.bugzilla.org/">Landfill</ulink>, + which you are welcome to play with (if it's up.) + However, it does not necessarily have all Bugzilla features enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here.</para> @@ -173,8 +22,8 @@ Chapter: Using Bugzilla Consult with the administrator responsible for your installation of Bugzilla for the URL you should use to access it. If you're test-driving Bugzilla, use this URL: - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> - http://landfill.tequilarista.org/bugzilla-tip/</ulink> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"> + http://landfill.bugzilla.org/bugzilla-tip/</ulink> </para> <orderedlist> @@ -200,18 +49,17 @@ Chapter: Using Bugzilla <listitem> <para>Click the <quote>Log In</quote> - link in the yellow area at the bottom of the page in your browser, enter your email address and password into the spaces provided, and click - <quote>Login</quote> - - .</para> + <quote>Login</quote>. + </para> + </listitem> </orderedlist> - <para>You are now logged in. Bugzilla uses cookies for authentication, - so (unless your IP address changes) you should not have to log in + <para>You are now logged in. Bugzilla uses cookies for authentication + so, unless your IP address changes, you should not have to log in again.</para> </section> @@ -221,75 +69,65 @@ Chapter: Using Bugzilla <para>The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1"> + url="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1"> Bug 1 on Landfill</ulink> - is a good example. Note that the names of most fields are hyperlinks; + is a good example. Note that the labels for most fields are hyperlinks; clicking them will take you to context-sensitive help on that - particular field.</para> + particular field. Fields marked * may not be present on every + installation of Bugzilla.</para> <orderedlist> <listitem> <para> - <emphasis>Product and Component</emphasis> - - : Bugs are divided up by Product and Component, with a Product + <emphasis>Product and Component</emphasis>: + Bugs are divided up by Product and Component, with a Product having one or more Components in it. For example, bugzilla.mozilla.org's "Bugzilla" Product is composed of several Components: <simplelist> <member> <emphasis>Administration:</emphasis> - Administration of a Bugzilla installation.</member> <member> <emphasis>Bugzilla-General:</emphasis> - Anything that doesn't fit in the other components, or spans multiple components.</member> <member> <emphasis>Creating/Changing Bugs:</emphasis> - Creating, changing, and viewing bugs.</member> <member> <emphasis>Documentation:</emphasis> - The Bugzilla documentation, including The Bugzilla Guide.</member> <member> <emphasis>Email:</emphasis> - Anything to do with email sent by Bugzilla.</member> <member> <emphasis>Installation:</emphasis> - The installation process of Bugzilla.</member> <member> <emphasis>Query/Buglist:</emphasis> - Anything to do with searching for bugs and viewing the buglists.</member> <member> <emphasis>Reporting/Charting:</emphasis> - Getting reports from Bugzilla.</member> <member> <emphasis>User Accounts:</emphasis> - Anything about managing a user account from the user's perspective. Saved queries, creating accounts, changing passwords, logging in, etc.</member> <member> <emphasis>User Interface:</emphasis> - General issues having to do with the user interface cosmetics (not functionality) including cosmetic issues, HTML templates, etc.</member> @@ -301,46 +139,41 @@ Chapter: Using Bugzilla <para> <emphasis>Status and Resolution:</emphasis> - A bug passes through several Statuses in its lifetime, and ends up - in the RESOLVED status, with one of a set of Resolutions (e.g. - FIXED, INVALID.) The different possible values for Status and - Resolution on your installation will be documented in the + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the context-sensitive help for those items.</para> </listitem> <listitem> <para> <emphasis>Assigned To:</emphasis> - The person responsible for fixing the bug.</para> </listitem> <listitem> <para> - <emphasis>URL:</emphasis> - + <emphasis>*URL:</emphasis> A URL associated with the bug, if any.</para> </listitem> <listitem> <para> <emphasis>Summary:</emphasis> - A one-sentence summary of the problem.</para> </listitem> <listitem> <para> - <emphasis>Status Whiteboard:</emphasis> - + <emphasis>*Status Whiteboard:</emphasis> (a.k.a. Whiteboard) A free-form text area for adding short notes and tags to a bug.</para> </listitem> <listitem> <para> - <emphasis>Keywords:</emphasis> - + <emphasis>*Keywords:</emphasis> The administrator can define keywords which you can use to tag and categorise bugs - e.g. The Mozilla Project has keywords like crash and regression.</para> @@ -349,7 +182,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Platform and OS:</emphasis> - These indicate the computing environment where the bug was found.</para> </listitem> @@ -357,7 +189,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Version:</emphasis> - The "Version" field is usually used for versions of a product which have been released, and is set to indicate which versions of a Component have the particular problem the bug report is @@ -367,7 +198,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Priority:</emphasis> - The bug assignee uses this field to prioritise his or her bugs. It's a good idea not to change this on other people's bugs.</para> </listitem> @@ -375,7 +205,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Severity:</emphasis> - This indicates how severe the problem is - from blocker ("application unusable") to trivial ("minor cosmetic issue"). You can also use this field to indicate whether a bug is an enhancement @@ -384,8 +213,7 @@ Chapter: Using Bugzilla <listitem> <para> - <emphasis>Target:</emphasis> - + <emphasis>*Target:</emphasis> (a.k.a. Target Milestone) A future version by which the bug is to be fixed. e.g. The Bugzilla Project's milestones for future Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not @@ -396,29 +224,25 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Reporter:</emphasis> - The person who filed the bug.</para> </listitem> <listitem> <para> <emphasis>CC list:</emphasis> - A list of people who get mail when the bug changes.</para> </listitem> <listitem> <para> <emphasis>Attachments:</emphasis> - You can attach files (e.g. testcases or patches) to bugs. If there are any attachments, they are listed in this section.</para> </listitem> <listitem> <para> - <emphasis>Dependencies:</emphasis> - + <emphasis>*Dependencies:</emphasis> If this bug cannot be fixed unless other bugs are fixed (depends on), or this bug stops other bugs being fixed (blocks), their numbers are recorded here.</para> @@ -426,15 +250,13 @@ Chapter: Using Bugzilla <listitem> <para> - <emphasis>Votes:</emphasis> - + <emphasis>*Votes:</emphasis> Whether this bug has any votes.</para> </listitem> <listitem> <para> <emphasis>Additional Comments:</emphasis> - You can add your two cents to the bug discussion here, if you have something worthwhile to say.</para> </listitem> @@ -447,8 +269,8 @@ Chapter: Using Bugzilla <para>The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You can play with it here: - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"> - landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/query.cgi"> + landfill.bugzilla.org/bugzilla-tip/query.cgi</ulink> .</para> @@ -460,7 +282,7 @@ Chapter: Using Bugzilla <para>Highly advanced querying is done using Boolean Charts, which have their own <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html"> + url="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html"> context-sensitive help</ulink> .</para> @@ -517,10 +339,9 @@ Chapter: Using Bugzilla <para>Years of bug writing experience has been distilled for your reading pleasure into the <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html"> - Bug Writing Guidelines</ulink> - - . While some of the advice is Mozilla-specific, the basic principles of + url="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html"> + Bug Writing Guidelines</ulink>. + 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 @@ -532,15 +353,13 @@ Chapter: Using Bugzilla <orderedlist> <listitem> <para>Go to - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"> Landfill</ulink> - in your browser and click <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> - Enter a new bug report</ulink> - - .</para> + url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi"> + Enter a new bug report</ulink>. + </para> </listitem> <listitem> @@ -560,29 +379,138 @@ Chapter: Using Bugzilla </section> </section> - <section id="init4me"> - <title>User Preferences</title> + <section id="hintsandtips"> + <title>Hints and Tips</title> + + <para>This section distills some Bugzilla tips and best practices + that have been developed.</para> + + <section> + <title>Autolinkification</title> + <para>Bugzilla comments are plain text - so posting HTML will result + in literal HTML tags rather than being interpreted by a browser. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + http://www.bugzilla.org will be turned into + <ulink url="http://www.bugzilla.org">http://www.bugzilla.org</ulink>. + Other strings which get linkified in the obvious manner are: + <simplelist> + <member>bug 12345</member> + <member>bug 23456, comment 53</member> + <member>attachment 4321</member> + <member>mailto:george@example.com</member> + <member>george@example.com</member> + <member>ftp://ftp.mozilla.org</member> + <member>Most other sorts of URL</member> + </simplelist> + </para> + + <para>A corollary here is that if you type a bug number in a comment, + you should put the word "bug" before it, so it gets autolinkified + for the convenience of others. + </para> + </section> - <para>You can customise various aspects of Bugzilla, via the "Edit prefs" - link in the page footer, once you have logged in, e.g. to - <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> - Landfill</ulink> + <section id="quicksearch"> + <title>Quicksearch</title> - . The preferences are split into four tabs.</para> + <para>Quicksearch is a single-text-box query tool which uses + metacharacters to indicate what is to be searched. For example, typing + "<filename>foo|bar</filename>" + into Quicksearch would search for "foo" or "bar" in the + summary and status whiteboard of a bug; adding + "<filename>:BazProduct</filename>" would + search only in that product. + </para> + + <para>You'll find the Quicksearch box on Bugzilla's + front page, along with a + <ulink url="../../quicksearch.html">Help</ulink> + link which details how to use it.</para> + </section> + + <section id="commenting"> + <title>Comments</title> + + <para>If you are changing the fields on a bug, only comment if + either you have something pertinent to say, or Bugzilla requires it. + Otherwise, you may spam people unnecessarily with bug mail. + To take an example: a user can set up their account to filter out messages + where someone just adds themselves to the CC field of a bug + (which happens a lot.) If you come along, add yourself to the CC field, + and add a comment saying "Adding self to CC", then that person + gets a pointless piece of mail they would otherwise have avoided. + </para> + + <para> + Don't use sigs in comments. Signing your name ("Bill") is acceptable, + particularly if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. + </para> + </section> + + <section id="attachments"> + <title>Attachments</title> + + <para> + Use attachments, rather than comments, for large chunks of ASCII data, + such as trace, debugging output files, or log files. That way, it doesn't + bloat the bug for everyone who wants to read it, and cause people to + receive fat, useless mails. + </para> + + <para>Trim screenshots. There's no need to show the whole screen if + you are pointing out a single-pixel problem. + </para> + + <para>Don't attach simple test cases (e.g. one HTML file, one + CSS file and an image) as a ZIP file. Instead, upload them in + reverse order and edit the referring file so that they point to the + attached files. This way, the test case works immediately + out of the bug. + </para> + </section> + + <section> + <title>Filing Bugs</title> + + <para>Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + </para> + + <para> + You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + </para> + + <para>If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + </para> + </section> + </section> + + <section id="userpreferences"> + <title>User Preferences</title> + + <para>Once you have logged in, you can customise various aspects of + Bugzilla via the "Edit prefs" link in the page footer. + The preferences are split into four tabs:</para> <section id="accountsettings" xreflabel="Account Settings"> <title>Account Settings</title> - <para>On this tab, you can change your basic Account Settings, + <para>On this tab, you can change your basic account information, including your password, email address and real name. For security reasons, in order to change anything on this page you must type your <emphasis>current</emphasis> - password into the <quote>Password</quote> - - field. If you attempt to change your email address, a confirmation + field at the top of the page. + If you attempt to change your email address, a confirmation email is sent to both the old and new addresses, with a link to use to confirm the change. This helps to prevent account hijacking.</para> </section> @@ -600,28 +528,27 @@ Chapter: Using Bugzilla "Users to watch" text entry box you can receive a copy of all the bugmail of other users (security settings permitting.) 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.</para> + projects or users go on holiday.</para> <note> - <para>This option may not be available in all Bugzilla installations. - Ask your administrator.</para> + <para>The ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator.</para> </note> </section> <section id="footersettings"> <title>Page Footer</title> - - <para>By default, this page is quite barren. However, if you explore - the Search 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. Once you have a stored query, you can come + + <para>On the Search page, you can store queries in Bugzilla, so if you + regularly run a particular query it is just a drop-down menu away. + Once you have a stored query, you can come here to request that it also be displayed in your page footer.</para> </section> <section id="permissionsettings"> <title>Permissions</title> - + <para>This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you are in, and whether you can edit bugs or perform various administration diff --git a/docs/sgml/variants.sgml b/docs/sgml/variants.sgml index 5fbea801f..73f6822fb 100644 --- a/docs/sgml/variants.sgml +++ b/docs/sgml/variants.sgml @@ -1,5 +1,5 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">--> -<chapter id="variants" xreflabel="Bugzilla Variants and Competitors"> +<appendix id="variants" xreflabel="Bugzilla Variants and Competitors"> <title>Bugzilla Variants and Competitors</title> <para>I created this section to answer questions about Bugzilla competitors @@ -13,13 +13,12 @@ <section id="rhbugzilla" xreflabel="Red Hat Bugzilla"> <title>Red Hat Bugzilla</title> - <para>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 + <para>Red Hat Bugzilla is a fork of Bugzilla 2.8. + One of its major benefits 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.</para> + back-end, instead of just MySQL. Dave Lawrence of Red Hat is + active in the Bugzilla community, and we hope to see a reunification + of the fork before too long.</para> <para>URL: <ulink url="http://bugzilla.redhat.com/bugzilla/"> @@ -30,38 +29,26 @@ <section id="variant-fenris" xreflabel="Loki Bugzilla, a.k.a. Fenris"> <title>Loki Bugzilla (Fenris)</title> - <para>Fenris can be found at - <ulink url="http://fenris.lokigames.com/"> - http://fenris.lokigames.com</ulink> - - . It is a fork from Bugzilla.</para> + <para>Fenris was a fork from Bugzilla made by Loki Games; when + Loki went into receivership, it died. While Loki's other code lives on, + its custodians recommend Bugzilla for future bug-tracker deployments. + </para> </section> <section id="variant-issuezilla" xreflabel="Issuezilla"> <title>Issuezilla</title> - <para>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, - <xref linkend="variant-scarab" /> - - , is under heavy development and looks promising!</para> - - <para>URL: - <ulink url="http://issuezilla.tigris.org/servlets/ProjectHome"> - http://issuezilla.tigris.org/servlets/ProjectHome</ulink> - </para> + <para>Issuezilla was another fork from Bugzilla, made by collab.net and + hosted at tigris.org. It is also dead; the primary focus of bug-tracking + at tigris.org is their Java-based bug-tracker, + <xref linkend="variant-scarab"/>.</para> </section> - <section id="variant-scarab" - xreflabel="Scarab, a newfangled Java-based issue tracker"> + <section id="variant-scarab" xreflabel="Scarab"> <title>Scarab</title> - <para>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.</para> + <para>Scarab is a new open source bug-tracking system built using Java + Serlet technology. It is currently at version 1.0 beta 8.</para> <para>URL: <ulink url="http://scarab.tigris.org/">http://scarab.tigris.org</ulink> @@ -72,32 +59,29 @@ <title>Perforce SCM</title> <para>Although Perforce isn't really a bug tracker, it can be used as - such through the - <quote>jobs</quote> - + such through the <quote>jobs</quote> functionality.</para> - <para> + <para>URL: <ulink url="http://www.perforce.com/perforce/technotes/note052.html"> + http://www.perforce.com/perforce/technotes/note052.html </ulink> - - http://www.perforce.com/perforce/technotes/note052.html</para> + </para> </section> <section id="variant-sourceforge" xreflabel="SourceForge"> <title>SourceForge</title> - <para>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!</para> + <para>SourceForge is a way of coordinating geographically + distributed free software and open source projects over the Internet. + It has a built-in bug tracker, but it's not highly thought of.</para> <para>URL: <ulink url="http://www.sourceforge.net"> http://www.sourceforge.net</ulink> </para> </section> -</chapter> +</appendix> <!-- Keep this comment at the end of the file Local variables: diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt index 2cb5f95c8..090154f99 100644 --- a/docs/txt/Bugzilla-Guide.txt +++ b/docs/txt/Bugzilla-Guide.txt @@ -1,208 +1,88 @@ -The Bugzilla GuideMatthew P. Barnson - - barnboy@trilobyte.net - -Zach Lipton - - zach AT zachlipton DOT com - -2001-04-25 - - Revision History - Revision v2.11 20 December 2000 Revised by: MPB - Converted the README, FAQ, and DATABASE information into SGML docbook - format. - Revision 2.11.1 06 March 2001 Revised by: MPB - 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. - Revision 2.12.0 24 April 2001 Revised by: MPB - 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. - Revision 2.14.0 07 August 2001 Revised by: MPB - 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. - - This is the documentation for Bugzilla, the Mozilla bug-tracking - system. +The Bugzilla GuideMatthew P. BarnsonThe Bugzilla Team - 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. + This is the documentation for Bugzilla, the mozilla.org bug-tracking + system. Bugzilla is an enterprise-class piece of software that powers + issue-tracking for hundreds of organizations around the world, + tracking millions of bugs. - 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! - _________________________________________________________________ + This documentation is maintained in DocBook 4.1.2 XML format. Changes + are best submitted as plain text or SGML diffs, attached to a bug + filed in mozilla.org's Bugzilla. + _______________________________________________________________________ Table of Contents 1. About This Guide - 1.1. Purpose and Scope of this Guide - 1.2. Copyright Information - 1.3. Disclaimer - 1.4. New Versions - 1.5. Credits - 1.6. Contributors - 1.7. Feedback - 1.8. Translations - 1.9. Document Conventions + 1.1. Copyright Information + 1.2. Disclaimer + 1.3. New Versions + 1.4. Credits + 1.5. Document Conventions - 2. Using Bugzilla + 2. Introduction 2.1. What is Bugzilla? 2.2. Why Should We Use Bugzilla? - 2.3. How do I use Bugzilla? - 2.4. Where can I find my user preferences? - 2.5. Using Bugzilla-Conclusion - 3. Installation + 3. Using Bugzilla - 3.1. ERRATA - 3.2. Step-by-step Install - 3.3. Mac OS X Installation Notes - 3.4. BSD Installation Notes - 3.5. Installation General Notes - 3.6. Win32 Installation Notes + 3.1. How do I use Bugzilla? + 3.2. Hints and Tips + 3.3. User Preferences - 4. Administering Bugzilla + 4. Installation - 4.1. Post-Installation Checklist - 4.2. User Administration - 4.3. Product, Component, Milestone, and Version Administration - 4.4. Bugzilla Security + 4.1. Step-by-step Install + 4.2. Optional Additional Configuration + 4.3. Win32 Installation Notes + 4.4. Mac OS X Installation Notes + 4.5. Troubleshooting - 5. Integrating Bugzilla with Third-Party Tools + 5. Administering Bugzilla - 5.1. Bonsai - 5.2. CVS - 5.3. Perforce SCM - 5.4. Tinderbox/Tinderbox2 + 5.1. Bugzilla Configuration + 5.2. User Administration + 5.3. Product, Component, Milestone, and Version Administration + 5.4. Voting + 5.5. Groups and Group Security + 5.6. Bugzilla Security + 5.7. Template Customisation + 5.8. Upgrading to New Releases + 5.9. Integrating Bugzilla with Third-Party Tools - 6. The Future of Bugzilla - 7. Bugzilla Variants and Competitors + A. The Bugzilla FAQ + B. The Bugzilla Database - 7.1. Red Hat Bugzilla - 7.2. Loki Bugzilla (Fenris) - 7.3. Issuezilla - 7.4. Scarab - 7.5. Perforce SCM - 7.6. SourceForge + B.1. Database Schema Chart + B.2. MySQL Bugzilla Database Introduction - A. The Bugzilla FAQ - B. Software Download Links - C. The Bugzilla Database - - C.1. Database Schema Chart - C.2. MySQL Bugzilla Database Introduction - C.3. MySQL Permissions & Grant Tables - - D. Useful Patches and Utilities for Bugzilla - - D.1. Apache mod_rewrite magic - D.2. The setperl.csh Utility - D.3. Command-line Bugzilla Queries - D.4. The Quicksearch Utility - D.5. Hacking Bugzilla - - E. GNU Free Documentation License - - 0. PREAMBLE - 1. APPLICABILITY AND DEFINITIONS - 2. VERBATIM COPYING - 3. COPYING IN QUANTITY - 4. MODIFICATIONS - 5. COMBINING DOCUMENTS - 6. COLLECTIONS OF DOCUMENTS - 7. AGGREGATION WITH INDEPENDENT WORKS - 8. TRANSLATION - 9. TERMINATION - 10. FUTURE REVISIONS OF THIS LICENSE - How to use this License for your documents + C. Useful Patches and Utilities for Bugzilla + + C.1. Apache mod_rewrite magic + C.2. Command-line Bugzilla Queries + + D. Bugzilla Variants and Competitors + + D.1. Red Hat Bugzilla + D.2. Loki Bugzilla (Fenris) + D.3. Issuezilla + D.4. Scarab + D.5. Perforce SCM + D.6. SourceForge Glossary List of Examples - 2-1. Some Famous Software Versions - 2-2. Mozilla's Bugzilla Components - 3-1. Setting up bonsaitools symlink - 3-2. Running checksetup.pl as the web user - 3-3. Installing ActivePerl ppd Modules on Microsoft Windows - 3-4. Installing OpenInteract ppd Modules manually on Microsoft Windows - 3-5. Removing encrypt() for Windows NT Bugzilla version 2.12 or + 4-1. Installing ActivePerl ppd Modules on Microsoft Windows + 4-2. Installing OpenInteract ppd Modules manually on Microsoft Windows + 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier - - 4-1. Creating some Components - 4-2. Common Use of Versions - 4-3. A Different Use of Versions - 4-4. Using SortKey with Target Milestone - 4-5. When to Use Group Security - 4-6. Creating a New Group - 4-7. Bugzilla Groups - D-1. Using Setperl to set your perl path - 1. A Sample Product _________________________________________________________________ Chapter 1. About This Guide -1.1. Purpose and Scope of this Guide - -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. - -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. - -This release of the Bugzilla Guide is the 2.14 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 even-numbered point -releases (1.2, 1.14, etc.) are considered "stable releases", intended for -public consumption; on the other hand, odd-numbered point releases (1.3, -2.09, etc.) are considered unstable development releases intended for -advanced users, systems administrators, developers, and those who enjoy a -lot of pain. - -Newer revisions of the Bugzilla Guide follow the numbering conventions of -the main-tree Bugzilla releases, available at http://www.bugzilla.org/. -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. - -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 <barnboy@trilobyte.net> to correct them. - _________________________________________________________________ - -1.2. Copyright Information +1.1. Copyright Information @@ -210,40 +90,382 @@ documentation; please contact <barnboy@trilobyte.net> to correct them. 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". + Texts. A copy of the license is included below. + +--Copyright (c) 2000-2002 Matthew P. Barnson and The Bugzilla Team + + If you have any questions regarding this document, its copyright, or + publishing this document in non-electronic form, please contact The + Bugzilla Team. + _________________________________________________________________ + +1.1.1. GNU Free Documentation License + +Version 1.1, March 2000 + + 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. + _________________________________________________________________ + +0. PREAMBLE + +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. + +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. + +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. + _________________________________________________________________ + +1. APPLICABILITY AND DEFINITIONS + +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". + +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. + +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. + +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. + +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. + +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". + +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. + +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. + _________________________________________________________________ + +2. VERBATIM COPYING + +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. + +You may also lend copies, under the same conditions stated above, and you +may publicly display copies. + _________________________________________________________________ + +3. COPYING IN QUANTITY + +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. + +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. + +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. + +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. + _________________________________________________________________ + +4. MODIFICATIONS ---Copyright (c) 2000-2001 Matthew P. Barnson +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: - If you have any questions regarding this document, its copyright, or - publishing this document in non-electronic form, please contact - Matthew P. Barnson. + A. 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. + B. 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). + C. State on the Title page the name of the publisher of the Modified + Version, as the publisher. + D. Preserve all the copyright notices of the Document. + E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. + F. 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. + G. Preserve in that license notice the full lists of Invariant + Sections and required Cover Texts given in the Document's license + notice. + H. Include an unaltered copy of this License. + I. 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. + J. 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. + K. 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. + L. 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. + M. Delete any section entitled "Endorsements". Such a section may not + be included in the Modified Version. + N. Do not retitle any existing section as "Endorsements" or to + conflict in title with any Invariant Section. + + 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. + + 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. + + 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. + + 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. _________________________________________________________________ -1.3. Disclaimer +5. COMBINING DOCUMENTS + +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. + +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. + +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." + _________________________________________________________________ + +6. COLLECTIONS OF DOCUMENTS + +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. + +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. + _________________________________________________________________ + +7. AGGREGATION WITH INDEPENDENT WORKS + +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. + +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. + _________________________________________________________________ + +8. TRANSLATION + +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. + _________________________________________________________________ + +9. TERMINATION + +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. + _________________________________________________________________ + +10. FUTURE REVISIONS OF THIS LICENSE + +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 http://www.gnu.org/copyleft/ . + +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. + _________________________________________________________________ + +How to use this License for your documents + +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: + + 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". + + 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. + + 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. + _________________________________________________________________ + +1.2. Disclaimer 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. +concepts, examples, and other content at your own risk. This document may +contain errors and inaccuracies that may damage your system, cause your +partner to leave you, your boss to fire you, your cats to pee on your +furniture and clothing, and global thermonuclear war. Proceed with caution. 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. 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. +with the exception of the term "GNU/Linux". We 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. 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! +installing Bugzilla and at regular intervals thereafter. If you implement +any suggestion in this Guide, implement this one! 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, @@ -253,38 +475,44 @@ 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. +auditing it yourself to ensure your security needs are met. _________________________________________________________________ -1.4. New Versions +1.3. New Versions -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. +This is the 2.16 version of The Bugzilla Guide. It is so named to match the +current version of Bugzilla. 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. This document can be found in the following places: - * TriloBYTE - * Mozilla.org + * bugzilla.org * The Linux Documentation Project - The latest version of this document can be checked out via CVS. Please - follow the instructions available at the Mozilla CVS page, and check - out the mozilla/webtools/bugzilla/docs/ branch. + The latest version of this document can always be checked out via CVS. + Please follow the instructions available at the Mozilla CVS page, and + check out the mozilla/webtools/bugzilla/docs/ subtree. + + The Bugzilla Guide is currently only available in English. If you + would like to volunteer to translate it, please contact Dave Miller. _________________________________________________________________ -1.5. Credits +1.4. Credits 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: +this Guide, through their writing, dedicated hacking efforts, numerous +e-mail and IRC support sessions, and overall excellent contribution to the +Bugzilla community: + +Matthew P. Barnson for the Herculaean task of pulling together the Bugzilla +Guide and shepherding it to 2.14. Terry Weissman for initially writing Bugzilla and creating the README upon which the UNIX installation documentation is largely based. Tara Hernandez for keeping Bugzilla development going strong after Terry -left Mozilla.org +left mozilla.org Dave Lawrence for providing insight into the key differences between Red Hat's customized Bugzilla, and being largely responsible for the "Red Hat @@ -296,60 +524,40 @@ incessant questions and arguments on irc.mozilla.org in #mozwebtools Last but not least, all the members of the netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. - _________________________________________________________________ - -1.6. Contributors -Thanks go to these people for significant contributions to this +Thanks also go to the following people for significant contributions to this documentation (in no particular order): -Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum, -Jacob Steenhagen, Joe Robins +Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron +Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham. _________________________________________________________________ -1.7. Feedback +1.5. Document Conventions -I welcome feedback on this document. Without your submissions and input, -this Guide cannot continue to exist. Please mail additions, comments, -criticisms, etc. to <barnboy@trilobyte.net>. Please send flames to -<devnull@localhost> - _________________________________________________________________ - -1.8. Translations - -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 -<mozilla-webtools@mozilla.org>, and arrange with Matt Barnson to check it -into CVS. - _________________________________________________________________ - -1.9. Document Conventions - -This document uses the following conventions +This document uses the following conventions: Descriptions Appearance Warnings Caution - Warnings. + Don't run with scissors! Hint Tip - Hint. + Would you like a breath mint? Notes Note - Note. + Dear John... Information requiring special attention Warning - Warning. - File Names file.extension + Read this or the cat gets it. + File Names filename Directory Names directory Commands to be typed command Applications Names application @@ -359,24 +567,20 @@ This document uses the following conventions Environment Variables VARIABLE Emphasized word word Code Example - <para>Beginning and end of paragraph</para> +<para> +Beginning and end of paragraph +</para> _________________________________________________________________ -Chapter 2. Using Bugzilla - - - - What, Why, How, & Where? - _________________________________________________________________ +Chapter 2. Introduction 2.1. What is Bugzilla? -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 +Bugzilla is a bug- or issue-tracking system. Bug-tracking systems allow +individual or groups of developers effectively to keep track of outstanding +problems with their product. Bugzilla was originally written by Terry +Weissman in a programming language called TCL, to replace a rudimentary +bug-tracking database used internally by 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 @@ -384,690 +588,429 @@ 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. -Bugzilla has matured immensely, and now boasts many advanced features. These -include: - - * integrated, product-based granular security schema - * inter-bug dependencies and dependency graphing - * advanced reporting capabilities - * a robust, stable RDBMS back-end - * extensive configurability - * a very well-understood and well-thought-out natural bug resolution - protocol - * email, XML, console, and HTTP APIs - * available integration with automated software configuration - management systems, including Perforce and CVS (through the - Bugzilla email interface and checkin/checkout scripts) - * too many more features to list - - 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. - - Some recent headway has been made on the query front, however. If you - are using the latest version of Bugzilla, you should see a "simple - search" form on the default front page of your Bugzilla install. Type - in two or three search terms and you should pull up some relevant - information. This is also available as "queryhelp.cgi". - - Despite these small problems, Bugzilla is very hard to beat. It is - under very active development to address the current issues, and - continually gains new features. +Bugzilla boasts many advanced features. These include: + + * Powerful searching + * User-configurable email notifications of bug changes + * Full change history + * Inter-bug dependency tracking and graphing + * Excellent attachment management + * Integrated, product-based, granular security schema + * Fully security-audited, and runs under Perl's taint mode + * A robust, stable RDBMS back-end + * Web, XML, email and console interfaces + * Completely customisable and/or localisable web user interface + * Extensive configurability + * Smooth upgrade pathway between versions _________________________________________________________________ 2.2. Why Should We Use Bugzilla? - - - No, Who's on first... - - 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. - - 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. - - But why should you use Bugzilla? - - 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 - - Bugzilla can dramatically increase the productivity and accountability - of individual employees by providing a documented workflow and - positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do something - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and by using Bugzilla's e-mail - integration features be able to follow the discussion trail that led - to critical decisions. - - 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. +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. + +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. + +But why should you use Bugzilla? + +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, NASA, 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. + +Bugzilla can dramatically increase the productivity and accountability of +individual employees by providing a documented workflow and positive +feedback for good performance. How many times do you wake up in the morning, +remembering that you were supposed to do something today, but you just can't +quite remember? Put it in Bugzilla, and you have a record of it from which +you can extrapolate milestones, predict product versions for integration, +and follow the discussion trail that led to critical decisions. + +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. _________________________________________________________________ -2.3. How do I use Bugzilla? - - - - Hey! I'm Woody! Howdy, Howdy, Howdy! - - 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. +Chapter 3. Using Bugzilla - Throughout this portion of the Guide, we will refer to user account - options available at the Bugzilla test installation, - landfill.tequilarista.org. +3.1. How do I use Bugzilla? - Note - - Some people have run into difficulties completing this tutorial. If - you run into problems, please check the updated online documentation - available at http://www.trilobyte.net/barnsons. 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 news://news.mozilla.org/netscape.public.mozilla.webtools - 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. +This section contains information for end-users of Bugzilla. There is a +Bugzilla test installation, called Landfill, which you are welcome to play +with (if it's up.) However, it does not necessarily have all Bugzilla +features enabled, and often runs cutting-edge versions of Bugzilla for +testing, so some things may work slightly differently than mentioned here. _________________________________________________________________ -2.3.1. Create a Bugzilla Account +3.1.1. Create a Bugzilla Account -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: -http://landfill.tequilarista.org/bugzilla-tip/ +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 Bugzilla, use this +URL: http://landfill.bugzilla.org/bugzilla-tip/ - 1. Click the "Open a new Bugzilla account" link. - 2. 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. - 3. Within moments, you should receive an email to the address you + 1. Click the "Open a new Bugzilla account" link, enter your email + address and, optionally, your name in the spaces provided, then + click "Create Account" . + 2. 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). - 4. Click the "Log In" link in the yellow area at the bottom of the - page in your browser, then enter your "E-mail address" and - "Password" you just received into the spaces provided, and select - "Login". + account. This password is randomly generated, and can be changed + to something more memorable. + 3. Click the "Log In" link in the yellow area at the bottom of the + page in your browser, enter your email address and password into + the spaces provided, and click "Login". + + You are now logged in. Bugzilla uses cookies for authentication so, + unless your IP address changes, you should not have to log in again. + _________________________________________________________________ - Note +3.1.2. Anatomy of a Bug - If you ever forget your password, you can come back to this page, - enter your "E-mail address", then select the "E-mail me a password" - button to have your password mailed to you again so that you can - login. +The core of Bugzilla is the screen which displays a particular bug. It's a +good place to explain some Bugzilla concepts. Bug 1 on Landfill is a good +example. Note that the labels for most fields are hyperlinks; clicking them +will take you to context-sensitive help on that particular field. Fields +marked * may not be present on every installation of Bugzilla. - Caution + 1. Product and Component: Bugs are divided up by Product and + Component, with a Product having one or more Components in it. For + example, bugzilla.mozilla.org's "Bugzilla" Product is composed of + several Components: - Many modern browsers include an "Auto-Complete" or "Form Fill" feature - to remember the user names and passwords you type in at many sites. - Unfortunately, sometimes they attempt to guess what you will put in as - your password, and guess wrong. If you notice a text box is already - filled out, please overwrite the contents of the text box so you can - be sure to input the correct information. - - Congratulations! If you followed these directions, you now are the - proud owner of a user account on landfill.tequilarista.org (Landfill) - or your local Bugzilla install. You should now see in your browser a - page called the "Bugzilla Query Page". It may look daunting, but with - this Guide to walk you through it, you will master it in no time. - _________________________________________________________________ - -2.3.2. The Bugzilla Query Page - -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. - -There are efforts underway to simplify query usage. If you have a local -installation of Bugzilla 2.12 or higher, you should have quicksearch.html -available to use and simplify your searches. There is also a helper for the -query interface, called queryhelp.cgi. Landfill tends to run the latest -code, so these two utilities should be available there for your perusal. - -At this point, let's visit the query page. -landfill.tequilarista.org/bugzilla-tip/query.cgi - -The first thing you need to notice about the Bugzilla Query Page is that -nearly every box you see on your screen has a hyperlink nearby, explaining -what it is or what it does. Near the upper-left-hand corner of your browser -window you should see the word "Status" underlined. Select it. - -Notice the page that popped up? Every underlined word you see on your screen -is a hyperlink that will take you to context-sensitive help. Click around -for a while, and learn what everything here does. To return to the query -interface after pulling up a help page, use the "Back" button in your -browser. - -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. - - 1. Ensure you are back on the "Bugzilla Query Page". Do nothing in - the boxes marked "Status", "Resolution", "Platform", "OpSys", - "Priority", or "Severity". The default query for "Status" is to - find all bugs that are NEW, ASSIGNED, or REOPENED, which is what - we want. If you don't select anything in the other 5 scrollboxes - there, then you are saying that "any of these are OK"; we're not - locking ourselves into only finding bugs on the "DEC" Platform, or - "Windows 95" OpSys (Operating System). You're smart, I think you - have it figured out. - Basically, selecting anything on the query page narrows your - search down. Leaving stuff unselected, or text boxes unfilled, - broadens your search. - 2. 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. - Type "barnboy@trilobyte.net" in the top Email text box. - 3. 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 scrollbox. Using the down arrow on the scrollbox, - scroll down until you can see an entry called "Bugzilla". Select - this entry. - 4. 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. - Example 2-1. Some Famous Software Versions - 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). - 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 older version of the software than 1.11, but is a newer version - than 1.1.1. - In general, a "Version" in Bugzilla should refer to released - products, not products that have not yet been released to the - public. Forthcoming products are what the Target Milestone field - is for. - 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. - Example 2-2. Mozilla's Bugzilla Components - Mozilla's "Bugzilla" Product is composed of several pieces - (Components): - - Administration, Administration of a bugzilla installation, including - editcomponents.cgi, editgroups.cgi, editkeywords.cgi, editparams.cgi, - editproducts.cgi, editusers.cgi, editversions.cgi, and - sanitycheck.cgi. - Bugzilla-General, Anything that doesn't fit in the other components, + Administration: Administration of a Bugzilla installation. + Bugzilla-General: Anything that doesn't fit in the other components, or spans multiple components. - Creating/Changing Bugs, Creating, changing, and viewing bugs. - enter_bug.cgi, post_bug.cgi, show_bug.cgi and process_bug.cgi. - Documentation, The bugzilla documentation, including anything in the - docs/ directory and The Bugzilla Guide (This document :) - Email, Anything to do with email sent by Bugzilla. processmail - Installation, The installation process of Bugzilla. This includes - checksetup.pl and whatever else it evolves into. - Query/Buglist, Anything to do with searching for bugs and viewing the - buglists. query.cgi and buglist.cgi - Reporting/Charting, Getting reports from Bugzilla. reports.cgi and - duplicates.cgi - User Accounts, Anything about managing a user account from the user's - perspective. userprefs.cgi, saved queries, creating accounts, changing - passwords, logging in, etc. - User Interface, General issues having to do with the user interface + Creating/Changing Bugs: Creating, changing, and viewing bugs. + Documentation: The Bugzilla documentation, including The Bugzilla + Guide. + Email: Anything to do with email sent by Bugzilla. + Installation: The installation process of Bugzilla. + Query/Buglist: Anything to do with searching for bugs and viewing the + buglists. + Reporting/Charting: Getting reports from Bugzilla. + User Accounts: Anything about managing a user account from the user's + perspective. Saved queries, creating accounts, changing passwords, + logging in, etc. + User Interface: General issues having to do with the user interface cosmetics (not functionality) including cosmetic issues, HTML templates, etc. - 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. - 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". - 5. OK, now let's select the "Bugzilla" component from its scrollbox. - 6. Skip down the page a bit -- do you see the "submit query" button? - Select it, and let's run this query! - 7. 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! - - 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. - - A couple more interesting things about the Bug List page: - - Change Columns: by selecting this link, you can show all kinds of - information in the Bug List - Change several bugs at once: 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. - Send mail to bug owners: 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. - Edit this query: 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. - - Note - - 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 Bugzilla Home Page to - learn about the Anatomy and Life Cycle of a Bug before continuing. + 2. Status and Resolution: These define exactly what state the bug is + in - from not even being confirmed as a bug, through to being + fixed and the fix confirmed by Quality Assurance. The different + possible values for Status and Resolution on your installation + should be documented in the context-sensitive help for those + items. + 3. Assigned To: The person responsible for fixing the bug. + 4. *URL: A URL associated with the bug, if any. + 5. Summary: A one-sentence summary of the problem. + 6. *Status Whiteboard: (a.k.a. Whiteboard) A free-form text area for + adding short notes and tags to a bug. + 7. *Keywords: The administrator can define keywords which you can use + to tag and categorise bugs - e.g. The Mozilla Project has keywords + like crash and regression. + 8. Platform and OS: These indicate the computing environment where + the bug was found. + 9. Version: The "Version" field is usually used for versions of a + product which have been released, and is set to indicate which + versions of a Component have the particular problem the bug report + is about. + 10. Priority: The bug assignee uses this field to prioritise his or + her bugs. It's a good idea not to change this on other people's + bugs. + 11. Severity: This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an + enhancement request. + 12. *Target: (a.k.a. Target Milestone) A future version by which the + bug is to be fixed. e.g. The Bugzilla Project's milestones for + future Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are + not restricted to numbers, thought - you can use any text strings, + such as dates. + 13. Reporter: The person who filed the bug. + 14. CC list: A list of people who get mail when the bug changes. + 15. Attachments: You can attach files (e.g. testcases or patches) to + bugs. If there are any attachments, they are listed in this + section. + 16. *Dependencies: If this bug cannot be fixed unless other bugs are + fixed (depends on), or this bug stops other bugs being fixed + (blocks), their numbers are recorded here. + 17. *Votes: Whether this bug has any votes. + 18. Additional Comments: You can add your two cents to the bug + discussion here, if you have something worthwhile to say. _________________________________________________________________ -2.3.3. Creating and Managing Bug Reports +3.1.3. Searching for Bugs - +The Bugzilla Search page is is the interface where you can find any bug +report, comment, or patch currently in the Bugzilla system. You can play +with it here: landfill.bugzilla.org/bugzilla-tip/query.cgi . - And all this time, I thought we were taking bugs out... - _________________________________________________________________ +The Search page has controls for selecting different possible values for all +of the fields in a bug, as described above. Once you've defined a search, +you can either run it, or save it as a Remembered Query, which can +optionally appear in the footer of your pages. -2.3.3.1. Writing a Great Bug Report - -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 here. If you are reading this online, check out the -Mozilla.org bug-writing guidelines at -http://www.mozilla.org/quality/bug-writing-guidelines.html. 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. - -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 -http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. - -I realize this was a lot to read. However, understanding the mentality of -writing great bug reports will help us on the next part! - - 1. Go back to http://landfill.tequilarista.org/bugzilla-tip/ in your - browser. - 2. Select the Enter a new bug report link. - 3. Select a product. - 4. 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?). - 5. Select a Component in the scrollbox. - 6. 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! - 7. 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. - 8. Leave the "CC" text box blank. Fill in the "URL" box with - "http://www.mozilla.org". - 9. 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. - - Voila! Select "Commit" and send in your bug report! Next we'll look at - resolving bugs. +Highly advanced querying is done using Boolean Charts, which have their own +context-sensitive help . _________________________________________________________________ -2.3.3.2. Managing your Bug Reports - -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. - - 1. 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". - 2. 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. - - 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. - - But I'll give a few last hints! - - There is a CLUE on the Query page that will teach you more how to use - the form. - - If you click the hyperlink on the Component box of the Query page, you - will be presented a form that will describe what all the components - are. - - Possibly the most powerful feature of the Query page is the Boolean - Chart 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. - - Finally, you can build some nifty Reports 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. - _________________________________________________________________ +3.1.4. Bug Lists + +If you run a search, a list of matching bugs will be returned. The default +search is to return all open bugs on the system - don't try running this +search on a Bugzilla installation with a lot of bugs! -2.4. Where can I find my user preferences? +The format of the list is configurable. For example, it can be sorted by +clicking the column headings. Other useful features can be accessed using +the links at the bottom of the list: + + Long Format: this gives you a large page with a non-editable summary + of the fields of each bug. +Change Columns: change the bug attributes which appear in the list. + Change several bugs at once: If your account is sufficiently + empowered, you can make the same change to all the bugs in the list - + for example, changing their owner. + Send mail to bug owners: Sends mail to the owners of all bugs on the + list. + Edit this query: 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. + _________________________________________________________________ - +3.1.5. Filing Bugs - Indiana, it feels like we walking on fortune cookies! +Years of bug writing experience has been distilled for your reading pleasure +into the Bug Writing Guidelines. 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. - These ain't fortune cookies, kid... +The procedure for filing a test bug is as follows: - 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 Landfill. + 1. Go to Landfill in your browser and click Enter a new bug report. + 2. Select a product - any one will do. + 3. Fill in the fields. Bugzilla should have made reasonable guesses, + based upon your browser, for the "Platform" and "OS" drop-down + boxes. If they are wrong, change them. + 4. Select "Commit" and send in your bug report. _________________________________________________________________ -2.4.1. Account Settings +3.2. Hints and Tips -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 current password into the "Old Password" field. -If you wish to change your password, type the new password you want into the -"New Password" field and again into the "Re-enter new password" field to -ensure you typed your new password correctly. Select the "Submit" button and -you are done. +This section distills some Bugzilla tips and best practices that have been +developed. _________________________________________________________________ -2.4.2. Email Settings - -2.4.2.1. Email Notification - -Here you can reduce or increase the amount of email sent you from Bugzilla. -Although this is referred to as "Advanced Email Filtering Options", 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 Bonsai, the Mozilla automated CVS management system or -Tinderbox, the Mozilla automated build management system, and restrict which -types of Bugzilla information are fed to these systems.. +3.2.1. Autolinkification + +Bugzilla comments are plain text - so posting HTML will result in literal +HTML tags rather than being interpreted by a browser. However, Bugzilla will +automatically make hyperlinks out of certain sorts of text in comments. For +example, the text http://www.bugzilla.org will be turned into +http://www.bugzilla.org. Other strings which get linkified in the obvious +manner are: + +bug 12345 +bug 23456, comment 53 +attachment 4321 +mailto:george@example.com +george@example.com +ftp://ftp.mozilla.org +Most other sorts of URL + + A corollary here is that if you type a bug number in a comment, you + should put the word "bug" before it, so it gets autolinkified for the + convenience of others. _________________________________________________________________ -2.4.2.2. New Email Technology +3.2.2. Quicksearch - Note +Quicksearch is a single-text-box query tool which uses metacharacters to +indicate what is to be searched. For example, typing "foo|bar" into +Quicksearch would search for "foo" or "bar" in the summary and status +whiteboard of a bug; adding ":BazProduct" would search only in that product. - 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. - - 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. - - 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. +You'll find the Quicksearch box on Bugzilla's front page, along with a Help +link which details how to use it. _________________________________________________________________ -2.4.2.3. "Watching" Users +3.2.3. Comments - Note +If you are changing the fields on a bug, only comment if either you have +something pertinent to say, or Bugzilla requires it. Otherwise, you may spam +people unnecessarily with bug mail. To take an example: a user can set up +their account to filter out messages where someone just adds themselves to +the CC field of a bug (which happens a lot.) If you come along, add yourself +to the CC field, and add a comment saying "Adding self to CC", then that +person gets a pointless piece of mail they would otherwise have avoided. - 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". - - 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. +Don't use sigs in comments. Signing your name ("Bill") is acceptable, +particularly if you do it out of habit, but full mail/news-style four line +ASCII art creations are not. _________________________________________________________________ -2.4.3. Page Footer +3.2.4. Attachments - Note +Use attachments, rather than comments, for large chunks of ASCII data, such +as trace, debugging output files, or log files. That way, it doesn't bloat +the bug for everyone who wants to read it, and cause people to receive fat, +useless mails. - 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! +Trim screenshots. There's no need to show the whole screen if you are +pointing out a single-pixel problem. - 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... +Don't attach simple test cases (e.g. one HTML file, one CSS file and an +image) as a ZIP file. Instead, upload them in reverse order and edit the +referring file so that they point to the attached files. This way, the test +case works immediately out of the bug. + _________________________________________________________________ - Tip +3.2.5. Filing Bugs - 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. - _________________________________________________________________ +Try to make sure that everything said in the summary is also said in the +first comment. Summaries are often updated and this will ensure your +original information is easily accessible. -2.4.4. Permissions +You do not need to put "any" or similar strings in the URL field. If there +is no specific URL associated with the bug, leave this field blank. -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. +If you feel a bug you filed was incorrectly marked as a DUPLICATE of +another, please question it in your bug, not the bug it was duped to. Feel +free to CC the person who duped it if they are not already CCed. _________________________________________________________________ -2.5. Using Bugzilla-Conclusion +3.3. User Preferences -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 mozilla-webtools 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 +Once you have logged in, you can customise various aspects of Bugzilla via +the "Edit prefs" link in the page footer. The preferences are split into +four tabs: _________________________________________________________________ -Chapter 3. Installation +3.3.1. Account Settings -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. +On this tab, you can change your basic account information, including your +password, email address and real name. For security reasons, in order to +change anything on this page you must type your current password into the +"Password" field at the top of the page. If you attempt to change your email +address, a confirmation email is sent to both the old and new addresses, +with a link to use to confirm the change. This helps to prevent account +hijacking. _________________________________________________________________ -3.1. ERRATA - -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. - - If you are installing Bugzilla on S.u.S.e. Linux, or some other - distributions with "paranoid" security options, it is possible that - the checksetup.pl script may fail with the error: cannot - chdir(/var/spool/mqueue): Permission denied This is because your - /var/spool/mqueue directory has a mode of "drwx------". Type chmod 755 - /var/spool/mqueue as root to fix this problem. - 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 - Release Notes for Bugzilla 2.14 are available at docs/rel_notes.txt in - your Bugzilla source distribution. - 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. +3.3.2. Email Settings - Warning +On this tab you can reduce or increase the amount of email sent you from +Bugzilla, opting in our out depending on your relationship to the bug and +the change that was made to it. (Note that you can also do client-side +filtering using the X-Bugzilla-Reason header which Bugzilla adds to all +bugmail.) - 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. +By entering user email names, delineated by commas, into the "Users to +watch" text entry box you can receive a copy of all the bugmail of other +users (security settings permitting.) This powerful functionality enables +seamless transitions as developers change projects or users go on holiday. - Warning + Note + + The ability to watch other users may not be available in all Bugzilla + installations. If you can't see it, ask your administrator. + _________________________________________________________________ + +3.3.3. Page Footer + +On the Search page, you can store queries in Bugzilla, so if you regularly +run a particular query it is just a drop-down menu away. Once you have a +stored query, you can come here to request that it also be displayed in your +page footer. + _________________________________________________________________ + +3.3.4. Permissions - 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. +This is a purely informative page which outlines your current permissions on +this installation of Bugzilla - what product groups you are in, and whether +you can edit bugs or perform various administration functions. _________________________________________________________________ -3.2. Step-by-step Install +Chapter 4. Installation -3.2.1. Introduction +4.1. Step-by-step Install -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. +4.1.1. Introduction 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 Win32 -Installation Notes for further advice on getting Bugzilla to work on -Microsoft Windows. - -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). +Win32 is not yet officially supported, but many people have got it working +fine. Please see the Win32 Installation Notes for further advice on getting +Bugzilla to work on Microsoft Windows. _________________________________________________________________ -3.2.2. Installing the Prerequisites +4.1.2. Package List Note - 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 Using - Bundle::Bugzilla instead of manually installing Perl modules + If you are running the very most recent version of Perl and MySQL + (both the executables and development libraries) on your system, you + can skip these manual installation steps for the Perl modules by using + Bundle::Bugzilla; see Using Bundle::Bugzilla instead of manually + installing Perl modules. - The software packages necessary for the proper running of bugzilla - are: + The software packages necessary for the proper running of Bugzilla + (with download links) are: - 1. MySQL database server and the mysql client (3.22.5 or greater) - 2. Perl (5.004 or greater, 5.6.1 is recommended if you wish to use + 1. MySQL database server (3.22.5 or greater) + 2. Perl (5.005 or greater, 5.6.1 is recommended if you wish to use Bundle::Bugzilla) - 3. DBI Perl module - 4. Data::Dumper Perl module - 5. Bundle::Mysql Perl module collection - 6. TimeDate Perl module collection - 7. GD perl module (1.8.3) (optional, for bug charting) - 8. Chart::Base Perl module (0.99c) (optional, for bug charting) - 9. DB_File Perl module (optional, for bug charting) - 10. The web server of your choice. Apache is recommended. - 11. MIME::Parser Perl module (optional, for contrib/bug_email.pl - interface) + 3. Perl Modules (minimum version): + a. Template (v2.07) + b. AppConfig (v1.52) + c. Text::Wrap (v2001.0131) + d. File::Spec (v0.8.2) + e. Data::Dumper (any) + f. DBD::mysql (v1.2209) + g. DBI (v1.13) + h. Date::Parse (any) + i. CGI::Carp (any) + and, optionally: + a. GD (v1.19) for bug charting + b. Chart::Base (v0.99c) for bug charting + c. XML::Parser (any) for the XML interface + d. MIME::Parser (any) for the email interface + 4. The web server of your choice. Apache is highly recommended. Warning - It is a good idea, while installing Bugzilla, to ensure it is not - accessible 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. + It is a good idea, while installing Bugzilla, to ensure that there is + some kind of firewall between you and the rest of the Internet, + because your machine may be insecure for periods during the install. + 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. Note - 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 urpmi utility. If you follow these commands, you should - have everything you need for Bugzilla, and checksetup.pl should not - complain about any missing libraries. You may already have some of - these installed. + Linux-Mandrake 8.0 includes every required and optional library for + Bugzilla. The easiest way to install them is by using the urpmi + utility. If you follow these commands, you should have everything you + need for Bugzilla, and checksetup.pl should not complain about any + missing libraries. You may already have some of these installed. bash# urpmi perl-mysql bash# urpmi perl-chart @@ -1076,70 +1019,50 @@ SGML source (docs/sgml). bash# urpmi apache-modules _________________________________________________________________ -3.2.3. Installing MySQL Database +4.1.3. MySQL -Visit MySQL homepage at www.mysql.com and grab the latest stable release of -the server. Many of the binary versions of MySQL store their data files in -/var 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 configure. - -If you install from source or non-package (RPM, deb, etc.) binaries you need -to add mysqld 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. +Visit the MySQL homepage at www.mysql.com to grab and install the latest +stable release of the server. Note - You should have your init script start mysqld with the ability to - accept large packets. By default, mysqld only accepts packets up to - 64K long. This limits the size of attachments you may put on bugs. If - you add -O max_allowed_packet=1M to the command that starts mysqld (or + Many of the binary versions of MySQL store their data files in /var. + On some Unix systems, this is part of a smaller root partition, and + may not have room for your bug database. You can set the data + directory as an option to configure if you build MySQL from source + yourself. + + If you install from something other than an RPM or Debian package, you + will need to add mysqld 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. + + Change your init script to start mysqld with the ability to accept + large packets. By default, mysqld only accepts packets up to 64K long. + This limits the size of attachments you may put on bugs. If you add -O + max_allowed_packet=1M to the command that starts mysqld (or safe_mysqld), then you will be able to have attachments up to about 1 - megabyte. - - Note + megabyte. There is a Bugzilla parameter for maximum attachment size; + you should configure it to match the value you choose here. If you plan on running Bugzilla and MySQL on the same machine, consider using the --skip-networking option in the init script. This enhances security by preventing network access to MySQL. _________________________________________________________________ -3.2.4. Perl (5.004 or greater) - -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. - -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. - - Warning +4.1.4. Perl - Many people complain that Perl modules will not install for them. Most - times, the error messages complain that they are missing a file in - "@INC". 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 are the local UNIX sysadmin, please consult - the newsgroup/mailing list for further assistance or hire someone to - help you out. +Any machine that doesn't have Perl on it is a sad machine indeed. Perl can +be got in source form from perl.com for the rare *nix systems which don't +have it. Although Bugzilla runs with all post-5.005 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. Tip You can skip the following Perl module installation steps by - installing Bundle::Bugzilla from CPAN, which includes them. All Perl - module installation steps require you have an active Internet - connection. If you wish to use Bundle::Bugzilla, however, you must be - using the latest version of Perl (at this writing, version 5.6.1) + installing Bundle::Bugzilla from CPAN, which installs all required + modules for you. bash# perl -MCPAN -e 'install "Bundle::Bugzilla"' @@ -1149,162 +1072,144 @@ snuff. isolate the problem. _________________________________________________________________ -3.2.5. DBI Perl Module - -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. +4.1.5. Perl Modules -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 Appendix B. +All Perl modules can be found on the Comprehensive Perl Archive Network +(CPAN). The CPAN servers have a real tendency to bog down, so please use +mirrors. 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. - -To use the CPAN shell to install DBI: - - bash# perl -MCPAN -e 'install "DBI"' - - Note +does all the hard work for you. To use the CPAN shell to install a module: - Replace "DBI" with the name of whichever module you wish to install, - such as Data::Dumper, TimeDate, GD, etc. +bash# perl -MCPAN -e 'install "<modulename>"' To do it the hard way: - Untar the module tarball -- it should create its own directory +Untar the module tarball -- it should create its own directory - CD to the directory just created, and enter the following commands: +CD to the directory just created, and enter the following commands: 1. bash# perl Makefile.PL 2. bash# make 3. bash# make test 4. bash# make install - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. + Warning + + Many people complain that Perl modules will not install for them. Most + times, the error messages complain that they are missing a file in + "@INC". Virtually every time, this error 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 are the local UNIX sysadmin, please consult + the newsgroup/mailing list for further assistance or hire someone to + help you out. + _________________________________________________________________ + +4.1.5.1. DBI + +The DBI module is a generic Perl module used 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. _________________________________________________________________ -3.2.6. Data::Dumper Perl Module +4.1.5.2. Data::Dumper 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. - -Data::Dumper is used by the MySQL-related Perl modules. It can be found on -CPAN (see Appendix B) and can be installed by following the same four step -make sequence used for the DBI module. _________________________________________________________________ -3.2.7. MySQL related Perl Module Collection +4.1.5.3. MySQL-related modules -The Perl/MySQL interface requires a few mutually-dependent perl modules. +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. - -The MySQL modules are all built using one make file which is generated by -running: bash# perl Makefile.pl 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. - -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. - -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. +compilation target and your MySQL installation. For most of the questions +the provided default will be adequate, but when asked if your desired target +is the MySQL or mSQL packages, you should 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. + +A host of 'localhost' should be fine and a testing user of 'test' with a +null password should find itself with sufficient access to run tests on the +'test' database which MySQL created upon installation. _________________________________________________________________ -3.2.8. TimeDate Perl Module Collection +4.1.5.4. TimeDate modules 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: Appendix B). 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. +stored on the CPAN under the name TimeDate. The component module we're most +interested in is the Date::Format module, but installing all of them is +probably a good idea anyway. _________________________________________________________________ -3.2.9. GD Perl Module (1.8.3) +4.1.5.5. GD (optional) 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 +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. -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 Appendix B. - Note The Perl GD library requires some other libraries that may or may not be installed on your system, including libpng and libgd. The full - requirements are listed in the Perl GD library README. Just realize - that if compiling GD fails, it's probably because you're missing a - required library. + requirements are listed in the Perl GD library README. If compiling GD + fails, it's probably because you're missing a required library. _________________________________________________________________ -3.2.10. Chart::Base Perl Module (0.99c) +4.1.5.6. Chart::Base (optional) -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 Appendix B. 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. +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. +Note that earlier versions that 0.99c used GIFs, which are no longer +supported by the latest versions of GD. _________________________________________________________________ -3.2.11. DB_File Perl Module +4.1.5.7. Template Toolkit -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. +When you install Template Toolkit, you'll get asked various questions about +features to enable. The defaults are fine, except that it is recommended you +use the high speed XS Stash of the Template Toolkit, in order to achieve +best performance. However, there are known problems with XS Stash and Perl +5.005_02 and lower. If you wish to use these older versions of Perl, please +use the regular stash. _________________________________________________________________ -3.2.12. HTTP Server +4.1.6. HTTP Server You have a freedom of choice here - Apache, Netscape or any other server on -UNIX would do. You can easily run the web server on a different machine than -MySQL, but need to adjust the MySQL "bugs" user permissions accordingly. +UNIX would do. You can run the web server on a different machine than MySQL, +but need to adjust the MySQL "bugs" user permissions accordingly. Note - I strongly recommend Apache as the web server to use. The Bugzilla + We 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. + Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us. - 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 + 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 httpd.conf file: AddHandler cgi-script .cgi - With apache you'll also want to make sure that within the access.conf + With Apache you'll also want to make sure that within the httpd.conf file the line: -Options ExecCGI -AllowOverride Limit + Options ExecCGI AllowOverride Limit - is in the stanza that covers the directories into which you intend to + is in the stanza that covers the directories into which you intend to put the bugzilla .html and .cgi files. Note @@ -1312,177 +1217,120 @@ AllowOverride Limit AllowOverride Limit allows the use of a Deny statement in the .htaccess file generated by checksetup.pl - 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. + Users of older versions of Apache may find the above lines in the + srm.conf and access.conf files, respecitvely. Warning There are important files and directories that should not be a served - by the HTTP server. These are most files in the "data" and "shadow" - directories and the "localconfig" file. You should configure your HTTP - server to not serve content from these files. Failure to do so will - expose critical passwords and other data. Please see .htaccess files - and security for details on how to do this for Apache. I appreciate - notes on how to get this same functionality using other webservers. + by the HTTP server - most files in the "data" and "shadow" directories + and the "localconfig" file. You should configure your HTTP server to + not serve these files. Failure to do so will expose critical passwords + and other data. Please see .htaccess files and security for details on + how to do this for Apache; the checksetup.pl script should create + appropriate .htaccess files for you. _________________________________________________________________ -3.2.13. Installing the Bugzilla Files +4.1.7. Bugzilla You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably "nobody"). You may -decide to put the files off of the main web space for your web server or -perhaps off of /usr/local with a symbolic link in the web space that points -to the Bugzilla directory. At any rate, just dump all the files in the same -place, and make sure you can access the files in that directory through your -web server. +decide to put the files in the main web space for your web server or perhaps +in /usr/local with a symbolic link in the web space that points to the +Bugzilla directory. Tip If you symlink the bugzilla directory into your Apache's HTML heirarchy, you may receive Forbidden errors unless you add the - "FollowSymLinks" directive to the <Directory> entry for the HTML root. + "FollowSymLinks" directive to the <Directory> entry for the HTML root + in httpd.conf. - 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 checksetup.pl script, which locks down + 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 checksetup.pl script, which locks down your installation. - Lastly, you'll need to set up a symbolic link to - /usr/bonsaitools/bin/perl for the correct location of your perl - executable (probably /usr/bin/perl). Otherwise you must hack all the - .cgi files to change where they look for perl, or use The setperl.csh - Utility, found in Useful Patches and Utilities for Bugzilla. I suggest - using the symlink approach for future release compatability. - - Example 3-1. Setting up bonsaitools symlink - - 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 "/usr/local/bin/perl" for "/usr/bin/perl" below; if - on certain other UNIX systems, Perl may live in weird places like - "/opt/perl". As root, run these commands: -bash# mkdir /usr/bonsaitools -bash# mkdir /usr/bonsaitools/bin -bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl + Lastly, you'll need to set up a symbolic link to + /usr/bonsaitools/bin/perl for the correct location of your Perl + executable (probably /usr/bin/perl). Otherwise you must hack all the + .cgi files to change where they look for Perl. This can be done using + the following Perl one-liner, but I suggest using the symlink approach + to avoid upgrade hassles. - Alternately, you can simply run this perl one-liner to change your - path to perl in all the files in your Bugzilla installation: -perl -pi -e 's@#!/usr/bonsaitools/bin/perl@#!/usr/bin/perl@' *cgi *pl Bug.pm pr -ocessmail syncshadowdb +perl -pi -e + 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm + processmail syncshadowdb - Change the second path to perl to match your installation. - - Tip - - If you don't have root access to set this symlink up, check out the - The setperl.csh Utility, listed in Useful Patches and Utilities for - Bugzilla. It will change the path to perl in all your Bugzilla files - for you. + Change /usr/bin/perl to match the location of Perl on your machine. _________________________________________________________________ -3.2.14. Setting Up the MySQL Database +4.1.8. Setting Up the MySQL Database 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. +start preparing the database for its life as the back end to a high quality +bug tracker. First, you'll want to fix MySQL permissions to allow access from Bugzilla. For the purpose of this Installation section, the Bugzilla username will be "bugs", and will have minimal permissions. - Warning +Begin by giving the MySQL root user a password. MySQL passwords are limited +to 16 characters. - Bugzilla has not undergone a thorough security audit. It may be - possible for a system cracker to somehow trick Bugzilla into executing - a command such as DROP DATABASE mysql. +bash# mysql -u root mysql + mysql> UPDATE user SET Password=PASSWORD('<new_password'>) WHERE + user='root'; +mysql> FLUSH PRIVILEGES; - That would be bad. + From this point on, if you need to access MySQL as the MySQL root + user, you will need to use mysql -u root -p and enter <new_password>. + Remember that MySQL user names have nothing to do with Unix user names + (login names). - Give the MySQL root user a password. MySQL passwords are limited to 16 - characters. + Next, we use an SQL GRANT command to create a "bugs" user, and grant + sufficient permissions for checksetup.pl, which we'll use later, to + work its magic. This also restricts the "bugs" user to operations + within a database called "bugs", and only allows the account to + connect from "localhost". Modify it to reflect your setup if you will + be connecting from another machine or as a different user. - bash# mysql -u root mysql - mysql> UPDATE user SET Password=PASSWORD ('new_password') WHERE - user='root'; - mysql> FLUSH PRIVILEGES; - - From this point on, if you need to access MySQL as the MySQL root - user, you will need to use mysql -u root -p and enter your - new_password. Remember that MySQL user names have nothing to do with - Unix user names (login names). - - Next, we create the "bugs" user, and grant sufficient permissions for - checksetup.pl, which we'll use later, to work its magic. This also - restricts the "bugs" user to operations within a database called - "bugs", and only allows the account to connect from "localhost". - Modify it to reflect your setup if you will be connecting from another - machine or as a different user. - - Remember to set bugs_password to some unique password. + Remember to set <bugs_password> to some unique password. mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost IDENTIFIED BY - 'bugs_password'; - mysql> FLUSH PRIVILEGES; + '<bugs_password>'; + mysql> FLUSH PRIVILEGES; + _________________________________________________________________ - Next, run the magic checksetup.pl script. (Many thanks to Holger - Schurig <holgerschurig@nikocity.de> for writing this script!) It will - make sure Bugzilla files and directories have reasonable permissions, - set up the data directory, and create all the MySQL tables. +4.1.9. checksetup.pl - bash# ./checksetup.pl +Next, run the magic checksetup.pl script. (Many thanks to Holger Schurig for +writing this script!) This script is designed to make sure your MySQL +database and other configuration options are consistent with the Bugzilla +CGI files. It will make sure Bugzilla files and directories have reasonable +permissions, set up the data directory, and create all the MySQL tables. - The first time you run it, it will create a file called localconfig. - _________________________________________________________________ +bash# ./checksetup.pl -3.2.15. Tweaking localconfig + The first time you run it, it will create a file called localconfig. -This file contains a variety of settings you may need to tweak including how -Bugzilla should connect to the MySQL database. + This file contains a variety of settings you may need to tweak + including how Bugzilla should connect to the MySQL database. -The connection settings include: + The connection settings include: 1. server's host: just use "localhost" if the MySQL server is local 2. database name: "bugs" if you're following these directions 3. MySQL username: "bugs" if you're following these directions - 4. Password for the "bugs" MySQL account above + 4. Password for the "bugs" MySQL account; (<bugs_password>) above - You should also install .htaccess files that the Apache webserver will - use to restrict access to Bugzilla data files. See .htaccess files and - security. - - Once you are happy with the settings, re-run checksetup.pl. On this - second run, it will create the database and an administrator account - for which you will be prompted to provide information. - - When logged into an administrator account once Bugzilla is running, if - you go to the query page (off of the Bugzilla main menu), you'll find - an "edit parameters" option that is filled with editable treats. - - Should everything work, you will have a nearly empty Bugzilla database - and a newly-created localconfig file in your Bugzilla root directory. - - Note - - 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 - "webservergroup" parameter in localconfig to match the web server's - group name, if any. I believe, for the next release of Bugzilla, this - will be fixed so that Bugzilla supports a "webserveruser" parameter in - localconfig as well. - - Example 3-2. Running checksetup.pl as the web user - - 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 second run of - checksetup.pl, do this: - -bash# chown -R apache:apache /usr/local/bugzilla -bash# su - apache -bash# cd /usr/local/bugzilla -bash# ./checksetup.pl + Once you are happy with the settings, su to the user your web server + runs as, and re-run checksetup.pl. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) On this second run, it will create + the database and an administrator account for which you will be + prompted to provide information. Note @@ -1491,51 +1339,7 @@ bash# ./checksetup.pl Bugzilla. _________________________________________________________________ -3.2.16. Setting Up Maintainers Manually (Optional) - -If you want to add someone else to every group by hand, you can do it by -typing the appropriate MySQL commands. Run mysql -u root -p bugs You may -need different parameters, depending on your security settings. Then: - - mysql> update profiles set groupset=0x7fffffffffffffff where - login_name = 'XXX'; (yes, that's fifteen"f"'s. - - replacing XXX with the Bugzilla email address. - _________________________________________________________________ - -3.2.17. The Whining Cron (Optional) - -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): - -cd <your-bugzilla-directory> ; ./whineatnews.pl - - Tip - - Depending on your system, crontab may have several manpages. The - following command should lead you to the most useful page for this - purpose: - man 5 crontab - _________________________________________________________________ - -3.2.18. Bug Graphs (Optional) - -As long as you installed the GD and Graph::Base Perl modules you might as -well turn on the nifty bugzilla bug reporting graphs. - -Add a cron entry like this to run collectstats daily at 5 after midnight: - -bash# crontab -e -5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl - - After two days have passed you'll be able to view bug graphs from the - Bug Reports page. - _________________________________________________________________ - -3.2.19. Securing MySQL +4.1.10. Securing MySQL 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 @@ -1550,8 +1354,8 @@ it has a known port number, and is easy to detect it defaults to no passwords whatsoever it defaults to allowing "File_Priv" - 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 + 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. To see your permissions do: @@ -1575,8 +1379,8 @@ it defaults to allowing "File_Priv" REVOKE DROP ON bugs.* FROM bugs@localhost; FLUSH PRIVILEGES; - With "mit-pthreads" you'll need to modify the "globals.pl" - Mysql->Connect line to specify a specific host name instead of + 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: GRANT USAGE ON *.* TO bugs@bounce.hop.com; @@ -1584,140 +1388,167 @@ it defaults to allowing "File_Priv" REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com; FLUSH PRIVILEGES; - Use .htaccess files with the Apache webserver to secure your bugzilla - install. See .htaccess files and security - Consider also: - 1. Turning off external networking with "--skip-networking", unless - you have "mit-pthreads", in which case you can't. Without + 1. 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. - 2. using the --user= option to mysqld to run it as an unprivileged + 2. using the --user= option to mysqld to run it as an unprivileged user. - 3. starting MySQL in a chroot jail - 4. running the httpd in a "chrooted" jail - 5. making sure the MySQL passwords are different from the OS + 3. running MySQL in a chroot jail + 4. running the httpd in a chroot jail + 5. making sure the MySQL passwords are different from the OS passwords (MySQL "root" has nothing to do with system "root"). 6. running MySQL on a separate untrusted machine 7. making backups ;-) _________________________________________________________________ -3.3. Mac OS X Installation Notes - -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. +4.1.11. Configuring Bugzilla -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/>. +You should run through the parameters on the Edit Parameters page (link in +the footer) and set them all to appropriate values. They key parameters are +documented in Section 5.1. + _________________________________________________________________ -Follow the instructions for setting up Fink. Once it's installed, you'll -want to run the following as root: fink install gd +4.2. Optional Additional Configuration -It will prompt you for a number of dependencies, type 'y' and hit enter to -install all of the dependencies. Then watch it work. - -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 :-) +4.2.1. Dependency Charts -Instead of typing "install GD" at the cpan> prompt, type look GD. 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 patch < patchfile: +As well as the text-based dependency graphs, Bugzilla also supports +dependency graphing, using a package called 'dot'. Exactly how this works is +controlled by the 'webdotbase' parameter, which can have one of three +values: + 1. A complete file path to the command 'dot' (part of GraphViz) will + generate the graphs locally + 2. A URL prefix pointing to an installation of the webdot package + will generate the graphs remotely + 3. A blank value will disable dependency graphing. ---- 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 versi -on 4.X).\n"; + So, to get this working, install GraphViz. If you do that, you need to + enable server-side image maps in Apache. Alternatively, you could set + up a webdot server, or use the AT&T public webdot server (the default + for the webdotbase param). Note that AT&T's server won't work if + Bugzilla is only accessible using HTTPS. + _________________________________________________________________ - # =====> 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/l -ib ); -+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/lo -cal/include/gd); -+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/u -sr/local/lib); - my @LIBS = qw(-lgd -lpng -lz); +4.2.2. Bug Graphs - # FEATURE FLAGS -@@ -23,7 +23,7 @@ +As long as you installed the GD and Graph::Base Perl modules you might as +well turn on the nifty Bugzilla bug reporting graphs. - push @LIBS,'-lttf' if $TTF; - push @LIBS,'-ljpeg' if $JPEG; --push @LIBS, '-lm' unless $^O eq 'MSWin32'; -+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/); +Add a cron entry like this to run collectstats.pl daily at 5 after midnight: - # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified - if ($^O ne 'freebsd' && $^O ne 'MSWin32') { +bash# crontab -e +5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl + After two days have passed you'll be able to view bug graphs from the + Bug Reports page. + _________________________________________________________________ +4.2.3. The Whining Cron - Then, run these commands to finish the installation of the perl - module: +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 to complain at engineers which leave +their bugs in the NEW state without triaging them. - perl Makefile.PL - make - make test - make install - And don't forget to run exit to get back to cpan. +This can be done by adding the following command as a daily crontab entry +(for help on that see that crontab man page): - Happy Hacking! - _________________________________________________________________ +cd <your-bugzilla-directory> ; ./whineatnews.pl -3.4. BSD Installation Notes + Tip -For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, -BSDi, etc. please consult Section 3.3. + Depending on your system, crontab may have several manpages. The + following command should lead you to the most useful page for this + purpose: + man 5 crontab _________________________________________________________________ -3.5. Installation General Notes +4.2.4. LDAP Authentication -3.5.1. Modifying Your Running System + Warning -Bugzilla optimizes database lookups by storing all relatively static -information in the versioncache file, located in the data/ subdirectory -under your installation directory. + This information on using the LDAP authentication options with + Bugzilla is old, and the authors do not know of anyone who has tested + it. Approach with caution. + + The existing authentication scheme for Bugzilla uses email addresses + as the primary user ID, and a password to authenticate that user. All + places within Bugzilla where you need to deal with user ID (e.g + assigning a bug) use the email address. The LDAP authentication builds + on top of this scheme, rather than replacing it. The initial log in is + done with a username and password for the LDAP directory. This then + fetches the email address from LDAP and authenticates seamlessly in + the standard Bugzilla authentication scheme using this email address. + If an account for this address already exists in your Bugzilla system, + it will log in to that account. If no account for that email address + exists, one is created at the time of login. (In this case, Bugzilla + will attempt to use the "displayName" or "cn" attribute to determine + the user's full name.) After authentication, all other user-related + tasks are still handled by email address, not LDAP username. You still + assign bugs by email address, query on users by email address, etc. + + Using LDAP for Bugzilla authentication requires the Mozilla::LDAP (aka + PerLDAP) Perl module. The Mozilla::LDAP module in turn requires + Netscape's Directory SDK for C. After you have installed the SDK, then + install the PerLDAP module. Mozilla::LDAP and the Directory SDK for C + are both available for download from mozilla.org. + + Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for authentication. Be very careful when setting up this + parameter; if you set LDAP authentication, but do not have a valid + LDAP directory set up, you will not be able to log back in to Bugzilla + once you log out. (If this happens, you can get back in by manually + editing the data/params file, and setting useLDAP back to 0.) + + If using LDAP, you must set the three additional parameters: Set + LDAPserver to the name (and optionally port) of your LDAP server. If + no port is specified, it defaults to the default port of 389. (e.g + "ldap.mycompany.com" or "ldap.mycompany.com:1234") Set LDAPBaseDN to + the base DN for searching for users in your LDAP directory. (e.g. + "ou=People,o=MyCompany") uids must be unique under the DN specified + here. Set LDAPmailattribute to the name of the attribute in your LDAP + directory which contains the primary email address. On most directory + servers available, this is "mail", but you may need to change this. + _________________________________________________________________ -If you make a change to the structural data in your database (the versions -table for example), or to the "constants" encoded in defparams.pl, you will -need to remove the cached content from the data directory (by doing a "rm -data/versioncache"), or your changes won't show up. +4.2.5. Preventing untrusted Bugzilla content from executing malicious +Javascript code -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. - _________________________________________________________________ +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 +http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. 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. -3.5.2. Upgrading From Previous Versions +bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; char +set=ISO-8859-1/i" *.cgi *.pl -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. + All this one-liner command does is search for all instances of + "Content-type: text/html" and replaces it with "Content-Type: + text/html; charset=ISO-8859-1" . 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 "ISO-8859-1", above, to "UTF-8". -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. + Note: using <meta> tags to set the charset is not recommended, as + there's a bug in Netscape 4.x which causes pages marked up in this way + to load twice. _________________________________________________________________ -3.5.3. .htaccess files and security +4.2.6. .htaccess files and security -To enhance the security of your Bugzilla installation, Bugzilla will -generate .htaccess files which the Apache webserver can use to restrict -access to the bugzilla data files. The checksetup script will generate the -.htaccess files. +To enhance the security of your Bugzilla installation, Bugzilla's +checksetup.pl script will generate .htaccess files which the Apache +webserver can use to restrict access to the bugzilla data files. These +.htaccess files will not work with Apache 1.2.x - but this has security +holes, so you shouldn't be using it anyway. Note @@ -1731,24 +1562,25 @@ access to the bugzilla data files. The checksetup script will generate the check the <Directory> entries for your Bugzilla directory so that the .htaccess file is allowed to override web server defaults. For instance, let's assume your installation of Bugzilla is installed to - /usr/local/bugzilla. You should have this <Directory> entry in your + /usr/local/bugzilla . You should have this <Directory> entry in your httpd.conf file: -<Directory /usr/local/bugzilla/> + <Directory /usr/local/bugzilla/> Options +FollowSymLinks +Indexes +Includes +ExecCGI AllowOverride All </Directory> - The important part above is "AllowOverride All". Without that, - the .htaccess file created by checksetup.pl will not have sufficient + The important part above is "AllowOverride All" . Without that, the + .htaccess file created by checksetup.pl will not have sufficient permissions to protect your Bugzilla installation. - If you are using Internet Information Server or other web server which - does not observe .htaccess conventions, you can disable their creation - by editing localconfig and setting the $create_htaccess variable to 0. + If you are using Internet Information Server (IIS) or another web + server which does not observe .htaccess conventions, you can disable + their creation by editing localconfig and setting the $create_htaccess + variable to 0. _________________________________________________________________ -3.5.4. mod_throttle and Security +4.2.7. mod_throttle and Security 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 @@ -1757,77 +1589,39 @@ install the Apache module mod_throttle which can limit connections by ip-address. You may download this module at http://www.snert.com/Software/Throttle/. Follow the instructions to install into your Apache install. This module only functions with the Apache web -server!. You may use the ThrottleClientIP command provided by this module to +server! You may use the ThrottleClientIP command provided by this module to accomplish this goal. See the Module Instructions for more information. _________________________________________________________________ -3.5.5. Preventing untrusted Bugzilla content from executing malicious -Javascript code - -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 -http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. 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. - -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 - - All this one-liner command does is search for all instances of - "Content-type: text/html" and replaces it with "Content-Type: - text/html; charset=ISO-8859-1". 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 "ISO-8859-1", above, to "UTF-8". - _________________________________________________________________ - -3.5.6. UNIX Installation Instructions History +4.3. Win32 Installation Notes -This document was originally adapted from the Bonsai installation -instructions by Terry Weissman <terry@mozilla.org>. - -The February 25, 1999 re-write of this page was done by Ry4an Brase -<ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin -Pool, & Dan Mosedale (But don't send bug reports to them; report them using -bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ). - -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. - -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. - -Comments from people using this Guide for the first time are particularly -welcome. - _________________________________________________________________ - -3.6. Win32 Installation Notes - -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 best and -easiest 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. - -The easiest way to install Bugzilla on Intel-archiecture machines is to +This section covers installation on Microsoft Windows. Bugzilla has been +made to work on Win32 platforms, but the Bugzilla team wish to emphasise +that 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. + + Warning + + After that warning, here's the situation for 2.16 and Windows. It + doesn't work at all out of the box. You are almost certainly better + off getting the 2.17 version from CVS (after consultation with the + Bugzilla Team to make sure you are pulling on a stable day) because + we'll be doing a load of work to make the Win32 experience more + pleasant than it is now. + + If you still want to try this, to have any hope of getting it to work, + you'll need to apply the mail patch from bug 124174. After that, + you'll need to read the (outdated) installation instructions below, + some (probably a lot better) more recent ones kindly provided by Toms + Baugis and Jean-Sebastien Guay, and also check the Bugzilla 2.16 Win32 + update page . If we get time, we'll write some better installation + instructions for 2.16 and put them up there. But no promises. _________________________________________________________________ -3.6.1. Win32 Installation: Step-by-step +4.3.1. Win32 Installation: Step-by-step Note @@ -1842,77 +1636,78 @@ Windows. 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 Appendix A. + suggestions are provided in Appendix A . 1. Install Apache Web Server for Windows, and copy the Bugzilla files - somewhere Apache can serve them. Please follow all the - instructions referenced in Bugzilla Installation regarding your - Apache configuration, particularly instructions regarding the - "AddHandler" parameter and "ExecCGI". + somewhere Apache can serve them. Please follow all the + instructions referenced in Bugzilla Installation regarding your + Apache configuration, particularly instructions regarding the + "AddHandler" parameter and "ExecCGI" . Note - 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 Appendix A. - 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 + 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 Appendix A . + 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. 2. Install ActivePerl for Windows. Check - http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a + http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a current compiled binary. - Please also check the following links to fully understand the - status of ActivePerl on Win32: Perl Porting, and Perl on Win32 FAQ - 3. Use ppm from your perl\bin directory to install the following + Please also check the following links to fully understand the + status of ActivePerl on Win32: Perl Porting , and Perl on Win32 + FAQ + 3. Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, - AppConfig, and Template. You may need to extract them from .zip - format using Winzip or other unzip program first. Most of these - additional ppm modules can be downloaded from ActiveState, but - AppConfig and Template should be obtained from OpenInteract using - the instructions on the Template Toolkit web site. + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using + the instructions on the Template Toolkit web site . Note You can find a list of modules at - http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ or + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ or http://www.activestate.com/PPMPackages/5.6plus The syntax for ppm is: C:> ppm <modulename> - Example 3-3. Installing ActivePerl ppd Modules on Microsoft + Example 4-1. Installing ActivePerl ppd Modules on Microsoft Windows - C:>ppm DBD-Mysql + C:> ppm DBD-Mysql Watch your capitalization! ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the + you might see the following error when trying to install the version at OpenInteract: - Error installing package 'AppConfig': Read a PPD for 'AppConfig', - but it is not intended for this build of Perl + Error installing package 'AppConfig': Read a PPD for 'AppConfig', + but it is not intended for this build of Perl (MSWin32-x86-multi-thread) - If so, download both the tarball and the ppd directly from + If so, download both the tarball and the ppd directly from OpenInteract, then run ppm from within the same directory to which - you downloaded those files and install the package by referencing + you downloaded those files and install the package by referencing the ppd file explicitly via in the install command, f.e.: - Example 3-4. Installing OpenInteract ppd Modules manually on + Example 4-2. Installing OpenInteract ppd Modules manually on Microsoft Windows - install C:\AppConfig.ppd + install C:\AppConfig.ppd 4. Install MySQL for NT. Note - You can download MySQL for Windows NT from MySQL.com. Some find it - helpful to use the WinMySqlAdmin utility, included with the download, + You can download MySQL for Windows NT from MySQL.com . Some find it + helpful to use the WinMySqlAdmin utility, included with the download, to set up the database. 5. Setup MySQL a. C:> C:\mysql\bin\mysql -u root mysql b. mysql> DELETE FROM user WHERE Host='localhost' AND User=''; - c. mysql> UPDATE user SET Password=PASSWORD ('new_password') + c. mysql> UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; - "new_password", above, indicates whatever password you wish + "new_password" , above, indicates whatever password you wish to use for your "root" user. - d. mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, - CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost + d. mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, + CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost IDENTIFIED BY 'bugs_password'; - "bugs_password", above, indicates whatever password you wish + "bugs_password" , above, indicates whatever password you wish to use for your "bugs" user. e. mysql> FLUSH PRIVILEGES; f. mysql> create database bugs; @@ -1920,99 +1715,96 @@ Windows. h. C:> C:\mysql\bin\mysqladmin -u root -p reload 6. Edit checksetup.pl in your Bugzilla directory. Change this line: -my $webservergid = getgrnam($my_webservergroup); - +my $webservergid = + getgrnam($my_webservergroup); to -my $webservergid = $my_webservergroup; - +my $webservergid = + $my_webservergroup; or the name of the group you wish to own the files explicitly: -my $webservergid = 'Administrators' - +my $webservergid = + 'Administrators' 7. Run checksetup.pl from the Bugzilla directory. - 8. Edit localconfig to suit your requirements. Set $db_pass to your - "bugs_password" from step 5.d, and $webservergroup to "8". + 8. Edit localconfig to suit your requirements. Set $db_pass to your + "bugs_password" from step 5.d , and $webservergroup to "8" . Note - Not sure on the "8" for $webservergroup above. If it's wrong, please + Not sure on the "8" for $webservergroup above. If it's wrong, please send corrections. - 9. Edit defparams.pl to suit your requirements. Particularly, set - DefParam("maintainer") and DefParam("urlbase") to match your + 9. Edit defparams.pl to suit your requirements. Particularly, set + DefParam("maintainer") and DefParam("urlbase") to match your install. Note 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 + documentation does not maintain Bugzilla on NT. If you can confirm or deny that this step is required, please let me know. 10. Note - There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a suggestion, not a requirement. Some other - mail packages that can work include BLAT, Windmail, Mercury Sendmail, - and the CPAN Net::SMTP Perl module (available in .ppm). Every option - requires some hacking of the Perl scripts for Bugzilla to make it + There are several alternatives to Sendmail that will work on Win32. + The one mentioned here is a suggestion , not a requirement. Some other + mail packages that can work include BLAT , Windmail , Mercury Sendmail + , 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. - 1. Download NTsendmail, available from www.ntsendmail.com. You - must have a "real" mail server which allows you to relay off - it in your $ENV{"NTsendmail"} (which you should probably + 1. Download NTsendmail, available from www.ntsendmail.com . 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) 2. Put ntsendmail.pm into your .\perl\lib directory. 3. Add to globals.pl: -# these settings configure the NTsendmail process -use NTsendmail; -$ENV{"NTsendmail"}="your.smtpserver.box"; -$ENV{"NTsendmail_debug"}=1; -$ENV{"NTsendmail_max_tries"}=5; - +# these settings configure the NTsendmail + process use NTsendmail; + $ENV{"NTsendmail"}="your.smtpserver.box"; + $ENV{"NTsendmail_debug"}=1; + $ENV{"NTsendmail_max_tries"}=5; Note - Some mention to also edit $db_pass in globals.pl to be your - "bugs_password". Although this may get you around some problem - authenticating to your database, since globals.pl is not normally - restricted by .htaccess, your database password is exposed to whoever + Some mention to also edit $db_pass in globals.pl to be your + "bugs_password" . Although this may get you around some problem + authenticating to your database, since globals.pl is not normally + restricted by .htaccess , your database password is exposed to whoever uses your web server. - 4. Find and comment out all occurences of "open(SENDMAIL" in + 4. Find and comment out all occurences of " open(SENDMAIL " in your Bugzilla directory. Then replace them with: -# 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); +# 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); Note - Some have found success using the commercial product, Windmail. You + Some have found success using the commercial product, Windmail . You could try replacing your sendmail calls with: -open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail. -log"; - +open SENDMAIL, + "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > + mail.log"; or something to that effect. - 11. Change all references in all files from processmail to - processmail.pl, and rename processmail to processmail.pl. + 11. Change all references in all files from processmail to + processmail.pl , and rename processmail to processmail.pl . Note - 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 + 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. Note - Some people have suggested using the Net::SMTP Perl module instead of - NTsendmail or the other options listed here. You can change + 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. my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP ser @@ -2027,6 +1819,8 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } + + here is a test mail program for Net::SMTP: use Net::SMTP; @@ -2044,67 +1838,71 @@ recipient's address exit; + + 12. Note 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), + only decides on an interpreter based upon the file extension (.pl), rather than the "shebang" line (#/usr/bonsaitools/bin/perl) - Modify the path to perl on the first line (#!) of all files to - point to your Perl installation, and add "perl" to the beginning - of all Perl system calls that use a perl script as an argument. - This may take you a while. There is a "setperl.csh" utility to - speed part of this procedure, available in the Useful Patches and - Utilities for Bugzilla section of The Bugzilla Guide. However, it + Modify the path to perl on the first line (#!) of all files to + point to your Perl installation, and add "perl" to the beginning + of all Perl system calls that use a perl script as an argument. + This may take you a while. There is a "setperl.csh" utility to + speed part of this procedure, available in the Useful Patches and + Utilities for Bugzilla section of The Bugzilla Guide. However, it requires the Cygwin GNU-compatible environment for Win32 be set up - in order to work. See http://www.cygwin.com/ for details on + in order to work. See http://www.cygwin.com/ for details on obtaining Cygwin. 13. 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 + your Bugzilla directory. You should specify the full path to perl + for each system() call. For instance, change this line in processmail: system ("./processmail",@ARGLIST); - </programlisting> to - <programlisting> + </programlisting> to + <programlisting> system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); - 14. Add binmode() calls so attachments will work (bug 62000). - Because Microsoft Windows based systems handle binary files - different than Unix based systems, you need to add the following - lines to createattachment.cgi and showattachment.cgi before the + + 14. Add binmode() calls so attachments will work ( bug 62000 ). + Because Microsoft Windows based systems handle binary files + different than Unix based systems, you need to add the following + lines to createattachment.cgi and showattachment.cgi before the require 'CGI.pl'; line. binmode(STDIN); binmode(STDOUT); + + Note - According to bug 62000, the perl documentation says that you should - always use binmode() when dealing with binary files, but never when - dealing with text files. That seems to suggest that rather than - arbitrarily putting binmode() at the beginning of the attachment - files, there should be logic to determine if binmode() is needed or + According to bug 62000 , the perl documentation says that you should + always use binmode() when dealing with binary files, but never when + dealing with text files. That seems to suggest that rather than + arbitrarily putting binmode() at the beginning of the attachment + files, there should be logic to determine if binmode() is needed or not. Tip - If you are using IIS or Personal Web Server, you must add cgi - relationships to Properties -> Home directory (tab) -> Application + 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: - -.cgi to: <perl install directory>\perl.exe %s %s -.pl to: <perl install directory>\perl.exe %s %s -GET,HEAD,POST +.cgi to: <perl install directory>\perl.exe %s + %s .pl to: <perl install directory>\perl.exe %s %s + GET,HEAD,POST Change the path to Perl to match your install, of course. _________________________________________________________________ -3.6.2. Additional Windows Tips +4.3.2. Additional Windows Tips Tip @@ -2118,7 +1916,8 @@ GET,HEAD,POST Basically you need to add two String Keys in the registry at the following location: -HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Paramete +rs\ScriptMap The keys should be called ".pl" and ".cgi", and both should have a value something like: c:/perl/bin/perl.exe "%s" "%s" @@ -2128,154 +1927,171 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap Tip - If attempting to run Bugzilla 2.12 or older, you will need to remove - encrypt() calls from the Perl source. This is not necessary for - Bugzilla 2.13 and later, which includes the current release, Bugzilla - 2.14. + If attempting to run Bugzilla 2.12 or older, you will need to remove + encrypt() calls from the Perl source. This is not necessary for + Bugzilla 2.13 and later, which includes the current release, Bugzilla + &bz-ver;. - Example 3-5. Removing encrypt() for Windows NT Bugzilla version 2.12 + Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier Replace this: - -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($rea -lcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . + ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my + $enteredcryptpwd = FetchOneColumn(); with this: - -my $enteredcryptpwd = $enteredpwd + my $enteredcryptpwd = $enteredpwd in cgi.pl. _________________________________________________________________ -3.6.3. Bugzilla LDAP Integration - -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. - -Mozilla::LDAP module -The Mozilla::LDAP module allows you to use LDAP for authentication to -the Bugzilla system. This module is not required if you are not using -LDAP. -Mozilla::LDAP (aka PerLDAP) is available for download from -http://www.mozilla.org/directory. -NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. -Follow the link for "Directory SDK for C" on that same page to -download the SDK first. After you have installed this SDK, then -install the PerLDAP module. ----------------------------------------------------------------------- -Post-Installation Checklist ----------------------------------------------------------------------- -Set useLDAP to "On" **only** if you will be using an LDAP directory -for authentication. Be very careful when setting up this parameter; -if you set LDAP authentication, but do not have a valid LDAP directory -set up, you will not be able to log back in to Bugzilla once you log -out. (If this happens, you can get back in by manually editing the -data/params file, and setting useLDAP back to 0.) -If using LDAP, you must set the three additional parameters: -Set LDAPserver to the name (and optionally port) of your LDAP server. -If no port is specified, it defaults to the default port of 389. (e.g -"ldap.mycompany.com" or "ldap.mycompany.com:1234") -Set LDAPBaseDN to the base DN for searching for users in your LDAP -directory. (e.g. "ou=People,o=MyCompany") uids must be unique under -the DN specified here. -Set LDAPmailattribute to the name of the attribute in your LDAP -directory which contains the primary email address. On most directory -servers available, this is "mail", but you may need to change this. ----------------------------------------------------------------------- -(Not sure where this bit should go, but it's important that it be in -there somewhere...) ----------------------------------------------------------------------- -Using LDAP authentication for Bugzilla: -The existing authentication scheme for Bugzilla uses email addresses -as the primary user ID, and a password to authenticate that user. All -places within Bugzilla where you need to deal with user ID (e.g -assigning a bug) use the email address. -The LDAP authentication builds on top of this scheme, rather than -replacing it. The initial log in is done with a username and password -for the LDAP directory. This then fetches the email address from LDAP -and authenticates seamlessly in the standard Bugzilla authentication -scheme using this email address. If an account for this address -already exists in your Bugzilla system, it will log in to that -account. If no account for that email address exists, one is created -at the time of login. (In this case, Bugzilla will attempt to use the -"displayName" or "cn" attribute to determine the user's full name.) -After authentication, all other user-related tasks are still handled -by email address, not LDAP username. You still assign bugs by email -address, query on users by email address, etc. ----------------------------------------------------------------------- +4.4. Mac OS X Installation Notes + +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. + +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/>. + +Follow the instructions for setting up Fink. Once it's installed, you'll +want to run the following as root: fink install gd + +It will prompt you for a number of dependencies, type 'y' and hit enter to +install all of the dependencies. Then watch it work. + +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, because it looks for +the specific paths instead of getting them from your environment. But +there's a way around that :-) + +Instead of typing "install GD" at the cpan> prompt, type look GD. 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 this patch to the Makefile.PL file (save the patch into a file and use +the command patch < patchfile.) + +Then, run these commands to finish the installation of the GD module: + +perl Makefile.PL +make +make test +make install +And don't forget to run exit to get back to CPAN. + _________________________________________________________________ + +4.5. Troubleshooting + +This section gives solutions to common Bugzilla installation problems. _________________________________________________________________ -Chapter 4. Administering Bugzilla Or, I just got this cool thing installed. -Now what the heck do I do with it? +4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1 -So you followed "Bugzilla Installation" 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. +Try executing perl -MCPAN -e 'install CPAN' and then continuing. + +Certain older versions of the CPAN toolset were somewhat naive about how to +upgrade Perl modules. When a couple of modules got rolled into the core Perl +distribution for 5.6.1, CPAN thought that the best way to get those modules +up to date was to haul down the Perl distribution itself and build it. +Needless to say, this has caused headaches for just about everybody. +Upgrading to a newer version of CPAN with the commandline above should fix +things. _________________________________________________________________ -4.1. Post-Installation Checklist - -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. - - 1. Bring up editparams.cgi in your web browser. This should be - available as the "edit parameters" link from any Bugzilla screen - once you have logged in. - 2. The "maintainer" 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. - Set "maintainer" to your email address. This allows Bugzilla's - error messages to display your email address and allow people to - contact you for help. - 3. The "urlbase" parameter defines the fully qualified domain name +4.5.2. DBD::Sponge::db prepare failed + +The following error message may appear due to a bug in DBD::mysql (over +which the Bugzilla team have no control): + + DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site +/lib/DBD/mysql.pm line 248. + SV = NULL(0x0) at 0x20fc444 + REFCNT = 1 + FLAGS = (PADBUSY,PADMY) + + To fix this, go to <path-to-perl>/lib/DBD/sponge.pm in your Perl + installation and replace + my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; + + by + my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; + + (note the S added to NAME.) + _________________________________________________________________ + +4.5.3. cannot chdir(/var/spool/mqueue) + +If you are installing Bugzilla on SuSE Linux, or some other distributions +with "paranoid" security options, it is possible that the checksetup.pl +script may fail with the error: + +cannot chdir(/var/spool/mqueue): Permission denied + + This is because your /var/spool/mqueue directory has a mode of + "drwx------". Type chmod 755 /var/spool/mqueue as root to fix this + problem. + _________________________________________________________________ + +Chapter 5. Administering Bugzilla + +5.1. Bugzilla Configuration + +Bugzilla is configured by changing various parameters, accessed from the +"Edit parameters" link in the page footer. Here are some of the key +parameters on that page. You should run down this list and set them +appropriately after installing Bugzilla. + + 1. maintainer: The maintainer parameter is the email address of the + person responsible for maintaining this Bugzilla installation. The + address need not be that of a valid Bugzilla account. + 2. urlbase: This parameter defines the fully qualified domain name and web server path to your Bugzilla installation. - For example, if your bugzilla query page is - http://www.foo.com/bugzilla/query.cgi, set your "urlbase" is + For example, if your Bugzilla query page is + http://www.foo.com/bugzilla/query.cgi, set your "urlbase" to http://www.foo.com/bugzilla/. - 4. "usebuggroups" 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. + 3. usebuggroups: This dictates whether or not to implement + group-based security for Bugzilla. If set, Bugzilla bugs can have + an associated 'group', defining which users are allowed to see and + edit the bug. Set "usebuggroups" to "on" only if you may wish to restrict access - to products. I suggest leaving this parameter off while initially - testing your Bugzilla. - 5. "usebuggroupsentry", when set to "on", requires that all bugs have - an associated groupmask when submitted. This parameter is made for - those installations where product isolation is a necessity. - 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. - 6. 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 "shadowdb" 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. - 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. + to particular bugs to certain groups of users. I suggest leaving + this parameter off while initially testing your Bugzilla. + 4. usebuggroupsentry: Bugzilla Products can have a group associated + with them, so that certain users can only see bugs in certain + products. When this parameter is set to "on", this places all + newly-created bugs in the group for their product immediately. + 5. shadowdb: 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 "shadowdb" 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. + As a guide, mozilla.org began needing "shadowdb" when they reached + around 40,000 Bugzilla users with several hundred Bugzilla bug + changes and comments per day. + The value of the parameter defines the name of the shadow bug + database. Set "shadowdb" to e.g. "bug_shadowdb" if you will be + running a *very* large installation of Bugzilla. Note @@ -2283,74 +2099,38 @@ tests on your Bugzilla setup. 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 "cron". - Once again, in testing you should avoid this option -- use it if - or when you need 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 "shadowdb" when they reached around 40,000 Bugzilla users - with several hundred Bugzilla bug changes and comments per day. If you use the "shadowdb" option, it is only natural that you - should turn the "queryagainstshadowdb" option "On" as well. + should turn the "queryagainstshadowdb" option on as well. Otherwise you are replicating data into a shadow database for no reason! - 7. "headerhtml", "footerhtml", "errorhtml", "bannerhtml", and - "blurbhtml" 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 data/params 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 - data/params file. - 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. - - Note - - The "headerhtml" text box is the HTML printed out before 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. - 8. "passwordmail" 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. + 6. shutdownhtml: If you need to shut down Bugzilla to perform + administration, enter some descriptive HTML here and anyone who + tries to use Bugzilla will receive a page to that effect. + Obviously, editparams.cgi will still be accessible so you can + remove the HTML and re-enable Bugzilla. :-) + 7. passwordmail: Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along + with their password message. 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. - 9. "useqacontact" allows you to define an email address for each + 8. useqacontact: This allows you to define an email address for each component, in addition to that of the default owner, who will be - sent carbon copies of incoming bugs. 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. - "usestatuswhiteboard" defines whether you wish to have a + sent carbon copies of incoming bugs. + 9. usestatuswhiteboard: This defines whether you wish to have a free-form, overwritable field associated with each bug. The advantage of the Status Whiteboard is that it can be deleted or modified with ease, and provides an easily-searchable field for - indexing some bugs that have some trait in common. Many people - will put "help wanted", "stalled", or "waiting on reply from - somebody" 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. - 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. - 10. Set "whinedays" to the amount of days you want to let bugs go in - the "New" or "Reopened" state before notifying people they have + indexing some bugs that have some trait in common. + 10. whinedays: Set this to the number of days you want to let bugs go + in the NEW or REOPENED state before notifying people they have untouched new bugs. If you do not plan to use this feature, simply do not set up the whining cron job described in the installation instructions, or set this value to "0" (never whine). - 11. "commenton" 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 + 11. commenton*: All these fields allow you to dictate what changes can + pass without comment, and which must have a comment from the + person who changed them. Often, administrators will allow users to + add themselves to the CC list, accept bugs, or change the Status Whiteboard without adding a comment as to their reasons for the change, yet require that most other changes come with an explanation. @@ -2364,89 +2144,52 @@ tests on your Bugzilla setup. 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!) - 12. The "supportwatchers" 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 "watcher" 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 privileges. She would still only receive email updates for - those bugs she could normally view. - For Bugzilla sites which require strong inter-Product security to - prevent snooping, watchers are not a good idea. - However, for most sites you should set "supportwatchers" to "On". - This feature is helpful for team leads to monitor progress in - their respective areas, and can offer many other benefits, such as - allowing a developer to pick up a former engineer's bugs without - requiring her to change all the information in the bug. + 12. supportwatchers: Turning on this option allows users to ask to + receive copies of all a particular other user's bug email. This + is, of course, subject to the groupset restrictions on the bug; if + the "watcher" 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 privileges. They + would still only receive email updates for those bugs she could + normally view. _________________________________________________________________ -4.2. User Administration +5.2. User Administration -User administration is one of the easiest parts of Bugzilla. Keeping it from -getting out of hand, however, can become a challenge. - _________________________________________________________________ - -4.2.1. Creating the Default User +5.2.1. Creating the Default User 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. +"super user". If for some reason you delete the "super user" account, +re-running checksetup.pl will again prompt you for this username and +password. Tip 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): - mysql> use bugs; mysql> update profiles set groupset=0x7ffffffffffffff - where login_name = "(user's login name)"; - - Yes, that is fourteen "f"'s. A whole lot of f-ing going on if you want - to create a new administator. - _________________________________________________________________ - -4.2.2. Managing Other Users - -4.2.2.1. Logging In + interface. Run "mysql" from the command line, and use these commands: - 1. Open the index.html page for your Bugzilla installation in your - browser window. - 2. Click the "Query Existing Bug Reports" link. - 3. Click the "Log In" link at the foot of the page. - 4. Type your email address, and the password which was emailed to you - when you created your Bugzilla account, into the spaces provided. + mysql> use bugs; + mysql> update profiles set groupset=0x7ffffffffffffff where login_name + = "(user's login name)"; - Congratulations, you are logged in! + Yes, that is fourteen "f" 's. A whole lot of f-ing going on if you + want to create a new administator. _________________________________________________________________ -4.2.2.2. Creating new users +5.2.2. Managing Other Users + +5.2.2.1. Creating new users 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. +link at the bottom of each page (assuming they aren't logged in as someone +else already.) However, should you desire to create user accounts ahead of +time, here is how you do it. 1. After logging in, click the "Users" link at the footer of the - query page. - 2. 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. - - Tip - - More functionality is available via the list on the right-hand side of - the text entry box. You can match what you type as a case-insensitive - substring (the default) of all users on your system, a case-sensitive - regular expression (please see the man regexp manual page for details - on regular expression syntax), or a reverse regular expression match, - where every user name which does NOT match the regular expression is - selected. - 3. Click the "Add New User" link at the bottom of the user list - 4. Fill out the form presented. This page is self-explanatory. When - done, click "submit". + query page, and then click "Add a new user". + 2. Fill out the form presented. This page is self-explanatory. When + done, click "Submit". Note @@ -2459,61 +2202,34 @@ accounts ahead of time, here is how you do it. account name and password. _________________________________________________________________ -4.2.2.3. Disabling Users - -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. - - Warning - - Don't disable your own administrative account, or you will hate life! - - At this time, "Disabled Text" 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. - _________________________________________________________________ - -4.2.2.4. Modifying Users - -Here I will attempt to describe the function of each option on the Edit User -screen. - - * Login Name: 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. - - Tip - - For compatability reasons, you should probably stick with email - addresses as user login names. It will make your life easier. - * Real Name: Duh! - * Password: You can change the user password here. It is normal to - only see asterisks. - * Email Notification: You may choose from one of three options: - 1. 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". - 2. 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. - - Note - - She will still receive whining cron emails if you set up the - "whinemail" feature. - 3. All Qualifying Bugs: 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. - Disable Text: 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. +5.2.2.2. Modifying Users + +To see a specific user, search for their login name in the box provided on +the "Edit Users" page. To see all users, leave the box blank. + +You can search in different ways the listbox to the right of the text entry +box. You can match by case-insensitive substring (the default), regular +expression, or a reverse regular expression match, which finds every user +name which does NOT match the regular expression. (Please see the man regexp +manual page for details on regular expression syntax.) + +Once you have found your user, you can change the following fields: + + * Login Name: This is generally the user's full email address. + However, if you have are using the emailsuffix Param, this may + just be the user's login name. Note that users can now change + their login names themselves (to any valid email address.) + * Real Name: The user's real name. Note that Bugzilla does not + require this to create an account. + * Password: You can change the user's password here. Users can + automatically request a new password, so you shouldn't need to do + this often. If you want to disable an account, see Disable Text + below. + * Disable Text: If you type anything in this box, including just a + space, the user is prevented from logging in, or making any + changes to bugs via the web interface. The HTML you type in this + box is presented to the user when they attempt to perform these + actions, and should explain why the account was disabled. Warning @@ -2521,91 +2237,64 @@ screen. Note - 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 not be enabled for secure installations of Bugzilla. - * CanConfirm: 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. - * Creategroups: 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. - * Editbugs: Unless a user has this bit set, they can only edit those - bugs for which they are the assignee or the reporter. - - Note - - 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. - * Editcomponents: This flag allows a user to create new products and + The user can still submit bugs via the e-mail gateway, if you set it + up, even if the disabled text field is filled in. The e-mail gateway + should not be enabled for secure installations of Bugzilla. + * <groupname>: If you have created some groups, e.g. + "securitysensitive", then checkboxes will appear here to allow you + to add users to, or remove them from, these groups. + * canconfirm: This field is only used if you have enabled the + "unconfirmed" status. If you enable this for a user, that user can + then move bugs from "Unconfirmed" to a "Confirmed" status (e.g.: + "New" status). + * creategroups: This option will allow a user to create and destroy + groups in Bugzilla. + * editbugs: Unless a user has this bit set, they can only edit those + bugs for which they are the assignee or the reporter. Even if this + option is unchecked, users can still add comments to bugs. + * editcomponents: 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. - * Editkeywords: If you use Bugzilla's keyword functionality, - enabling this feature allows a user can create and destroy + destroyed. + * editkeywords: If you use Bugzilla's keyword functionality, + enabling this feature allows a user to create and destroy keywords. As always, the keywords for existing bugs containing the keyword the user wishes to destroy must be changed before Bugzilla - will allow it to die. 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. - * Editusers: 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 privileges from other users or grant them to - themselves. Enable with care. - * PRODUCT: 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. + will allow it to die. + * editusers: This flag allows a user to do what you're doing right + now: edit other users. This will allow those with the right to do + so to remove administrator privileges from other users or grant + them to themselves. Enable with care. + * tweakparams: This flag allows a user to change Bugzilla's Params + (using editparams.cgi.) + * <productname>: This allows an administrator to specify the + products in which a user can see bugs. The user must still have + the "editbugs" privilege to edit bugs in these products. _________________________________________________________________ -4.3. Product, Component, Milestone, and Version Administration +5.3. Product, Component, Milestone, and Version Administration - +5.3.1. Products - Dear Lord, we have to get our users to do WHAT? - _________________________________________________________________ - -4.3.1. ProductsFormerly, and in some spots still, called "Programs" - -Products 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...) +Products are the broadest category in Bugzilla, and tend to represent +real-world shipping products. E.g. if your company makes computer games, you +should have one product per game, perhaps a "Common" product for units of +technology used in multiple games, and maybe a few special products +(Website, Administration...) -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. +Many of Bugzilla's settings are configurable on a per-product basis. The +number of "votes" available to users is set per-product, as is the number of +votes required to move a bug automatically from the UNCONFIRMED status to +the NEW status. To create a new product: - 1. Select "components" from the yellow footer - - Tip - - 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... - 2. Select the "Add" link to the right of "Add a new product". + 1. Select "products" from the footer + 2. Select the "Add" link in the bottom right 3. Enter the name of the product and a description. The Description - field is free-form. - - Tip + field may contain HTML. 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 @@ -2614,17 +2303,13 @@ To create a new product: few moments. _________________________________________________________________ -4.3.2. Components - -Components are subsections of a Product. - - Example 4-1. Creating some Components +5.3.2. Components - 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. +Components are subsections of a Product. E.g. the computer game you are +designing may have a "UI" component, an "API" component, a "Sound System" +component, and a "Plugins" component, each overseen by a different +programmer. It often makes sense to divide Components in Bugzilla according +to the natural divisions of responsibility within your Product or company. 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 @@ -2632,1187 +2317,512 @@ 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 default -assignments; the Owner and QA Contact fields in a bug are otherwise -unrelated to the Component. +assignments; these can be changed on bug submission, or at any later point +in a bug's life. - To create a new Component: +To create a new Component: 1. Select the "Edit components" link from the "Edit product" page - 2. Select the "Add" link to the right of the "Add a new component" - text on the "Select Component" page. - 3. 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. - - Tip - - Is your "Default Owner" a user who is not yet in the database? No - problem. - a. Select the "Log out" link on the footer of the page. - b. Select the "New Account" link on the footer of the "Relogin" - page - c. 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. - d. Now select "Log in" again, type in your login information, - and you can modify the product to use the Default Owner - information you require. - - 4. 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. + 2. Select the "Add" link in the bottom right. + 3. Fill out the "Component" field, a short "Description", the + "Initial Owner" and "Initial QA Contact" (if enabled.) The + Component and Description fields may contain HTML; the "Initial + Owner" field must be a login name already existing in the + database. _________________________________________________________________ -4.3.3. Versions +5.3.3. Versions 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. - - Example 4-2. Common Use of Versions +95", and "Flinders 2000". Version is not a multi-select field; the usual +practice is to select the most recent version with the bug. - 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 - - Example 4-3. A Different Use of Versions - - 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. - - To create and edit Versions: +To create and edit Versions: 1. From the "Edit product" screen, select "Edit Versions" - 2. 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. - Otherwise, click the "Add" button to the right of the "Add a new - version" text. - 3. 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. - 4. 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. + 2. You will notice that the product already has the default version + "undefined". Click the "Add" link in the bottom right. + 3. Enter the name of the Version. This field takes text only. Then + click the "Add" button. _________________________________________________________________ -4.3.4. Milestones +5.3.4. Milestones 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. +assigned the milestone of 3.0. Note - Milestone options will only appear for a Product if you turned the - "usetargetmilestone" field in the "Edit Parameters" screen "On". + Milestone options will only appear for a Product if you turned on the + "usetargetmilestone" Param in the "Edit Parameters" screen. To create new Milestones, set Default Milestones, and set Milestone URL: - 1. Select "edit milestones" - 2. Select "Add" to the right of the "Add a new milestone" text + 1. Select "Edit milestones" from the "Edit product" page. + 2. Select "Add" in the bottom right corner. text 3. Enter the name of the Milestone in the "Milestone" field. You can - optionally set the "Sortkey", which is a positive or negative + 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". - Example 4-4. Using SortKey with Target Milestone - 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" - 4. 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. + particular milestone appears. This is because milestones often do + not occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add". + 4. From the Edit product screen, you can enter the URL of a page + which gives information about your milestones and what they mean. - Note + Tip - 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. - 5. 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" - Some common uses of this field include product descriptions, - product roadmaps, and of course a simple description of the - meaning of each milestone. - 6. 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. - Select the "Update" button when you are done. + If you want your milestone document to be restricted so that it can + only be viewed by people in a particular Bugzilla group, the best way + is to attach the document to a bug in that group, and make the URL the + URL of that attachment. _________________________________________________________________ -4.3.5. Voting - -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. - -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. +5.4. Voting + +Voting allows users to be given a pot of votes which they can allocate to +bugs, to indicate that they'd like them fixed. This allows developers to +gauge user need for a particular enhancement or bugfix. By allowing bugs +with a certain number of votes to automatically move from "UNCONFIRMED" to +"NEW", users of the bug system can help high-priority bugs garner attention +so they don't sit for a long time awaiting triage. To modify Voting settings: 1. Navigate to the "Edit product" screen for the Product you wish to modify - 2. Set "Maximum Votes per person" to your calculated value. Setting - this field to "0" disables voting. - 3. 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. - 4. 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? - - Tip - - 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 really bad bug! - 5. Once you have adjusted the values to your preference, select the - "Update" button. + 2. Maximum Votes per person: Setting this field to "0" disables + voting. + 3. Maximum Votes a person can put on a single bug": It should + probably be some number lower than the "Maximum votes per person". + Don't set this field to "0" if "Maximum votes per person" is + non-zero; that doesn't make any sense. + 4. Number of votes a bug in this product needs to automatically get + out of the UNCONFIRMED state: Setting this field to "0" disables + the automatic move of bugs from UNCONFIRMED to NEW. + 5. Once you have adjusted the values to your preference, click + "Update". _________________________________________________________________ -4.3.6. Groups and Group Security +5.5. Groups and Group Security -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. +Groups allow the administrator to isolate bugs or products that should only +be seen by certain people. There are two types of group - Generic Groups, +and Product-Based Groups. - Example 4-5. When to Use Group Security +Product-Based Groups are matched with products, and allow you to restrict +access to bugs on a per-product basis. They are enabled using the +usebuggroups Param. Turning on the usebuggroupsentry Param will mean bugs +automatically get added to their product group when filed. - 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. +Generic Groups have no special relationship to products; you create them, +and put bugs in them as required. One example of the use of Generic Groups +is Mozilla's "Security" group, into which security-sensitive bugs are placed +until fixed. Only the Mozilla Security Team are members of this group. -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. +To create Generic Groups: - Note - - 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. - - 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. - - To enable Generic Group Security ("usebuggroups"): - - 1. Turn "On" "usebuggroups" in the "Edit Parameters" screen. - 2. You will generally have no groups set up. Select the "groups" link - in the footer. - 3. 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. - 4. 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. - Example 4-6. Creating a New Group - I created a group called DefaultGroup with a description of "This - is simply a group to play with", and a New User RegExp of - ".*@mydomain.tld". 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. - When you have finished, select the Add button. - - To enable Product-Based Group Security (usebuggroupsentry): + 1. Select the "groups" link in the footer. + 2. Take a moment to understand the instructions on the "Edit Groups" + screen, then select the "Add Group" link. + 3. Fill out the "New Name", "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. When + you have finished, click "Add". - Warning + To use Product-Based Groups: - 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. - - 1. Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit + 1. Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. Warning - "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. - 2. 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. - - You may find this example illustrative for how bug groups work. - - Example 4-7. Bugzilla Groups - - Bugzilla Groups example - ----------------------- - For this example, let us suppose we have four groups, call them - Group1, Group2, Group3, and Group4. - We have 5 users, User1, User2, User3, User4, User5. - We have 8 bugs, Bug1, ..., Bug8. - Group membership is defined by this chart: - (X denotes that user is in that group.) - (I apologize for the nasty formatting of this table. Try viewing - it in a text-based browser or something for now. -MPB) - G G G G - r r r r - o o o o - u u u u - p p p p - 1 2 3 4 - +-+-+-+-+ - User1|X| | | | - +-+-+-+-+ - User2| |X| | | - +-+-+-+-+ - User3|X| |X| | - +-+-+-+-+ - User4|X|X|X| | - +-+-+-+-+ - User5| | | | | - +-+-+-+-+ - Bug restrictions are defined by this chart: - (X denotes that bug is restricted to that group.) - G G G G - r r r r - o o o o - u u u u - p p p p - 1 2 3 4 - +-+-+-+-+ - Bug1| | | | | - +-+-+-+-+ - Bug2| |X| | | - +-+-+-+-+ - Bug3| | |X| | - +-+-+-+-+ - Bug4| | | |X| - +-+-+-+-+ - Bug5|X|X| | | - +-+-+-+-+ - Bug6|X| |X| | - +-+-+-+-+ - Bug7|X|X|X| | - +-+-+-+-+ - Bug8|X|X|X|X| - +-+-+-+-+ - Who can see each bug? - Bug1 has no group restrictions. Therefore, Bug1 can be seen by any - user, whatever their group membership. This is going to be the only - bug that User5 can see, because User5 isn't in any groups. - Bug2 can be seen by anyone in Group2, that is User2 and User4. - Bug3 can be seen by anyone in Group3, that is User3 and User4. - Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of - these users can see Bug4. - Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This - is only User4. User1 cannot see it because he is not in Group2, and - User2 cannot see it because she is not in Group1. - Bug6 can be seen by anyone who is in both Group1 and Group3. This - would include User3 and User4. Similar to Bug5, User1 cannot see Bug6 - because he is not in Group3. - Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This - is only User4. All of the others are missing at least one of those - group privileges, and thus cannot see the bug. - Bug8 can be seen by anyone who is in Group1, Group2, Group3, and - Group4. There is nobody in all four of these groups, so nobody can - see Bug8. It doesn't matter that User4 is in Group1, Group2, and - Group3, since he isn't in Group4. - _________________________________________________________________ + XXX is this still true? "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. + 2. In future, when you create a Product, a matching group will be + automatically created. If you need to add a Product Group to a + Product which was created before you turned on usebuggroups, then + simply create a new group, as outlined above, with the same name + as the Product. -4.4. Bugzilla Security + Warning - + Bugzilla currently has a limit of 64 groups per installation. If you + have more than about 50 products, you should consider running multiple + Bugzillas. Ask in the newsgroup for other suggestions for working + around this restriction. - 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. + Note that group permissions are such that you need to be a member of + all the groups a bug is in, for whatever reason, to see that bug. + _________________________________________________________________ - Note +5.6. Bugzilla Security + + Warning - Poorly-configured MySQL, Bugzilla, and FTP installations have given + Poorly-configured MySQL and Bugzilla 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. - Secure your installation. - Note - 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 + 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 mozilla-webtools@mozilla.org + To secure your installation: + 1. 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. + Earlier versions had notable security holes and (from a security + point of view) poor default configuration choices. 2. There is no substitute for understanding the tools on your system! Read The MySQL Privilege System until you can recite it from memory! - 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 : ) 3. 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. - 4. Do not run Apache as "nobody". This will require very lax + 4. Do not run Apache as "nobody" . This will require very lax permissions in your Bugzilla directories. Run it, instead, as a user with a name, set via your httpd.conf file. Note - "nobody" is a real user on UNIX systems. Having a process run as user + "nobody" is a real user on UNIX systems. Having a process run as user id "nobody" 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 + 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. 5. 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. + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. The localconfig file stores your + "bugs" database account password. In addition, some files under + $BUGZILLA_HOME/data/ store sensitive information. + 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. + If you are using a web server that does not support the .htaccess + control method, you are at risk! After installing, check to see if + you can view the file "localconfig" in your web browser (e.g.: + http://bugzilla.mozilla.org/localconfig ). 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. + When you run checksetup.pl, the script will attempt to modify + various permissions on files which Bugzilla uses. If you do not + have a webservergroup set in the localconfig file, then Bugzilla + will have to make certain files world readable and/or writable. + THIS IS INSECURE! . This means that anyone who can get access to + your system can do whatever they want to your Bugzilla + installation. Note - 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. - If you are using a web server that does not support the .htaccess - control method, you are at risk! After installing, check to see if you - can view the file "localconfig" in your web browser (e.g.: - http://bugzilla.mozilla.org/localconfig). 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. + This also means that if your webserver runs all cgi scripts as the + same user/group, anyone on the system who can run cgi scripts will be + able to take control of your Bugzilla installation. On Apache, you can use .htaccess files to protect access to these directories, as outlined in Bug 57161 for the localconfig file, - and Bug 65572 for adequate protection in your data/ and shadow/ - directories. + and Bug 65572 for adequate protection in your data/ directory. 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. Place the following text into a file named ".htaccess", readable by your web server, in your $BUGZILLA_HOME/data directory. - <Files comments> allow - from all </Files> deny from all + <Files comments> allow from all </Files> + deny from all Place the following text into a file named ".htaccess", readable by your web server, in your $BUGZILLA_HOME/ directory. - <Files localconfig> deny - from all </Files> allow from all - Place the following text into a file named ".htaccess", readable - by your web server, in your $BUGZILLA_HOME/shadow directory. - deny from all + <Files localconfig> deny from all </Files> + allow from all _________________________________________________________________ -Chapter 5. Integrating Bugzilla with Third-Party Tools +5.7. Template Customisation -5.1. Bonsai +One of the large changes for 2.16 was the templatisation of the entire +user-facing UI, using the Template Toolkit. Administrators can now configure +the look and feel of Bugzilla without having to edit Perl files or face the +nightmare of massive merge conflicts when they upgrade to a newer version in +the future. -Bonsai is a web-based tool for managing CVS, the Concurrent Versioning -System . 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 "on the -hook" (include cool URL link here for Hook policies at mozilla.org). Bonsai -also includes gateways to Tinderbox, the Mozilla automated build management -system and Bugzilla +Templatisation also makes localised versions of Bugzilla possible, for the +first time. In the future, a Bugzilla installation may have templates +installed for multiple localisations, and select which ones to use based on +the user's browser language setting. _________________________________________________________________ -5.2. CVS +5.7.1. What to Edit + +There are two different ways of editing of Bugzilla's templates, and which +you use depends mainly on how you upgrade Bugzilla. The template directory +structure is that there's a top level directory, template, which contains a +directory for each installed localisation. The default English templates are +therefore in en. Underneath that, there is the default directory and +optionally the custom directory. The default directory contains all the +templates shipped with Bugzilla, whereas the custom directory does not exist +at first and must be created if you want to use it. + +The first method of making customisations is to directly edit the templates +in template/en/default. This is probably the best method for small changes +if you are going to use the CVS method of upgrading, because if you then +execute a cvs update, any template fixes will get automagically merged into +your modified versions. + +If you use this method, your installation will break if CVS conflicts occur. + +The other method is to copy the templates into a mirrored directory +structure under template/en/custom. The templates in this directory +automatically override those in default. This is the technique you need to +use if you use the overwriting method of upgrade, because otherwise your +changes will be lost. This method is also better if you are using the CVS +method of upgrading and are going to make major changes, because it is +guaranteed that the contents of this directory will not be touched during an +upgrade, and you can then decide whether to continue using your own +templates, or make the effort to merge your changes into the new versions by +hand. + +If you use this method, your installation may break if incompatible changes +are made to the template interface. If such changes are made they will be +documented in the release notes, provided you are using a stable release of +Bugzilla. If you use using unstable code, you will need to deal with this +one yourself, although if possible the changes will be mentioned before they +occur in the deprecations section of the previous stable release's release +notes. -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. - -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 "[Bug XXXX]", 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. - -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: -http://homepages.kcbbs.gen.nz/~tonyg/, under the "cvszilla" link. + Note + + Don't directly edit the compiled templates in data/template/* - your + changes will be lost when Template Toolkit recompiles them. _________________________________________________________________ -5.3. Perforce SCM +5.7.2. How To Edit Templates + +The syntax of the Template Toolkit language is beyond the scope of this +guide. It's reasonably easy to pick up by looking at the current templates; +or, you can read the manual, available on the Template Toolkit home page. +However, you should particularly remember (for security reasons) to always +HTML filter things which come from the database or user input, to prevent +cross-site scripting attacks. + +However, one thing you should take particular care about is the need to +properly HTML filter data that has been passed into the template. This means +that if the data can possibly contain special HTML characters such as <, and +the data was not intended to be HTML, they need to be converted to entity +form, ie <. You use the 'html' filter in the Template Toolkit to do this. +If you fail to do this, you may open up your installation to cross-site +scripting attacks. + +Also note that Bugzilla adds a few filters of its own, that are not in +standard Template Toolkit. In particular, the 'url_quote' filter can convert +characters that are illegal or have special meaning in URLs, such as &, to +the encoded form, ie %26. This actually encodes most characters (but not the +common ones such as letters and numbers and so on), including the +HTML-special characters, so there's never a need to HTML filter afterwards. + +Editing templates is a good way of doing a "poor man's custom fields". For +example, if you don't use the Status Whiteboard, but want to have a +free-form text entry box for "Build Identifier", then you can just edit the +templates to change the field labels. It's still be called status_whiteboard +internally, but your users don't need to know that. -You can find the project page for Bugzilla and Teamtrack Perforce -integration (p4dti) at: http://www.ravenbrook.com/project/p4dti . "p4dti" is -now an officially supported product from Perforce, and you can find the -"Perforce Public Depot" p4dti page at -http://public.perforce.com/public/perforce/p4dti/index.html. + Note -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. + If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the Developers' Guide. _________________________________________________________________ -5.4. Tinderbox/Tinderbox2 +5.7.3. Template Formats -We need Tinderbox integration information. - _________________________________________________________________ +Some CGIs have the ability to use more than one template. For example, +buglist.cgi can output bug lists as RDF or two different forms of HTML +(complex and simple). (Try this out by appending &format=simple to a +buglist.cgi URL on your Bugzilla installation.) This mechanism, called +template 'formats', is extensible. -Chapter 6. The Future of Bugzilla - -Bugzilla's Future. Much of this is the present, now. - - Bugzilla's future is a constantly-changing thing, as various - developers "scratch an itch" 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. - - Bugzilla Blue Sky - Customisability - One of the major stumbling blocks of Bugzilla has been that it is t - oo - rigid and does not adapt itself well enough to the needs of an - organisation. This has led to organisations making changes to the - Bugzilla code that need to be redone each new version of Bugzilla. - Bugzilla should attempt to move away from this to a world where thi - s - doesn't need to occur. - Most of the subsections in this section are currently explicit desi - gn - goals for the "Bugzilla 3" rewrite. This does not necessarily mean - that they will not occur before them in Bugzilla 2, but most are - significant undertakings. - Field Customisation - Many installations wish to customise the fields that appear on bug - reports. Current versions of Bugzilla offer limited - customisability. In particular, some fields can be turned off. - However, many administrators wish to add their own fields, and rena - me - or otherwise modify existing fields. An architecture that supports - this would be extraordinarily useful. - Indeed, many fields work similarly and could be abstracted into "fi - eld - types", so that an administrator need write little or no code to - support the new fields they desire. - Possible field types include text (eg status whiteboard), numbers, - dates (eg report time), accounts (eg reporter, qa, cc), inter-bug - relationships (dependencies, duplicates), option groups (platform, - os, - severity, priority, target milestone, version) etc. - Ideally an administrator could configure their fields through a - Bugzilla interface that requires no code to be added. However, it - is - highly unlikely this ideal will never be met, and in a similar way - that office applications have scripting languages, Bugzilla should - allow new field types to be written. - Similarly, a common desire is for resolutions to be added or remove - d. - Allocations - ? - Option Groups - ? - Relations - ? - Database Integrity - Furthermore, it is desirable for administrators to be able to speci - fy - rules that must or should apply between the fields on a bug report. - For example, you might wish to specify that a bug with status ASSIG - NED - must have a target milestone field that that is not untargetted. O - r - that a bug with a certain number of votes should get ASSIGNED. Or - that the QA contact must be different from the assignee. - "Must" relationships could be implemented by refusing to make chang - es - that violate the relationships, or alternatively, automatically - updating certain fields in order to satisfy the criteria. Which - occurs should be up to the administrator. - "Should" relationships could be implemented by a combination of - emitting warnings on the process bug page, the same on notification - mails, or emitting periodic whine mails about the situation. Again - , - which occurs should be up to the administrator. - It should also be possible for whine mails to be emitted for "must" - relationships, as they might become violated through direct databas - e - access, Bugzilla bugs, or because they were there before the - relationship was enforced. - As well as implementing intra-bug constraints, it would be useful t - o - create inter-bug constraints. For example, a bug that is dependent - on - another bug should not have an earlier milestone or greater priorit - y - than that bug. - Database Adaptability - Often an administrator desires that fields adapt to the values of - other fields. For example, the value of a field might determine th - e - possible values of another field or even whether it appears (whethe - r - it is "applicable"). - Limited adaptability is present in Bugzilla 2, and only on the - "Product" field: - * The possible values of the target milestone, version and compon - ent - fields depend on the product. - * UNCONFIRMED can be turned off for specific products. - * Voting can be configured differently or turned off for differen - t - products, and there is a separate user vote limits for each - product. - It would be good if more adaptability was present, both in terms of - all fields relying on the product, as well as the ability to adapt - based on the value of all fields. - Example ??? - General adaptability raises the issue of circular references betwee - n - fields causing problems. One possible solution to this is to place - the fields in a total ordering and require a field refer only to th - e - previous fields. - In Bugzilla 2, changing the product of a bug meant a second page wo - uld - appear that allowed you to choose a new milestone, component and - version, as those fields adapted themselves to the new product. Th - is - page could be generalised to support all instances where: - * a field value must or might be changed because the possible val - ues - have changed - * is going to drop off because it it is no longer applicable, and - this should be confirmed - * must be specified because it is suddenly applicable, and the - default value, if one exists, might not be acceptable - Database Independence - Currently Bugzilla only runs on the MySQL database. It would be - desirable for Bugzilla to run on other databases, because: - * Organisations may have existing database products they use and - would prefer to run a homogenous environment. - * Databases each have their own shortcomings, including MySQL. A - n - administrator might choose a database that would work better wi - th - their Bugzilla. - This raises the possibility that we could use features that are onl - y - present in some databases, by appropriately falling back. For - example, in the MySQL world, we live without: - * record-level locking, instead we use table-level locking - * referential and record constraints, instead we checking code - * subselects, instead we use multiple queries and redundant "cach - es" - Multiple Front Ends - Currently Bugzilla is manipulated via the Web, and notifies via - E-Mail. It would be desirable for Bugzilla to easily support vario - us - front ends. - There is no reason that Bugzilla could not be controlled via a whol - e - range of front ends, including Web, E-Mail, IRC, ICQ, etc, and - similarly for how it notifies. It's also possible that we could - introduce a special Bugzilla client that uses its own protocol, for - maximum user productivity. - Indeed a request reply might be returned via a totally different - transport method than was use to submit the request. - Internationalisation - Bugzilla currently supports only English. All of the field names, - user instructions, etc are written in English. It would be desirab - le - to allow "language packs" so Bugzilla can be easily used in - non-English speaking locales. - To a degree field customisation supports this, because administrato - rs - could specify their own fields names anyway. However, there will - always be some basic facilities not covered by this, and it is - desirable that the administrator's interface also is - internationalisable. - Better Searching - General Summary Reports - Sometimes, the normal querying page leaves a lot to be desired. Th - ere - are other facilities already in place or which people have asked fo - r: - Most Doomed Reports - All Bugs or All Bugs In A Product, Categorise - d - On Assignee, Shows and Counts Number of Bugs For Each Assignee - Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top T - en - Bugs Voters Most Want Fixed - Number of Open Bugs For An Assignee - Bug List, Categorised On - Developers, Counts Number of Bugs In Category - The important thing to realise is that people want categorised repo - rts - on all sorts of things - a general summary report. - In a categorised report, you choose the subset of bugs you wish to - operate on (similar to how you would specify a query), and then - categorise them on one or more fields. - For each category you display the count of the number of things in - that category. You can optionally display the bugs themselves, or - leave them out, just showing the counts. And you can optionally li - mit - the number of things (bugs or subcategories) that display in each - category. - Such a mechanism would let you do all of the above and more. - Applications of this mechanism would only be recognised once it was - implemented. - Related Bugs - It would be nice to have a field where you could enter other bugs - related to the current bug. It would be handy for navigation and - possibly even finding duplicates. - Column Specification Support - Currently bug lists use the columns that you last used. This doesn - 't - work well for "prepackaged queries", where you followed a link. Yo - u - can probably add a column by specifying a sort column, but this is - difficult and suboptimal. - Furthermore, I find that when I want to add a column to a bug list, - it's usually a one off and I would prefer it to go away for the nex - t - query. Hence, it would be nice to specify the columns that appear - on - the bug list (and general summary report) pages. The default query - mechanism should be able to let you specify your default columns. - Advanced Querying Redesign - ? - Keywords - People have a need to apply tags to bugs. In the beginning, people - placed designators in the summary and status whiteboard. However, - these fields were not designed for that, and so there were many fla - ws - with this system: - * They pollute the field with information that was never intended - to - be present. - * Removing them with a bulk change is a difficult problem that ha - s - too many pitfalls to implement. - * You can easily get the capitalisation wrong. - Then dependencies were introduced (when?), and people realised that - they could use them for "tracking bugs". Again, dependencies were - not - designed for that, and so there were more flaws, albeit different - ones, including: - * They aren't really bugs, so it's difficult to distinguish issue - s - from bugs. - * They can pollute bugs counts, and you must somehow exclude them - from queries. - * There is a whole lot of useless information on them. They have - an - assignee but there is nothing to fix, and that person can get - whined at by Bugzilla. They have target milestones which must - be - manually maintained. And so on. - Finally, keywords were introduced (when?) for this purpose to remov - e - the need for these two systems. Unfortunately, the simple keywords - implementation was itself lacking in certain features provided by t - he - two previous systems, and has remained almost unchanged since its - inception. Furthermore, it could not be forseen that in large - installations, the sheer number of keywords could become unwieldly - and - could lead to a movement back to the other systems. - The keywords system was the right idea, however, and it remains so. - Fixing the keywords system is one of the most important Bugzilla - issues. - Bringing Keywords Up To Par - For the most part, keywords are very good at what they do. It is e - asy - to add and remove them (unlike summary/whiteboard designators), we - can - simply see what issues are present on a bug (unlike tracking bugs), - and we do not confuse bugs with issues (unlike tracking bugs). - However, there are still some "regressions" in the keyword system o - ver - previous systems: - * Users wish to view the "dependency forest" of a keyword. While - a - dependency tree is of one bug, a dependency forest is of a bug - list, and consists of a dependency tree for each member of the - bug - list. Users can work around this with tracking bugs by creatin - g a - tracking bug and viewing the dependency tree of that tracking b - ug. - * Users wish to specify the keywords that initially apply to a bu - g, - but instead they must edit the bug once it has already been - submitted. They can work around this with summary designators, - since they specify the summary at reporting time. - * Users wish to store or share a bug list that contains a keyword - s - column. Hence they wish to be able to specify what columns app - ear - in the bug list URL, as mentioned earlier. They can work aroun - d - this using summary designators, since almost all bug lists have - a - summary column. - * Users wish to be able to view keywords on a bug list. However - often they are only interested in a small number of keywords. - Having a bug list with a keywords column means that all keyword - s - will appear on a bug list. This can take a substantial amount - of - space where a bug has a lot of keywords, since the table column - s - in Bugzilla adjust to the largest cell in that column. Hence - users wish to be able to specify which keywords should appear i - n - the bug list. In a very real sense, each keyword is a field un - to - itself. Users can work around this by using summary designator - s, - since they keywords will share the space in the summary column. - * Users wish to know when bugs with a specific issue are resolved - . - Hence they wish to be able to receive notifications on all the - bugs with a specific keyword. The introduction a generic watch - ing - facility (also for things like watching all bugs in a component - ) - would achieve this. Users can work around this by using tracki - ng - bugs, as dependencies have an existing way of detecting fixes t - o - bug a bug was blocked by. - Dealing With The Keyword Overload - At the time of writing, the mozilla.org installation has approximat - ely - 100 keywords, and many more would be in use if the keywords system - didn't have the problems it does. - Such a large number of keywords introduces logistical problems: - * It must be easy for someone to learn what a keyword means. If - a - keyword is buried within a lot of other keywords, it can be - difficult to find. - * It must be easy to see what keywords are on a bug. If the numb - er - of keywords is large, then this can be difficult. - These lead some people to feel that there are "too many keywords". - These problems are not without solutions however. It is harder to - find a list of designators or tracking bugs than it is a list of - keywords. - The essential problem is it needs to be easy to find the keywords - we're interested in through the mass of keywords. - Keyword Applicability - As has been previously mentioned, it is desirable for fields to be - able to adapt to the values of other fields. This is certainly tru - e - for keywords. Many keywords are simply not relevant because of the - bugs product, component, etc. - Hence, by introducing keyword applicability, and not displaying - keywords that are not relevant to the current bug, or clearly - separating them, we can make the keyword overload problem less - significant. - Currently when you click on "keywords" on a bug, you get a list of - all - bugs. It would be desirable to introduce a list of keywords tailor - ed - to a specific bug, that reports, in order: - * the keywords currently on the bug - * the keywords not currently on the bug, but applicable to the bu - g - * optionally, the keywords not applicable to the bug - This essentially orders the keywords into three groups, where each - group is more important than the previous, and therefore appears - closer to the top. - Keyword Grouping & Ordering - We could further enhance both the global and bug specific keyword l - ist - by grouping keywords. We should always have a "flat" view of - keywords, but other ways of viewing the keywords would be useful to - o. - If keyword applicability was implemented, we could group keywords - based on their "applicability condition". Keywords that apply to a - ll - bugs could be separated from keywords that apply to a specific - product, both on the global keyword list and the keyword list of a - bug - that is in that product. - We could specify groups of our own. For example, many keywords are - in - a mutually exclusive group, essentially like radio buttons in a use - r - interface. This creates a natural grouping, although other groupin - gs - occur (which depends on your keywords). - It is possible that we could use collapsing/expanding operations on - "twisties" to only should the groups we are interested in. - And instead of grouping keywords, we could order them on some metri - c - of usefulness, such as: - * when the keyword was last added to a bug - * how many bugs the keyword is on - * how many open bugs the keyword is on - Opting Out Of Keywords - Not all people are going to care about all keywords. Therefore it - makes sense that you may wish to specify which keywords you are - interested in, either on the bug page, or on notifications. - Other keywords will therefore not bother users who are not interest - ed - in them. - Keyword Security - Currently all keywords are available and editable to all people wit - h - edit bugs access. This situation is clearly suboptimal. - Although relying on good behaviour for people to not do what they - shouldn't works reasonably well on the mozilla.org, it is better to - enforce that behaviour - it can be breached through malice, acciden - t - or ignorance. - And in the situation where it is desirable for the presence or abse - nce - of a keyword not to be revealed, organisations either need to be - content with the divulgence, or not use keywords at all. - In the situation where they choose to divulge, introducing the abil - ity - to restrict who can see the keyword would also reduce keyword - overload. - Personal Keywords - Keywords join together a set of bugs which would otherwise be - unrelated in the bug system. - We allow users to store their own queries. However we don't allow - them to store their own keywords on a bug. This reduces the - usefulness of personal queries, since you cannot join a set of - unrelated bugs together in a way that you wish. Lists of bug numbe - rs - can work, by they can only be used for small lists, and it is - impossible to share a list between multiple queries. - Personal keywords are necessary to replace personal tracking bugs, - as - they would not pollute the keyword space. Indeed, on many - installations this could remove some keywords out of the global - keyword space. - In a similar vein and with similar effects, group keywords could be - introduced that are only available to members of a specific group. - Keyword Restrictions - Keywords are not islands unto themselves. Along with their potenti - al - to be involved in the inter-field relationships mentioned earlier, - keywords can also be related to other keywords. - Essentially, there are two possibilities: - * a set of keywords are mutually exclusive - * the presence of a keyword implies another keyword must be prese - nt - Introduction of the ability to specify these restrictions would hav - e - benefits. - If mutually exclusive keywords were present on a bug, their removal - would fix up the database, as well as reducing the number of keywor - ds - on that bug. - In the situation where a keyword implies another keyword, there are - two possiblities as to how to handle the situation. - The first is automatically add the keyword. This would fix up the - database, but it would increase the number of keywords on a bug. - The second is to automatically remove the keyword, and alter querie - s - so they pick up the first keyword as well as the removed keyword. - This would fix up the database and reduce the number of keywords on - a - bug, but it might confuse users who don't see the keyword. - Alternatively, the implied keywords could be listed separately. - Notifications - Every time a bug gets changed notifications get sent out to people - letting them know about what changes have been made. This is a - significant feature, and all sorts of questions can be raised, but - they mainly boil down to when they should be sent and what they sho - uld - look like. - Changes You're Interested In - As of version 2.12 users can specify what sort of changes they are - interested in receiving notifications for. However, this is still - limited. As yet there is no facility to specify which keywords you - care about, and whether you care about changes to fields such as th - e - QA contact changes. - Furthermore, often an unnecessary comment will go along with a chan - ge, - either because it is required, or the commenter is ignorant of how - the - new system works. While explaining why you did something is useful - , - merely commenting on what you did is not because that information i - s - already accessible view "Bug Activity". - Because of this unnecessary comment, a lot of changes that would - otherwise not generate notifications for certain people do so, beca - use - few people are willing to turn off comments. One way to deal with - this problem is to allow people to specify that their comments are - purely explanatory, and that anyone who is not interested in the - change will not be interested in the comment. - Furthermore, one possible rationale for unnecessary comments is tha - t - the bug activity does not display on the normal page and hence it i - s - difficult to cross reference comments and actions. Hence, it would - be - beneficial to be able to do this. - Bugs You're Watching - Currently to receive a notification about a bug you need to have yo - ur - name on it. This is suboptimal because you need to know about a bu - g - before you can receive notifications on it. Often you are interest - ed - in any bug with a field set to a specific value. For example, you - might be interested in all bugs with a specific product, component - or - keyword. - If someone could automatically receive notifications about these bu - gs, - it would make everyone's lives easier. Currently the default assig - nee - and QA contact for a component will automatically receive - notifications for - Question: This moves half way to a BCC. - Bulk Changes - A very useful feature of Bugzilla is the ability to perform an acti - on - on multiple bugs at once. However, this means that similar - notifications are currently generated for each bug modified. - This can result in a torrent of notifications that can annoy. - Furthermore, since the bugs are all changed close to each other in - time, it is easy for someone to mass delete all the notifications - generated by a bulk change and miss an unrelated notification in th - e - middle. - These factors can lead to a tendency for people to delay bulk chang - es, - or avoid them entirely. This is suboptimal. - It would be better if a bulk change generated only one notification - mail. This would vastly reduce the annoyance factor, and prevent - accidental deletion of notifications. - One problem with this change is that some people separate out - notifications using filtering. This means that they would no longe - r - be match parts of a bulk change under different filtering rules. - One possibility to resolve this is to allow people to specify group - s - of bugs. All bugs within a group would go into the same - notification. The filters could then distinguish the different bug - groups. - In any case, it is likely there would need to be a transition perio - d - to allow people to alter their filters. - Nominations - ? - Linking Bugzilla Installations - The first example of linking Bugzilla installations together has is - the introduction of bug moving in version 2.12. However, it would - be - useful to be able to link installations in more ways. - * Dependencies and other relationships between bugs in other - installations. This is difficult because dependencies are - synchronised on both bugs, so the installation that changes - dependencies would need to communicate the new state to the oth - er - installation. It would also mean that relationships and - notifications that refer to other bugs would need to communicat - e - with the other installation. - * References to bugs in other installations. Currently if you ty - pe - "bug XXX" or "bug #XXX" where XXX is a number, you get an - automatic hyperlink to that bug. It would be useful if you cou - ld - say "YYY bug #XXX" where YYY is the name of another installatio - n. - Retirement - ? - Whiny Reports - ? - Group Redesign - ? - Hard Wrapping Comments - Currently Bugzilla "hard wraps" its comments to a specific line siz - e, - similar to E-Mail. This has various problems: - * The way it currently works, wrapping is done in the browser at - submission time using a non-standard HTML extension not support - ed - by some (uncommon) browsers. These browsers generate comments - that scroll off the right side of the screen. - * Because comments are of fixed width, when you expand your brows - er - window, the comments do not expand to fit available space. - It would be much better to move to a world of soft wrapping, where - the - browser wraps the text at display time, similar to a world processo - r. - And as in a word processor, soft wrapping does not preclude the - insertion of newlines. - Hard wrapping is too entrenched into text E-Mail to fix, but we can - fix Bugzilla without causing any problems. The old content will st - ill - be wrapped too early, but at least new content will work. - _________________________________________________________________ +To see if a CGI supports multiple output formats, grep the CGI for +"ValidateOutputFormat". If it's not present, adding multiple format support +isn't too hard - see how it's done in other CGIs. -Chapter 7. Bugzilla Variants and Competitors +To make a new format template for a CGI which supports this, open a current +template for that CGI and take note of the INTERFACE comment (if present.) +This comment defines what variables are passed into this template. If there +isn't one, I'm afraid you'll have to read the template and the code to find +out what information you get. -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: http://linas.org/linux/pm.html +Write your template in whatever markup or text style is appropriate. + +You now need to decide what content type you want your template served as. +Open up the localconfig file and find the $contenttypes variable. If your +content type is not there, add it. Remember the three- or four-letter tag +assigned to you content type. This tag will be part of the template +filename. + +Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. Try out +the template by calling the CGI as <cginame>.cgi?format=<formatname> . _________________________________________________________________ -7.1. Red Hat Bugzilla +5.7.4. Particular Templates -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. +There are a few templates you may be particularly interested in customising +for your installation. -URL: http://bugzilla.redhat.com/bugzilla/ +index.html.tmpl: This is the Bugzilla front page. + +global/header.html.tmpl: This defines the header that goes on all Bugzilla +pages. The header includes the banner, which is what appears to users and is +probably what you want to edit instead. However the header also includes the +HTML HEAD section, so you could for example add a stylesheet or META tag by +editing the header. + +global/banner.html.tmpl: This contains the "banner", the part of the header +that appears at the top of all Bugzilla pages. The default banner is +reasonably barren, so you'll probably want to customise this to give your +installation a distinctive look and feel. It is recommended you preserve the +Bugzilla version number in some form so the version you are running can be +determined, and users know what docs to read. + +global/footer.html.tmpl: This defines the footer that goes on all Bugzilla +pages. Editing this is another way to quickly get a distinctive look and +feel for your Bugzilla installation. + +bug/create/user-message.html.tmpl: This is a message that appears near the +top of the bug reporting page. By modifying this, you can tell your users +how they should report bugs. + +bug/create/create.html.tmpl and bug/create/comment.txt.tmpl: You may wish to +get bug submitters to give certain bits of structured information, each in a +separate input widget, for which there is not a field in the database. The +bug entry system has been designed in an extensible fashion to enable you to +define arbitrary fields and widgets, and have their values appear formatted +in the initial Description, rather than in database fields. An example of +this is the mozilla.org guided bug submission form. + +To make this work, create a custom template for enter_bug.cgi (the default +template, on which you could base it, is create.html.tmpl), and either call +it create.html.tmpl or use a format and call it +create-<formatname>.html.tmpl. Put it in the custom/bug/create directory. In +it, add widgets for each piece of information you'd like collected - such as +a build number, or set of steps to reproduce. + +Then, create a template like custom/bug/create/comment.txt.tmpl, also named +after your format if you are using one, which references the form fields you +have created. When a bug report is submitted, the initial comment attached +to the bug report will be formatted according to the layout of this +template. + +For example, if your enter_bug template had a field + +<input type="text" name="buildid" size="30"> + +and then your comment.txt.tmpl had + + BuildID: [% form.buildid %] + + then + BuildID: 20020303 + + would appear in the initial checkin comment. _________________________________________________________________ -7.2. Loki Bugzilla (Fenris) +5.8. Upgrading to New Releases + +A plain Bugzilla is fairly easy to upgrade from one version to a newer one. +Always read the release notes to see if there are any issues that you might +need to take note of. It is recommended that you take a backup of your +database and your entire Bugzilla installation before attempting an upgrade. +You can upgrade a 'clean' installation by untarring a new tarball over the +old installation. If you are upgrading from 2.12 or later, and have cvs +installed, you can type cvs -z3 update, and resolve conflicts if there are +any. + +However, things get a bit more complicated if you've made changes to +Bugzilla's code. In this case, you may have to re-make or reapply those +changes. One good method is to take a diff of your customised version +against the original, so you can survey all that you've changed. Hopefully, +templatisation will reduce the need for this in the future. + +From version 2.8 onwards, Bugzilla databases can be automatically carried +forward during an upgrade. However, because the developers of Bugzilla are +constantly adding new tables, columns and fields, you'll probably get SQL +errors if you just update the code and attempt to use Bugzilla. Always run +the checksetup.pl script whenever you upgrade your installation. -Fenris can be found at http://fenris.lokigames.com. It is a fork from -Bugzilla. +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. _________________________________________________________________ -7.3. Issuezilla +5.9. Integrating Bugzilla with Third-Party Tools -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, -Scarab, a newfangled Java-based issue tracker, is under heavy development -and looks promising! +5.9.1. Bonsai -URL: http://issuezilla.tigris.org/servlets/ProjectHome +Bonsai is a web-based tool for managing CVS, the Concurrent Versioning +System . 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. Bonsai also integrates with Tinderbox, the Mozilla automated build +management system. _________________________________________________________________ -7.4. Scarab - -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. +5.9.2. CVS -URL: http://scarab.tigris.org +CVS integration is best accomplished, at this point, using the Bugzilla +Email Gateway. + +Follow the instructions in this Guide 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 "[Bug XXXX]", 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. + +There is also a CVSZilla project, based upon somewhat dated Bugzilla code, +to integrate CVS and Bugzilla through CVS' ability to email. Check it out +at: http://homepages.kcbbs.gen.nz/~tonyg/. _________________________________________________________________ -7.5. Perforce SCM +5.9.3. Perforce SCM -Although Perforce isn't really a bug tracker, it can be used as such through -the "jobs" functionality. +You can find the project page for Bugzilla and Teamtrack Perforce +integration (p4dti) at: http://www.ravenbrook.com/project/p4dti . "p4dti" is +now an officially supported product from Perforce, and you can find the +"Perforce Public Depot" p4dti page at +http://public.perforce.com/public/perforce/p4dti/index.html . -http://www.perforce.com/perforce/technotes/note052.htmlhttp://www.perforce.c -om/perforce/technotes/note052.html +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. _________________________________________________________________ -7.6. SourceForge - -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! +5.9.4. Tinderbox/Tinderbox2 -URL: http://www.sourceforge.net +We need Tinderbox integration information. _________________________________________________________________ Appendix A. The Bugzilla FAQ +This FAQ includes questions not covered elsewhere in the Guide. + 1. General Questions A.1.1. Where can I find information about Bugzilla? @@ -3825,228 +2835,179 @@ Appendix A. The Bugzilla FAQ A.1.6. How does Bugzilla stack up against other bug-tracking databases? - A.1.7. How do I change my user name in Bugzilla? - A.1.8. Why doesn't Bugzilla offer this or that feature or + A.1.7. Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? - A.1.9. Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? - - A.1.10. Why do the scripts say "/usr/bonsaitools/bin/perl" - instead of "/usr/bin/perl" or something else? - - 2. Red Hat Bugzilla - - A.2.1. What about Red Hat Bugzilla? - A.2.2. What are the primary benefits of Red Hat Bugzilla? - A.2.3. What's the current status of Red Hat Bugzilla? - - 3. Loki Bugzilla (AKA Fenris) + A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on + Oracle/Sybase/Msql/PostgreSQL/MSSQL. - A.3.1. What is Loki Bugzilla (Fenris)? + A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead + of "/usr/bin/perl" or something else? - 4. Pointy-Haired-Boss Questions + A.1.10. Is there an easy way to change the Bugzilla cookie name? - A.4.1. Is Bugzilla web-based or do you have to have specific - software or specific operating system on your machine? + 2. Managerial Questions - A.4.2. Has anyone you know of already done any Bugzilla - integration with Perforce (SCM software)? + A.2.1. Is Bugzilla web-based, or do you have to have specific + software or a specific operating system on your machine? - A.4.3. Does Bugzilla allow the user to track multiple projects? - A.4.4. If I am on many projects, and search for all bugs assigned + A.2.2. Can Bugzilla integrate with Perforce (SCM software)? + A.2.3. Does Bugzilla allow the user to track multiple projects? + A.2.4. 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.4.5. Does Bugzilla allow attachments (text, screenshots, urls + A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? - A.4.6. Does Bugzilla allow us to define our own priorities and + A.2.6. 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.4.7. 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.4.8. Does Bugzilla provide any reporting features, metrics, + A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) - A.4.9. 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.2.8. Is there email notification and if so, what do you see + when you get an email? - A.4.10. Can email notification be set up to send to multiple + A.2.9. Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? - A.4.11. If there is email notification, do users have to have any - particular type of email application? - - A.4.12. 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.2.10. Do users have to have any particular type of email + application? - A.4.13. Does Bugzilla allow data to be imported and exported? If + A.2.11. 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.4.14. Has anyone converted Bugzilla to another language to be + A.2.12. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? - A.4.15. Can a user create and save reports? Can they do this in + A.2.13. Can a user create and save reports? Can they do this in Word format? Excel format? - A.4.16. Can a user re-run a report with a new project, same - query? - - A.4.17. Can a user modify an existing report and then save it - into another name? - - A.4.18. Does Bugzilla have the ability to search by word, phrase, + A.2.14. Does Bugzilla have the ability to search by word, phrase, compound search? - A.4.19. Can the admin person establish separate group and - individual user privileges? - - A.4.20. Does Bugzilla provide record locking when there is + A.2.15. 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.4.21. Are there any backup features provided? - A.4.22. Can users be on the system while a backup is in progress? + A.2.16. Are there any backup features provided? + A.2.17. Can users be on the system while a backup is in progress? - A.4.23. What type of human resources are needed to be on staff to + A.2.18. 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.4.24. What time frame are we looking at if we decide to hire + A.2.19. 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.4.25. Is there any licensing fee or other fees for using + A.2.20. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? - 5. Bugzilla Installation + 3. Bugzilla Security - A.5.1. How do I download and install Bugzilla? - A.5.2. How do I install Bugzilla on Windows NT? - A.5.3. Is there an easy way to change the Bugzilla cookie name? - - 6. Bugzilla Security - - A.6.1. How do I completely disable MySQL security if it's giving + A.3.1. 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!)? + installation section of this guide)? - A.6.2. Are there any security problems with Bugzilla? - A.6.3. I've implemented the security fixes mentioned in Chris + A.3.2. Are there any security problems with Bugzilla? + A.3.3. 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. - 7. Bugzilla Email + 4. Bugzilla Email - A.7.1. I have a user who doesn't want to receive any more email + A.4.1. 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.7.2. I'm evaluating/testing Bugzilla, and don't want it to send + A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? - A.7.3. I want whineatnews.pl to whine at something more, or other + A.4.3. I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? - A.7.4. I don't like/want to use Procmail to hand mail off to + A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? - A.7.5. How do I set up the email interface to submit/change bugs + A.4.5. How do I set up the email interface to submit/change bugs via email? - A.7.6. Email takes FOREVER to reach me from bugzilla -- it's + A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? - A.7.7. How come email never reaches me from bugzilla changes? - - 8. Bugzilla Database + A.4.7. How come email from Bugzilla changes never reaches me? - A.8.1. I've heard Bugzilla can be used with Oracle? - A.8.2. Bugs are missing from queries, but exist in the database - (and I can pull them up by specifying the bug ID). What's - wrong? + 5. Bugzilla Database - A.8.3. I think my database might be corrupted, or contain invalid + A.5.1. I've heard Bugzilla can be used with Oracle? + A.5.2. I think my database might be corrupted, or contain invalid entries. What do I do? - A.8.4. I want to manually edit some entries in my database. How? - A.8.5. I try to add myself as a user, but Bugzilla always tells + A.5.3. I want to manually edit some entries in my database. How? + A.5.4. I try to add myself as a user, but Bugzilla always tells me my password is wrong. - A.8.6. I think I've set up MySQL permissions correctly, but - bugzilla still can't connect. + A.5.5. I think I've set up MySQL permissions correctly, but + Bugzilla still can't connect. - A.8.7. How do I synchronize bug information among multiple + A.5.6. How do I synchronize bug information among multiple different Bugzilla databases? - A.8.8. Why do I get bizarre errors when trying to submit data, - particularly problems with "groupset"? - - A.8.9. How come even after I delete bugs, the long descriptions - show up? - - 9. Bugzilla and Win32 + 6. Bugzilla and Win32 - A.9.1. What is the easiest way to run Bugzilla on Win32 + A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? - A.9.2. Is there a "Bundle::Bugzilla" equivalent for Win32? - A.9.3. CGI's are failing with a "something.cgi is not a valid + A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? - A.9.4. Can I have some general instructions on how to make - Bugzilla on Win32 work? - - A.9.5. I'm having trouble with the perl modules for NT not being + A.6.4. I'm having trouble with the perl modules for NT not being able to talk to to the database. - 10. Bugzilla Usage + 7. Bugzilla Usage - A.10.1. The query page is very confusing. Isn't there a simpler + A.7.1. How do I change my user name (email address) in Bugzilla? + A.7.2. The query page is very confusing. Isn't there a simpler way to query? - A.10.2. 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.7.3. 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.10.3. I can't upload anything into the database via the "Create + A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? - A.10.4. Email submissions to Bugzilla that have attachments end - up asking me to save it as a "cgi" file. + A.7.5. Email submissions to Bugzilla that have attachments end up + asking me to save it as a "cgi" file. - A.10.5. How do I change a keyword in Bugzilla, once some bugs are + A.7.6. How do I change a keyword in Bugzilla, once some bugs are using it? - 11. Bugzilla Hacking + 8. Bugzilla Hacking - A.11.1. What bugs are in Bugzilla right now? - A.11.2. How can I change the default priority to a null value? - For instance, have the default priority be "---" instead - of "P2"? + A.8.1. What bugs are in Bugzilla right now? + A.8.2. How can I change the default priority to a null value? For + instance, have the default priority be "---" instead of + "P2"? - A.11.3. What's the best way to submit patches? What guidelines + A.8.3. What's the best way to submit patches? What guidelines should I follow? 1. General Questions @@ -4054,7 +3015,7 @@ Appendix A. The Bugzilla FAQ A.1.1. Where can I find information about Bugzilla? You can stay up-to-date with the latest Bugzilla information at - http://www.mozilla.org/projects/bugzilla/ + http://www.bugzilla.org/ A.1.2. What license is Bugzilla distributed under? @@ -4068,9 +3029,9 @@ Appendix A. The Bugzilla FAQ and generally aren't interested in small projects. 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. + list/newsgroup who are willing to make themselves available for + generous compensation. Try sending a message to the mailing list + asking for a volunteer. A.1.4. What major companies or projects are currently using Bugzilla for bug-tracking? @@ -4080,12 +3041,11 @@ Appendix A. The Bugzilla FAQ Netscape/AOL Mozilla.org + NASA AtHome Corporation Red Hat Software - Loki Entertainment Software SuSe Corp The Horde Project - The Eazel Project AbiSource Real Time Enterprises, Inc Eggheads.org @@ -4094,6 +3054,7 @@ Appendix A. The Bugzilla FAQ Creative Labs (makers of SoundBlaster) The Apache Foundation The Gnome Foundation + Ximian Linux-Mandrake Suffice to say, there are more than enough huge projects using @@ -4101,31 +3062,25 @@ Appendix A. The Bugzilla FAQ A.1.5. Who maintains Bugzilla? - Bugzilla maintenance has been in a state of flux recently. Please - check the Bugzilla Project Page for the latest details. + A core team, led by Dave Miller (justdave@syndicomm.com). A.1.6. How does Bugzilla stack up against other bug-tracking databases? - A year has gone by, and I still 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. + We can't find any head-to-head comparisons of Bugzilla against other + defect-tracking software. If you know of one, please get in touch. + However, from the author's personal 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. 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. - - A.1.7. How do I change my user name in Bugzilla? + forward with a list of advantages your product has over Bugzilla. We'd + be happy to include it in the "Competitors" section. - You can't. However, the administrative account can, by simply opening - your user account in editusers.cgi and changing the login name. - - A.1.8. Why doesn't Bugzilla offer this or that feature or + A.1.7. Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? It may be that the support has not been built yet, or that you have @@ -4140,266 +3095,66 @@ Appendix A. The Bugzilla FAQ Enhancement" (RFE) using the bug submission interface at bugzilla.mozilla.org. - A.1.9. Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? - - Terry Weissman answers, + A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on + Oracle/Sybase/Msql/PostgreSQL/MSSQL. - You're not the only one. But I 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. + There is DB-independence work afoot. PostgreSQL support is planned for + 2.18, and full DB-independence can't be far further on. - 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: - - Red Hat Bugzilla: Runs a modified Bugzilla 2.8 atop an Oracle - database. - Interzilla: A project to run Bugzilla on Interbase. No code released - yet, however. - Bugzilla 3.0: One of the primary stated goals is multiple database - support. - - A.1.10. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of + A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? - 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. - - Here's Terry Weissman's comment, for some historical context: - - [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. - - Note + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally Terry + wanted a place to put a version of Perl and other tools that was + strictly under his control. 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. - - Obviously, if you do not have root access to your Bugzilla box, our - suggestion is irrelevant. + /usr/bonsaitools/bin/perl, and simply add symlink. This will make + upgrading your Bugzilla much easier in the future. -2. Red Hat Bugzilla - - Note + A.1.10. Is there an easy way to change the Bugzilla cookie name? - This section is no longer up-to-date. Please see the section on "Red - Hat Bugzilla" under "Variants" in The Bugzilla Guide. - - A.2.1. What about Red Hat Bugzilla? - - 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? - - Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions: - - Somebody needs to take the ball and run with it. I'm the only - maintainer and am very pressed for time. - - 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. - - A.2.2. What are the primary benefits of Red Hat Bugzilla? - - Dave Lawrence: - - 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. - - 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. - - 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: - - 1. No enum types. All old enum types are now separate smaller tables. - 2. No bit wise operations. Not all databases support this so they - were changed to a more generic way of doing this task - 3. 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 - 4. 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. - 5. 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. - 6. 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. - 7. 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. - 8. 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. - - 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. - - A.2.3. What's the current status of Red Hat Bugzilla? - - Note + At present, no. - 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. - Dave Lawrence: - - 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. - - 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. - -3. Loki Bugzilla (AKA Fenris) - - A.3.1. What is Loki Bugzilla (Fenris)? - - Loki Games has a customized version of Bugzilla available at - http://fenris.lokigames.com. 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. - -4. Pointy-Haired-Boss Questions +2. Managerial Questions Note - 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 :) + Questions likely to be asked by managers. :-) - A.4.1. Is Bugzilla web-based or do you have to have specific software - or specific operating system on your machine? + A.2.1. Is Bugzilla web-based, or do you have to have specific software + or a specific operating system on your machine? 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. - A.4.2. Has anyone you know of already done any Bugzilla integration - with Perforce (SCM software)? + A.2.2. Can Bugzilla integrate with Perforce (SCM software)? Yes! You can find more information elsewhere in "The Bugzilla Guide" in the "Integration with Third-Party Products" section. - A.4.3. Does Bugzilla allow the user to track multiple projects? + A.2.3. Does Bugzilla allow the user to track multiple projects? - 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. + Absolutely! You can track any number of Products (although you are + limited to about 55 or so if you are using Product-Based Groups), that + can each be composed of any number of Components. - A.4.4. If I am on many projects, and search for all bugs assigned to + A.2.4. 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? Yes. - A.4.5. Does Bugzilla allow attachments (text, screenshots, urls etc)? + A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? - 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. + Yes - any sort of attachment is allowed, although administrators can + configure a maximum size. 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. - A.4.6. Does Bugzilla allow us to define our own priorities and levels? + A.2.6. 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? @@ -4411,52 +3166,11 @@ Appendix A. The Bugzilla FAQ follow development of this feature at http://bugzilla.mozilla.org/show_bug.cgi?id=91037 - A.4.7. 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? - - 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 index.html to index.shtml. - - After you've done all that, you can add the following line to - index.shtml: -<!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; PutFooter();"" --> - - Note - - 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. - - 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 api.cgi) that basically looks - like: -#!/usr/bonsaitools/bin/perl -w - -require 'globals.pl'; - -if ($::FORM{sub} eq 'PutFooter') { - PutFooter(); -} else { - die 'api.cgi was incorrectly called'; -} - - and then put this line in index.shtml. -<!--#include virtual="api.cgi?sub=PutFooter"--> - - Note - - This still requires being able to use Server Side Includes, if this - simply will not work for you, see bug 80183 for a third option. - - A.4.8. Does Bugzilla provide any reporting features, metrics, graphs, + A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) Yes. Look at http://bugzilla.mozilla.org/reports.cgi for basic - reporting facilities. + reporting and graphing facilities. For more advanced reporting, I recommend hooking up a professional reporting package, such as Crystal Reports, and use ODBC to access the @@ -4465,23 +3179,20 @@ if ($::FORM{sub} eq 'PutFooter') { through third-party utilities that can interface with the database directly. - Advanced Reporting is a Bugzilla 3.X proposed feature. + A.2.8. Is there email notification and if so, what do you see when you + get an email? - A.4.9. 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? + Email notification is user-configurable. By default, the bug id and + Summary of the bug report accompany each email notification, along + with a list of the changes made. - 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. - - A.4.10. Can email notification be set up to send to multiple people, + A.2.9. Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? Yes. - A.4.11. If there is email notification, do users have to have any - particular type of email application? + A.2.10. Do users have to have any particular type of email + application? Bugzilla email is sent in plain text, the most compatible mail format on the planet. @@ -4495,16 +3206,7 @@ if ($::FORM{sub} eq 'PutFooter') { ignores HTML tags in comments, and if a user sends HTML-based email into Bugzilla the resulting comment looks downright awful. - A.4.12. 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.? - - 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. - - A.4.13. Does Bugzilla allow data to be imported and exported? If I had + A.2.11. 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 @@ -4526,40 +3228,26 @@ if ($::FORM{sub} eq 'PutFooter') { find an excellent example at http://www.mozilla.org/quality/help/bugzilla-helper.html - A.4.14. Has anyone converted Bugzilla to another language to be used + A.2.12. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? - 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. + To a certain extent, yes. 2.16's templates mean that you can localise + the user-facing UI (and several projects are doing exactly that.) + However, error messages and the admin interface are currently not + localisable. This should be achieved by 2.18. - A.4.15. Can a user create and save reports? Can they do this in Word + A.2.13. Can a user create and save reports? Can they do this in Word format? Excel format? Yes. No. No. - A.4.16. Can a user re-run a report with a new project, same query? - - Yes. - - A.4.17. Can a user modify an existing report and then save it into - another name? - - You can save an unlimited number of queries in Bugzilla. You are free - to modify them and rename them to your heart's desire. - - A.4.18. Does Bugzilla have the ability to search by word, phrase, + A.2.14. Does Bugzilla have the ability to search by word, phrase, compound search? You have no idea. Bugzilla's query interface, particularly with the advanced Boolean operators, is incredibly versatile. - A.4.19. Can the admin person establish separate group and individual - user privileges? - - Yes. - - A.4.20. Does Bugzilla provide record locking when there is + A.2.15. 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? @@ -4567,38 +3255,33 @@ if ($::FORM{sub} eq 'PutFooter') { detection, and offers the offending user a choice of options to deal with the conflict. - A.4.21. Are there any backup features provided? + A.2.16. Are there any backup features provided? MySQL, the database back-end for Bugzilla, allows hot-backup of data. You can find strategies for dealing with backup considerations at http://www.mysql.com/doc/B/a/Backup.html - A.4.22. Can users be on the system while a backup is in progress? + A.2.17. Can users be on the system while a backup is in progress? 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. - A.4.23. What type of human resources are needed to be on staff to + A.2.18. 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. 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". + needs are minimal and can be done easily using the web interface. 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. + available from skilled members of the newsgroup. Simple questions are + answered there and then. - 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. - - A.4.24. What time frame are we looking at if we decide to hire people + A.2.19. 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 @@ -4611,69 +3294,53 @@ if ($::FORM{sub} eq 'PutFooter') { UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. - A.4.25. Is there any licensing fee or other fees for using Bugzilla? + A.2.20. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? No. MySQL asks, if you find their product valuable, that you purchase a support contract from them that suits your needs. -5. Bugzilla Installation - - A.5.1. How do I download and install Bugzilla? - - Check http://www.mozilla.org/projects/bugzilla/ for details. Once you - download it, untar it, read the Bugzilla Guide. - - A.5.2. How do I install Bugzilla on Windows NT? - - Installation on Windows NT has its own section in "The Bugzilla - Guide". +3. Bugzilla Security - A.5.3. Is there an easy way to change the Bugzilla cookie name? - - At present, no. - -6. Bugzilla Security - - A.6.1. How do I completely disable MySQL security if it's giving me + A.3.1. 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!)? + of this guide)? - Run mysql like this: "mysqld --skip-grant-tables". Please remember - this makes mysql as secure as taping a $100 to the floor of a football - stadium bathroom for safekeeping. Please read the Security section of - the Administration chapter of "The Bugzilla Guide" before proceeding. + Run MySQL like this: "mysqld --skip-grant-tables". Please remember + this makes MySQL as secure as taping a $100 to the floor of a football + stadium bathroom for safekeeping. - A.6.2. Are there any security problems with Bugzilla? + A.3.2. Are there any security problems with Bugzilla? - The Bugzilla code has not undergone a complete security audit. It is + The Bugzilla code has undergone a reasonably complete security audit, + and user-facing CGIs run under Perl's taint mode. However, it is recommended that you closely examine permissions on your Bugzilla installation, and follow the recommended security guidelines found in The Bugzilla Guide. - A.6.3. I've implemented the security fixes mentioned in Chris Yeh's + A.3.3. 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. This is a common problem, related to running out of file descriptors. Simply add "ulimit -n unlimited" to the script which starts mysqld. -7. Bugzilla Email +4. Bugzilla Email - A.7.1. I have a user who doesn't want to receive any more email from + A.4.1. I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user? - With the email changes to 2.12, the user should be able to set this in - user email preferences. + The user should be able to set this in user email preferences (uncheck + all boxes.) - A.7.2. I'm evaluating/testing Bugzilla, and don't want it to send + A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? - Edit the param for the mail text. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)". + Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", replace + "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". - A.7.3. I want whineatnews.pl to whine at something more, or other + A.4.3. I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? Try Klaas Freitag's excellent patch for "whineatassigned" @@ -4682,7 +3349,7 @@ if ($::FORM{sub} eq 'PutFooter') { against an older version of Bugzilla, so you must apply the diffs manually. - A.7.4. I don't like/want to use Procmail to hand mail off to + A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? You can call bug_email.pl directly from your aliases file, with an @@ -4694,24 +3361,24 @@ if ($::FORM{sub} eq 'PutFooter') { to set up your smrsh (sendmail restricted shell) to allow it. In a pinch, though, it can work. - A.7.5. How do I set up the email interface to submit/change bugs via + A.4.5. How do I set up the email interface to submit/change bugs via email? You can find an updated README.mailif file in the contrib/ directory of your Bugzilla distribution that walks you through the setup. - A.7.6. Email takes FOREVER to reach me from bugzilla -- it's extremely + A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? 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. + sendmail), make sure the options given in the "processmail" and other + scripts for all instances of "sendmail" are correct for your MTA. If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. If you are using Postfix, you will also need to enable "sendmailnow". - A.7.7. How come email never reaches me from bugzilla changes? + A.4.7. How come email from Bugzilla changes never reaches me? Double-check that you have not turned off email in your user preferences. Confirm that Bugzilla is able to send email by visiting @@ -4722,34 +3389,16 @@ if ($::FORM{sub} eq 'PutFooter') { sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked to, "/usr/lib/sendmail". -8. Bugzilla Database - - A.8.1. I've heard Bugzilla can be used with Oracle? - - 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. - - A.8.2. Bugs are missing from queries, but exist in the database (and I - can pull them up by specifying the bug ID). What's wrong? - - 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. - - A.8.3. I think my database might be corrupted, or contain invalid +5. Bugzilla Database + + A.5.1. I've heard Bugzilla can be used with Oracle? + + Red Hat Bugzilla 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.14 and 2.16 if you go with the 2.8-based Redhat version. + + A.5.2. I think my database might be corrupted, or contain invalid entries. What do I do? Run the "sanity check" utility (./sanitycheck.cgi in the Bugzilla_home @@ -4764,7 +3413,7 @@ if ($::FORM{sub} eq 'PutFooter') { exhaustive, and was created to do a basic check for the most common problems in Bugzilla databases. - A.8.4. I want to manually edit some entries in my database. How? + A.5.3. I want to manually edit some entries in my database. How? 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 @@ -4774,7 +3423,7 @@ if ($::FORM{sub} eq 'PutFooter') { module with MySQL support to make it work, but it's very clean and easy to use. - A.8.5. I try to add myself as a user, but Bugzilla always tells me my + A.5.4. I try to add myself as a user, but Bugzilla always tells me my password is wrong. Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally @@ -4782,7 +3431,7 @@ if ($::FORM{sub} eq 'PutFooter') { encrypted passwords. Upgrade to the "3.23 stable" version of MySQL and you should be good to go. - A.8.6. I think I've set up MySQL permissions correctly, but bugzilla + A.5.5. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. Try running MySQL from its binary: "mysqld --skip-grant-tables". This @@ -4791,7 +3440,7 @@ if ($::FORM{sub} eq 'PutFooter') { regular basis, unless you really want your web site defaced and your machine cracked. - A.8.7. How do I synchronize bug information among multiple different + A.5.6. How do I synchronize bug information among multiple different Bugzilla databases? Well, you can synchronize or you can move bugs. Synchronization will @@ -4807,37 +3456,21 @@ if ($::FORM{sub} eq 'PutFooter') { If you simply need to transfer bugs from one Bugzilla to another, checkout the "move.pl" script in the Bugzilla distribution. - A.8.8. Why do I get bizarre errors when trying to submit data, - particularly problems with "groupset"? - - 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. - - A.8.9. How come even after I delete bugs, the long descriptions show - up? - - This should only happen with Bugzilla 2.14 if you are using the - "shadow database" feature, and your shadow database is out of sync. - Try running syncshadowdb -syncall to make sure your shadow database is - in synch with your primary database. +6. Bugzilla and Win32 -9. Bugzilla and Win32 - - A.9.1. What is the easiest way to run Bugzilla on Win32 + A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? Remove Windows. Install Linux. Install Bugzilla. The boss will never know the difference. - A.9.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? 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. - A.9.3. CGI's are failing with a "something.cgi is not a valid Windows + A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? Depending on what Web server you are using, you will have to configure @@ -4858,114 +3491,7 @@ if ($::FORM{sub} eq 'PutFooter') { the end of the pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s" - A.9.4. Can I have some general instructions on how to make Bugzilla on - Win32 work? - - 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. - - 1. #!C:/perl/bin/perl had to be added to every perl file. - 2. Converted to Net::SMTP to handle mail messages instead of - /usr/bin/sendmail. - 3. The crypt function isn't available on Windows NT (at least none t - hat I - am aware), so I made encrypted passwords = plaintext passwords. - 4. The system call to diff had to be changed to the Cygwin diff. - 5. This was just to get a demo running under NT, it seems to be work - ing - good, and I have inserted almost 100 bugs from another bug tracki - ng - system. Since this work was done just to get an in-house demo, I - am NOT - planning on making a patch for submission to Bugzilla. If you wou - ld - like a zip file, let me know. - Q: Hmm, couldn't figure it out from the general instructions above. H - ow - about step-by-step? - A: Sure! Here ya go! - 1. Install IIS 4.0 from the NT Option Pack #4. - 2. Download and install Active Perl. - 3. Install the Windows GNU tools from Cygwin. Make sure to add the b - in - directory to your system path. (Everyone should have these, wheth - er - they decide to use Bugzilla or not. :-) ) - 4. Download relevant packages from ActiveState at - http://www.activestate.com/packages/zips/. + DBD-Mysql.zip - 5. Extract each zip file with WinZip, and install each ppd file usin - g the - notation: ppm install <module>.ppd - 6. Install Mysql. *Note: If you move the default install from c:\my - sql, - you must add the appropriate startup parameters to the NT service - . (ex. - -b e:\\programs\\mysql) - 7. Download any Mysql client. http://www.mysql.com/download_win.html - 8. Setup MySql. (These are the commands that I used.) - I. Cleanup default database settings. - C:\mysql\bin\mysql -u root mysql - mysql> DELETE FROM user WHERE Host='localhost' AND User=''; - mysql> quit - C:\mysql\bin\mysqladmin reload - II. Set password for root. - C:\mysql\bin\mysql -u root mysql - mysql> UPDATE user SET Password=PASSWORD('new_password') - WHERE user='root'; - mysql> FLUSH PRIVILEGES; - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - III. Create bugs user. - C:\mysql\bin\mysql -u root -p - mysql> insert into user (host,user,password) - values('localhost','bugs',''); - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - IV. Create the bugs database. - C:\mysql\bin\mysql -u root -p - mysql> create database bugs; - V. Give the bugs user access to the bugs database. - mysql> insert into db - (host,db,user,select_priv,insert_priv,update_priv,delete_pri - v,create_priv,drop_priv) - values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - 9. Run the table scripts to setup the bugs database. - 10. Change CGI.pm to use the following regular expression because of - differing backslashes in NT versus UNIX. - o $0 =~ m:[^\\]*$:; - 11. Had to make the crypt password = plain text password in the datab - ase. - (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one. - ) The - files that I changed were: - o globals.pl - o CGI.pl - o alternately, you can try commenting all references to 'crypt - ' - string and replace them with similar lines but without encry - pt() - or crypr() functions insida all files. - 12. Replaced sendmail with Windmail. Basically, you have to come up w - ith a - sendmail substitute for NT. Someone said that they used a Perl mo - dule - (Net::SMTP), but I was trying to save time and do as little Perl - coding - as possible. - 13. Added "perl" to the beginning of all Perl system calls that use a - perl - script as an argument and renamed processmail to processmail.pl. - 14. In processmail.pl, I added binmode(HANDLE) before all read() call - s. I'm - not sure about this one, but the read() under NT wasn't counting - the - EOLs without the binary read." - - A.9.5. I'm having trouble with the perl modules for NT not being able + A.6.4. I'm having trouble with the perl modules for NT not being able to talk to to the database. Your modules may be outdated or inaccurate. Try: @@ -4980,93 +3506,93 @@ if ($::FORM{sub} eq 'PutFooter') { check the ActiveState site for packages for installation through PPM. http://www.activestate.com/Packages/ -10. Bugzilla Usage +7. Bugzilla Usage + + A.7.1. How do I change my user name (email address) in Bugzilla? - A.10.1. The query page is very confusing. Isn't there a simpler way to + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + + A.7.2. The query page is very confusing. Isn't there a simpler way to query? - We are developing in that direction. You can follow progress on this - at http://bugzilla.mozilla.org/show_bug.cgi?id=16775. Some - functionality is available in Bugzilla 2.12, and is available as - "quicksearch.html" + The interface was simplified by a UI designer for 2.16. Further + suggestions for improvement are welcome, but we won't sacrifice power + for simplicity. - A.10.2. 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.7.3. 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? 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. + users. You have your choice of patches to change this behavior, + however. Add a "and accept bug" radio button "Accept" button automatically assigns to you - 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. + Note that these patches are somewhat dated. You will need to apply + them manually. - A.10.3. I can't upload anything into the database via the "Create + A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? 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. - A.10.4. Email submissions to Bugzilla that have attachments end up + A.7.5. Email submissions to Bugzilla that have attachments end up asking me to save it as a "cgi" file. 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 + filename. This will not be fixed anytime soon, because it would cripple some other functionality. - A.10.5. How do I change a keyword in Bugzilla, once some bugs are - using it? + A.7.6. How do I change a keyword in Bugzilla, once some bugs are using + it? 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. -11. Bugzilla Hacking +8. Bugzilla Hacking - A.11.1. What bugs are in Bugzilla right now? + A.8.1. What bugs are in Bugzilla right now? Try this link to view current bugs or requests for enhancement for Bugzilla. - You can view bugs marked for 2.16 release here. This list includes - bugs for the 2.16 release that have already been fixed and checked + You can view bugs marked for 2.18 release here. This list includes + bugs for the 2.18 release that have already been fixed and checked into CVS. Please consult the Bugzilla Project Page for details on how to check current sources out of CVS so you can have these bug fixes early! - A.11.2. How can I change the default priority to a null value? For + A.8.2. How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? This is well-documented here: http://bugzilla.mozilla.org/show_bug.cgi?id=49862. 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... + default priority in your browser using "editparams.cgi". - A.11.3. What's the best way to submit patches? What guidelines should - I follow? + A.8.3. What's the best way to submit patches? What guidelines should I + follow? 1. Enter a bug into bugzilla.mozilla.org for the "Bugzilla" product. - 2. Upload your patch as a unified DIFF (having used "diff -u" against + 2. Upload your patch as a unified diff (having used "diff -u" against the current sources 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! + click the "Patch" checkbox to indicate the text you are sending is + a patch! 3. 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. + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) 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. 4. 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. @@ -5074,40 +3600,7 @@ if ($::FORM{sub} eq 'PutFooter') { successful open-source bug-tracking software on the planet :) _________________________________________________________________ -Appendix B. Software Download Links - -All of these sites are current as of April, 2001. Hopefully they'll stay -current for a while. - -Apache Web Server: http://www.apache.org Optional web server for Bugzilla, -but recommended because of broad user base and support. - -Bugzilla: http://www.mozilla.org/projects/bugzilla/ - -MySQL: http://www.mysql.com/ - -Perl: http://www.perl.org/ - -CPAN: http://www.cpan.org/ - -DBI Perl module: http://www.cpan.org/modules/by-module/DBI/ - -Data::Dumper module: http://www.cpan.org/modules/by-module/Data/ - -MySQL related Perl modules: http://www.cpan.org/modules/by-module/Mysql/ - -TimeDate Perl module collection: http://www.cpan.org/modules/by-module/Date/ - -GD Perl module: http://www.cpan.org/modules/by-module/GD/ Alternately, you -should be able to find the latest version of GD at -http://www.boutell.com/gd/ - -Chart::Base module: http://www.cpan.org/modules/by-module/Chart/ - -LinuxDoc Software: http://www.linuxdoc.org/ (for documentation maintenance) - _________________________________________________________________ - -Appendix C. The Bugzilla Database +Appendix B. The Bugzilla Database Note @@ -5116,14 +3609,14 @@ Appendix C. The Bugzilla Database nifty tables to document dependencies. Any takers? _________________________________________________________________ -C.1. Database Schema Chart +B.1. Database Schema Chart [dbschema.jpg] Bugzilla database relationships chart _________________________________________________________________ -C.2. MySQL Bugzilla Database Introduction +B.2. MySQL Bugzilla Database Introduction This information comes straight from my life. I was forced to learn how Bugzilla organizes database because of nitpicky requests from users for tiny @@ -5178,46 +3671,39 @@ learn about non-portable enum() fields, varchar columns, and tinyint definitions. The Adventure Awaits You! _________________________________________________________________ -C.2.1. Bugzilla Database Basics +B.2.1. Bugzilla Database Basics 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 "bigint" and a "tinyint" entry in MySQL. I recommend you refer to the MySQL -documentation, available at MySQL.com. Below are the basics you need to know -about the Bugzilla database. Check the chart above for more details. +documentation, available at MySQL.com . Below are the basics you need to +know about the Bugzilla database. Check the chart above for more details. 1. To connect to your database: - bash#mysql-u root - If this works without asking you for a password, shame on you! You - should have locked your security down like the installation + bash# mysql -u root + If this works without asking you for a password, shame on you ! + 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 . + searchable documentation. 2. You should now be at a prompt that looks like this: mysql> - At the prompt, if "bugs" is the name you chose in thelocalconfig + At the prompt, if "bugs" is the name you chose in the localconfig file for your Bugzilla database, type: - mysqluse bugs; - - Note - - Don't forget the ";" at the end of each line, or you'll be kicking - yourself later. + mysql use bugs; _________________________________________________________________ -C.2.1.1. Bugzilla Database Tables +B.2.1.1. Bugzilla Database Tables Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command: -mysql>show tables from bugs; +mysql> show tables from bugs; -you'll be able to see all the "spreadsheets" (tables) in your database. It -is similar to a file system, only faster and more robust for certain types -of operations. +you'll be able to see the names of all the "spreadsheets" (tables) in your +database. From the command issued above, ou should have some output that looks like this: @@ -5438,228 +3924,20 @@ this: mentioned can also be done by editing checksetup.pl, which automates a lot of this. But you need to know this stuff anyway, right? - I hope this database tutorial has been useful for you. If you have - comments - to add, questions, concerns, etc. please direct them to - mbarnson@excitehome.net. Please direct flames to /dev/null :) Have a - nice - day! - === - LINKS - === - Great MySQL tutorial site: - http://www.devshed.com/Server_Side/MySQL/ _________________________________________________________________ -C.3. MySQL Permissions & Grant Tables - - Note - - 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. - - 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. - - From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 - Date: Mon, 1 Mar 1999 21:37:04 -0700 - From: Matthew Barnson matt_barnson@singletrac.com - To: keystone-users@homeport.org - Subject: [keystone-users] Grant Tables FAQ - [The following text is in the "iso-8859-1" character set] - [Your display is set for the "US-ASCII" character set] - [Some characters may be displayed incorrectly] - Maybe we can include this rambling message in the Keystone FAQ? It ge - ts - asked a lot, and the only option current listed in the FAQ is - "--skip-grant-tables". - Really, you can't go wrong by reading section 6 of the MySQL manual, a - t - http://www.mysql.com/Manual/manual.html. I am sure their description - is - better than mine. - MySQL runs fine without permissions set up correctly if you run the my - sql - daemon with the "--skip-grant-tables" option. Running this way denies - access to nobody. Unfortunately, unless you've got yourself firewalle - d it - also opens the potential for abuse if someone knows you're running it. - Additionally, the default permissions for MySQL allow anyone at localh - ost - access to the database if the database name begins with "test_" or is - named - "test" (i.e. "test_keystone"). You can change the name of your databa - se in - the keystone.conf file ($sys_dbname). This is the way I am doing it f - or - some of my databases, and it works fine. - The methods described below assume you're running MySQL on the same bo - x as - your webserver, and that you don't mind if your $sys_dbuser for Keysto - ne has - superuser access. See near the bottom of this message for a descripti - on of - what each field does. - Method #1: - 1. cd /var/lib - #location where you'll want to run /usr/bin/mysql_install_db shell - script from to get it to work. - 2. ln -s mysql data - # soft links the "mysql" directory to "data", which is what - mysql_install_db expects. Alternately, you can edit mysql_install_db - and - change all the "./data" references to "./mysql". - 3. Edit /usr/bin/mysql_install_db with your favorite text editor (vi, - emacs, jot, pico, etc.) - A) Copy the "INSERT INTO db VALUES - ('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately - after - itself. Chage the 'test\_%' value to 'keystone', or the value of - $sys_dbname in keystone.conf. - B) If you are running your keystone database with any user, you'll ne - ed to - copy the "INSERT INTO user VALUES - ('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line - after - itself and change 'root' to the name of the keystone database user - ($sys_dbuser) in keystone.conf. - # adds entries to the script to create grant tables for specific - hosts and users. The user you set up has super-user access ($sys_dbus - er) -- - you may or may not want this. The layout of mysql_install_db is reall - y very - uncomplicated. - 4. /usr/bin/mysqladmin shutdown - # ya gotta shut it down before you can reinstall the grant tables! - 5. rm -i /var/lib/mysql/mysql/*.IS?' and answer 'Y' to the deletion - questions. - # nuke your current grant tables. This WILL NOT delete any other - databases than your grant tables. - 6. /usr/bin/mysql_install_db - # run the script you just edited to install your new grant tables. - 7. mysqladmin -u root password (new_password) - # change the root MySQL password, or else anyone on localhost can - login to MySQL as root and make changes. You can skip this step if yo - u want - keystone to connect as root with no password. - 8. mysqladmin -u (webserver_user_name) password (new_password) - # change the password of the $sys_dbuser. Note that you will need - to change the password in the keystone.conf file as well in $sys_dbpas - swd, - and if your permissions are set up incorrectly anybody can type the UR - L to - your keystone.conf file and get the password. Not that this will help - them - much if your permissions are set to @localhost. - Method #2: easier, but a pain reproducing if you have to delete your - grant - tables. This is the "recommended" method for altering grant tables in - MySQL. I don't use it because I like the other way :) - shell> mysql --user=root keystone - mysql> GRANT - SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PR - OCESS, - FILE, - ON keystone.* - TO <$sys_dbuser name>@localhost - IDENTIFIED BY '(password)' - WITH GRANT OPTION; - OR - mysql> GRANT ALL PRIVILEGES - ON keystone.* - TO <$sys_dbuser name>@localhost - IDENTIFIED BY '(password)' - WITH GRANT OPTION; - # this grants the required permissions to the keystone ($sys_dbuser) - account defined in keystone.conf. However, if you are runnning many - different MySQL-based apps, as we are, it's generally better to edit t - he - mysql_install_db script to be able to quickly reproduce your permissio - ns - structure again. Note that the FILE privelege and WITH GRANT OPTION m - ay not - be in your best interest to include. - GRANT TABLE FIELDS EXPLANATION: - Quick syntax summary: "%" in MySQL is a wildcard. I.E., if you are - defining your DB table and in the 'host' field and enter '%', that mea - ns - that any host can access that database. Of course, that host must als - o have - a valid db user in order to do anything useful. 'db'=name of database - . In - our case, it should be "keystone". "user" should be your "$sys_dbuser - " - defined in keystone.conf. Note that you CANNOT add or change a passwo - rd by - using the "INSERT INTO db (X)" command -- you must change it with the - mysql - -u command as defined above. Passwords are stored encrypted in the My - SQL - database, and if you try to enter it directly into the table they will - not - match. - TABLE: USER. Everything after "password" is a privelege granted (Y/N - ). - This table controls individual user global access rights. - 'host','user','password','select','insert','update','delete','index',' - alter' - ,'create','drop','grant','reload','shutdown','process','file' - TABLE: DB. This controls access of USERS to databases. - 'host','db','user','select','insert','update','delete','index','alter' - ,'crea - te','drop','grant' - TABLE: HOST. This controls which HOSTS are allowed what global acces - s - rights. Note that the HOST table, USER table, and DB table are very c - losely - connected -- if an authorized USER attempts an SQL request from an - unauthorized HOST, she's denied. If a request from an authorized HOST - is - not an authorized USER, it is denied. If a globally authorized USER d - oes - not have rights to a certain DB, she's denied. Get the picture? - 'host','db','select','insert','update','delete','index','alter','creat - e','dr - op','grant' - You should now have a working knowledge of MySQL grant tables. If the - re is - anything I've left out of this answer that you feel is pertinent, or i - f my - instructions don't work for you, please let me know and I'll re-post t - his - letter again, corrected. I threw it together one night out of exasper - ation - for all the newbies who don't know squat about MySQL yet, so it is alm - ost - guaranteed to have errors. - Once again, you can't go wrong by reading section 6 of the MySQL manua - l. It - is more detailed than I! - http://www.mysql.com/Manual/manual.html. - _________________________________________________________________ - -Appendix D. Useful Patches and Utilities for Bugzilla +Appendix C. Useful Patches and Utilities for Bugzilla Are you looking for a way to put your Bugzilla into overdrive? Catch some of the niftiest tricks here in this section. _________________________________________________________________ -D.1. Apache mod_rewrite magic +C.1. Apache mod_rewrite magic Apache's mod_rewrite module lets you do some truly amazing things with URL rewriting. Here are a couple of examples of what you can do. - 1. Make it so if someone types http://www.foo.com/12345, Bugzilla + 1. Make it so if someone types http://www.foo.com/12345 , 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: @@ -5668,44 +3946,22 @@ RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </VirtualHost> - 2. 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 http://www.apache.org - _________________________________________________________________ - -D.2. The setperl.csh Utility - -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! - - 1. Download the "setperl.csh" utility to your Bugzilla directory and - make it executable. - a. bash# cd /your/path/to/bugzilla - b. bash# wget -O setperl.csh - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=107 - 95' - c. bash# chmod u+x setperl.csh - 2. Prepare (and fix) Bugzilla file permissions. - a. bash# chmod u+w * - b. bash# chmod u+x duplicates.cgi - c. bash# chmod a-x bug_status.html - 3. Run the script: - bash# ./setperl.csh /your/path/to/perl - Example D-1. Using Setperl to set your perl path - bash# ./setperl.csh /usr/bin/perl + 2. There are many, many more things you can do with mod_rewrite. + Please refer to the mod_rewrite documentation at + http://www.apache.org. _________________________________________________________________ -D.3. Command-line Bugzilla Queries +C.2. Command-line Bugzilla Queries -Users can query Bugzilla from the command line using this suite of -utilities. +There are a suite of Unix utilities for querying Bugzilla from the command +line. They live in the contrib/cmdline directory. However, they have not yet +been updated to work with 2.16 (post-templatisation.). There are three files +- query.conf, buglist and bugs. -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" +query.conf 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". 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 @@ -5713,10 +3969,10 @@ resulting HTML page to stdout. It supports both short options, (such as "--reporter=bar"). If the first character of an option is not "-", it is treated as if it were prefixed with "--default=". -The columlist is taken from the COLUMNLIST environment variable. This is +The column list 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 grep COLUMLIST ~/.netscape/cookies to -see your current COLUMNLIST setting. +If you have already used Bugzilla, grep for COLUMNLIST in your cookies file +to see your current COLUMNLIST setting. bugs is a simple shell script which calls buglist and extracts the bug numbers from the output. Adding the prefix @@ -5724,516 +3980,66 @@ numbers from the output. Adding the prefix working link if any bugs are found. Counting bugs is easy. Pipe the results through sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}' -Akkana says she has good results piping buglist output through w3m -T +Akkana Peck says she has good results piping buglist output through w3m -T text/html -dump - - 1. Download three files: - a. bash$ wget -O query.conf - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=261 - 57' - b. bash$ wget -O buglist - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=269 - 44' - c. bash# wget -O bugs - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=262 - 15' - 2. Make your utilities executable: bash$ chmod u+x buglist bugs - _________________________________________________________________ - -D.4. The Quicksearch Utility - -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" - -The index.html page has been updated to include the QuickSearch text box. - -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. - -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". - -Workarounds for Bugzilla users: - -search for '!foo' (this will find only bugs with the keyword "foo" -search 'foo,!foo' (equivalent to 'foo OR keyword:foo') - - When this tool is ported from client-side JavaScript to server-side - Perl, the requirement for hard-coding keywords can be fixed. This bug - has details. - _________________________________________________________________ - -D.5. Hacking Bugzilla - -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. - _________________________________________________________________ - -D.5.1. Things that have caused problems and should be avoided - - 1. Usage of variables in Regular Expressions - 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: - -grep ($_ eq $value, @array); - - - -- NOT THIS -- - -grep (/$value/, @array); - - - Note - - If you need to use a non-expression variable inside of an expression, - be sure to quote it properly (using \Q..\E). - _________________________________________________________________ - -D.5.2. Coding Style for Bugzilla - -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 :). - -The Bugzilla development team has decided to adopt the perl style guide as -published by Larry Wall. This giude can be found in "Programming Perl" (the -camel book) or by typing man perlstyle at your favorite shell prompt. - -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. - - * Whitespace - Bugzilla's preferred indentation is 4 spaces (no tabs, please). - * Curly braces. - 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: - -if ($var) { - print "The variable is true"; -} -else { - print "Try again"; -} - - - -- NOT THIS -- - -if ($var) -{ - print "The variable is true"; -} -else -{ - print "Try again"; -} - - - * Cookies - Bugzilla uses cookies to ease the user experience, but no new - patches should require user-side cookies. - * File Names - File names for bugzilla code and support documention should be - legal across multiple platforms. \ / : * ? " < > and | 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. - * Javascript dependencies - While Bugzilla uses Javascript to make the user experience easier, - no patch to Bugzilla should require Javascript. - * Patch Format - All patches submitted for inclusion into Bugzilla should be in the - form of a "unified diff". This comes from using "diff -u" instead - of simply "diff" when creating your patch. This will result in - quicker acceptance of the patch. - * Schema Changes - If you make schema changes, you should modify sanitycheck.cgi to - support the new schema. All referential columns should be checked. - * Taint Mode - 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. - * Templatization - Patches to Bugzilla need to support templates so they do not force - user interface choices on Bugzilla administrators. - * Variable Names - If a variable is scoped globally ($::variable) 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, $ret could be used as a staging variable for a routine's - return value as the line return $ret; will make it blatantly - obvious what the variable holds and most likely be shown on the - same screen as my $ret = "";. - * Cross Database Compatability - 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 encrypt(). - * Cross Platform Compatability - 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. - _________________________________________________________________ - -Appendix E. GNU Free Documentation License - -Version 1.1, March 2000 - - 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. _________________________________________________________________ -0. PREAMBLE - -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. - -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. +Appendix D. Bugzilla Variants and Competitors -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. - _________________________________________________________________ - -1. APPLICABILITY AND DEFINITIONS - -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". - -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. - -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. - -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. - -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. - -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". - -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. - -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. - _________________________________________________________________ - -2. VERBATIM COPYING - -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. - -You may also lend copies, under the same conditions stated above, and you -may publicly display copies. - _________________________________________________________________ - -3. COPYING IN QUANTITY - -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. - -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. - -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. - -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. - _________________________________________________________________ - -4. MODIFICATIONS - -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: - - A. 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. - B. 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). - C. State on the Title page the name of the publisher of the Modified - Version, as the publisher. - D. Preserve all the copyright notices of the Document. - E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. - F. 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. - G. Preserve in that license notice the full lists of Invariant - Sections and required Cover Texts given in the Document's license - notice. - H. Include an unaltered copy of this License. - I. 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. - J. 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. - K. 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. - L. 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. - M. Delete any section entitled "Endorsements". Such a section may not - be included in the Modified Version. - N. Do not retitle any existing section as "Endorsements" or to - conflict in title with any Invariant Section. - - 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. - - 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. - - 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. - - 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. +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: http://linas.org/linux/pm.html _________________________________________________________________ -5. COMBINING DOCUMENTS +D.1. Red Hat Bugzilla -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. - -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. +Red Hat Bugzilla is a fork of Bugzilla 2.8. One of its major benefits is the +ability to work with Oracle, MySQL, and PostGreSQL databases serving as the +back-end, instead of just MySQL. Dave Lawrence of Red Hat is active in the +Bugzilla community, and we hope to see a reunification of the fork before +too long. -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." +URL: http://bugzilla.redhat.com/bugzilla/ _________________________________________________________________ -6. COLLECTIONS OF DOCUMENTS +D.2. Loki Bugzilla (Fenris) -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. - -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. +Fenris was a fork from Bugzilla made by Loki Games; when Loki went into +receivership, it died. While Loki's other code lives on, its custodians +recommend Bugzilla for future bug-tracker deployments. _________________________________________________________________ -7. AGGREGATION WITH INDEPENDENT WORKS +D.3. Issuezilla -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. - -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. +Issuezilla was another fork from Bugzilla, made by collab.net and hosted at +tigris.org. It is also dead; the primary focus of bug-tracking at tigris.org +is their Java-based bug-tracker, Scarab. _________________________________________________________________ -8. TRANSLATION - -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. - _________________________________________________________________ +D.4. Scarab -9. TERMINATION +Scarab is a new open source bug-tracking system built using Java Serlet +technology. It is currently at version 1.0 beta 8. -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. +URL: http://scarab.tigris.org _________________________________________________________________ -10. FUTURE REVISIONS OF THIS LICENSE +D.5. Perforce SCM -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 http://www.gnu.org/copyleft/. +Although Perforce isn't really a bug tracker, it can be used as such through +the "jobs" functionality. -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. +URL: http://www.perforce.com/perforce/technotes/note052.html _________________________________________________________________ -How to use this License for your documents - -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: - - 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". +D.6. SourceForge - 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. +SourceForge is a way of coordinating geographically distributed free +software and open source projects over the Internet. It has a built-in bug +tracker, but it's not highly thought of. - 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. +URL: http://www.sourceforge.net Glossary @@ -6242,13 +4048,10 @@ Glossary .htaccess Apache web server, and other NCSA-compliant web servers, observe the convention of using files in directories called - .htaccess 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 localconfig 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. + .htaccess to restrict access to certain files. In Bugzilla, + they are used to keep secret files which would otherwise + compromise your installation - e.g. the localconfig file + contains the password to your database. curious. A @@ -6263,26 +4066,20 @@ A B Bug - A "Bug" in Bugzilla refers to an issue entered into the + A "bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Some also refer to a "tickets" or "issues"; in the context of Bugzilla, they are synonymous. Bug Number - Each Bugzilla Bug is assigned a number that uniquely identifies - that Bug. The Bug associated with a Bug Number can be pulled up + 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. - Bug Life Cycle - A Bug has stages through which it must pass before becoming a - "closed bug", including acceptance, resolution, and - verification. The "Bug Life Cycle" is moderately flexible - according to the needs of the organization using it, though. - Bugzilla - Bugzilla is the industry-standard bug tracking system. It is - quite popular among Open Source enthusiasts. + Bugzilla is the world-leading free software bug tracking + system. Component A Component is a subsection of a Product. It should be a narrow @@ -6291,12 +4088,10 @@ B creating a Product with no Components will create an error in Bugzilla). - CPAN + CPAN CPAN stands for the "Comprehensive Perl Archive Network". CPAN - maintains a large number of extremely useful Perl modules. By - themselves, Perl modules generally do nothing, but when used as - part of a larger program, they provide much-needed algorithms - and functionality. + maintains a large number of extremely useful Perl modules - + encapsulated chunks of code for performing a particular task. D @@ -6309,14 +4104,9 @@ D Groups The word "Groups" 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 - Products and Components in the Bugzilla database. - -I - - Infinite Loop - A loop of information that never ends; see recursion. + Bugzilla's main security mechanism comes by placing users in + groups, and assigning those groups certain privileges to view + bugs in particular Products in the Bugzilla database. M @@ -6330,20 +4120,11 @@ M P Product - 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. - - Example 1. A Sample Product - - A company sells a software product called "X". They also - maintain some older software called "Y", and have a secret - project "Z". An effective use of Products might be to create - Products "X", "Y", "Z", 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 - "Z" can see components and bugs under Product "Z". + A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, + there are several Components to a Product. A Product may define + a group (used for security) for all bugs entered into its + Components. Perl First written by Larry Wall, Perl is a remarkable program @@ -6360,19 +4141,11 @@ Q 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 - "QA Contact" field in a Bug. - -R - - Recursion - The property of a function looking back at itself for - something. "GNU", for instance, stands for "GNU's Not UNIX", - thus recursing upon itself for definition. For further clarity, - see Infinite Loop. + "QA Contact" field in a bug. S - SGML + SGML SGML stands for "Standard Generalized Markup Language". Created in the 1980's to provide an extensible means to maintain documentation based upon content instead of presentation, SGML diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml index bd0b3a4a1..b8868a618 100644 --- a/docs/xml/Bugzilla-Guide.xml +++ b/docs/xml/Bugzilla-Guide.xml @@ -16,7 +16,7 @@ <!ENTITY database SYSTEM "database.sgml"> <!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY variants SYSTEM "variants.sgml"> -<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> +<!ENTITY introduction SYSTEM "introduction.sgml"> <!ENTITY revhistory SYSTEM "revhistory.sgml"> <!ENTITY bz "http://www.bugzilla.org/"> @@ -61,33 +61,35 @@ try to avoid clutter and feel free to waste space in the code to make it more re <title>The Bugzilla Guide</title> <authorgroup> - <author> - <firstname>Matthew</firstname> - <othername>P.</othername> - <surname>Barnson</surname> - <affiliation> - <address><email>mbarnson@sisna.com</email></address> - </affiliation> + <firstname>Matthew</firstname> + <othername>P.</othername> + <surname>Barnson</surname> + </author> + <author> + <firstname>The</firstname> + <othername>Bugzilla</othername> + <surname>Team</surname> </author> </authorgroup> <abstract> <para> - This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. - Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. + This is the documentation for Bugzilla, the mozilla.org + bug-tracking system. + Bugzilla is an enterprise-class piece of software + that powers issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. </para> - <para> - This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or SGML diffs, attached - to a Bugzilla bug. + + <para> + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or SGML diffs, attached + to a bug filed in + <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">mozilla.org's Bugzilla</ulink>. </para> </abstract> - <keywordset> <keyword>Bugzilla</keyword> <keyword>Guide</keyword> @@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- About This Guide --> &about; +<!-- Introduction --> +&introduction; + <!-- Using Bugzilla --> &using; @@ -113,26 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- Administering Bugzilla --> &administration; -<!-- Integrating Bugzilla with Third-Party Tools --> -&integration; - -<!-- Major Bugzilla Variants --> -&variants; - <!-- Appendix: The Frequently Asked Questions --> &faq; -<!-- Appendix: Required Bugzilla Software Links --> -&requiredsoftware; - <!-- Appendix: The Database Schema --> &database; <!-- Appendix: Custom Patches --> &patches; -<!-- Appendix: The GNU Free Documentation License --> -&gfdl; +<!-- Appendix: Major Bugzilla Variants --> +&variants; <!-- Glossary --> &glossary; diff --git a/docs/xml/about.xml b/docs/xml/about.xml index 62e486573..b4349644a 100644 --- a/docs/xml/about.xml +++ b/docs/xml/about.xml @@ -4,40 +4,6 @@ <chapter id="about"> <title>About This Guide</title> - <section id="aboutthisguide"> - <title>Purpose and Scope of this Guide</title> - <para> - 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. - </para> - <para> - This release of the Bugzilla Guide is the - <emphasis>&bzg-ver;</emphasis> 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 <emphasis>even-numbered</emphasis> point releases (1.2, - 1.14, etc.) are considered "stable releases", intended for - public consumption; on the other hand, - <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09, - etc.) are considered unstable <emphasis>development</emphasis> - releases intended for advanced users, systems administrators, - developers, and those who enjoy a lot of pain. - </para> - <para> - Newer revisions of the Bugzilla Guide follow the numbering - conventions of the main-tree Bugzilla releases, available at - <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have - a minor revision number following a period. The current version - of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if - something were seriously wrong with that edition of the Guide, - subsequent releases would receive an additional dotted-decimal - digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.). - Got it? Good. - </para> - </section> - <section id="copyright"> <title>Copyright Information</title> <blockquote> @@ -48,8 +14,7 @@ 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". + the license is included below. </para> </blockquote> <para> @@ -57,6 +22,11 @@ copyright, or publishing this document in non-electronic form, please contact &bzg-auth;. </para> + + + <!-- The GNU Free Documentation License --> + &gfdl; + </section> <section id="disclaimer"> @@ -64,12 +34,11 @@ <para> 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. + This document may contain errors + and inaccuracies that may damage your system, cause your partner + to leave you, your boss to fire you, your cats to + pee on your furniture and clothing, and global thermonuclear + war. Proceed with caution. </para> <para> All copyrights are held by their respective owners, unless @@ -100,7 +69,7 @@ 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 + product, and are responsible for auditing it yourself to ensure your security needs are met. </para> </section> @@ -110,7 +79,8 @@ <section id="newversions"> <title>New Versions</title> <para> - This is the &bzg-ver; version of The Bugzilla Guide. If you are + This is the &bzg-ver; version of The Bugzilla Guide. It is so named + to match the current version of Bugzilla. 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. @@ -134,9 +104,16 @@ </itemizedlist> </para> <para> - The latest version of this document can be checked out via CVS. - Please follow the instructions available at <ulink - url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch. + The latest version of this document can always be checked out via CVS. + Please follow the instructions available at + <ulink url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, + and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> + subtree. + </para> + <para> + The Bugzilla Guide is currently only available in English. + If you would like to volunteer to translate it, please contact + <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>. </para> </section> @@ -144,13 +121,14 @@ <title>Credits</title> <para> The people listed below have made enormous contributions to the - creation of this Guide, through their dedicated hacking efforts, + creation of this Guide, through their writing, dedicated hacking efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: </para> <para> <ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink> - for pulling together the Bugzilla Guide and shepherding it to 2.14. + for the Herculaean task of pulling together the Bugzilla Guide and + shepherding it to 2.14. </para> <para> <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink> @@ -158,13 +136,13 @@ README upon which the UNIX installation documentation is largely based. </para> <para> - <ulink url="mailto://tara@tequilarista.org">Tara - Hernandez</ulink> for keeping Bugzilla development going - strong after Terry left Mozilla.org + <ulink url="mailto://tara@tequilarista.org">Tara Hernandez</ulink> + for keeping Bugzilla development going + strong after Terry left mozilla.org </para> <para> - <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for - providing insight into the key differences between Red Hat's + <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> + for providing insight into the key differences between Red Hat's customized Bugzilla, and being largely responsible for the "Red Hat Bugzilla" appendix </para> @@ -174,8 +152,8 @@ questions and arguments on irc.mozilla.org in #mozwebtools </para> <para> - Last but not least, all the members of the <ulink - url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. + Last but not least, all the members of the + <ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. </para> <para> Thanks also go to the following people for significant contributions @@ -183,19 +161,7 @@ </para> <para> Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, - Ron Teitelbaum, Jacob Steenhagen, Joe Robins. - </para> - </section> - - <section id="translations"> - <title>Translations</title> - <para> - 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 - <email>mozilla-webtools@mozilla.org</email>, and arrange with - &bzg-auth; to check it into CVS. + Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham. </para> </section> diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml index cf52999e4..f932beb25 100644 --- a/docs/xml/administration.xml +++ b/docs/xml/administration.xml @@ -2,28 +2,13 @@ <chapter id="administration"> <title>Administering Bugzilla</title> - <subtitle>Or, I just got this cool thing installed. Now what the heck do I - do with it?</subtitle> + <section id="parameters"> + <title>Bugzilla Configuration</title> - <para>So you followed - <quote> - <xref linkend="installation" /> - </quote> - - 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.</para> - - <section id="postinstall-check"> - <title>Post-Installation Checklist</title> - - <para>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.</para> + <para>Bugzilla is configured by changing various parameters, accessed + from the "Edit parameters" link in the page footer. Here are + some of the key parameters on that page. You should run down this + list and set them appropriately after installing Bugzilla.</para> <indexterm> <primary>checklist</primary> @@ -31,185 +16,112 @@ <procedure> <step> - <para>Bring up - <filename>editparams.cgi</filename> - - in your web browser. This should be available as the - <quote>edit parameters</quote> - - link from any Bugzilla screen once you have logged in.</para> - </step> - - <step> - <para>The - <quote>maintainer</quote> - - 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.</para> - - <para>Set - <quote>maintainer</quote> - - to - <emphasis>your</emphasis> - - email address. This allows Bugzilla's error messages to display your - email address and allow people to contact you for help.</para> + <para> + <command>maintainer</command>: + The maintainer parameter is the email address of the person + responsible for maintaining this + Bugzilla installation. The address need not be that of a valid Bugzilla + account.</para> </step> <step> - <para>The - <quote>urlbase</quote> - - parameter defines the fully qualified domain name and web server path - to your Bugzilla installation.</para> - - <para>For example, if your bugzilla query page is - http://www.foo.com/bugzilla/query.cgi, set your - <quote>urlbase</quote> - - is http://www.foo.com/bugzilla/.</para> + <para> + <command>urlbase</command>: + This parameter defines the fully qualified domain name and web + server path to your Bugzilla installation.</para> + + <para>For example, if your Bugzilla query page is + <filename>http://www.foo.com/bugzilla/query.cgi</filename>, + set your <quote>urlbase</quote> + to <filename>http://www.foo.com/bugzilla/</filename>.</para> </step> <step> <para> - <quote>usebuggroups</quote> - - 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 + <command>usebuggroups</command>: + This dictates whether or not to implement group-based security for + Bugzilla. If set, Bugzilla bugs can have an associated 'group', + defining which users are allowed to see and edit the bug.</para> <para>Set "usebuggroups" to "on" <emphasis>only</emphasis> - - if you may wish to restrict access to products. I suggest leaving - this parameter - <emphasis>off</emphasis> - + if you may wish to restrict access to particular bugs to certain + groups of users. I suggest leaving + this parameter <emphasis>off</emphasis> while initially testing your Bugzilla.</para> </step> <step> <para> - <quote>usebuggroupsentry</quote> - - , when set to - <quote>on</quote> - - , requires that all bugs have an associated groupmask when submitted. - This parameter is made for those installations where product - isolation is a necessity.</para> - - <para>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.</para> + <command>usebuggroupsentry</command>: + Bugzilla Products can have a group associated with them, so that + certain users can only see bugs in certain products. When this parameter + is set to <quote>on</quote>, this places all newly-created bugs in the + group for their product immediately.</para> </step> <step> - <para>You run into an interesting problem when Bugzilla reaches a + <para> + <command>shadowdb</command>: + 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 <quote>shadowdb</quote> - parameter was designed to get around this limitation. While only a single user is allowed to write to a table at a time, reads can continue unimpeded on a read-only shadow copy of the database. Although your database size will double, a shadow database can cause an enormous performance improvement when implemented on extremely high-traffic Bugzilla databases.</para> + + <para> + As a guide, mozilla.org began needing + <quote>shadowdb</quote> + when they reached around 40,000 Bugzilla users with several hundred + Bugzilla bug changes and comments per day.</para> - <para>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. + <para>The value of the parameter defines the name of the + shadow bug database. + Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. <note> <para>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 - <quote>cron</quote> - - .</para> + <quote>cron</quote>. + </para> </note> - - Once again, in testing you should avoid this option -- use it if or - when you - <emphasis>need</emphasis> - - 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 - <quote>shadowdb</quote> - - when they reached around 40,000 Bugzilla users with several hundred - Bugzilla bug changes and comments per day.</para> - + </para> + <para>If you use the "shadowdb" option, it is only natural that you - should turn the "queryagainstshadowdb" option "On" as well. Otherwise + should turn the "queryagainstshadowdb" option on as well. Otherwise you are replicating data into a shadow database for no reason!</para> + </step> <step> <para> - <quote>headerhtml</quote> - - , - <quote>footerhtml</quote> - - , - <quote>errorhtml</quote> - - , - <quote>bannerhtml</quote> - - , and - <quote>blurbhtml</quote> - - 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 - <filename>data/params</filename> - - 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 - <filename>data/params</filename> - - file.</para> - - <para>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. - <note> - <para>The "headerhtml" text box is the HTML printed out - <emphasis>before</emphasis> + <command>shutdownhtml</command>: - 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.</para> - </note> + If you need to shut down Bugzilla to perform administration, enter + some descriptive HTML here and anyone who tries to use Bugzilla will + receive a page to that effect. Obviously, editparams.cgi will + still be accessible so you can remove the HTML and re-enable Bugzilla. + :-) </para> </step> <step> <para> - <quote>passwordmail</quote> + <command>passwordmail</command>: - 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 + Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along with their password message.</para> <para>Add any text you wish to the "passwordmail" parameter box. For @@ -219,45 +131,29 @@ <step> <para> - <quote>useqacontact</quote> + <command>useqacontact</command>: - allows you to define an email address for each component, in addition + This allows you to define an email address for each component, in + addition to that of the default owner, who will be sent carbon copies of - incoming bugs. 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.</para> - + incoming bugs.</para> + </step> + <step> <para> - <quote>usestatuswhiteboard</quote> - - defines whether you wish to have a free-form, overwritable field + <command>usestatuswhiteboard</command>: + This defines whether you wish to have a free-form, overwritable field associated with each bug. The advantage of the Status Whiteboard is that it can be deleted or modified with ease, and provides an easily-searchable field for indexing some bugs that have some trait - in common. Many people will put - <quote>help wanted</quote> - - , - <quote>stalled</quote> - - , or - <quote>waiting on reply from somebody</quote> - - 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.</para> - - <para>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.</para> + in common. + </para> </step> <step> - <para>Set "whinedays" to the amount of days you want to let bugs go - in the "New" or "Reopened" state before notifying people they have + <para> + <command>whinedays</command>: + Set this to the number of days you want to let bugs go + in the NEW or REOPENED state before notifying people they have untouched new bugs. If you do not plan to use this feature, simply do not set up the whining cron job described in the installation instructions, or set this value to "0" (never whine).</para> @@ -265,8 +161,8 @@ <step> <para> - <quote>commenton</quote> - + <command>commenton*</command>: + All these fields allow you to dictate what changes can pass without comment, and which must have a comment from the person who changed them. Often, administrators will allow users to add themselves to the CC @@ -288,30 +184,17 @@ </step> <step> - <para>The - <quote>supportwatchers</quote> + <para> + <command>supportwatchers</command>: - 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 + Turning on this option allows users to ask to receive copies of + all a particular other user's bug email. This is, of course, subject to the groupset restrictions on the bug; if the <quote>watcher</quote> - 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 privileges. She would still only receive email - updates for those bugs she could normally view.</para> - - <para>For Bugzilla sites which require strong inter-Product security - to prevent snooping, watchers are not a good idea.</para> - - <para>However, for most sites you should set - <quote>supportwatchers</quote> - - 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.</para> + with bugs outside her privileges. They would still only receive email + updates for those bugs she could normally view.</para> </step> </procedure> </section> @@ -319,34 +202,34 @@ <section id="useradmin"> <title>User Administration</title> - <para>User administration is one of the easiest parts of Bugzilla. - Keeping it from getting out of hand, however, can become a - challenge.</para> - <section id="defaultuser"> <title>Creating the Default User</title> <para>When you first run checksetup.pl after installing Bugzilla, it will prompt you for the administrative username (email address) and - password for this "super user". If for some reason you were to delete + password for this "super user". If for some reason you delete the "super user" account, re-running checksetup.pl will again prompt you for this username and password.</para> <tip> <para>If you wish to add more administrative users, 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): - <command> - <prompt>mysql></prompt> - - use bugs;</command> - - <command> - <prompt>mysql></prompt> - - update profiles set groupset=0x7ffffffffffffff where login_name = - "(user's login name)";</command> + commands: + <simplelist> + <member> + <prompt>mysql></prompt> + <command>use bugs;</command> + </member> + + <member> + <prompt>mysql></prompt> + + <command> + update profiles set groupset=0x7ffffffffffffff where login_name = + "(user's login name)"; + </command> + </member> + </simplelist> </para> <para>Yes, that is @@ -362,77 +245,24 @@ <section id="manageusers"> <title>Managing Other Users</title> - <section id="login"> - <title>Logging In</title> - - <orderedlist> - <listitem> - <para>Open the index.html page for your Bugzilla installation in - your browser window.</para> - </listitem> - - <listitem> - <para>Click the "Query Existing Bug Reports" link.</para> - </listitem> - - <listitem> - <para>Click the "Log In" link at the foot of the page.</para> - </listitem> - - <listitem> - <para>Type your email address, and the password which was emailed - to you when you created your Bugzilla account, into the spaces - provided.</para> - </listitem> - </orderedlist> - - <para>Congratulations, you are logged in!</para> - </section> - <section id="createnewusers"> <title>Creating new users</title> <para>Your users can create their own user accounts by clicking the - "New Account" link at the bottom of each page. However, should you + "New Account" link at the bottom of each page (assuming they + aren't logged in as someone else already.) However, should you desire to create user accounts ahead of time, here is how you do it.</para> <orderedlist> <listitem> <para>After logging in, click the "Users" link at the footer of - the query page.</para> - </listitem> - - <listitem> - <para>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.</para> - - <tip> - <para>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 - <command>man regexp</command> - - manual page for details on regular expression syntax), or a - <emphasis>reverse</emphasis> - - regular expression match, where every user name which does NOT - match the regular expression is selected.</para> - </tip> - </listitem> - - <listitem> - <para>Click the "Add New User" link at the bottom of the user - list</para> + the query page, and then click "Add a new user".</para> </listitem> <listitem> <para>Fill out the form presented. This page is self-explanatory. - When done, click "submit".</para> + When done, click "Submit".</para> <note> <para>Adding a user this way will @@ -453,84 +283,71 @@ </orderedlist> </section> - <section id="disableusers"> - <title>Disabling Users</title> - - <para>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. - <warning> - <para>Don't disable your own administrative account, or you will - hate life!</para> - - <para>At this time, - <quote>Disabled Text</quote> - - 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.</para> - </warning> - </para> - </section> - <section id="modifyusers"> <title>Modifying Users</title> - <para>Here I will attempt to describe the function of each option on - the Edit User screen.</para> + <para>To see a specific user, search for their login name + in the box provided on the "Edit Users" page. To see all users, + leave the box blank.</para> + + <para>You can search in different ways the listbox to the right + of the text entry box. You can match by + case-insensitive substring (the default), + regular expression, or a + <emphasis>reverse</emphasis> + regular expression match, which finds every user name which does NOT + match the regular expression. (Please see + the <command>man regexp</command> + manual page for details on regular expression syntax.) + </para> + + <para>Once you have found your user, you can change the following + fields:</para> <itemizedlist> <listitem> <para> - <emphasis>Login Name</emphasis> - - : This is generally the user's email address. However, if you - have edited your system parameters, this may just be the user's - login name or some other identifier. - <tip> - <para>For compatability reasons, you should probably stick with - email addresses as user login names. It will make your life - easier.</para> - </tip> + <emphasis>Login Name</emphasis>: + This is generally the user's full email address. However, if you + have are using the emailsuffix Param, this may just be the user's + login name. Note that users can now change their login names + themselves (to any valid email address.) </para> </listitem> <listitem> <para> - <emphasis>Real Name</emphasis> - - : Duh!</para> + <emphasis>Real Name</emphasis>: The user's real name. Note that + Bugzilla does not require this to create an account.</para> </listitem> <listitem> <para> - <emphasis>Password</emphasis> - - : You can change the user password here. It is normal to only see - asterisks.</para> + <emphasis>Password</emphasis>: + You can change the user's password here. Users can automatically + request a new password, so you shouldn't need to do this often. + If you want to disable an account, see Disable Text below. + </para> </listitem> <listitem> <para> - <emphasis>Disable Text</emphasis> - - : If you type anything in this box, including just a space, the - user 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. + <emphasis>Disable Text</emphasis>: + If you type anything in this box, including just a space, the + user is prevented from logging in, or making any changes to + bugs via the web interface. + The HTML you type in this box is presented to the user when + they attempt to perform these actions, and should explain + why the account was disabled. <warning> <para>Don't disable the administrator account!</para> </warning> <note> - <para>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 + <para>The user can still submit bugs via + the e-mail gateway, if you set it up, even if the disabled text + field is filled in. The e-mail gateway should <emphasis>not</emphasis> - be enabled for secure installations of Bugzilla.</para> </note> </para> @@ -538,90 +355,82 @@ <listitem> <para> - <emphasis>CanConfirm</emphasis> - - : 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.</para> + <emphasis><groupname></emphasis>: + If you have created some groups, e.g. "securitysensitive", then + checkboxes will appear here to allow you to add users to, or + remove them from, these groups. + </para> </listitem> <listitem> <para> - <emphasis>Creategroups</emphasis> - - : 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.</para> + <emphasis>canconfirm</emphasis>: + This field is only used if you have enabled the "unconfirmed" + status. If you enable this for a user, + that user can then move bugs from "Unconfirmed" to a "Confirmed" + status (e.g.: "New" status).</para> </listitem> <listitem> <para> - <emphasis>Editbugs</emphasis> + <emphasis>creategroups</emphasis>: + This option will allow a user to create and destroy groups in + Bugzilla.</para> + </listitem> - : Unless a user has this bit set, they can only edit those bugs - for which they are the assignee or the reporter. - <note> - <para>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.</para> - </note> + <listitem> + <para> + <emphasis>editbugs</emphasis>: + Unless a user has this bit set, they can only edit those bugs + for which they are the assignee or the reporter. Even if this + option is unchecked, users can still add comments to bugs. </para> </listitem> <listitem> <para> - <emphasis>Editcomponents</emphasis> - - : This flag allows a user to create new products and components, + <emphasis>editcomponents</emphasis>: + This flag allows a user to create new products and components, as well as modify and destroy those that have no bugs associated with them. If a product or component has bugs associated with it, those bugs must be moved to a different product or component - before Bugzilla will allow them to be destroyed. 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.</para> + before Bugzilla will allow them to be destroyed. + </para> </listitem> <listitem> <para> - <emphasis>Editkeywords</emphasis> - - : If you use Bugzilla's keyword functionality, enabling this - feature allows a user can create and destroy keywords. As always, + <emphasis>editkeywords</emphasis>: + If you use Bugzilla's keyword functionality, enabling this + feature allows a user to create and destroy keywords. As always, the keywords for existing bugs containing the keyword the user wishes to destroy must be changed before Bugzilla will allow it - to die. 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.</para> + to die.</para> </listitem> <listitem> <para> - <emphasis>Editusers</emphasis> - - : This flag allows a user do what you're doing right now: edit + <emphasis>editusers</emphasis>: + This flag allows a user to do what you're doing right now: edit other users. This will allow those with the right to do so to remove administrator privileges from other users or grant them to themselves. Enable with care.</para> </listitem> + + <listitem> + <para> + <emphasis>tweakparams</emphasis>: + This flag allows a user to change Bugzilla's Params + (using <filename>editparams.cgi</filename>.)</para> + </listitem> + <listitem> <para> - <emphasis>PRODUCT</emphasis> - - : 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.</para> + <emphasis><productname></emphasis>: + This allows an administrator to specify the products in which + a user can see bugs. The user must still have the + "editbugs" privilege to edit bugs in these products.</para> </listitem> </itemizedlist> </section> @@ -631,83 +440,63 @@ <section id="programadmin"> <title>Product, Component, Milestone, and Version Administration</title> - <epigraph> - <para>Dear Lord, we have to get our users to do WHAT?</para> - </epigraph> - <section id="products"> <title>Products</title> - <subtitle>Formerly, and in some spots still, called - "Programs"</subtitle> - <para> <glossterm linkend="gloss-product" baseform="product"> Products</glossterm> - 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...)</para> + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...)</para> - <para>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 + <para>Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes required to move a bug automatically from the UNCONFIRMED status to the - NEW status. One can close a Product for further bug entry and define - various Versions available from the Edit product screen.</para> + NEW status.</para> <para>To create a new product:</para> <orderedlist> <listitem> - <para>Select "components" from the yellow footer</para> + <para>Select "products" from the footer</para> - <tip> - <para>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...</para> - </tip> </listitem> <listitem> - <para>Select the "Add" link to the right of "Add a new - product".</para> + <para>Select the "Add" link in the bottom right</para> </listitem> <listitem> <para>Enter the name of the product and a description. The - Description field is free-form.</para> + Description field may contain HTML.</para> </listitem> </orderedlist> - <tip> - <para>Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get out - of the UNCOMFIRMED state", and "Version" options yet. We'll cover - those in a few moments.</para> - </tip> + <para>Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single bug", + "Number of votes a bug in this Product needs to automatically get out + of the UNCOMFIRMED state", and "Version" options yet. We'll cover + those in a few moments. + </para> </section> <section id="components"> <title>Components</title> - <para>Components are subsections of a Product. - <example> - <title>Creating some Components</title> - - <informalexample> - <para>The computer game you are designing may have a "UI" - component, an "API" component, a "Sound System" component, and a - "Plugins" component, each overseen by a different programmer. It - often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or - company.</para> - </informalexample> - </example> - + <para>Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.</para> + + <para> Each component has a owner and (if you turned it on in the parameters), a QA Contact. The owner should be the primary person who fixes bugs in that component. The QA Contact should be the person who will ensure @@ -715,10 +504,9 @@ will get email when new bugs are created in this Component and when these bugs change. Default Owner and Default QA Contact fields only dictate the - <emphasis>default assignments</emphasis> - - ; the Owner and QA Contact fields in a bug are otherwise unrelated to - the Component.</para> + <emphasis>default assignments</emphasis>; + these can be changed on bug submission, or at any later point in + a bug's life.</para> <para>To create a new Component:</para> @@ -729,53 +517,17 @@ </listitem> <listitem> - <para>Select the "Add" link to the right of the "Add a new - component" text on the "Select Component" page.</para> + <para>Select the "Add" link in the bottom right.</para> </listitem> <listitem> - <para>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. - <tip> - <para>Is your "Default Owner" a user who is not yet in the - database? No problem. - <orderedlist> - <listitem> - <para>Select the "Log out" link on the footer of the - page.</para> - </listitem> - - <listitem> - <para>Select the "New Account" link on the footer of the - "Relogin" page</para> - </listitem> - - <listitem> - <para>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.</para> - </listitem> - - <listitem> - <para>Now select "Log in" again, type in your login - information, and you can modify the product to use the - Default Owner information you require.</para> - </listitem> - </orderedlist> - </para> - </tip> + <para>Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. </para> </listitem> - - <listitem> - <para>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.</para> - </listitem> </orderedlist> </section> @@ -783,36 +535,9 @@ <title>Versions</title> <para>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. - <example> - <title>Common Use of Versions</title> - - <informalexample> - <para>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</para> - </informalexample> - </example> - - <example> - <title>A Different Use of Versions</title> - - <informalexample> - <para>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.</para> - </informalexample> - </example> + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the most recent version with + the bug. </para> <para>To create and edit Versions:</para> @@ -824,27 +549,14 @@ <listitem> <para>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.</para> - - <para>Otherwise, click the "Add" button to the right of the "Add a - new version" text.</para> + version "undefined". Click the "Add" link in the bottom right.</para> </listitem> <listitem> - <para>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.</para> + <para>Enter the name of the Version. This field takes text only. + Then click the "Add" button.</para> </listitem> - <listitem> - <para>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.</para> - </listitem> </orderedlist> </section> @@ -853,13 +565,12 @@ <para>Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it - would be assigned the milestone of 3.0. Or, you have a bug that you - plan to fix for 2.8, this would have a milestone of 2.8.</para> + would be assigned the milestone of 3.0.</para> <note> <para>Milestone options will only appear for a Product if you turned - the "usetargetmilestone" field in the "Edit Parameters" screen - "On".</para> + on the "usetargetmilestone" Param in the "Edit Parameters" screen. + </para> </note> <para>To create new Milestones, set Default Milestones, and set @@ -867,345 +578,188 @@ <orderedlist> <listitem> - <para>Select "edit milestones"</para> + <para>Select "Edit milestones" from the "Edit product" page.</para> </listitem> <listitem> - <para>Select "Add" to the right of the "Add a new milestone" + <para>Select "Add" in the bottom right corner. text</para> </listitem> <listitem> <para>Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "Sortkey", which is a positive or negative + 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".</para> - - <example> - <title>Using SortKey with Target Milestone</title> - - <informalexample> - <para>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"</para> - </informalexample> - </example> + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add".</para> </listitem> <listitem> - <para>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. - <note> - <para>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.</para> - </note> - </para> - </listitem> - - <listitem> - <para>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"</para> - - <para>Some common uses of this field include product descriptions, - product roadmaps, and of course a simple description of the meaning - of each milestone.</para> - </listitem> - - <listitem> - <para>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.</para> - - <para>Select the "Update" button when you are done.</para> + <para>From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean. </para> + + <tip> + <para>If you want your milestone document to be restricted so + that it can only be viewed by people in a particular Bugzilla + group, the best way is to attach the document to a bug in that + group, and make the URL the URL of that attachment.</para> + </tip> </listitem> </orderedlist> </section> + </section> + + <section id="voting"> + <title>Voting</title> - <section id="voting"> - <title>Voting</title> - - <para>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.</para> - - <para>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.</para> - - <para>To modify Voting settings:</para> - - <orderedlist> - <listitem> - <para>Navigate to the "Edit product" screen for the Product you - wish to modify</para> - </listitem> + <para>Voting allows users to be given a pot of votes which they can allocate + to bugs, to indicate that they'd like them fixed. + This allows developers to gauge + user need for a particular enhancement or bugfix. By allowing bugs with + a certain number of votes to automatically move from "UNCONFIRMED" to + "NEW", users of the bug system can help high-priority bugs garner + attention so they don't sit for a long time awaiting triage.</para> - <listitem> - <para>Set "Maximum Votes per person" to your calculated value. - Setting this field to "0" disables voting.</para> - </listitem> + <para>To modify Voting settings:</para> - <listitem> - <para>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.</para> - </listitem> + <orderedlist> + <listitem> + <para>Navigate to the "Edit product" screen for the Product you + wish to modify</para> + </listitem> - <listitem> - <para>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? - <tip> - <para>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 - <emphasis>really</emphasis> - - bad bug!</para> - </tip> - </para> - </listitem> + <listitem> + <para><emphasis>Maximum Votes per person</emphasis>: + Setting this field to "0" disables voting.</para> + </listitem> - <listitem> - <para>Once you have adjusted the values to your preference, select - the "Update" button.</para> - </listitem> - </orderedlist> - </section> + <listitem> + <para><emphasis>Maximum Votes a person can put on a single + bug"</emphasis>: + It should probably be some number lower than the + "Maximum votes per person". Don't set this field to "0" if + "Maximum votes per person" is non-zero; that doesn't make + any sense.</para> + </listitem> - <section id="groups"> - <title>Groups and Group Security</title> - - <para>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. - <example> - <title>When to Use Group Security</title> - - <informalexample> - <para>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.</para> - </informalexample> - </example> - - 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.</para> + <listitem> + <para><emphasis>Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state</emphasis>: + Setting this field to "0" disables the automatic move of + bugs from UNCONFIRMED to NEW. + </para> + </listitem> - <note> - <para>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.</para> - - <para>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.</para> - </note> + <listitem> + <para>Once you have adjusted the values to your preference, click + "Update".</para> + </listitem> + </orderedlist> + </section> - <para>To enable Generic Group Security ("usebuggroups"):</para> + <section id="groups"> + <title>Groups and Group Security</title> - <orderedlist> - <listitem> - <para>Turn "On" "usebuggroups" in the "Edit Parameters" - screen.</para> - </listitem> + <para>Groups allow the administrator + to isolate bugs or products that should only be seen by certain people. + There are two types of group - Generic Groups, and Product-Based Groups. + </para> + + <para> + Product-Based Groups are matched with products, and allow you to restrict + access to bugs on a per-product basis. They are enabled using the + usebuggroups Param. Turning on the usebuggroupsentry + Param will mean bugs automatically get added to their product group when + filed. + </para> + + <para> + Generic Groups have no special relationship to products; + you create them, and put bugs in them + as required. One example of the use of Generic Groups + is Mozilla's "Security" group, + into which security-sensitive bugs are placed until fixed. Only the + Mozilla Security Team are members of this group. + </para> + + <para>To create Generic Groups:</para> - <listitem> - <para>You will generally have no groups set up. Select the "groups" - link in the footer.</para> - </listitem> + <orderedlist> + <listitem> + <para>Select the "groups" + link in the footer.</para> + </listitem> - <listitem> - <para>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.</para> - </listitem> + <listitem> + <para>Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.</para> + </listitem> - <listitem> - <para>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. - <example> - <title>Creating a New Group</title> - - <informalexample> - <para>I created a group called DefaultGroup with a description - of - <quote>This is simply a group to play with</quote> - - , and a New User RegExp of - <quote>.*@mydomain.tld</quote> - - . 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.</para> - </informalexample> - </example> - - When you have finished, select the Add button.</para> - </listitem> - </orderedlist> + <listitem> + <para>Fill out the "New Name", "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. + When you have finished, click "Add".</para> + </listitem> + </orderedlist> - <para>To enable Product-Based Group Security - (usebuggroupsentry):</para> + <para>To use Product-Based Groups:</para> - <warning> - <para>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.</para> - </warning> + <orderedlist> + <listitem> + <para>Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit + Parameters" screen.</para> - <orderedlist> - <listitem> - <para>Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen.</para> - - <warning> - <para>"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.</para> - </warning> - </listitem> + <warning> + <para>XXX is this still true? + "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.</para> + </warning> + </listitem> - <listitem> - <para>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.</para> - </listitem> - </orderedlist> + <listitem> + <para>In future, when you create a Product, a matching group will be + automatically created. If you need to add a Product Group to + a Product which was created before you turned on usebuggroups, + then simply create a new group, as outlined above, with the + same name as the Product.</para> + </listitem> + </orderedlist> - <para>You may find this example illustrative for how bug groups work. - <example> - <title>Bugzilla Groups</title> - - <literallayout>Bugzilla Groups example ----------------------- For - this example, let us suppose we have four groups, call them Group1, - Group2, Group3, and Group4. We have 5 users, User1, User2, User3, - User4, User5. We have 8 bugs, Bug1, ..., Bug8. Group membership is - defined by this chart: (X denotes that user is in that group.) (I - apologize for the nasty formatting of this table. Try viewing it in a - text-based browser or something for now. -MPB) G G G G r r r r o o o - o u u u u p p p p 1 2 3 4 +-+-+-+-+ User1|X| | | | +-+-+-+-+ User2| - |X| | | +-+-+-+-+ User3|X| |X| | +-+-+-+-+ User4|X|X|X| | +-+-+-+-+ - User5| | | | | +-+-+-+-+ Bug restrictions are defined by this chart: - (X denotes that bug is restricted to that group.) G G G G r r r r o o - o o u u u u p p p p 1 2 3 4 +-+-+-+-+ Bug1| | | | | +-+-+-+-+ Bug2| - |X| | | +-+-+-+-+ Bug3| | |X| | +-+-+-+-+ Bug4| | | |X| +-+-+-+-+ - Bug5|X|X| | | +-+-+-+-+ Bug6|X| |X| | +-+-+-+-+ Bug7|X|X|X| | - +-+-+-+-+ Bug8|X|X|X|X| +-+-+-+-+ Who can see each bug? Bug1 has no - group restrictions. Therefore, Bug1 can be seen by any user, whatever - their group membership. This is going to be the only bug that User5 - can see, because User5 isn't in any groups. Bug2 can be seen by - anyone in Group2, that is User2 and User4. Bug3 can be seen by anyone - in Group3, that is User3 and User4. Bug4 can be seen by anyone in - Group4. Nobody is in Group4, so none of these users can see Bug4. - Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This - is only User4. User1 cannot see it because he is not in Group2, and - User2 cannot see it because she is not in Group1. Bug6 can be seen by - anyone who is in both Group1 and Group3. This would include User3 and - User4. Similar to Bug5, User1 cannot see Bug6 because he is not in - Group3. Bug7 can be seen by anyone who is in Group1, Group2, and - Group3. This is only User4. All of the others are missing at least - one of those group privileges, and thus cannot see the bug. Bug8 can - be seen by anyone who is in Group1, Group2, Group3, and Group4. There - is nobody in all four of these groups, so nobody can see Bug8. It - doesn't matter that User4 is in Group1, Group2, and Group3, since he - isn't in Group4.</literallayout> - </example> - </para> - </section> + <warning> + <para>Bugzilla currently has a limit of 64 groups per installation. If + you have more than about 50 products, you should consider + running multiple Bugzillas. Ask in the newsgroup for other + suggestions for working around this restriction.</para> + </warning> + + <para> + Note that group permissions are such that you need to be a member + of <emphasis>all</emphasis> the groups a bug is in, for whatever + reason, to see that bug. + </para> </section> + <section id="security"> <title>Bugzilla Security</title> - <epigraph> - <para>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.</para> - </epigraph> - - <note> - <para>Poorly-configured MySQL, Bugzilla, and FTP installations have + <warning> + <para>Poorly-configured MySQL and Bugzilla 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.</para> - </note> + </warning> - <para>Secure your installation. <note> <para>These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different platforms. If you have refinements @@ -1215,11 +769,13 @@ </para> </note> + <para>To secure your installation: + <orderedlist> <listitem> <para>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.</para> + Earlier versions had notable security holes and (from a security + point of view) poor default configuration choices.</para> </listitem> <listitem> @@ -1228,18 +784,9 @@ system!</emphasis> Read - <ulink - url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> + <ulink url="http://www.mysql.com/doc/P/r/Privilege_system.html"> The MySQL Privilege System</ulink> - until you can recite it from memory!</para> - - <para>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 : )</para> </listitem> <listitem> @@ -1273,42 +820,35 @@ <listitem> <para>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.</para> + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. + The localconfig file stores your "bugs" database account password. + In addition, some + files under $BUGZILLA_HOME/data/ store sensitive information. + </para> - <note> - <para>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.</para> - - <para>If you are using a web server that does not support the - .htaccess control method, - <emphasis>you are at risk!</emphasis> - - After installing, check to see if you can view the file - "localconfig" in your web browser (e.g.: - <ulink url="http://bugzilla.mozilla.org/localconfig"> - http://bugzilla.mozilla.org/localconfig</ulink> - - ). 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.</para> - </note> + <para>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.</para> + + <para>If you are using a web server that does not support the + .htaccess control method, + <emphasis>you are at risk!</emphasis> + + After installing, check to see if you can view the file + "localconfig" in your web browser (e.g.: + <ulink url="http://bugzilla.mozilla.org/localconfig"> + http://bugzilla.mozilla.org/localconfig</ulink> + + ). 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.</para> <para>When you run checksetup.pl, the script will attempt to modify various permissions on files which Bugzilla uses. If you do not have @@ -1335,7 +875,7 @@ <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572">Bug 65572</ulink> - for adequate protection in your data/ and shadow/ directories.</para> + for adequate protection in your data/ directory.</para> <para>Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other non-Apache web servers, please consult @@ -1354,15 +894,325 @@ allow from all</literallayout> </para> - <para>Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/shadow directory. - - <literallayout>deny from all</literallayout> - </para> </listitem> </orderedlist> </para> </section> + + <section id="cust-templates"> + <title>Template Customisation</title> + + <para> + One of the large changes for 2.16 was the templatisation of the + entire user-facing UI, using the + <ulink url="http://www.template-toolkit.org">Template Toolkit</ulink>. + Administrators can now configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + </para> + + <para> + Templatisation also makes localised versions of Bugzilla possible, + for the first time. In the future, a Bugzilla installation may + have templates installed for multiple localisations, and select + which ones to use based on the user's browser language setting. + </para> + + <section> + <title>What to Edit</title> + <para> + There are two different ways of editing of Bugzilla's templates, + and which you use depends mainly on how you upgrade Bugzilla. The + template directory structure is that there's a top level directory, + <filename>template</filename>, which contains a directory for + each installed localisation. The default English templates are + therefore in <filename>en</filename>. Underneath that, there + is the <filename>default</filename> directory and optionally the + <filename>custom</filename> directory. The <filename>default</filename> + directory contains all the templates shipped with Bugzilla, whereas + the <filename>custom</filename> directory does not exist at first and + must be created if you want to use it. + </para> + + <para> + The first method of making customisations is to directly edit the + templates in <filename>template/en/default</filename>. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + <command>cvs update</command>, any template fixes will get + automagically merged into your modified versions. + </para> + + <para> + If you use this method, your installation will break if CVS conflicts + occur. + </para> + + <para> + The other method is to copy the templates into a mirrored directory + structure under <filename>template/en/custom</filename>. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. + </para> + + <para> + If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. + </para> + + <note> + <para> + Don't directly edit the compiled templates in + <filename class="directory">data/template/*</filename> - your + changes will be lost when Template Toolkit recompiles them. + </para> + </note> + </section> + + <section> + <title>How To Edit Templates</title> + + <para> + The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + <ulink url="http://www.template-toolkit.org">Template Toolkit home + page</ulink>. However, you should particularly remember (for security + reasons) to always HTML filter things which come from the database or + user input, to prevent cross-site scripting attacks. + </para> + + <para> + However, one thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you fail to do this, you may open up + your installation to cross-site scripting attacks. + </para> + + <para> + Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. + </para> + + <para> + Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + </para> + + <note> + <para> + If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + <ulink url="http://www.bugzilla.org/developerguide.html">Developers' + Guide</ulink>. + </para> + </note> + </section> + + + <section> + <title>Template Formats</title> + + <para> + Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending <filename>&format=simple</filename> to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. + </para> + + <para> + To see if a CGI supports multiple output formats, grep the + CGI for "ValidateOutputFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs. + </para> + + <para> + To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. + </para> + + <para> + Write your template in whatever markup or text style is appropriate. + </para> + + <para> + You now need to decide what content type you want your template + served as. Open up the <filename>localconfig</filename> file and find the + <filename>$contenttypes</filename> + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. + </para> + + <para> + Save the template as <filename><stubname>-<formatname>.<contenttypetag>.tmpl</filename>. + Try out the template by calling the CGI as + <filename><cginame>.cgi?format=<formatname></filename> . + </para> + </section> + + + <section> + <title>Particular Templates</title> + + <para> + There are a few templates you may be particularly interested in + customising for your installation. + </para> + + <para> + <command>index.html.tmpl</command>: + This is the Bugzilla front page. + </para> + + <para> + <command>global/header.html.tmpl</command>: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + </para> + + <para> + <command>global/banner.html.tmpl</command>: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customise this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + </para> + + <para> + <command>global/footer.html.tmpl</command>: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + </para> + + <para> + <command>bug/create/user-message.html.tmpl</command>: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + </para> + + <para> + <command>bug/create/create.html.tmpl</command> and + <command>bug/create/comment.txt.tmpl</command>: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided">guided + bug submission form</ulink>. + </para> + + <para> + To make this work, create a custom template for + <filename>enter_bug.cgi</filename> (the default template, on which you + could base it, is <filename>create.html.tmpl</filename>), + and either call it <filename>create.html.tmpl</filename> or use a format and + call it <filename>create-<formatname>.html.tmpl</filename>. + Put it in the <filename class="directory">custom/bug/create</filename> + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + </para> + + <para> + Then, create a template like + <filename>custom/bug/create/comment.txt.tmpl</filename>, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + </para> + + <para> + For example, if your enter_bug template had a field + <programlisting><input type="text" name="buildid" size="30"></programlisting> + and then your comment.txt.tmpl had + <programlisting>BuildID: [% form.buildid %]</programlisting> + then + <programlisting>BuildID: 20020303</programlisting> + would appear in the initial checkin comment. + </para> + </section> + + </section> + + <section id="upgrading"> + <title>Upgrading to New Releases</title> + + <para>A plain Bugzilla is fairly easy to upgrade from one version to a + newer one. Always read the release notes to see if there are any issues + that you might need to take note of. It is recommended that you take a + backup of your database and your entire Bugzilla installation before attempting an + upgrade. You can upgrade a 'clean' installation by untarring a new + tarball over the old installation. If you are upgrading from 2.12 or + later, and have cvs installed, you can type <filename>cvs -z3 update</filename>, + and resolve conflicts if there are any. + </para> + + <para>However, things get a bit more complicated if you've made + changes to Bugzilla's code. In this case, you may have to re-make or + reapply those changes. One good method is to take a diff of your customised + version against the original, so you can survey all that you've changed. + Hopefully, templatisation will reduce the need for + this in the future.</para> + + <para>From version 2.8 onwards, Bugzilla databases can be automatically + carried forward during an upgrade. However, because the developers of + Bugzilla are constantly adding new + tables, columns and fields, you'll probably get SQL errors if you just + update the code and attempt to use Bugzilla. Always run the + <filename>checksetup.pl</filename> + script whenever you upgrade your installation.</para> + + <para>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.</para> + </section> + + <!-- Integrating Bugzilla with Third-Party Tools --> + &integration; + </chapter> <!-- Keep this comment at the end of the file diff --git a/docs/xml/conventions.xml b/docs/xml/conventions.xml index f6aa00338..7334b02b8 100644 --- a/docs/xml/conventions.xml +++ b/docs/xml/conventions.xml @@ -6,7 +6,7 @@ <primary>conventions</primary> </indexterm> - <para>This document uses the following conventions</para> + <para>This document uses the following conventions:</para> <informaltable frame="none"> <tgroup cols="2"> @@ -34,7 +34,7 @@ <entry> <tip> - <para>Warm jar lids under the hot tap to loosen them.</para> + <para>Would you like a breath mint?</para> </tip> </entry> </row> @@ -63,7 +63,7 @@ <entry>File Names</entry> <entry> - <filename>file.extension</filename> + <filename>filename</filename> </entry> </row> @@ -138,12 +138,9 @@ <entry>Code Example</entry> <entry> - <programlisting> - <sgmltag class="starttag">para</sgmltag> - - Beginning and end of paragraph - <sgmltag class="endtag">para</sgmltag> - </programlisting> + <programlisting><sgmltag class="starttag">para</sgmltag> +Beginning and end of paragraph +<sgmltag class="endtag">para</sgmltag></programlisting> </entry> </row> </tbody> diff --git a/docs/xml/database.xml b/docs/xml/database.xml index 4cba46a48..d758259da 100644 --- a/docs/xml/database.xml +++ b/docs/xml/database.xml @@ -123,10 +123,10 @@ ! 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 - .</para> + "Security"), or more robust security generalities in the + <ulink url="http://www.mysql.com/php/manual.php3?section=Privilege_system">MySQL + searchable documentation</ulink>. + </para> </listitem> <listitem> @@ -150,13 +150,6 @@ <command>use bugs;</command> </para> - <note> - <para>Don't forget the - <quote>;</quote> - - at the end of each line, or you'll be kicking yourself - later.</para> - </note> </listitem> </orderedlist> </para> @@ -169,273 +162,212 @@ <para> <prompt>mysql></prompt> - <command>show tables from bugs;</command> </para> - <para>you'll be able to see all the + <para>you'll be able to see the names of all the <quote>spreadsheets</quote> + (tables) in your database.</para> + + <para>From the command issued above, ou should have some + output that looks like this: +<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 | ++-------------------+ +</programlisting> +</para> + +<literallayout> + Here's an overview of what each table does. Most columns in each table have +descriptive names that make it fairly trivial to figure out their jobs. + +attachments: This table stores all attachments to bugs. It tends to be your +largest table, yet also generally has the fewest entries because file +attachments are so (relatively) large. + +bugs: This is the core of your system. The bugs table stores most of the +current information about a bug, with the exception of the info stored in the +other tables. + +bugs_activity: This stores information regarding what changes are made to bugs +when -- a history file. + +cc: This tiny table simply stores all the CC information for any bug which has +any entries in the CC field of the bug. Note that, like most other tables in +Bugzilla, it does not refer to users by their user names, but by their unique +userid, stored as a primary key in the profiles table. + +components: This stores the programs and components (or products and +components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program" +(product) field is the full name of the product, rather than some other unique +identifier, like bug_id and user_id are elsewhere in the database. + +dependencies: Stores data about those cool dependency trees. + +fielddefs: A nifty table that defines other tables. For instance, when you +submit a form that changes the value of "AssignedTo" this table allows +translation to the actual field name "assigned_to" for entry into MySQL. + +groups: defines bitmasks for groups. A bitmask is a number that can uniquely +identify group memberships. For instance, say the group that is allowed to +tweak parameters is assigned a value of "1", the group that is allowed to edit +users is assigned a "2", and the group that is allowed to create new groups is +assigned the bitmask of "4". By uniquely combining the group bitmasks (much +like the chmod command in UNIX,) you can identify a user is allowed to tweak +parameters and create groups, but not edit users, by giving him a bitmask of +"5", or a user allowed to edit users and create groups, but not tweak +parameters, by giving him a bitmask of "6" Simple, huh? + If this makes no sense to you, try this at the mysql prompt: +mysql> select * from groups; + You'll see the list, it makes much more sense that way. + +keyworddefs: Definitions of keywords to be used + +keywords: Unlike what you'd think, this table holds which keywords are +associated with which bug id's. + +logincookies: This stores every login cookie ever assigned to you for every +machine you've ever logged into Bugzilla from. Curiously, it never does any +housecleaning -- I see cookies in this file I've not used for months. However, +since Bugzilla never expires your cookie (for convenience' sake), it makes +sense. + +longdescs: The meat of bugzilla -- here is where all user comments are stored! +You've only got 2^24 bytes per comment (it's a mediumtext field), so speak +sparingly -- that's only the amount of space the Old Testament from the Bible +would take (uncompressed, 16 megabytes). Each comment is keyed to the +bug_id to which it's attached, so the order is necessarily chronological, for +comments are played back in the order in which they are received. + +milestones: Interesting that milestones are associated with a specific product +in this table, but Bugzilla does not yet support differing milestones by +product through the standard configuration interfaces. + +namedqueries: This is where everybody stores their "custom queries". Very +cool feature; it beats the tar out of having to bookmark each cool query you +construct. + +products: What products you have, whether new bug entries are allowed for the +product, what milestone you're working toward on that product, votes, etc. It +will be nice when the components table supports these same features, so you +could close a particular component for bug entry without having to close an +entire product... + +profiles: Ahh, so you were wondering where your precious user information was +stored? Here it is! With the passwords in plain text for all to see! (but +sshh... don't tell your users!) + +profiles_activity: Need to know who did what when to who's profile? This'll +tell you, it's a pretty complete history. + +shadowlog: I could be mistaken here, but I believe this table tells you when +your shadow database is updated and what commands were used to update it. We +don't use a shadow database at our site yet, so it's pretty empty for us. + +versions: Version information for every product + +votes: Who voted for what when + +watch: Who (according to userid) is watching who's bugs (according to their +userid). - (tables) in your database. It is similar to a file system, only - faster and more robust for certain types of operations.</para> - - <para>From the command issued above, ou should have some output that - looks like this: - <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 | +-------------------+</programlisting> - </para> - <literallayout>Here's an overview of what each table does. Most - columns in each table have descriptive names that make it fairly - trivial to figure out their jobs. attachments: This table stores all - attachments to bugs. It tends to be your largest table, yet also - generally has the fewest entries because file attachments are so - (relatively) large. bugs: This is the core of your system. The bugs - table stores most of the current information about a bug, with the - exception of the info stored in the other tables. bugs_activity: This - stores information regarding what changes are made to bugs when -- a - history file. cc: This tiny table simply stores all the CC - information for any bug which has any entries in the CC field of the - bug. Note that, like most other tables in Bugzilla, it does not refer - to users by their user names, but by their unique userid, stored as a - primary key in the profiles table. components: This stores the - programs and components (or products and components, in newer - Bugzilla parlance) for Bugzilla. Curiously, the "program" (product) - field is the full name of the product, rather than some other unique - identifier, like bug_id and user_id are elsewhere in the database. - dependencies: Stores data about those cool dependency trees. - fielddefs: A nifty table that defines other tables. For instance, - when you submit a form that changes the value of "AssignedTo" this - table allows translation to the actual field name "assigned_to" for - entry into MySQL. groups: defines bitmasks for groups. A bitmask is a - number that can uniquely identify group memberships. For instance, - say the group that is allowed to tweak parameters is assigned a value - of "1", the group that is allowed to edit users is assigned a "2", - and the group that is allowed to create new groups is assigned the - bitmask of "4". By uniquely combining the group bitmasks (much like - the chmod command in UNIX,) you can identify a user is allowed to - tweak parameters and create groups, but not edit users, by giving him - a bitmask of "5", or a user allowed to edit users and create groups, - but not tweak parameters, by giving him a bitmask of "6" Simple, huh? - If this makes no sense to you, try this at the mysql prompt: - mysql> select * from groups; You'll see the list, it makes much - more sense that way. keyworddefs: Definitions of keywords to be used - keywords: Unlike what you'd think, this table holds which keywords - are associated with which bug id's. logincookies: This stores every - login cookie ever assigned to you for every machine you've ever - logged into Bugzilla from. Curiously, it never does any housecleaning - -- I see cookies in this file I've not used for months. However, - since Bugzilla never expires your cookie (for convenience' sake), it - makes sense. longdescs: The meat of bugzilla -- here is where all - user comments are stored! You've only got 2^24 bytes per comment - (it's a mediumtext field), so speak sparingly -- that's only the - amount of space the Old Testament from the Bible would take - (uncompressed, 16 megabytes). Each comment is keyed to the bug_id to - which it's attached, so the order is necessarily chronological, for - comments are played back in the order in which they are received. - milestones: Interesting that milestones are associated with a - specific product in this table, but Bugzilla does not yet support - differing milestones by product through the standard configuration - interfaces. namedqueries: This is where everybody stores their - "custom queries". Very cool feature; it beats the tar out of having - to bookmark each cool query you construct. products: What products - you have, whether new bug entries are allowed for the product, what - milestone you're working toward on that product, votes, etc. It will - be nice when the components table supports these same features, so - you could close a particular component for bug entry without having - to close an entire product... profiles: Ahh, so you were wondering - where your precious user information was stored? Here it is! With the - passwords in plain text for all to see! (but sshh... don't tell your - users!) profiles_activity: Need to know who did what when to who's - profile? This'll tell you, it's a pretty complete history. shadowlog: - I could be mistaken here, but I believe this table tells you when - your shadow database is updated and what commands were used to update - it. We don't use a shadow database at our site yet, so it's pretty - empty for us. versions: Version information for every product votes: - Who voted for what when watch: Who (according to userid) is watching - who's bugs (according to their userid). === THE DETAILS === Ahh, so - you're wondering just what to do with the information above? At the - mysql prompt, you can view any information about the columns in a - table with this command (where "table" is the name of the table you - wish to view): mysql> show columns from table; You can also view - all the data in a table with this command: mysql> select * from - table; -- note: this is a very bad idea to do on, for instance, the - "bugs" table if you have 50,000 bugs. You'll be sitting there a while - until you ctrl-c or 50,000 bugs play across your screen. You can - limit the display from above a little with the command, where - "column" is the name of the column for which you wish to restrict - information: mysql> select * from table where (column = "some - info"); -- or the reverse of this mysql> select * from table where - (column != "some info"); Let's take our example from the - introduction, and assume you need to change the word "verified" to - "approved" in the resolution field. We know from the above - information that the resolution is likely to be stored in the "bugs" - table. Note we'll need to change a little perl code as well as this - database change, but I won't plunge into that in this document. Let's - verify the information is stored in the "bugs" table: mysql> show - columns from bugs (exceedingly long output truncated here) | - bug_status| - enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL - | UNCONFIRMED|| Sorry about that long line. We see from this that the - "bug status" column is an "enum field", which is a MySQL peculiarity - where a string type field can only have certain types of entries. - While I think this is very cool, it's not standard SQL. Anyway, we - need to add the possible enum field entry 'APPROVED' by altering the - "bugs" table. mysql> ALTER table bugs CHANGE bug_status bug_status - -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED", - -> "VERIFIED", "APPROVED", "CLOSED") not null; (note we can take - three lines or more -- whatever you put in before the semicolon is - evaluated as a single expression) Now if you do this: mysql> show - columns from bugs; you'll see that the bug_status field has an extra - "APPROVED" enum that's available! Cool thing, too, is that this is - reflected on your query page as well -- you can query by the new - status. But how's it fit into the existing scheme of things? Looks - like you need to go back and look for instances of the word - "verified" in the perl code for Bugzilla -- wherever you find - "verified", change it to "approved" and you're in business (make sure - that's a case-insensitive search). Although you can query by the enum - field, you can't give something a status of "APPROVED" until you make - the perl changes. Note that this change I mentioned can also be done - by editing checksetup.pl, which automates a lot of this. But you need - to know this stuff anyway, right? I hope this database tutorial has - been useful for you. If you have comments to add, questions, - concerns, etc. please direct them to mbarnson@excitehome.net. Please - direct flames to /dev/null :) Have a nice day! === LINKS === Great - MySQL tutorial site: - http://www.devshed.com/Server_Side/MySQL/</literallayout> +=== +THE DETAILS +=== + + Ahh, so you're wondering just what to do with the information above? At the +mysql prompt, you can view any information about the columns in a table with +this command (where "table" is the name of the table you wish to view): + +mysql> show columns from table; + + You can also view all the data in a table with this command: + +mysql> select * from table; + + -- note: this is a very bad idea to do on, for instance, the "bugs" table if +you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or +50,000 bugs play across your screen. + + You can limit the display from above a little with the command, where +"column" is the name of the column for which you wish to restrict information: + +mysql> select * from table where (column = "some info"); + + -- or the reverse of this + +mysql> select * from table where (column != "some info"); + + Let's take our example from the introduction, and assume you need to change +the word "verified" to "approved" in the resolution field. We know from the +above information that the resolution is likely to be stored in the "bugs" +table. Note we'll need to change a little perl code as well as this database +change, but I won't plunge into that in this document. Let's verify the +information is stored in the "bugs" table: + +mysql> show columns from bugs + + (exceedingly long output truncated here) +| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED|| + + Sorry about that long line. We see from this that the "bug status" column is +an "enum field", which is a MySQL peculiarity where a string type field can +only have certain types of entries. While I think this is very cool, it's not +standard SQL. Anyway, we need to add the possible enum field entry +'APPROVED' by altering the "bugs" table. + +mysql> ALTER table bugs CHANGE bug_status bug_status + -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED", + -> "VERIFIED", "APPROVED", "CLOSED") not null; + + (note we can take three lines or more -- whatever you put in before the +semicolon is evaluated as a single expression) + +Now if you do this: + +mysql> show columns from bugs; + + you'll see that the bug_status field has an extra "APPROVED" enum that's +available! Cool thing, too, is that this is reflected on your query page as +well -- you can query by the new status. But how's it fit into the existing +scheme of things? + Looks like you need to go back and look for instances of the word "verified" +in the perl code for Bugzilla -- wherever you find "verified", change it to +"approved" and you're in business (make sure that's a case-insensitive search). +Although you can query by the enum field, you can't give something a status +of "APPROVED" until you make the perl changes. Note that this change I +mentioned can also be done by editing checksetup.pl, which automates a lot of +this. But you need to know this stuff anyway, right? + </literallayout> </section> </section> </section> - <section id="granttables"> - <title>MySQL Permissions & Grant Tables</title> - - <note> - <para>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.</para> - - <para>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.</para> - </note> - - <literallayout>From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 - Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson - matt_barnson@singletrac.com To: keystone-users@homeport.org Subject: - [keystone-users] Grant Tables FAQ [The following text is in the - "iso-8859-1" character set] [Your display is set for the "US-ASCII" - character set] [Some characters may be displayed incorrectly] Maybe we - can include this rambling message in the Keystone FAQ? It gets asked a - lot, and the only option current listed in the FAQ is - "--skip-grant-tables". Really, you can't go wrong by reading section 6 of - the MySQL manual, at http://www.mysql.com/Manual/manual.html. I am sure - their description is better than mine. MySQL runs fine without - permissions set up correctly if you run the mysql daemon with the - "--skip-grant-tables" option. Running this way denies access to nobody. - Unfortunately, unless you've got yourself firewalled it also opens the - potential for abuse if someone knows you're running it. Additionally, the - default permissions for MySQL allow anyone at localhost access to the - database if the database name begins with "test_" or is named "test" - (i.e. "test_keystone"). You can change the name of your database in the - keystone.conf file ($sys_dbname). This is the way I am doing it for some - of my databases, and it works fine. The methods described below assume - you're running MySQL on the same box as your webserver, and that you - don't mind if your $sys_dbuser for Keystone has superuser access. See - near the bottom of this message for a description of what each field - does. Method #1: 1. cd /var/lib #location where you'll want to run - /usr/bin/mysql_install_db shell script from to get it to work. 2. ln -s - mysql data # soft links the "mysql" directory to "data", which is what - mysql_install_db expects. Alternately, you can edit mysql_install_db and - change all the "./data" references to "./mysql". 3. Edit - /usr/bin/mysql_install_db with your favorite text editor (vi, emacs, jot, - pico, etc.) A) Copy the "INSERT INTO db VALUES - ('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately - after itself. Chage the 'test\_%' value to 'keystone', or the value of - $sys_dbname in keystone.conf. B) If you are running your keystone - database with any user, you'll need to copy the "INSERT INTO user VALUES - ('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line - after itself and change 'root' to the name of the keystone database user - ($sys_dbuser) in keystone.conf. # adds entries to the script to create - grant tables for specific hosts and users. The user you set up has - super-user access ($sys_dbuser) -- you may or may not want this. The - layout of mysql_install_db is really very uncomplicated. 4. - /usr/bin/mysqladmin shutdown # ya gotta shut it down before you can - reinstall the grant tables! 5. rm -i /var/lib/mysql/mysql/*.IS?' and - answer 'Y' to the deletion questions. # nuke your current grant tables. - This WILL NOT delete any other databases than your grant tables. 6. - /usr/bin/mysql_install_db # run the script you just edited to install - your new grant tables. 7. mysqladmin -u root password (new_password) # - change the root MySQL password, or else anyone on localhost can login to - MySQL as root and make changes. You can skip this step if you want - keystone to connect as root with no password. 8. mysqladmin -u - (webserver_user_name) password (new_password) # change the password of - the $sys_dbuser. Note that you will need to change the password in the - keystone.conf file as well in $sys_dbpasswd, and if your permissions are - set up incorrectly anybody can type the URL to your keystone.conf file - and get the password. Not that this will help them much if your - permissions are set to @localhost. Method #2: easier, but a pain - reproducing if you have to delete your grant tables. This is the - "recommended" method for altering grant tables in MySQL. I don't use it - because I like the other way :) shell> mysql --user=root keystone - mysql> GRANT - SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS, - FILE, ON keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY - '(password)' WITH GRANT OPTION; OR mysql> GRANT ALL PRIVILEGES ON - keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY - '(password)' WITH GRANT OPTION; # this grants the required permissions to - the keystone ($sys_dbuser) account defined in keystone.conf. However, if - you are runnning many different MySQL-based apps, as we are, it's - generally better to edit the mysql_install_db script to be able to - quickly reproduce your permissions structure again. Note that the FILE - privelege and WITH GRANT OPTION may not be in your best interest to - include. GRANT TABLE FIELDS EXPLANATION: Quick syntax summary: "%" in - MySQL is a wildcard. I.E., if you are defining your DB table and in the - 'host' field and enter '%', that means that any host can access that - database. Of course, that host must also have a valid db user in order to - do anything useful. 'db'=name of database. In our case, it should be - "keystone". "user" should be your "$sys_dbuser" defined in keystone.conf. - Note that you CANNOT add or change a password by using the "INSERT INTO - db (X)" command -- you must change it with the mysql -u command as - defined above. Passwords are stored encrypted in the MySQL database, and - if you try to enter it directly into the table they will not match. - TABLE: USER. Everything after "password" is a privelege granted (Y/N). - This table controls individual user global access rights. - 'host','user','password','select','insert','update','delete','index','alter' - ,'create','drop','grant','reload','shutdown','process','file' TABLE: DB. - This controls access of USERS to databases. - 'host','db','user','select','insert','update','delete','index','alter','crea - te','drop','grant' TABLE: HOST. This controls which HOSTS are allowed - what global access rights. Note that the HOST table, USER table, and DB - table are very closely connected -- if an authorized USER attempts an SQL - request from an unauthorized HOST, she's denied. If a request from an - authorized HOST is not an authorized USER, it is denied. If a globally - authorized USER does not have rights to a certain DB, she's denied. Get - the picture? - 'host','db','select','insert','update','delete','index','alter','create','dr - op','grant' You should now have a working knowledge of MySQL grant - tables. If there is anything I've left out of this answer that you feel - is pertinent, or if my instructions don't work for you, please let me - know and I'll re-post this letter again, corrected. I threw it together - one night out of exasperation for all the newbies who don't know squat - about MySQL yet, so it is almost guaranteed to have errors. Once again, - you can't go wrong by reading section 6 of the MySQL manual. It is more - detailed than I! http://www.mysql.com/Manual/manual.html.</literallayout> - </section> </appendix> <!-- Keep this comment at the end of the file diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml index f7fafd3e8..91380863f 100644 --- a/docs/xml/faq.xml +++ b/docs/xml/faq.xml @@ -3,6 +3,10 @@ <appendix id="faq"> <title>The Bugzilla FAQ</title> + <para> + This FAQ includes questions not covered elsewhere in the Guide. + </para> + <qandaset> @@ -121,9 +125,9 @@ </question> <answer> <para> - A year has gone by, and I <emphasis>still</emphasis> can't - find any head-to-head comparisons of Bugzilla against - other defect-tracking software. However, from my personal + We can't find any head-to-head comparisons of Bugzilla against + other defect-tracking software. If you know of one, please + get in touch. However, from the author's personal experience with other bug-trackers, Bugzilla offers superior performance on commodity hardware, better price (free!), more developer- friendly features (such as stored @@ -133,24 +137,9 @@ </para> <para> 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. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I change my user name (email address) in Bugzilla? - </para> - </question> - <answer> - <para> - New in 2.16 - go to the Account section of the Preferences. You will - be emailed at both addresses for confirmation. + step forward with a list of advantages your product has over + Bugzilla. We'd be happy to include it in the "Competitors" + section. </para> </answer> </qandaentry> @@ -184,7 +173,7 @@ <question> <para> Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL? + Oracle/Sybase/Msql/PostgreSQL/MSSQL. </para> </question> <answer> @@ -204,42 +193,41 @@ </question> <answer> <para> - 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. - </para> - <para> - Here's Terry Weissman's comment, for some historical context: - <blockquote> - <para> - [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. - </para> - <note> + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally + Terry wanted a place to put a version of Perl and other tools + that was strictly under his control. + </para> <para> 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 + as /usr/bonsaitools/bin/perl, and simply add symlink. + This will make upgrading your Bugzilla much easier in the future. </para> - </note> - </blockquote> - </para> </answer> </qandaentry> + + <qandaentry> + <question> + <para> + Is there an easy way to change the Bugzilla cookie name? + </para> + </question> + <answer> + <para> + At present, no. + </para> + </answer> + </qandaentry> + </qandadiv> <qandadiv id="faq-phb"> - <title>Pointy-Haired-Boss Questions</title> + <title>Managerial Questions</title> <para> <note> <para> - 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 :) + Questions likely to be asked by managers. :-) </para> </note> </para> @@ -247,8 +235,8 @@ <qandaentry> <question> <para> - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based, or do you have to have specific software or + a specific operating system on your machine? </para> </question> <answer> @@ -262,7 +250,7 @@ <qandaentry> <question> <para> - Has anyone you know of already done any Bugzilla integration with + Can Bugzilla integrate with Perforce (SCM software)? </para> </question> @@ -282,11 +270,10 @@ </question> <answer> <para> - 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. + Absolutely! You can track any number of Products (although you + are limited to about 55 or so if + you are using Product-Based Groups), that can each be composed of any + number of Components. </para> </answer> </qandaentry> @@ -308,7 +295,7 @@ <qandaentry> <question> <para> - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, + Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? </para> </question> @@ -346,19 +333,6 @@ </answer> </qandaentry> - - <qandaentry> - <question> - <para> - 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. - </para> - </question> - <answer> - <para>If you upgrade to 2.16, the index page has a footer. - </para> - </answer> - </qandaentry> <qandaentry> <question> <para> @@ -370,7 +344,7 @@ <para> Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi"> http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting - facilities. + and graphing facilities. </para> <para> For more advanced reporting, I recommend hooking up a professional @@ -387,7 +361,7 @@ <question> <para> 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? + email? </para> </question> <answer> @@ -416,7 +390,7 @@ <qandaentry> <question> <para> - If there is email notification, do users have to have any particular + Do users have to have any particular type of email application? </para> </question> @@ -441,24 +415,6 @@ <qandaentry> <question> <para> - 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.? - </para> - </question> - <answer> - <para> - 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. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> 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 @@ -523,33 +479,6 @@ <qandaentry> <question> <para> - Can a user re-run a report with a new project, same query? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Can a user modify an existing report and then save it into another name? - </para> - </question> - <answer> - <para> - You can save an unlimited number of queries in Bugzilla. You are free - to modify them and rename them to your heart's desire. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> Does Bugzilla have the ability to search by word, phrase, compound search? </para> @@ -565,20 +494,6 @@ <qandaentry> <question> <para> - Can the admin person establish separate group and individual user - privileges? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> 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? @@ -635,9 +550,8 @@ </question> <answer> <para> - 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". + If Bugzilla is set up correctly from the start, continuing maintenance + needs are minimal and can be done easily using the web interface. </para> <para> Commercial Bug-tracking software typically costs somewhere upwards @@ -686,52 +600,6 @@ </qandaentry> </qandadiv> - <qandadiv id="faq-install"> - <title>Bugzilla Installation</title> - <qandaentry> - <question> - <para> - How do I download and install Bugzilla? - </para> - </question> - <answer> - <para> - Check <ulink url="http://www.bugzilla.org/"> - http://www.bugzilla.org/</ulink> for details. - Read the other parts of this Guide for installation instructions. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I install Bugzilla on Windows NT? - </para> - </question> - <answer> - <para> - Installation on Windows NT has its own section in - this document. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Is there an easy way to change the Bugzilla cookie name? - </para> - </question> - <answer> - <para> - At present, no. - </para> - </answer> - </qandaentry> - - </qandadiv> - <qandadiv id="faq-security"> <title>Bugzilla Security</title> @@ -739,15 +607,14 @@ <question> <para> 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!)? + (I've followed the instructions in the installation section of this guide)? </para> </question> <answer> <para> Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this makes MySQL as secure as taping a $100 to the floor of a football stadium - bathroom for safekeeping.</emphasis> Please read the Security section of the - Administration chapter of "The Bugzilla Guide" before proceeding. + bathroom for safekeeping.</emphasis> </para> </answer> </qandaentry> @@ -815,8 +682,8 @@ </question> <answer> <para> - Edit the "changedmail" param. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)". + Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". </para> </answer> </qandaentry> @@ -1002,7 +869,7 @@ <qandaentry> <question> <para> - I think I've set up MySQL permissions correctly, but bugzilla still can't + I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. </para> </question> @@ -1162,6 +1029,20 @@ <qandaentry> <question> <para> + How do I change my user name (email address) in Bugzilla? + </para> + </question> + <answer> + <para> + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> The query page is very confusing. Isn't there a simpler way to query? </para> </question> @@ -1184,7 +1065,7 @@ <answer> <para> The current behavior is acceptable to bugzilla.mozilla.org and most - users. I personally don't like it. You have your choice of patches + users. You have your choice of patches to change this behavior, however. <simplelist> <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> @@ -1192,8 +1073,8 @@ <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> "Accept" button automatically assigns to you</ulink></member> </simplelist> - 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. + Note that these patches are somewhat dated. You will need to apply + them manually. </para> </answer> </qandaentry> @@ -1224,7 +1105,7 @@ <answer> <para> 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 + filename. This will not be fixed anytime soon, because it would cripple some other functionality. </para> </answer> @@ -1288,9 +1169,7 @@ http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your localconfig file in the appropriate area, re-running checksetup.pl, and then changing the default priority in your browser using - "editparams.cgi". 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... + "editparams.cgi". </para> </answer> </qandaentry> @@ -1325,7 +1204,7 @@ <listitem> <para> Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) 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 diff --git a/docs/xml/gfdl.xml b/docs/xml/gfdl.xml index d9e18de38..047646411 100644 --- a/docs/xml/gfdl.xml +++ b/docs/xml/gfdl.xml @@ -1,10 +1,10 @@ <!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="gfdl"> +<section id="gfdl"> <title>GNU Free Documentation License</title> <!-- - GNU Project - Free Software Foundation (FSF) --> <!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" --> -<!-- sect1> +<!-- section> <title>GNU Free Documentation License</title --> <para>Version 1.1, March 2000</para> @@ -15,7 +15,7 @@ not allowed.</para> </blockquote> - <sect1 label="0" id="gfdl-0"> + <section label="0" id="gfdl-0"> <title>PREAMBLE</title> <para>The purpose of this License is to make a manual, textbook, or other @@ -38,9 +38,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="1" id="gfdl-1"> + <section label="1" id="gfdl-1"> <title>APPLICABILITY AND DEFINITIONS</title> <para>This License applies to any manual or other work that contains a @@ -98,9 +98,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="2" id="gfdl-2"> + <section label="2" id="gfdl-2"> <title>VERBATIM COPYING</title> <para>You may copy and distribute the Document in any medium, either @@ -115,9 +115,9 @@ <para>You may also lend copies, under the same conditions stated above, and you may publicly display copies.</para> - </sect1> + </section> - <sect1 label="3" id="gfdl-3"> + <section label="3" id="gfdl-3"> <title>COPYING IN QUANTITY</title> <para>If you publish printed copies of the Document numbering more than @@ -154,9 +154,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="4" id="gfdl-4"> + <section label="4" id="gfdl-4"> <title>MODIFICATIONS</title> <para>You may copy and distribute a Modified Version of the Document @@ -284,9 +284,9 @@ <para>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.</para> - </sect1> + </section> - <sect1 label="5" id="gfdl-5"> + <section label="5" id="gfdl-5"> <title>COMBINING DOCUMENTS</title> <para>You may combine the Document with other documents released under @@ -310,9 +310,9 @@ "History"; likewise combine any sections entitled "Acknowledgements", and any sections entitled "Dedications". You must delete all sections entitled "Endorsements."</para> - </sect1> + </section> - <sect1 label="6" id="gfdl-6"> + <section label="6" id="gfdl-6"> <title>COLLECTIONS OF DOCUMENTS</title> <para>You may make a collection consisting of the Document and other @@ -326,9 +326,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="7" id="gfdl-7"> + <section label="7" id="gfdl-7"> <title>AGGREGATION WITH INDEPENDENT WORKS</title> <para>A compilation of the Document or its derivatives with other @@ -345,9 +345,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="8" id="gfdl-8"> + <section label="8" id="gfdl-8"> <title>TRANSLATION</title> <para>Translation is considered a kind of modification, so you may @@ -360,9 +360,9 @@ License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.</para> - </sect1> + </section> - <sect1 label="9" id="gfdl-9"> + <section label="9" id="gfdl-9"> <title>TERMINATION</title> <para>You may not copy, modify, sublicense, or distribute the Document @@ -372,9 +372,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="10" id="gfdl-10"> + <section label="10" id="gfdl-10"> <title>FUTURE REVISIONS OF THIS LICENSE</title> <para>The Free Software Foundation may publish new, revised versions of @@ -394,9 +394,9 @@ 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.</para> - </sect1> + </section> - <sect1 label="" id="gfdl-howto"> + <section label="" id="gfdl-howto"> <title>How to use this License for your documents</title> <para>To use this License in a document you have written, include a copy @@ -422,8 +422,8 @@ 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.</para> - </sect1> -</appendix> + </section> +</section> <!-- Keep this comment at the end of the file Local variables: diff --git a/docs/xml/glossary.xml b/docs/xml/glossary.xml index 3e40df58a..cc5d4fb69 100644 --- a/docs/xml/glossary.xml +++ b/docs/xml/glossary.xml @@ -15,10 +15,7 @@ to keep secret files which would otherwise compromise your installation - e.g. the <filename>localconfig</filename> - - 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 + file contains the password to your database. curious.</para> </glossdef> </glossentry> @@ -56,7 +53,7 @@ <glossdef> <para>A - <quote>Bug</quote> + <quote>bug</quote> in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Some also refer to a @@ -71,33 +68,19 @@ <glossterm>Bug Number</glossterm> <glossdef> - <para>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 + <para>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.</para> </glossdef> </glossentry> <glossentry> - <glossterm>Bug Life Cycle</glossterm> - - <glossdef> - <para>A Bug has stages through which it must pass before becoming a - <quote>closed bug</quote>, - including acceptance, resolution, and verification. The - <quote>Bug Life Cycle</quote> - - is moderately flexible according to the needs of the organization - using it, though.</para> - </glossdef> - </glossentry> - - <glossentry> <glossterm>Bugzilla</glossterm> <glossdef> - <para>Bugzilla is the industry-standard bug tracking system. It is - quite popular among Open Source enthusiasts.</para> + <para>Bugzilla is the world-leading free software bug tracking system. + </para> </glossdef> </glossentry> </glossdiv> @@ -127,14 +110,11 @@ <acronym>CPAN</acronym> stands for the - <quote>Comprehensive Perl Archive Network</quote> - - . CPAN maintains a large number of extremely useful + <quote>Comprehensive Perl Archive Network</quote>. + CPAN maintains a large number of extremely useful <glossterm>Perl</glossterm> - - modules. By themselves, Perl modules generally do nothing, but when - used as part of a larger program, they provide much-needed algorithms - and functionality.</para> + modules - encapsulated chunks of code for performing a + particular task.</para> </glossdef> </glossentry> </glossdiv> @@ -169,33 +149,16 @@ <quote>Groups</quote> 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 + mechanism comes by placing users in groups, and assigning those + groups certain privileges to view bugs in particular <glossterm>Products</glossterm> - - and - <glossterm>Components</glossterm> - in the <glossterm>Bugzilla</glossterm> - database.</para> </glossdef> </glossentry> </glossdiv> - <glossdiv id="gloss-i"> - <title>I</title> - - <glossentry id="gloss-infiniteloop"> - <glossterm>Infinite Loop</glossterm> - - <glossdef> - <para>A loop of information that never ends; see recursion.</para> - </glossdef> - </glossentry> - </glossdiv> - <glossdiv id="gloss-m"> <title>M</title> @@ -221,10 +184,11 @@ <glossterm id="gloss-product">Product</glossterm> <glossdef> - <para>A Product is a broad category of types of bugs. In general, - there are several Components to a Product. A Product may also define a + <para>A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, + there are several Components to a Product. A Product may define a group (used for security) for all bugs entered into - components beneath it.</para> + its Components.</para> </glossdef> </glossentry> @@ -262,24 +226,7 @@ bugs over their life cycle, thus the need for the <quote>QA Contact</quote> - field in a Bug.</para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss-r"> - <title>R</title> - - <glossentry id="gloss-recursion" xreflabel="Recursion"> - <glossterm>Recursion</glossterm> - - <glossdef> - <para>The property of a function looking back at itself for - something. - <quote>GNU</quote>, for instance, stands for - <quote>GNU's Not UNIX</quote>, - thus recursing upon itself for definition. For further clarity, see - Infinite Loop.</para> + field in a bug.</para> </glossdef> </glossentry> </glossdiv> diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml index 8cadbdd58..0433b4b52 100644 --- a/docs/xml/installation.xml +++ b/docs/xml/installation.xml @@ -1,1729 +1,1766 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> +<chapter id="installation" xreflabel="Bugzilla Installation"> + <title>Installation</title> - <chapter id="installation" xreflabel="Bugzilla Installation"> - <title>Installation</title> - <para> - 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. - </para> - <section id="errata"> - <title>ERRATA</title> - <para>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.</para> - - <simplelist> - <member> - If you are installing Bugzilla on S.u.S.e. Linux, or some - other distributions with <quote>paranoid</quote> security - options, it is possible that the checksetup.pl script may fail - with the error: <errorname>cannot chdir(/var/spool/mqueue): - Permission denied</errorname> This is because your - <filename>/var/spool/mqueue</filename> directory has a mode of - <quote>drwx------</quote>. Type <command>chmod 755 - <filename>/var/spool/mqueue</filename></command> as root to - fix this problem. - </member> - - <member> - 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 - </member> - - <member> - Release Notes for Bugzilla &bz-ver; are available at - <filename>docs/rel_notes.txt</filename> in your Bugzilla - source distribution. - </member> - - <member> - 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. - </member> - - </simplelist> - - <warning> - <para> - 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. - </para> - </warning> - - <warning> - <para> - 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. - </para> - </warning> - </section> - <section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step"> <title>Step-by-step Install</title> + <section> <title>Introduction</title> - <para> - 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. - </para> - - <para> - 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 <xref linkend="win32" /> for further advice - on getting Bugzilla to work on Microsoft Windows. - </para> - - <para> - 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). - </para> + + <para>Bugzilla has been successfully installed under Solaris, Linux, + and Win32. Win32 is not yet officially supported, but many people + have got it working fine. + Please see the + <xref linkend="win32" /> + for further advice on getting Bugzilla to work on Microsoft + Windows.</para> + </section> + <section> - <title>Installing the Prerequisites</title> + <title>Package List</title> + <note> - <para>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 <xref linkend="bundlebugzilla" /></para> + <para> If you are running the very most recent + version of Perl and MySQL (both the executables and development + libraries) on your system, you can skip these manual installation + steps for the Perl modules by using Bundle::Bugzilla; see + <xref linkend="bundlebugzilla" />. + </para> </note> + + <para>The software packages necessary for the proper running of + Bugzilla (with download links) are: + <orderedlist> + + +<listitem> + <para> + <ulink url="http://www.mysql.com/">MySQL database server</ulink> + (3.22.5 or greater) + </para> +</listitem> + +<listitem> + <para> + <ulink url="http://www.perl.org">Perl</ulink> + (5.005 or greater, 5.6.1 is recommended if you wish to + use Bundle::Bugzilla) + </para> +</listitem> + +<listitem> + <para>Perl Modules (minimum version): + <orderedlist> + <listitem> <para> - The software packages necessary for the proper running of bugzilla are: - <orderedlist> - <listitem> - <para> - MySQL database server and the mysql client (3.22.5 or greater) - </para> - </listitem> - <listitem> - <para> - Perl (5.004 or greater, 5.6.1 is recommended if you wish - to use Bundle::Bugzilla) - </para> - </listitem> - <listitem> - <para> - DBI Perl module - </para> - </listitem> - <listitem> - <para> - Data::Dumper Perl module - </para> - </listitem> - <listitem> - <para> - Bundle::Mysql Perl module collection - </para> - </listitem> - <listitem> - <para> - TimeDate Perl module collection - </para> - </listitem> - <listitem> - <para> - GD perl module (1.8.3) (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - Chart::Base Perl module (0.99c) (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - DB_File Perl module (optional, for bug charting) - </para> - </listitem> - <listitem> - <para> - The web server of your choice. Apache is recommended. - </para> - </listitem> - <listitem> - <para> - MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </para> - </listitem> - </orderedlist> - - <warning> - <para> - It is a good idea, while installing Bugzilla, to ensure it - is not <emphasis>accessible</emphasis> 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. - </para> - </warning> - <note> - <para>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 - <filename>urpmi</filename> utility. If you follow these - commands, you should have everything you need for - Bugzilla, and <filename>checksetup.pl</filename> should - not complain about any missing libraries. You may already - have some of these installed.</para> - <simplelist> - <member><prompt>bash#</prompt><command> urpmi - perl-mysql</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-chart</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-gd</command></member> - <member><prompt>bash#</prompt><command> urpmi - perl-MailTools</command> (for Bugzilla email - integration)</member> - <member><prompt>bash#</prompt><command> urpmi - apache-modules</command></member> - </simplelist> - </note> - + <ulink url="http://www.template-toolkit.org">Template</ulink> + (v2.07) </para> - </section> - <section id="install-mysql"> - <title>Installing MySQL Database</title> + </listitem> + + <listitem> <para> - Visit MySQL homepage at <ulink - url="http://www.mysql.com">www.mysql.com</ulink> and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in <filename>/var</filename> 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 <filename>configure</filename>. + <ulink url="http://www.cpan.org/modules/by-module/AppConfig/">AppConfig + </ulink> + (v1.52) </para> - <para> - If you install from source or non-package (RPM, deb, etc.) - binaries you need to add - <firstterm>mysqld</firstterm> 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. - <note> - <para>You should have your init script start - <glossterm>mysqld</glossterm> with the ability to accept - large packets. By default, <filename>mysqld</filename> - only accepts packets up to 64K long. This limits the size - of attachments you may put on bugs. If you add <option>-O - max_allowed_packet=1M</option> to the command that starts - <filename>mysqld</filename> (or - <filename>safe_mysqld</filename>), then you will be able - to have attachments up to about 1 megabyte.</para> - </note> + </listitem> - </para> - <note> - <para> - If you plan on running Bugzilla and MySQL on the same - machine, consider using the <option>--skip-networking</option> - option in the init script. This enhances security by - preventing network access to MySQL. - </para> - </note> - </section> - - <section id="install-perl"> - <title>Perl (5.004 or greater)</title> + <listitem> <para> - 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 &perl-ver;. + <ulink url="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz">Text::Wrap</ulink> + (v2001.0131) </para> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://search.cpan.org/search?dist=File-Spec">File::Spec + </ulink> + (v0.8.2) </para> - <warning> - <para>Many people complain that Perl modules will not install - for them. Most times, the error messages complain that they - are missing a file in <quote>@INC</quote>. 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 - <emphasis>are</emphasis> the local UNIX sysadmin, please - consult the newsgroup/mailing list for further assistance or - hire someone to help you out. - </para> - </warning> - <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> - <para> - You can skip the following Perl module installation steps by - installing <productname>Bundle::Bugzilla</productname> from - <glossterm linkend="gloss-cpan">CPAN</glossterm>, 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 &perl-ver;) - </para> - <para> - <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN - -e 'install "Bundle::Bugzilla"'</command> - </computeroutput> - </para> - <para> - 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. - </para> - </tip> - </section> - - <section> - <title>DBI Perl Module</title> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/Data/">Data::Dumper + </ulink> + (any) </para> + </listitem> + + <listitem> <para> - 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 <xref linkend="downloadlinks" />. + <ulink url="http://www.cpan.org/modules/by-module/Mysql/">DBD::mysql + </ulink> + (v1.2209) </para> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/DBI/">DBI</ulink> + (v1.13) </para> + </listitem> + + <listitem> <para> - To use the CPAN shell to install DBI: - <informalexample> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>perl -MCPAN -e 'install "DBI"'</command> - </computeroutput> - <note> - <para>Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc.</para> - </note> - </para> - </informalexample> - To do it the hard way: - <informalexample> - <para> - Untar the module tarball -- it should create its own directory - </para> - <para> - CD to the directory just created, and enter the following commands: - <orderedlist> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>perl Makefile.PL</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make test</command> - </computeroutput> - </para> - </listitem> - <listitem> - <para> - <computeroutput> - <prompt>bash#</prompt> - <command>make install</command> - </computeroutput> - </para> - </listitem> - </orderedlist> - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. - </para> - </informalexample> + <ulink url="http://www.cpan.org/modules/by-module/Date/">Date::Parse + </ulink> + (any) </para> - </section> - <section> - <title>Data::Dumper Perl Module</title> + </listitem> + + <listitem> <para> - 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. + CGI::Carp + (any) </para> + </listitem> + + </orderedlist> + and, optionally: + <orderedlist> + <listitem> <para> - Data::Dumper is used by the MySQL-related Perl modules. It - can be found on CPAN (see <xref linkend="downloadlinks" />) and - can be - installed by following the same four step make sequence used - for the DBI module. + <ulink url="http://www.cpan.org/modules/by-module/GD/">GD</ulink> + (v1.19) for bug charting </para> - </section> - - <section> - <title>MySQL related Perl Module Collection</title> + </listitem> + + <listitem> <para> - 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. + <ulink url="http://www.cpan.org/modules/by-module/Chart/">Chart::Base + </ulink> + (v0.99c) for bug charting </para> + </listitem> + + <listitem> <para> - The MySQL modules are all built using one make file which is generated - by running: - <prompt>bash#</prompt> - <command>perl Makefile.pl</command> + XML::Parser + (any) for the XML interface </para> + </listitem> + + <listitem> <para> - 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. + MIME::Parser + (any) for the email interface </para> - <para> - 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. - </para> - <para> - 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. - </para> - </section> - - <section> - <title>TimeDate Perl Module Collection</title> - <para> - 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: <xref linkend="downloadlinks" />). 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. - </para> - </section> - <section> - <title>GD Perl Module (1.8.3)</title> - <para> - 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. - </para> - <para> - 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 <xref linkend="downloadlinks" />. - </para> - <note> - <para> - The Perl GD library requires some other libraries that may - or may not be installed on your system, including - <classname>libpng</classname> and - <classname>libgd</classname>. 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. - </para> - </note> - </section> - - <section> - <title>Chart::Base Perl Module (0.99c)</title> - <para> - 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 <xref linkend="downloadlinks" />. 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. - </para> - </section> - - <section> - <title>DB_File Perl Module</title> - <para> - 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. - </para> - </section> - - <section> - <title>HTTP Server</title> - <para> - 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 <quote>bugs</quote> user permissions accordingly. - <note> - <para>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.</para> - </note> - </para> - <para> - 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: - <programlisting> -AddHandler cgi-script .cgi - </programlisting> - </para> - <para> - With apache you'll also want to make sure that within the - access.conf file the line: - <programlisting> -Options ExecCGI -AllowOverride Limit -</programlisting> - is in the stanza that covers the directories into which - you intend to put the bugzilla .html and .cgi files. - </para> + </listitem> + </orderedlist> + </para> +</listitem> + + +<listitem> + <para> + The web server of your choice. + <ulink url="http://www.apache.org/">Apache</ulink> + is highly recommended. + </para> +</listitem> + + + </orderedlist> + + <warning> + <para>It is a good idea, while installing Bugzilla, to ensure that there + is some kind of firewall between you and the rest of the Internet, + because your machine may be insecure for periods during the install. + 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.</para> + </warning> + <note> - <para> - AllowOverride Limit allows the use of a Deny statement in the - .htaccess file generated by checksetup.pl - </para> - <para> - 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. - </para> + <para>Linux-Mandrake 8.0 includes every + required and optional library for Bugzilla. The easiest way to + install them is by using the + <filename>urpmi</filename> + + utility. If you follow these commands, you should have everything you + need for Bugzilla, and + <filename>checksetup.pl</filename> + + should not complain about any missing libraries. You may already have + some of these installed.</para> + + <simplelist> + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-mysql</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-chart</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-gd</command> + </member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi perl-MailTools</command> + + (for Bugzilla email integration)</member> + + <member> + <prompt>bash#</prompt> + + <command>urpmi apache-modules</command> + </member> + </simplelist> </note> - <warning> - <para> - There are important files and directories that should not - be a served by the HTTP server. These are most files in the - <quote>data</quote> and <quote>shadow</quote> directories - and the <quote>localconfig</quote> 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 <xref linkend="htaccess" /> for details - on how to do this for Apache. I appreciate notes on how to - get this same functionality using other webservers. - </para> - </warning> - </section> - - <section> - <title>Installing the Bugzilla Files</title> - <para> - You should untar the Bugzilla files into a directory that - you're willing to make writable by the default web server user - (probably <quote>nobody</quote>). You may decide to put the - files off of the main web space for your web server or perhaps - off of <filename>/usr/local</filename> 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. - </para> - <tip> - <para> - If you symlink the bugzilla directory into your Apache's - HTML heirarchy, you may receive - <errorname>Forbidden</errorname> errors unless you add the - <quote>FollowSymLinks</quote> directive to the - <Directory> entry for the HTML root. - </para> - </tip> - <para> - 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 - <filename>checksetup.pl</filename> script, which locks down your - installation. </para> - <para> - Lastly, you'll need to set up a symbolic link to - <filename>/usr/bonsaitools/bin/perl</filename> for the correct - location of your perl executable (probably - <filename>/usr/bin/perl</filename>). Otherwise you must hack - all the .cgi files to change where they look for perl, or use - <xref linkend="setperl" />, found in - <xref linkend="patches" />. I suggest using the symlink - approach for future release compatability. - <example> - <title>Setting up bonsaitools symlink</title> - <para> - 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 - <quote>/usr/local/bin/perl</quote> for - <quote>/usr/bin/perl</quote> below; if on certain other - UNIX systems, Perl may live in weird places like - <quote>/opt/perl</quote>. As root, run these commands: - <programlisting> -bash# mkdir /usr/bonsaitools -bash# mkdir /usr/bonsaitools/bin -bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl - </programlisting> - </para> - <para> - Alternately, you can simply run this perl one-liner to - change your path to perl in all the files in your Bugzilla - installation: - <programlisting> -perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm -processmail syncshadowdb - </programlisting> - Change the second path to perl to match your installation. - </para> - </example> - <tip> - <para> - If you don't have root access to set this symlink up, - check out the - <xref linkend="setperl" />, listed in <xref - linkend="patches" />. It will change the path to perl in all your Bugzilla files for you. - </para> - </tip> - </para> - </section> - - <section> - <title>Setting Up the MySQL Database</title> - <para> - 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. - </para> - <para> - 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 <quote>bugs</quote>, and will - have minimal permissions. - - <warning> - <para> - 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 <command>DROP - DATABASE mysql</command>. - </para> - <para>That would be bad.</para> - </warning> + </section> + + <section id="install-mysql"> + <title>MySQL</title> + + <para>Visit the MySQL homepage at + <ulink url="http://www.mysql.com">www.mysql.com</ulink> + to grab and install the latest stable release of the server. </para> - <para> - Give the MySQL root user a password. MySQL passwords are - limited to 16 characters. - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> <command>mysql - -u root mysql</command> </computeroutput> - </member> - <member> - <computeroutput> <prompt>mysql></prompt> <command> - UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root'; </command> </computeroutput> - </member> - <member> - <computeroutput> <prompt>mysql></prompt> <command>FLUSH - PRIVILEGES;</command> </computeroutput> - </member> - </simplelist> From this point on, if you need to access - MySQL as the MySQL root user, you will need to use - <command>mysql -u root -p</command> and enter your - new_password. Remember that MySQL user names have nothing to - do with Unix user names (login names). - </para> - <para> - Next, we create the <quote>bugs</quote> user, and grant - sufficient permissions for checksetup.pl, which we'll use - later, to work its magic. This also restricts the - <quote>bugs</quote> user to operations within a database - called <quote>bugs</quote>, and only allows the account to - connect from <quote>localhost</quote>. Modify it to reflect - your setup if you will be connecting from another machine or - as a different user. - </para> - <para> - Remember to set bugs_password to some unique password. - <simplelist> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, - ALTER,CREATE,DROP,REFERENCES - ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt> - mysql> - </prompt> - <command> - FLUSH PRIVILEGES; - </command> - </computeroutput> - </member> - </simplelist> - </para> - <para> - 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 - <filename>data</filename> directory, and create all the MySQL - tables. - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> - <command>./checksetup.pl</command> </computeroutput> - </member> - </simplelist> The first time you run it, it will create a - file called <filename>localconfig</filename>. + <note> + <para> Many of the binary + versions of MySQL store their data files in + <filename>/var</filename>. + On some Unix systems, this is part of a smaller root partition, + and may not have room for your bug database. You can set the data + directory as an option to <filename>configure</filename> + if you build MySQL from source yourself.</para> + </note> + + <para>If you install from something other than an RPM or Debian + package, you will need to add <filename>mysqld</filename> + 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. </para> + + <para>Change your init script to start + <filename>mysqld</filename> + with the ability to accept large packets. By default, + <filename>mysqld</filename> + only accepts packets up to 64K long. This limits the size of + attachments you may put on bugs. If you add + <option>-O max_allowed_packet=1M</option> + to the command that starts + <filename>mysqld</filename> + (or <filename>safe_mysqld</filename>), + then you will be able to have attachments up to about 1 megabyte. + There is a Bugzilla parameter for maximum attachment size; + you should configure it to match the value you choose here.</para> + + <para>If you plan on running Bugzilla and MySQL on the same machine, + consider using the + <option>--skip-networking</option> + option in the init script. This enhances security by preventing + network access to MySQL.</para> + </section> + + <section id="install-perl"> + <title>Perl</title> + + <para>Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from + <ulink url="http://www.perl.com">perl.com</ulink> for the rare + *nix systems which don't have it. + Although Bugzilla runs with all post-5.005 + 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 &perl-ver;.</para> + + <tip id="bundlebugzilla" + xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> + + <para>You can skip the following Perl module installation steps by + installing + <productname>Bundle::Bugzilla</productname> + + from + <glossterm linkend="gloss-cpan">CPAN</glossterm>, + which installs all required modules for you.</para> + + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>perl -MCPAN -e 'install "Bundle::Bugzilla"'</command> + </computeroutput> + </para> + + <para>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.</para> + </tip> + </section> + + <section id="perl-modules"> + <title>Perl Modules</title> + + <para> + All Perl modules can be found on the + <ulink url="http://www.cpan.org">Comprehensive Perl + Archive Network</ulink> (CPAN). The + CPAN servers have a real tendency to bog down, so please use mirrors. + </para> - <section> - <title>Tweaking <filename>localconfig</filename></title> - <para> - This file contains a variety of settings you may need to tweak including - how Bugzilla should connect to the MySQL database. - </para> - <para> - The connection settings include: - <orderedlist> - <listitem> - <para> - server's host: just use <quote>localhost</quote> if the - MySQL server is local - </para> - </listitem> - <listitem> - <para> - database name: <quote>bugs</quote> if you're following - these directions - </para> - </listitem> - <listitem> - <para> - MySQL username: <quote>bugs</quote> if you're following - these directions - </para> - </listitem> - <listitem> - <para> - Password for the <quote>bugs</quote> MySQL account above - </para> - </listitem> - </orderedlist> + <para>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. + To use the CPAN shell to install a module: </para> + <para> - You should also install .htaccess files that the Apache - webserver will use to restrict access to Bugzilla data files. - See <xref - linkend="htaccess" />. + <computeroutput> + <prompt>bash#</prompt> + <command>perl -MCPAN -e 'install "<modulename>"'</command> + </computeroutput> </para> + <para> - Once you are happy with the settings, re-run - <filename>checksetup.pl</filename>. On this second run, it will - create the database and an administrator account for which - you will be prompted to provide information. + To do it the hard way: </para> - <para> - 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 <quote>edit parameters</quote> option - that is filled with editable treats. + + <para>Untar the module tarball -- it should create its own + directory</para> + + <para>CD to the directory just created, and enter the following + commands: + <orderedlist> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>perl Makefile.PL</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make test</command> + </computeroutput> + </para> + </listitem> + + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>make install</command> + </computeroutput> + </para> + </listitem> + </orderedlist> </para> - <para> - Should everything work, you will have a nearly empty Bugzilla - database and a newly-created <filename>localconfig</filename> - file in your Bugzilla root directory. + + <warning> + <para>Many people complain that Perl modules will not install for + them. Most times, the error messages complain that they are missing a + file in + <quote>@INC</quote>. + Virtually every time, this error 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 + <emphasis>are</emphasis> + the local UNIX sysadmin, please consult the newsgroup/mailing list + for further assistance or hire someone to help you out.</para> + </warning> + + + <section> + <title>DBI</title> + + <para>The DBI module is a generic Perl module used 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.</para> + </section> + + <section> + <title>Data::Dumper</title> + + <para>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.</para> + </section> + + <section> + <title>MySQL-related modules</title> + + <para>The Perl/MySQL interface requires a few mutually-dependent Perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package.</para> + + <para>The MakeMaker process will ask you a few questions about the + desired compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if your + desired target is the MySQL or mSQL packages, you should + 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.</para> + + <para>A host of 'localhost' should be fine and a testing user of 'test' + with a null password should find itself with sufficient access to run + tests on the 'test' database which MySQL created upon installation. </para> - <para> - <note> - <para> - 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 <quote>webservergroup</quote> 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 <quote>webserveruser</quote> parameter in - localconfig as well. - <example> - <title>Running checksetup.pl as the web user</title> - <para> - 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 <emphasis>second run</emphasis> of - checksetup.pl, do this: - <programlisting> -bash# chown -R apache:apache /usr/local/bugzilla -bash# su - apache -bash# cd /usr/local/bugzilla -bash# ./checksetup.pl - </programlisting> - </para> - </example> - </para> - </note> + </section> + + <section> + <title>TimeDate modules</title> + + <para>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. + The component module we're most interested in is the Date::Format + module, but installing all of them is probably a good idea anyway. </para> + </section> + + <section> + <title>GD (optional)</title> + + <para>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.</para> + <note> - <para> - 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. - </para> + <para>The Perl GD library requires some other libraries that may or + may not be installed on your system, including + <classname>libpng</classname> + and + <classname>libgd</classname>. + The full requirements are listed in the Perl GD library README. + If compiling GD fails, it's probably because you're + missing a required library.</para> </note> </section> + + <section> + <title>Chart::Base (optional)</title> + + <para>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. + Note that earlier versions that 0.99c used GIFs, which are no longer + supported by the latest versions of GD.</para> + </section> <section> - <title>Setting Up Maintainers Manually (Optional)</title> - <para> - If you want to add someone else to every group by hand, you - can do it by typing the appropriate MySQL commands. Run - <command> mysql -u root -p bugs</command> You - may need different parameters, depending on your security - settings. Then: - <simplelist> - <member> - <computeroutput> <prompt>mysql></prompt> <command>update - profiles set groupset=0x7fffffffffffffff where - login_name = 'XXX';</command> </computeroutput> (yes, that's <emphasis>fifteen</emphasis><quote>f</quote>'s. - </member> - </simplelist> replacing XXX with the Bugzilla email address. - </para> - </section> - - <section> - <title>The Whining Cron (Optional)</title> - <para> - 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): - <simplelist> - <member> - <computeroutput> <command>cd - <your-bugzilla-directory> ; - ./whineatnews.pl</command> </computeroutput> - </member> - </simplelist> + <title>Template Toolkit</title> + + <para>When you install Template Toolkit, you'll get asked various + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. However, there are + known problems with XS Stash and Perl 5.005_02 and lower. If you + wish to use these older versions of Perl, please use the regular + stash.</para> + </section> + + + </section> + + <section> + <title>HTTP Server</title> + + <para>You have a freedom of choice here - Apache, Netscape or any other + server on UNIX would do. You can run the web server on a + different machine than MySQL, but need to adjust the MySQL + <quote>bugs</quote> + user permissions accordingly. + <note> + <para>We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us.</para> + </note> + </para> + + <para>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 httpd.conf + file: + <programlisting>AddHandler cgi-script .cgi</programlisting> + </para> + + <para>With Apache you'll also want to make sure that within the + httpd.conf file the line: + <programlisting>Options ExecCGI AllowOverride Limit</programlisting> + + is in the stanza that covers the directories into which you intend to + put the bugzilla .html and .cgi files. + + <note> + <para>AllowOverride Limit allows the use of a Deny statement in the + .htaccess file generated by checksetup.pl</para> + + <para>Users of older versions of Apache may find the above lines + in the srm.conf and access.conf files, respecitvely.</para> + </note> </para> + + <warning> + <para>There are important files and directories that should not be a + served by the HTTP server - most files in the + <quote>data</quote> + and + <quote>shadow</quote> + directories and the + <quote>localconfig</quote> + file. You should configure your HTTP server to not serve + these files. Failure to do so will expose critical passwords and + other data. Please see + <xref linkend="htaccess" /> + for details on how to do this for Apache; the checksetup.pl + script should create appropriate .htaccess files for you.</para> + </warning> + </section> + + <section> + <title>Bugzilla</title> + + <para>You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + <quote>nobody</quote>). + You may decide to put the files in the main web space for your + web server or perhaps in + <filename>/usr/local</filename> + with a symbolic link in the web space that points to the Bugzilla + directory.</para> + <tip> - <para> - Depending on your system, crontab may have several manpages. - The following command should lead you to the most useful - page for this purpose: - <programlisting> - man 5 crontab - </programlisting> - </para> + <para>If you symlink the bugzilla directory into your Apache's HTML + heirarchy, you may receive + <errorname>Forbidden</errorname> + errors unless you add the + <quote>FollowSymLinks</quote> + directive to the <Directory> entry for the HTML root + in httpd.conf.</para> </tip> + + <para>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 + <filename>checksetup.pl</filename> + script, which locks down your installation.</para> + + <para>Lastly, you'll need to set up a symbolic link to + <filename>/usr/bonsaitools/bin/perl</filename> + for the correct location of your Perl executable (probably + <filename>/usr/bin/perl</filename>). + Otherwise you must hack all the .cgi files to change where they look + for Perl. This can be done using the following Perl one-liner, but + I suggest using the symlink approach to avoid upgrade hassles. + </para> + + <para> + <programlisting>perl -pi -e + 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm + processmail syncshadowdb</programlisting> + + Change <filename>/usr/bin/perl</filename> to match the location + of Perl on your machine. + </para> </section> - + <section> - <title>Bug Graphs (Optional)</title> - <para> - As long as you installed the GD and Graph::Base Perl modules - you might as well turn on the nifty bugzilla bug reporting - graphs. + <title>Setting Up the MySQL Database</title> + + <para>After you've gotten all the software installed and working you're + ready to start preparing the database for its life as the back end to + a high quality bug tracker.</para> + + <para>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 + <quote>bugs</quote>, and will have minimal permissions. </para> - <para> - Add a cron entry like this to run collectstats daily at 5 - after midnight: - <simplelist> - <member> - <computeroutput> <prompt>bash#</prompt> <command>crontab - -e</command> </computeroutput> - </member> - <member> - <computeroutput> 5 0 * * * cd - <your-bugzilla-directory> ; ./collectstats.pl - </computeroutput> - </member> - </simplelist> + + <para>Begin by giving the MySQL root user a password. MySQL passwords are limited + to 16 characters. + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>mysql -u root mysql</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>UPDATE user SET Password=PASSWORD('<new_password'>) + WHERE user='root';</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> + + From this point on, if you need to access MySQL as the MySQL root user, + you will need to use + <command>mysql -u root -p</command> + + and enter <new_password>. Remember that MySQL user names have + nothing to do with Unix user names (login names).</para> + + <para>Next, we use an SQL <command>GRANT</command> command to create a + <quote>bugs</quote> + + user, and grant sufficient permissions for checksetup.pl, which we'll + use later, to work its magic. This also restricts the + <quote>bugs</quote> + user to operations within a database called + <quote>bugs</quote>, and only allows the account to connect from + <quote>localhost</quote>. + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.</para> + + <para>Remember to set <bugs_password> to some unique password. + <simplelist> + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, + ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '<bugs_password>';</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> </para> - <para> - After two days have passed you'll be able to view bug graphs - from the Bug Reports page. + </section> + + <section> + <title> + <filename>checksetup.pl</filename> + </title> + + <para>Next, run the magic checksetup.pl script. (Many thanks to + <ulink url="mailto:holgerschurig@nikocity.de">Holger Schurig </ulink> + for writing this script!) + This script is designed to make sure your MySQL database and other + configuration options are consistent with the Bugzilla CGI files. + It will make sure Bugzilla files and directories have reasonable + permissions, set up the + <filename>data</filename> + directory, and create all the MySQL tables. + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>./checksetup.pl</command> + </computeroutput> + </member> + </simplelist> + + The first time you run it, it will create a file called + <filename>localconfig</filename>.</para> + + <para>This file contains a variety of settings you may need to tweak + including how Bugzilla should connect to the MySQL database.</para> + + <para>The connection settings include: + <orderedlist> + <listitem> + <para>server's host: just use + <quote>localhost</quote> + if the MySQL server is local</para> + </listitem> + + <listitem> + <para>database name: + <quote>bugs</quote> + if you're following these directions</para> + </listitem> + + <listitem> + <para>MySQL username: + <quote>bugs</quote> + if you're following these directions</para> + </listitem> + + <listitem> + <para>Password for the + <quote>bugs</quote> + MySQL account; (<bugs_password>) above</para> + </listitem> + </orderedlist> </para> + + <para>Once you are happy with the settings, + <filename>su</filename> to the user + your web server runs as, and re-run + <filename>checksetup.pl</filename>. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) + On this second run, it will create the database and an administrator + account for which you will be prompted to provide information.</para> + + <note> + <para>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.</para> + </note> </section> - + <section> <title>Securing MySQL</title> - <para> - 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. - </para> - <para> - Most MySQL installs have "interesting" default security parameters: - <simplelist> - <member>mysqld defaults to running as root</member> - <member>it defaults to allowing external network connections</member> - <member>it has a known port number, and is easy to detect</member> - <member>it defaults to no passwords whatsoever</member> - <member>it defaults to allowing "File_Priv"</member> - </simplelist> - </para> - <para> - 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. + + <para>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.</para> + + <para>Most MySQL installs have "interesting" default security + parameters: + <simplelist> + <member>mysqld defaults to running as root</member> + + <member>it defaults to allowing external network connections</member> + + <member>it has a known port number, and is easy to detect</member> + + <member>it defaults to no passwords whatsoever</member> + + <member>it defaults to allowing "File_Priv"</member> + </simplelist> </para> - <para> - To see your permissions do: - <simplelist> - <member> - <computeroutput> - <prompt>bash#</prompt> - <command>mysql -u root -p</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>use mysql;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>show tables;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>select * from user;</command> - </computeroutput> - </member> - <member> - <computeroutput> - <prompt>mysql></prompt> - <command>select * from db;</command> - </computeroutput> - </member> - </simplelist> + + <para>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.</para> + + <para>To see your permissions do: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>mysql -u root -p</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>use mysql;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>show tables;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>select * from user;</command> + </computeroutput> + </member> + + <member> + <computeroutput> + <prompt>mysql></prompt> + + <command>select * from db;</command> + </computeroutput> + </member> + </simplelist> </para> - <para> - To fix the gaping holes: - <simplelist> - <member>DELETE FROM user WHERE User='';</member> - <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member> - <member> FLUSH PRIVILEGES;</member> - </simplelist> + + <para>To fix the gaping holes: + <simplelist> + <member>DELETE FROM user WHERE User='';</member> + + <member>UPDATE user SET Password=PASSWORD('new_password') WHERE + user='root';</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - If you're not running "mit-pthreads" you can use: - <simplelist> - <member>GRANT USAGE ON *.* TO bugs@localhost;</member> - <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> - <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> - <member>FLUSH PRIVILEGES;</member> - </simplelist> + + <para>If you're not running "mit-pthreads" you can use: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@localhost;</member> + + <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> + + <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - 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: - <simplelist> - <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> - <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> - <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> - <member>FLUSH PRIVILEGES;</member> - </simplelist> + + <para>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: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> + + <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> + + <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> + + <member>FLUSH PRIVILEGES;</member> + </simplelist> </para> - <para> - Use .htaccess files with the Apache webserver to secure your - bugzilla install. See <xref linkend="htaccess" /> + + <para>Consider also: + <orderedlist> + <listitem> + <para>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.</para> + </listitem> + + <listitem> + <para>using the --user= option to mysqld to run it as an + unprivileged user.</para> + </listitem> + + <listitem> + <para>running MySQL in a chroot jail</para> + </listitem> + + <listitem> + <para>running the httpd in a chroot jail</para> + </listitem> + + <listitem> + <para>making sure the MySQL passwords are different from the OS + passwords (MySQL "root" has nothing to do with system + "root").</para> + </listitem> + + <listitem> + <para>running MySQL on a separate untrusted machine</para> + </listitem> + + <listitem> + <para>making backups ;-)</para> + </listitem> + </orderedlist> </para> + </section> + + <section> + <title>Configuring Bugzilla</title> <para> - Consider also: - <orderedlist> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - using the --user= option to mysqld to run it as an unprivileged - user. - </para> - </listitem> - <listitem> - <para> - starting MySQL in a chroot jail - </para> - </listitem> - <listitem> - <para> - running the httpd in a "chrooted" jail - </para> - </listitem> - <listitem> - <para> - making sure the MySQL passwords are different from the OS - passwords (MySQL "root" has nothing to do with system "root"). - </para> - </listitem> - <listitem> - <para> - running MySQL on a separate untrusted machine - </para> - </listitem> - <listitem> - <para> - making backups ;-) - </para> - </listitem> - </orderedlist> + You should run through the parameters on the Edit Parameters page + (link in the footer) and set them all to appropriate values. + They key parameters are documented in <xref linkend="parameters" />. </para> </section> - </section> - <section id="osx"> - <title>Mac OS X Installation Notes</title> - <para> - 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. - </para> - <para> - 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/>. - </para> - <para> - Follow the instructions for setting up Fink. Once it's - installed, you'll want to run the following as root: - <command>fink install gd</command> - </para> - <para> - It will prompt you for a number of dependencies, type 'y' and - hit enter to install all of the dependencies. Then watch it - work. - </para> - <para> - 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 - :-) - </para> - <para> - Instead of typing <quote>install GD</quote> at the - <prompt>cpan></prompt> prompt, type <command>look - GD</command>. 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 <command>patch < - patchfile</command>: - </para> - <para> - <programlisting> -<![CDATA[ - ---- 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') { - -]]> - </programlisting> - </para> - <para> - Then, run these commands to finish the installation of the perl module: - <simplelist> - <member><command>perl Makefile.PL</command></member> - <member><command>make</command></member> - <member><command>make test</command></member> - <member><command>make install</command></member> - <member>And don't forget to run <command>exit</command> to get back to cpan.</member> - </simplelist> - </para> - <para> - Happy Hacking! - </para> - </section> - - <section id="bsdinstall" xreflabel="BSD Installation Notes"> - <title>BSD Installation Notes</title> - <para> - For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please - consult <xref linkend="osx" />. - </para> </section> - - <section id="geninstall" xreflabel="Installation General Notes"> - <title>Installation General Notes</title> + <section id="extraconfig"> + <title>Optional Additional Configuration</title> + <section> - <title>Modifying Your Running System</title> - <para> - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory. + <title>Dependency Charts</title> + + <para>As well as the text-based dependency graphs, Bugzilla also + supports dependency graphing, using a package called 'dot'. + Exactly how this works is controlled by the 'webdotbase' parameter, + which can have one of three values: </para> + <para> - If you make a change to the structural data in your database - (the versions table for example), or to the - <quote>constants</quote> encoded in defparams.pl, you will - need to remove the cached content from the data directory - (by doing a <quote>rm data/versioncache</quote>), or your - changes won't show up. + <orderedlist> + <listitem> + <para> + A complete file path to the command 'dot' (part of + <ulink url="http://www.graphviz.org/">GraphViz</ulink>) + will generate the graphs locally + </para> + </listitem> + <listitem> + <para> + A URL prefix pointing to an installation of the webdot package will + generate the graphs remotely + </para> + </listitem> + <listitem> + <para> + A blank value will disable dependency graphing. + </para> + </listitem> + </orderedlist> </para> - <para> - 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. + + <para>So, to get this working, install + <ulink url="http://www.graphviz.org/">GraphViz</ulink>. If you + do that, you need to + <ulink url="http://httpd.apache.org/docs/mod/mod_imap.html">enable + server-side image maps</ulink> in Apache. + Alternatively, you could set up a webdot server, or use the AT&T + public webdot server (the + default for the webdotbase param). Note that AT&T's server won't work + if Bugzilla is only accessible using HTTPS. </para> + </section> + + <section> + <title>Bug Graphs</title> + + <para>As long as you installed the GD and Graph::Base Perl modules you + might as well turn on the nifty Bugzilla bug reporting graphs.</para> + + <para>Add a cron entry like this to run + <filename>collectstats.pl</filename> + daily at 5 after midnight: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + + <command>crontab -e</command> + </computeroutput> + </member> + + <member> + <computeroutput>5 0 * * * cd <your-bugzilla-directory> ; + ./collectstats.pl</computeroutput> + </member> + </simplelist> + </para> + + <para>After two days have passed you'll be able to view bug graphs from + the Bug Reports page.</para> </section> + <section> - <title>Upgrading From Previous Versions</title> + <title>The Whining Cron</title> + + <para>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 to complain at engineers + which leave their bugs in the NEW state without triaging them. + </para> + <para> + This can be done by + adding the following command as a daily crontab entry (for help on that + see that crontab man page): + <simplelist> + <member> + <computeroutput> + <command>cd <your-bugzilla-directory> ; + ./whineatnews.pl</command> + </computeroutput> + </member> + </simplelist> + </para> + + <tip> + <para>Depending on your system, crontab may have several manpages. + The following command should lead you to the most useful page for + this purpose: + <programlisting>man 5 crontab</programlisting> + </para> + </tip> + </section> + + <section id="bzldap"> + <title>LDAP Authentication</title> <para> - A plain Bugzilla is fairly easy to upgrade from one version to a newer one. - However, things get a bit more complicated if you've made changes to - Bugzilla's code. In this case, you may have to re-make or reapply those - changes. - It is recommended that you take a backup of your database and your entire - Bugzilla installation before attempting an upgrade. You can upgrade a 'clean' - installation by untarring a new tarball over the old installation. If you - are upgrading from 2.12 or later, you can type <filename>cvs -z3 - update</filename>, and resolve conflicts if there are any. + <warning> + <para>This information on using the LDAP + authentication options with Bugzilla is old, and the authors do + not know of anyone who has tested it. Approach with caution. + </para> + </warning> </para> + <para> - Because the developers of Bugzilla are constantly adding new tables, columns - and fields, you'll probably get SQL errors if you just update the code and - attempt to use Bugzilla. Always run the checksetup.pl script whenever - you upgrade your installation. + The existing authentication + scheme for Bugzilla uses email addresses as the primary user ID, and a + password to authenticate that user. All places within Bugzilla where + you need to deal with user ID (e.g assigning a bug) use the email + address. The LDAP authentication builds on top of this scheme, rather + than replacing it. The initial log in is done with a username and + password for the LDAP directory. This then fetches the email address + from LDAP and authenticates seamlessly in the standard Bugzilla + authentication scheme using this email address. If an account for this + address already exists in your Bugzilla system, it will log in to that + account. If no account for that email address exists, one is created at + the time of login. (In this case, Bugzilla will attempt to use the + "displayName" or "cn" attribute to determine the user's full name.) + After authentication, all other user-related tasks are still handled by + email address, not LDAP username. You still assign bugs by email + address, query on users by email address, etc. + </para> + + <para>Using LDAP for Bugzilla authentication requires the + Mozilla::LDAP (aka PerLDAP) Perl module. The + Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. + After you have installed the SDK, then install the PerLDAP module. + Mozilla::LDAP and the Directory SDK for C are both + <ulink url="http://www.mozilla.org/directory/">available for + download</ulink> from mozilla.org. </para> + <para> - 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. + Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for + authentication. Be very careful when setting up this parameter; if you + set LDAP authentication, but do not have a valid LDAP directory set up, + you will not be able to log back in to Bugzilla once you log out. (If + this happens, you can get back in by manually editing the data/params + file, and setting useLDAP back to 0.) </para> + + <para>If using LDAP, you must set the + three additional parameters: Set LDAPserver to the name (and optionally + port) of your LDAP server. If no port is specified, it defaults to the + default port of 389. (e.g "ldap.mycompany.com" or + "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching + for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids + must be unique under the DN specified here. Set LDAPmailattribute to + the name of the attribute in your LDAP directory which contains the + primary email address. On most directory servers available, this is + "mail", but you may need to change this. + </para> </section> + + <section id="content-type" + xreflabel="Preventing untrusted Bugzilla content from executing malicious Javascript code"> + + <title>Preventing untrusted Bugzilla content from executing malicious + Javascript code</title> + + <para>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 + <ulink + url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3"> + http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>. + 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.</para> - <section id="htaccess" xreflabel=".htaccess files and security"> - <title><filename>.htaccess</filename> files and security</title> <para> - To enhance the security of your Bugzilla installation, - Bugzilla will generate - <glossterm><filename>.htaccess</filename></glossterm> files - which the Apache webserver can use to restrict access to - the bugzilla data files. The checksetup script will - generate the <filename>.htaccess</filename> files. These .htaccess files - will not work with Apache 1.2.x - but this has security holes, so you - shouldn't be using it anyway. - - <note> - <para> - If you are using an alternate provider of - <productname>webdot</productname> services for graphing - (as described when viewing - <filename>editparams.cgi</filename> in your web - browser), you will need to change the ip address in - <filename>data/webdot/.htaccess</filename> to the ip - address of the webdot server that you are using. - </para> - </note> - + <programlisting>bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl + </programlisting> </para> - <para> - 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 <filename>.htaccess</filename> - file is allowed to override web server defaults. For instance, - let's assume your installation of Bugzilla is installed to - <filename>/usr/local/bugzilla</filename>. You should have - this <Directory> entry in your <filename>httpd.conf</filename> - file: + <para>All this one-liner command does is search for all instances of + <quote>Content-type: text/html</quote> + + and replaces it with + <quote>Content-Type: text/html; charset=ISO-8859-1</quote> + + . 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 + <quote>ISO-8859-1</quote>, above, to + <quote>UTF-8</quote>.</para> + + <para>Note: using <meta> tags to set the charset is not + recommended, as there's a bug in Netscape 4.x which causes pages + marked up in this way to load twice.</para> + </section> + + <section id="htaccess" xreflabel=".htaccess files and security"> + <title> + <filename>.htaccess</filename> + files and security</title> + + <para>To enhance the security of your Bugzilla installation, Bugzilla's + <filename>checksetup.pl</filename> script will generate + <glossterm> + <filename>.htaccess</filename> + </glossterm> + + files which the Apache webserver can use to restrict access to the + bugzilla data files. + These .htaccess files will not work with Apache 1.2.x - but this + has security holes, so you shouldn't be using it anyway. + <note> + <para>If you are using an alternate provider of + <productname>webdot</productname> + + services for graphing (as described when viewing + <filename>editparams.cgi</filename> + + in your web browser), you will need to change the ip address in + <filename>data/webdot/.htaccess</filename> + + to the ip address of the webdot server that you are using.</para> + </note> </para> + <para>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 + <filename>.htaccess</filename> + + file is allowed to override web server defaults. For instance, let's + assume your installation of Bugzilla is installed to + <filename>/usr/local/bugzilla</filename> + + . You should have this <Directory> entry in your + <filename>httpd.conf</filename> + + file:</para> + <para> - <programlisting> -<![CDATA[ -<Directory /usr/local/bugzilla/> + +<programlisting><![CDATA[ + <Directory /usr/local/bugzilla/> Options +FollowSymLinks +Indexes +Includes +ExecCGI AllowOverride All </Directory> -]]> - </programlisting> - </para> +]]></programlisting> - <para> - The important part above is <quote>AllowOverride All</quote>. - Without that, the <filename>.htaccess</filename> file created by - <filename>checksetup.pl</filename> will not have sufficient - permissions to protect your Bugzilla installation. </para> - <para> - If you are using Internet Information Server or other web - server which does not observe <filename>.htaccess</filename> - conventions, you can disable their creation by editing - <filename>localconfig</filename> and setting the - <varname>$create_htaccess</varname> variable to - <parameter>0</parameter>. - </para> - </section> + <para>The important part above is + <quote>AllowOverride All</quote> - <section id="mod-throttle" xreflabel="Using mod_throttle to prevent Denial of Service attacks"> - <title><filename>mod_throttle</filename> and Security</title> - <para> - 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 <filename>mod_throttle</filename> which can limit - connections by ip-address. You may download this module at - <ulink - url="http://www.snert.com/Software/Throttle/">http://www.snert.com/Software/Throttle/</ulink>. Follow the instructions to install into your Apache install. <emphasis>This module only functions with the Apache web server!</emphasis>. You may use the <command>ThrottleClientIP</command> command provided by this module to accomplish this goal. See the <ulink url="http://www.snert.com/Software/Throttle/">Module Instructions</ulink> for more information. </para> - </section> - - <section id="content-type" xreflabel="Preventing untrusted Bugzilla contentfrom executing malicious Javascript code"> - <title>Preventing untrusted Bugzilla content from executing malicious Javascript code</title> - <para>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 <ulink - url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3">http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>. 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. </para> - <para><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 - </programlisting></para> - <para> - All this one-liner command does is search for all instances of - <quote>Content-type: text/html</quote> and replaces it with - <quote>Content-Type: text/html; charset=ISO-8859-1</quote>. - 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 - <quote>ISO-8859-1</quote>, above, to <quote>UTF-8</quote>. + . Without that, the + <filename>.htaccess</filename> + + file created by + <filename>checksetup.pl</filename> + + will not have sufficient permissions to protect your Bugzilla + installation.</para> + + <para>If you are using Internet Information Server (IIS) or another + web server which does not observe + <filename>.htaccess</filename> + conventions, you can disable their creation by editing + <filename>localconfig</filename> + and setting the + <varname>$create_htaccess</varname> + variable to + <parameter>0</parameter>. </para> </section> - - <section id="unixhistory"> - <title>UNIX Installation Instructions History</title> - <para> - This document was originally adapted from the Bonsai - installation instructions by Terry Weissman - <terry@mozilla.org>. - </para> - <para> - 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 <ulink - url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ). - </para> - <para> - 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. - </para> - <para> - 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. - </para> - <para> - Comments from people using this Guide for the first time are - particularly welcome. - </para> + <section id="mod-throttle" + xreflabel="Using mod_throttle to prevent Denial of Service attacks"> + <title> + <filename>mod_throttle</filename> + + and Security</title> + + <para>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 + <filename>mod_throttle</filename> + + which can limit connections by ip-address. You may download this module + at + <ulink url="http://www.snert.com/Software/Throttle/"> + http://www.snert.com/Software/Throttle/</ulink>. + Follow the instructions to install into your Apache install. + <emphasis>This module only functions with the Apache web + server!</emphasis> + You may use the + <command>ThrottleClientIP</command> + + command provided by this module to accomplish this goal. See the + <ulink url="http://www.snert.com/Software/Throttle/">Module + Instructions</ulink> + for more information.</para> </section> </section> - + <section id="win32" xreflabel="Win32 Installation Notes"> <title>Win32 Installation Notes</title> - <para>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 <emphasis>best</emphasis> - and <emphasis>easiest</emphasis> 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.</para> - <para>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.</para> + <para>This section covers installation on Microsoft Windows. + Bugzilla has been made to work on Win32 platforms, but the Bugzilla team + wish to emphasise that 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.</para> + + <warning> + <para>After that warning, here's the situation for 2.16 + and Windows. It doesn't work at all out of the box. + You are almost certainly better off getting + the 2.17 version from CVS (after consultation with the Bugzilla Team to + make sure you are pulling on a stable day) because we'll be doing a load + of work to make the Win32 experience more pleasant than it is now. + </para> + </warning> + + <para> + If you still want to try this, to have any hope of getting it to work, + you'll need to apply the + <ulink url="">mail patch</ulink> from + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=124174">bug 124174</ulink>. + After that, you'll need to read the (outdated) installation + instructions below, some (probably a lot better) <ulink url="http://bugzilla.mozilla.org/attachment.cgi?id=84430&action=view">more + recent ones</ulink> kindly provided by Toms Baugis and Jean-Sebastien + Guay, and also check the + <ulink url="http://www.bugzilla.org/releases/2.16/docs/win32.html">Bugzilla 2.16 Win32 update page + </ulink>. If we get time, + we'll write some better installation instructions for 2.16 and put + them up there. But no promises. + </para> + <section id="wininstall" xreflabel="Win32 Installation: Step-by-step"> <title>Win32 Installation: Step-by-step</title> + <note> - <para> - You should be familiar with, and cross-reference, the rest - of the - <xref linkend="installation" /> section while performing your - Win32 installation. - </para> - <para> 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 <emphasis>very</emphasis> 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 - <xref linkend="faq" />. - </para> + <para>You should be familiar with, and cross-reference, the rest of + the + <xref linkend="installation" /> + + section while performing your Win32 installation.</para> + + <para>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 + <emphasis>very</emphasis> + + 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 + <xref linkend="faq" /> + + .</para> </note> - + <procedure> - <step> - <para> - Install <ulink url="http://www.apache.org/">Apache Web - Server</ulink> for Windows, and copy the Bugzilla files - somewhere Apache can serve them. Please follow all the - instructions referenced in <xref linkend="installation" /> - regarding your Apache configuration, particularly - instructions regarding the <quote>AddHandler</quote> - parameter and <quote>ExecCGI</quote>. - </para> - <note> - <para> - 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 <xref linkend="faq" />. - </para> - <para> - 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. - </para> - </note> - </step> - <step> - <para> - Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary. - </para> - <para> - Please also check the following links to fully understand the status - of ActivePerl on Win32: - <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> - Perl Porting</ulink>, and - <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> - Perl on Win32 FAQ</ulink> - </para> - </step> - <step> - <para> - Use ppm from your perl\bin directory to install the following - packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, - GD, AppConfig, and Template. You may need to extract them from - .zip format using Winzip or other unzip program first. Most of - these additional ppm modules can be downloaded from ActiveState, - but AppConfig and Template should be obtained from OpenInteract - using <ulink type="http" - url="http://openinteract.sourceforge.net/">the instructions on - the Template Toolkit web site</ulink>. + <step> + <para>Install + <ulink url="http://www.apache.org/">Apache Web Server</ulink> + + for Windows, and copy the Bugzilla files somewhere Apache can serve + them. Please follow all the instructions referenced in + <xref linkend="installation" /> + + regarding your Apache configuration, particularly instructions + regarding the + <quote>AddHandler</quote> + + parameter and + <quote>ExecCGI</quote> + + .</para> + + <note> + <para>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 + <xref linkend="faq" /> + + .</para> + + <para>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.</para> + </note> + </step> + + <step> + <para>Install + <ulink url="http://www.activestate.com/">ActivePerl</ulink> + + for Windows. Check + <ulink + url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/"> + http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> + + for a current compiled binary.</para> + + <para>Please also check the following links to fully understand the + status of ActivePerl on Win32: + <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> + Perl Porting</ulink> + + , and + <ulink + url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> + Perl on Win32 FAQ</ulink> </para> - <note> - <para> - You can find a list of modules at - <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> - http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> - or <ulink - url="http://www.activestate.com/PPMPackages/5.6plus">http://www.activestate.com/PPMPackages/5.6plus</ulink> - </para> - </note> - <para> - The syntax for ppm is: - <computeroutput> - <prompt>C:> </prompt><command>ppm <modulename></command> - </computeroutput> - </para> - - <example> - <title>Installing ActivePerl ppd Modules on Microsoft Windows</title> - <para><prompt>C:></prompt><command>ppm - <option>DBD-Mysql</option></command></para> - <para>Watch your capitalization!</para> - </example> - - <para> - ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the - version at OpenInteract: + </step> + + <step> + <para>Use ppm from your perl\bin directory to install the following + packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using + <ulink type="http" url="http://openinteract.sourceforge.net/">the + instructions on the Template Toolkit web site</ulink> + + .</para> + + <note> + <para>You can find a list of modules at + <ulink + url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> + + or + <ulink url="http://www.activestate.com/PPMPackages/5.6plus"> + http://www.activestate.com/PPMPackages/5.6plus</ulink> + </para> + </note> + + <para>The syntax for ppm is: + <computeroutput> + <prompt>C:></prompt> + + <command>ppm <modulename></command> + </computeroutput> </para> + + <example> + <title>Installing ActivePerl ppd Modules on Microsoft + Windows</title> + + <para> + <prompt>C:></prompt> + + <command>ppm + <option>DBD-Mysql</option> + </command> + </para> + + <para>Watch your capitalization!</para> + </example> + + <para>ActiveState's 5.6Plus directory also contains an AppConfig + ppm, so you might see the following error when trying to install + the version at OpenInteract:</para> + <para> - <computeroutput> - Error installing package 'AppConfig': Read a PPD for - 'AppConfig', but it is not intended for this build of Perl - (MSWin32-x86-multi-thread) - </computeroutput> - </para> - <para> - If so, download both <ulink - url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz">the - tarball</ulink> and <ulink - url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd">the - ppd</ulink> directly from OpenInteract, then run ppm from within - the same directory to which you downloaded those files and - install the package by referencing the ppd file explicitly via in - the install command, f.e.: - <example> - <title>Installing OpenInteract ppd Modules manually on Microsoft - Windows</title> + <computeroutput>Error installing package 'AppConfig': Read a PPD + for 'AppConfig', but it is not intended for this build of Perl + (MSWin32-x86-multi-thread)</computeroutput> + </para> + + <para>If so, download both + <ulink + url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz"> + the tarball</ulink> + + and + <ulink + url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd"> + the ppd</ulink> + + directly from OpenInteract, then run ppm from within the same + directory to which you downloaded those files and install the + package by referencing the ppd file explicitly via in the install + command, f.e.: + <example> + <title>Installing OpenInteract ppd Modules manually on Microsoft + Windows</title> + + <para> + <computeroutput> + <command>install + <filename>C:\AppConfig.ppd</filename> + </command> + </computeroutput> + </para> + </example> + </para> + </step> + + <step> + <para>Install MySQL for NT. + <note> + <para>You can download MySQL for Windows NT from + <ulink url="http://www.mysql.com/">MySQL.com</ulink> + + . Some find it helpful to use the WinMySqlAdmin utility, included + with the download, to set up the database.</para> + </note> + </para> + </step> + + <step> + <para>Setup MySQL</para> + + <substeps> + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + + <command>C:\mysql\bin\mysql -u root mysql</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>DELETE FROM user WHERE Host='localhost' AND + User='';</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>UPDATE user SET Password=PASSWORD ('new_password') + WHERE user='root';</command> + </computeroutput> + </para> + + <para> + <quote>new_password</quote> + + , above, indicates whatever password you wish to use for your + <quote>root</quote> + + user.</para> + </step> + + <step id="ntbugs-password"> <para> - <computeroutput><command>install - <filename>C:\AppConfig.ppd</filename></command></computeroutput> + <computeroutput> + <prompt>mysql></prompt> + + <command>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, + ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> </para> - </example> + + <para> + <quote>bugs_password</quote> + + , above, indicates whatever password you wish to use for your + <quote>bugs</quote> + + user.</para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>create database bugs;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + + <command>exit;</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + + <command>C:\mysql\bin\mysqladmin -u root -p + reload</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + + <step> + <para>Edit + <filename>checksetup.pl</filename> + + in your Bugzilla directory. Change this line:</para> + + <para> + <programlisting>my $webservergid = + getgrnam($my_webservergroup);</programlisting> </para> - </step> - - <step> - <para> - Install MySQL for NT. - <note> - <para> - You can download MySQL for Windows NT from <ulink url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database. - </para> - </note> - </para> - </step> - <step> - <para> - Setup MySQL - </para> - <substeps> - <step> - <para> - <computeroutput> - <prompt>C:> </prompt> - <command>C:\mysql\bin\mysql -u root mysql</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>DELETE FROM user WHERE Host='localhost' AND User='';</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</command> - </computeroutput> - </para> - <para><quote>new_password</quote>, above, indicates - whatever password you wish to use for your - <quote>root</quote> user.</para> - </step> - <step id="ntbugs-password"> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>GRANT SELECT, INSERT, UPDATE, DELETE, - INDEX, ALTER, CREATE, DROP, REFERENCES - ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</command> - </computeroutput> - </para> - <para><quote>bugs_password</quote>, above, indicates - whatever password you wish to use for your - <quote>bugs</quote> user.</para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>FLUSH PRIVILEGES;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>create database bugs;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>mysql></prompt> - <command>exit;</command> - </computeroutput> - </para> - </step> - <step> - <para> - <computeroutput> - <prompt>C:></prompt> - <command>C:\mysql\bin\mysqladmin -u root -p reload</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para> - Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change - this line: - </para> - <para> - <programlisting> -my $webservergid = getgrnam($my_webservergroup); - </programlisting> - </para> - <para> - to - </para> - <para> - <programlisting> -my $webservergid = $my_webservergroup; - </programlisting> -or the name of the group you wish to own the files explicitly: - <programlisting> -my $webservergid = 'Administrators' - </programlisting> - </para> - </step> - - <step> - <para> - Run <filename>checksetup.pl</filename> from the Bugzilla directory. - </para> - </step> - - <step> - <para>Edit <filename>localconfig</filename> to suit your - requirements. Set <varname>$db_pass</varname> to your - <quote>bugs_password</quote> from <xref linkend="ntbugs-password" />, and <varname>$webservergroup</varname> to <quote>8</quote>.</para> - <note> - <para>Not sure on the <quote>8</quote> for - <varname>$webservergroup</varname> above. If it's - wrong, please send corrections.</para> - </note> - </step> - - <step> - <para> - Edit <filename>defparams.pl</filename> to suit your - requirements. Particularly, set - <varname>DefParam("maintainer")</varname> and - <varname>DefParam("urlbase") to match your - install.</varname> - </para> - <note> - <para>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.</para> - </note> - </step> - - <step> - <note> - <para> - There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <emphasis>suggestion</emphasis>, not - a requirement. Some other mail packages that can work include - <ulink url="http://www.blat.net/">BLAT</ulink>, - <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>, - <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>, - 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. - </para> - </note> - - <procedure> - <step> - <para> - Download NTsendmail, available from<ulink url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. 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) - </para> - </step> - - <step> - <para>Put ntsendmail.pm into your .\perl\lib directory.</para> - </step> - - <step> - <para>Add to globals.pl:</para> - <programlisting> -# these settings configure the NTsendmail process -use NTsendmail; -$ENV{"NTsendmail"}="your.smtpserver.box"; -$ENV{"NTsendmail_debug"}=1; -$ENV{"NTsendmail_max_tries"}=5; - </programlisting> - <note> - <para> - Some mention to also edit - <varname>$db_pass</varname> in - <filename>globals.pl</filename> to be your - <quote>bugs_password</quote>. Although this may get - you around some problem authenticating to your - database, since globals.pl is not normally - restricted by <filename>.htaccess</filename>, your - database password is exposed to whoever uses your - web server. - </para> - </note> - </step> - - <step> - <para> - Find and comment out all occurences of - <quote><command>open(SENDMAIL</command></quote> in - your Bugzilla directory. Then replace them with: - <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); - </programlisting> - </para> - <note> - <para> - Some have found success using the commercial product, - <productname>Windmail</productname>. - You could try replacing your sendmail calls with: - <programlisting> -open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </programlisting> - or something to that effect. - </para> - </note> - </step> - </procedure> - </step> - - <step> - <para> - Change all references in all files from - <filename>processmail</filename> to - <filename>processmail.pl</filename>, and - rename <filename>processmail</filename> to - <filename>processmail.pl</filename>. - </para> - <note> - <para> - 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. - </para> - </note> - <note> - <para> - 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. - <programlisting> + + <para>to</para> + + <para> + <programlisting>my $webservergid = + $my_webservergroup;</programlisting> + + or the name of the group you wish to own the files explicitly: + <programlisting>my $webservergid = + 'Administrators'</programlisting> + </para> + </step> + + <step> + <para>Run + <filename>checksetup.pl</filename> + + from the Bugzilla directory.</para> + </step> + + <step> + <para>Edit + <filename>localconfig</filename> + + to suit your requirements. Set + <varname>$db_pass</varname> + + to your + <quote>bugs_password</quote> + + from + <xref linkend="ntbugs-password" /> + + , and + <varname>$webservergroup</varname> + + to + <quote>8</quote> + + .</para> + + <note> + <para>Not sure on the + <quote>8</quote> + + for + <varname>$webservergroup</varname> + + above. If it's wrong, please send corrections.</para> + </note> + </step> + + <step> + <para>Edit + <filename>defparams.pl</filename> + + to suit your requirements. Particularly, set + <varname>DefParam("maintainer")</varname> + + and + <varname>DefParam("urlbase") to match your install.</varname> + </para> + + <note> + <para>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.</para> + </note> + </step> + + <step> + <note> + <para>There are several alternatives to Sendmail that will work + on Win32. The one mentioned here is a + <emphasis>suggestion</emphasis> + + , not a requirement. Some other mail packages that can work + include + <ulink url="http://www.blat.net/">BLAT</ulink> + + , + <ulink url="http://www.geocel.com/windmail/">Windmail</ulink> + + , + <ulink url="http://www.dynamicstate.com/">Mercury + Sendmail</ulink> + + , 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.</para> + </note> + + <procedure> + <step> + <para>Download NTsendmail, available from + <ulink url="http://www.ntsendmail.com/"> + www.ntsendmail.com</ulink> + + . 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)</para> + </step> + + <step> + <para>Put ntsendmail.pm into your .\perl\lib directory.</para> + </step> + + <step> + <para>Add to globals.pl:</para> + + <programlisting># these settings configure the NTsendmail + process use NTsendmail; + $ENV{"NTsendmail"}="your.smtpserver.box"; + $ENV{"NTsendmail_debug"}=1; + $ENV{"NTsendmail_max_tries"}=5;</programlisting> + + <note> + <para>Some mention to also edit + <varname>$db_pass</varname> + + in + <filename>globals.pl</filename> + + to be your + <quote>bugs_password</quote> + + . Although this may get you around some problem + authenticating to your database, since globals.pl is not + normally restricted by + <filename>.htaccess</filename> + + , your database password is exposed to whoever uses your web + server.</para> + </note> + </step> + + <step> + <para>Find and comment out all occurences of + <quote> + <command>open(SENDMAIL</command> + </quote> + + in your Bugzilla directory. Then replace them with: + <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);</programlisting> + </para> + + <note> + <para>Some have found success using the commercial product, + <productname>Windmail</productname> + + . You could try replacing your sendmail calls with: + <programlisting>open SENDMAIL, + "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > + mail.log";</programlisting> + + or something to that effect.</para> + </note> + </step> + </procedure> + </step> + + <step> + <para>Change all references in all files from + <filename>processmail</filename> + + to + <filename>processmail.pl</filename> + + , and rename + <filename>processmail</filename> + + to + <filename>processmail.pl</filename> + + .</para> + + <note> + <para>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.</para> + </note> + + <note> + <para>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. + <programlisting> <![CDATA[ my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server @@ -1737,9 +1774,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } ]]> -</programlisting> -here is a test mail program for Net::SMTP: -<programlisting> + </programlisting> + + here is a test mail program for Net::SMTP: + <programlisting> <![CDATA[ use Net::SMTP; @@ -1757,241 +1795,352 @@ recipient's address exit; ]]> -</programlisting> - </para> - </note> - </step> - <step> - <note> - <para> - 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 - <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl) - </para> - </note> - <para> - Modify the path to perl on the first line (#!) of all - files to point to your Perl installation, and add - <quote>perl</quote> 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 <quote>setperl.csh</quote> - utility to speed part of this procedure, available in the - <xref linkend="patches" /> section of The Bugzilla Guide. - However, it requires the Cygwin GNU-compatible environment - for Win32 be set up in order to work. See <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin. - </para> - </step> - - <step> - <para> - 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: - <programlisting><![CDATA[ + </programlisting> + </para> + </note> + </step> + + <step> + <note> + <para>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 + <quote>shebang</quote> + + line (#/usr/bonsaitools/bin/perl)</para> + </note> + + <para>Modify the path to perl on the first line (#!) of all files + to point to your Perl installation, and add + <quote>perl</quote> + + 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 + <quote>setperl.csh</quote> + + utility to speed part of this procedure, available in the + <xref linkend="patches" /> + + section of The Bugzilla Guide. However, it requires the Cygwin + GNU-compatible environment for Win32 be set up in order to work. + See + <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> + + for details on obtaining Cygwin.</para> + </step> + + <step> + <para>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: + <programlisting> +<![CDATA[ system ("./processmail",@ARGLIST); - </programlisting> to - <programlisting> + </programlisting> to + <programlisting> system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); -]]> </programlisting> - </para> - </step> - <step> - <para> - Add <function>binmode()</function> calls so attachments - will work (<ulink - url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>). +]]> + </programlisting> </para> + </step> + + <step> + <para>Add + <function>binmode()</function> + + calls so attachments will work ( + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug + 62000</ulink> + + ).</para> + + <para>Because Microsoft Windows based systems handle binary files + different than Unix based systems, you need to add the following + lines to + <filename>createattachment.cgi</filename> + + and + <filename>showattachment.cgi</filename> + + before the + <function>require 'CGI.pl';</function> + + line.</para> + <para> - Because Microsoft Windows based systems handle binary - files different than Unix based systems, you need to add - the following lines to - <filename>createattachment.cgi</filename> and - <filename>showattachment.cgi</filename> before the - <function>require 'CGI.pl';</function> line. -</para> -<para> -<programlisting> + <programlisting> <![CDATA[ binmode(STDIN); binmode(STDOUT); ]]> -</programlisting> + </programlisting> </para> + <note> - <para> - According to <ulink - url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, - the perl documentation says that you should always use - <function>binmode()</function> when dealing with binary - files, but never when dealing with text files. That seems - to suggest that rather than arbitrarily putting - <function>binmode()</function> at the beginning of the - attachment files, there should be logic to determine if - <function>binmode()</function> is needed or not. - </para> + <para>According to + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000"> + bug 62000</ulink> + + , the perl documentation says that you should always use + <function>binmode()</function> + + when dealing with binary files, but never when dealing with text + files. That seems to suggest that rather than arbitrarily putting + + <function>binmode()</function> + + at the beginning of the attachment files, there should be logic + to determine if + <function>binmode()</function> + + is needed or not.</para> </note> </step> </procedure> <tip> - <para> - 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: - </para> - <para> - <programlisting> -.cgi to: <perl install directory>\perl.exe %s %s -.pl to: <perl install directory>\perl.exe %s %s -GET,HEAD,POST - </programlisting> - Change the path to Perl to match your - install, of course. - </para> + <para>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:</para> + + <para> + <programlisting>.cgi to: <perl install directory>\perl.exe %s + %s .pl to: <perl install directory>\perl.exe %s %s + GET,HEAD,POST</programlisting> + + Change the path to Perl to match your install, of course.</para> </tip> </section> <section id="addlwintips"> <title>Additional Windows Tips</title> + <tip> - <para> - From Andrew Pearson: - <blockquote> - <para> - 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 <ulink url=" - http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> - </para> - <para> - Basically you need to add two String Keys in the - registry at the following location: - </para> - <para> - <programlisting> -HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </programlisting> - </para> - <para> - The keys should be called ".pl" and ".cgi", and both - should have a value something like: - <command>c:/perl/bin/perl.exe "%s" "%s"</command> - </para> - <para> - The KB article only talks about .pl, but it goes into - more detail and provides a perl test script. - </para> - </blockquote> - </para> + <para>From Andrew Pearson: + <blockquote> + <para>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 + <ulink + url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> + http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> + </para> + + <para>Basically you need to add two String Keys in the registry at + the following location:</para> + + <para> + <programlisting> + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</programlisting> + </para> + + <para>The keys should be called ".pl" and ".cgi", and both should + have a value something like: + <command>c:/perl/bin/perl.exe "%s" "%s"</command> + </para> + + <para>The KB article only talks about .pl, but it goes into more + detail and provides a perl test script.</para> + </blockquote> + </para> </tip> + <tip> - <para> - If attempting to run Bugzilla 2.12 or older, you will need - to remove encrypt() calls from the Perl source. This is - <emphasis>not necessary</emphasis> for Bugzilla 2.13 and - later, which includes the current release, Bugzilla - &bz-ver;. - <example> - <title>Removing encrypt() for Windows NT Bugzilla version - 2.12 or earlier</title> - <para> - Replace this: - <programlisting> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </programlisting> -with this: - <programlisting> -my $enteredcryptpwd = $enteredpwd - </programlisting> - in cgi.pl. - </para> - </example> - </para> + <para>If attempting to run Bugzilla 2.12 or older, you will need to + remove encrypt() calls from the Perl source. This is + <emphasis>not necessary</emphasis> + + for Bugzilla 2.13 and later, which includes the current release, + Bugzilla &bz-ver;. + <example> + <title>Removing encrypt() for Windows NT Bugzilla version 2.12 or + earlier</title> + + <para>Replace this: + <programlisting>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . + ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my + $enteredcryptpwd = FetchOneColumn();</programlisting> + + with this: + <programlisting>my $enteredcryptpwd = $enteredpwd</programlisting> + + in cgi.pl.</para> + </example> + </para> </tip> </section> + </section> + + <section id="osx"> + <title>Mac OS X Installation Notes</title> + + <para>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.</para> + + <para>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/>.</para> + + <para>Follow the instructions for setting up Fink. Once it's installed, + you'll want to run the following as root: + <command>fink install gd</command> + </para> + + <para>It will prompt you for a number of dependencies, type 'y' and hit + enter to install all of the dependencies. Then watch it work.</para> + + <para>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, because it + looks for the specific paths instead of getting them from your + environment. But there's a way around that :-)</para> + + <para>Instead of typing + <quote>install GD</quote> + at the + <prompt>cpan></prompt> + prompt, type + <command>look GD</command>. + 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 <ulink url="../sgml/gd-makefile.patch">this patch</ulink> + to the Makefile.PL file (save the + patch into a file and use the command + <command>patch < patchfile</command>.) + </para> - <section id="bzldap"> - <title>Bugzilla LDAP Integration</title> + <para>Then, run these commands to finish the installation of the GD + module: + <simplelist> + <member> + <command>perl Makefile.PL</command> + </member> + + <member> + <command>make</command> + </member> + + <member> + <command>make test</command> + </member> + + <member> + <command>make install</command> + </member> + + <member>And don't forget to run + <command>exit</command> + + to get back to CPAN.</member> + </simplelist> + </para> + + </section> + + <section id="troubleshooting"> + <title>Troubleshooting</title> + + <para>This section gives solutions to common Bugzilla installation + problems. + </para> + + <section> + <title>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</title> + <para> - 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. + Try executing <command>perl -MCPAN -e 'install CPAN'</command> + and then continuing. + </para> + + <para> + Certain older versions of the CPAN toolset were somewhat naive about how + to upgrade Perl modules. When a couple of modules got rolled into the core + Perl distribution for 5.6.1, CPAN thought that the best way to get those + modules up to date was to haul down the Perl distribution itself and + build it. Needless to say, this has caused headaches for just about + everybody. Upgrading to a newer version of CPAN with the + commandline above should fix things. </para> - <literallayout> -Mozilla::LDAP module - -The Mozilla::LDAP module allows you to use LDAP for authentication to -the Bugzilla system. This module is not required if you are not using -LDAP. - -Mozilla::LDAP (aka PerLDAP) is available for download from -http://www.mozilla.org/directory. - -NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. -Follow the link for "Directory SDK for C" on that same page to -download the SDK first. After you have installed this SDK, then -install the PerLDAP module. ----------------------------------------------------------------------- - -Post-Installation Checklist ----------------------------------------------------------------------- -Set useLDAP to "On" **only** if you will be using an LDAP directory -for authentication. Be very careful when setting up this parameter; -if you set LDAP authentication, but do not have a valid LDAP directory -set up, you will not be able to log back in to Bugzilla once you log -out. (If this happens, you can get back in by manually editing the -data/params file, and setting useLDAP back to 0.) - -If using LDAP, you must set the three additional parameters: - -Set LDAPserver to the name (and optionally port) of your LDAP server. -If no port is specified, it defaults to the default port of 389. (e.g -"ldap.mycompany.com" or "ldap.mycompany.com:1234") - -Set LDAPBaseDN to the base DN for searching for users in your LDAP -directory. (e.g. "ou=People,o=MyCompany") uids must be unique under -the DN specified here. - -Set LDAPmailattribute to the name of the attribute in your LDAP -directory which contains the primary email address. On most directory -servers available, this is "mail", but you may need to change this. ----------------------------------------------------------------------- - -(Not sure where this bit should go, but it's important that it be in -there somewhere...) ----------------------------------------------------------------------- -Using LDAP authentication for Bugzilla: - -The existing authentication scheme for Bugzilla uses email addresses -as the primary user ID, and a password to authenticate that user. All -places within Bugzilla where you need to deal with user ID (e.g -assigning a bug) use the email address. - -The LDAP authentication builds on top of this scheme, rather than -replacing it. The initial log in is done with a username and password -for the LDAP directory. This then fetches the email address from LDAP -and authenticates seamlessly in the standard Bugzilla authentication -scheme using this email address. If an account for this address -already exists in your Bugzilla system, it will log in to that -account. If no account for that email address exists, one is created -at the time of login. (In this case, Bugzilla will attempt to use the -"displayName" or "cn" attribute to determine the user's full name.) - -After authentication, all other user-related tasks are still handled -by email address, not LDAP username. You still assign bugs by email -address, query on users by email address, etc. ----------------------------------------------------------------------- - </literallayout> </section> + + + <section> + <title>DBD::Sponge::db prepare failed</title> + + <para> + The following error message may appear due to a bug in DBD::mysql + (over which the Bugzilla team have no control): + </para> + +<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248. + SV = NULL(0x0) at 0x20fc444 + REFCNT = 1 + FLAGS = (PADBUSY,PADMY) +]]></programlisting> + + <para> + To fix this, go to + <filename><path-to-perl>/lib/DBD/sponge.pm</filename> + in your Perl installation and replace + </para> + +<programlisting><![CDATA[ my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; +]]></programlisting> + + <para> + by + </para> + +<programlisting><![CDATA[ my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; +]]></programlisting> + + <para> + (note the S added to NAME.) + </para> + </section> + + <section id="paranoid-security"> + <title>cannot chdir(/var/spool/mqueue)</title> + + <para>If you are installing Bugzilla on SuSE Linux, or some other + distributions with + <quote>paranoid</quote> + security options, it is possible that the checksetup.pl script may fail + with the error: +<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied +]]></programlisting> + </para> + + <para> + This is because your + <filename>/var/spool/mqueue</filename> + directory has a mode of + <quote>drwx------</quote>. Type + <command>chmod 755 + <filename>/var/spool/mqueue</filename> + </command> + as root to fix this problem. + </para> + </section> </section> </chapter> - <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -2012,3 +2161,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/xml/integration.xml b/docs/xml/integration.xml index e801847d6..68054ee13 100644 --- a/docs/xml/integration.xml +++ b/docs/xml/integration.xml @@ -1,6 +1,6 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- Keep these tools listings in alphabetical order please. -MPB --> -<chapter id="integration"> +<section id="integration"> <title>Integrating Bugzilla with Third-Party Tools</title> <section id="bonsai" @@ -13,43 +13,32 @@ . 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 - <quote>on the hook</quote> - - (include cool URL link here for Hook policies at mozilla.org). Bonsai - also includes gateways to - <xref linkend="tinderbox" /> - - and Bugzilla</para> + closed. Bonsai + also integrates with + <xref linkend="tinderbox" />. + </para> </section> <section id="cvs" xreflabel="CVS, the Concurrent Versioning System"> <title>CVS</title> <para>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.</para> + Bugzilla Email Gateway.</para> - <para>Follow the instructions in the FAQ for enabling Bugzilla e-mail + <para>Follow the instructions in this Guide 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 - <quote>[Bug XXXX]</quote> - - , and you can have CVS check-in comments append to your Bugzilla bug. If + <quote>[Bug XXXX]</quote>, + 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.</para> - <para>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: + <para>There is also a CVSZilla project, based upon somewhat dated + Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"> - http://homepages.kcbbs.gen.nz/~tonyg/</ulink> - - , under the - <quote>cvszilla</quote> - - link.</para> + http://homepages.kcbbs.gen.nz/~tonyg/</ulink>. + </para> </section> <section id="scm" @@ -86,7 +75,7 @@ <para>We need Tinderbox integration information.</para> </section> -</chapter> +</section> <!-- Keep this comment at the end of the file Local variables: diff --git a/docs/xml/patches.xml b/docs/xml/patches.xml index 540109feb..43f816758 100644 --- a/docs/xml/patches.xml +++ b/docs/xml/patches.xml @@ -26,160 +26,54 @@ setting up your VirtualHost section for Bugzilla with a rule like this:</para> - <programlisting> -<![CDATA[ + <programlisting><![CDATA[ <VirtualHost 12.34.56.78> RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </VirtualHost> -]]> - </programlisting> +]]></programlisting> </listitem> <listitem> <para>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 - <ulink url="http://www.apache.org">http://www.apache.org</ulink> + Please refer to the mod_rewrite documentation at + <ulink url="http://www.apache.org">http://www.apache.org</ulink>. </para> </listitem> </orderedlist> </section> - <section id="setperl" xreflabel="The setperl.csh Utility"> - <title>The setperl.csh Utility</title> - - <para>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!</para> - - <procedure> - <step> - <para>Download the "setperl.csh" utility to your Bugzilla directory - and make it executable.</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>cd /your/path/to/bugzilla</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>wget -O setperl.csh - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+x setperl.csh</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Prepare (and fix) Bugzilla file permissions.</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+w *</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod u+x duplicates.cgi</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>chmod a-x bug_status.html</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Run the script:</para> - - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>./setperl.csh /your/path/to/perl</command> - </computeroutput> - - <example> - <title>Using Setperl to set your perl path</title> - - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>./setperl.csh /usr/bin/perl</command> - </computeroutput> - </para> - </example> - </para> - </step> - </procedure> - </section> - <section id="cmdline"> <title>Command-line Bugzilla Queries</title> - <para>Users can query Bugzilla from the command line using this suite of - utilities.</para> - - <para>The query.conf file contains the mapping from options to field + <para>There are a suite of Unix utilities for querying Bugzilla from the + command line. They live in the + <filename class="directory">contrib/cmdline</filename> + directory. However, they + have not yet been updated to work with 2.16 (post-templatisation.). + There are three files - <filename>query.conf</filename>, + <filename>buglist</filename> and <filename>bugs</filename>.</para> + + <para><filename>query.conf</filename> + 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"</para> + make sure these lines do not contain any quoted "option".</para> - <para>buglist is a shell script which submits a Bugzilla query and writes + <para><filename>buglist</filename> + 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=".</para> - <para>The columlist is taken from the COLUMNLIST environment variable. + <para>The column list 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 - <command>grep COLUMLIST ~/.netscape/cookies</command> - - to see your current COLUMNLIST setting.</para> + buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST + in your cookies file to see your current COLUMNLIST setting.</para> - <para>bugs is a simple shell script which calls buglist and extracts the + <para><filename>bugs</filename> is a simple shell script which calls + <filename>buglist</filename> 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 @@ -187,100 +81,13 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> </para> - <para>Akkana says she has good results piping buglist output through + <para>Akkana Peck says she has good results piping + <filename>buglist</filename> output through <command>w3m -T text/html -dump</command> </para> - <procedure> - <step> - <para>Download three files:</para> - - <substeps> - <step> - <para> - <computeroutput> - <prompt>bash$</prompt> - - <command>wget -O query.conf - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash$</prompt> - - <command>wget -O buglist - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> - </computeroutput> - </para> - </step> - - <step> - <para> - <computeroutput> - <prompt>bash#</prompt> - - <command>wget -O bugs - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> - </computeroutput> - </para> - </step> - </substeps> - </step> - - <step> - <para>Make your utilities executable: - <computeroutput> - <prompt>bash$</prompt> - - <command>chmod u+x buglist bugs</command> - </computeroutput> - </para> - </step> - </procedure> </section> - <section id="quicksearch"> - <title>The Quicksearch Utility</title> - - <para>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"</para> - - <para>The index.html page has been updated to include the QuickSearch - text box.</para> - - <para>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.</para> - - <para>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".</para> - - <para>Workarounds for Bugzilla users: - <simplelist> - <member>search for '!foo' (this will find only bugs with the keyword - "foo"</member> - - <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> - </simplelist> - </para> - - <para>When this tool is ported from client-side JavaScript to server-side - Perl, the requirement for hard-coding keywords can be fixed. - <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This - bug</ulink> - - has details.</para> - </section> </appendix> <!-- Keep this comment at the end of the file diff --git a/docs/xml/using.xml b/docs/xml/using.xml index b447ef9c0..a3986c27d 100644 --- a/docs/xml/using.xml +++ b/docs/xml/using.xml @@ -1,167 +1,16 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<!-- TOC -Chapter: Using Bugzilla - Create an account - Logging in - Setting up preferences - Account Settings - Email Settings - Page Footer - Permissions - Life cycle of a bug - Creating a bug - Checking for duplicates - Overview of all bug fields - Setting bug permissions - The Query Interface - Standard Queries - Email Queries - Boolean Queries - Regexp Queries - The Query Results - Changing Columns - Changing sorting order - Mass changes - Miscellaneous usage hints ---> <chapter id="using"> <title>Using Bugzilla</title> - <section id="whatis"> - <title>What is Bugzilla?</title> - - <para>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 by 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.</para> - - <para>Bugzilla has matured immensely, and now boasts many advanced - features. These include: - <itemizedlist> - <listitem> - <para>Powerful searching</para> - </listitem> - - <listitem> - <para>User-configurable email notifications of bug changes</para> - </listitem> - - <listitem> - <para>Full change history</para> - </listitem> - - <listitem> - <para>Inter-bug dependency tracking and graphing</para> - </listitem> - - <listitem> - <para>Excellent attachment management</para> - </listitem> - - <listitem> - <para>Integrated, product-based, granular security schema</para> - </listitem> - - <listitem> - <para>Fully security-audited, and runs under Perl's taint mode</para> - </listitem> - - <listitem> - <para>A robust, stable RDBMS back-end</para> - </listitem> - - <listitem> - <para>Web, XML, email and console interfaces</para> - </listitem> - - <listitem> - <para>Completely customisable and/or localisable web user - interface</para> - </listitem> - - <listitem> - <para>Extensive configurability</para> - </listitem> - - <listitem> - <para>Smooth upgrade pathway between versions</para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="why"> - <title>Why Should We Use Bugzilla?</title> - - <para>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.</para> - - <para>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.</para> - - <para>But why should - <emphasis>you</emphasis> - - use Bugzilla?</para> - - <para>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</para> - - <para>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 - <emphasis>something</emphasis> - - 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.</para> - - <para>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.</para> - </section> - <section id="how"> <title>How do I use Bugzilla?</title> - <para>This section contains information for end-users of Bugzilla. If you - are administering a Bugzilla installation, please consult the Installing - and Administering Bugzilla portions of this Guide.</para> - - <para>There is a Bugzilla test installation, called - <ulink url="http://landfill.tequilarista.org/">Landfill</ulink> - - , which you are welcome to play with. However, it does not necessarily + <para>This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + <ulink url="http://landfill.bugzilla.org/">Landfill</ulink>, + which you are welcome to play with (if it's up.) + However, it does not necessarily have all Bugzilla features enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here.</para> @@ -173,8 +22,8 @@ Chapter: Using Bugzilla Consult with the administrator responsible for your installation of Bugzilla for the URL you should use to access it. If you're test-driving Bugzilla, use this URL: - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> - http://landfill.tequilarista.org/bugzilla-tip/</ulink> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"> + http://landfill.bugzilla.org/bugzilla-tip/</ulink> </para> <orderedlist> @@ -200,18 +49,17 @@ Chapter: Using Bugzilla <listitem> <para>Click the <quote>Log In</quote> - link in the yellow area at the bottom of the page in your browser, enter your email address and password into the spaces provided, and click - <quote>Login</quote> - - .</para> + <quote>Login</quote>. + </para> + </listitem> </orderedlist> - <para>You are now logged in. Bugzilla uses cookies for authentication, - so (unless your IP address changes) you should not have to log in + <para>You are now logged in. Bugzilla uses cookies for authentication + so, unless your IP address changes, you should not have to log in again.</para> </section> @@ -221,75 +69,65 @@ Chapter: Using Bugzilla <para>The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1"> + url="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1"> Bug 1 on Landfill</ulink> - is a good example. Note that the names of most fields are hyperlinks; + is a good example. Note that the labels for most fields are hyperlinks; clicking them will take you to context-sensitive help on that - particular field.</para> + particular field. Fields marked * may not be present on every + installation of Bugzilla.</para> <orderedlist> <listitem> <para> - <emphasis>Product and Component</emphasis> - - : Bugs are divided up by Product and Component, with a Product + <emphasis>Product and Component</emphasis>: + Bugs are divided up by Product and Component, with a Product having one or more Components in it. For example, bugzilla.mozilla.org's "Bugzilla" Product is composed of several Components: <simplelist> <member> <emphasis>Administration:</emphasis> - Administration of a Bugzilla installation.</member> <member> <emphasis>Bugzilla-General:</emphasis> - Anything that doesn't fit in the other components, or spans multiple components.</member> <member> <emphasis>Creating/Changing Bugs:</emphasis> - Creating, changing, and viewing bugs.</member> <member> <emphasis>Documentation:</emphasis> - The Bugzilla documentation, including The Bugzilla Guide.</member> <member> <emphasis>Email:</emphasis> - Anything to do with email sent by Bugzilla.</member> <member> <emphasis>Installation:</emphasis> - The installation process of Bugzilla.</member> <member> <emphasis>Query/Buglist:</emphasis> - Anything to do with searching for bugs and viewing the buglists.</member> <member> <emphasis>Reporting/Charting:</emphasis> - Getting reports from Bugzilla.</member> <member> <emphasis>User Accounts:</emphasis> - Anything about managing a user account from the user's perspective. Saved queries, creating accounts, changing passwords, logging in, etc.</member> <member> <emphasis>User Interface:</emphasis> - General issues having to do with the user interface cosmetics (not functionality) including cosmetic issues, HTML templates, etc.</member> @@ -301,46 +139,41 @@ Chapter: Using Bugzilla <para> <emphasis>Status and Resolution:</emphasis> - A bug passes through several Statuses in its lifetime, and ends up - in the RESOLVED status, with one of a set of Resolutions (e.g. - FIXED, INVALID.) The different possible values for Status and - Resolution on your installation will be documented in the + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the context-sensitive help for those items.</para> </listitem> <listitem> <para> <emphasis>Assigned To:</emphasis> - The person responsible for fixing the bug.</para> </listitem> <listitem> <para> - <emphasis>URL:</emphasis> - + <emphasis>*URL:</emphasis> A URL associated with the bug, if any.</para> </listitem> <listitem> <para> <emphasis>Summary:</emphasis> - A one-sentence summary of the problem.</para> </listitem> <listitem> <para> - <emphasis>Status Whiteboard:</emphasis> - + <emphasis>*Status Whiteboard:</emphasis> (a.k.a. Whiteboard) A free-form text area for adding short notes and tags to a bug.</para> </listitem> <listitem> <para> - <emphasis>Keywords:</emphasis> - + <emphasis>*Keywords:</emphasis> The administrator can define keywords which you can use to tag and categorise bugs - e.g. The Mozilla Project has keywords like crash and regression.</para> @@ -349,7 +182,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Platform and OS:</emphasis> - These indicate the computing environment where the bug was found.</para> </listitem> @@ -357,7 +189,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Version:</emphasis> - The "Version" field is usually used for versions of a product which have been released, and is set to indicate which versions of a Component have the particular problem the bug report is @@ -367,7 +198,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Priority:</emphasis> - The bug assignee uses this field to prioritise his or her bugs. It's a good idea not to change this on other people's bugs.</para> </listitem> @@ -375,7 +205,6 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Severity:</emphasis> - This indicates how severe the problem is - from blocker ("application unusable") to trivial ("minor cosmetic issue"). You can also use this field to indicate whether a bug is an enhancement @@ -384,8 +213,7 @@ Chapter: Using Bugzilla <listitem> <para> - <emphasis>Target:</emphasis> - + <emphasis>*Target:</emphasis> (a.k.a. Target Milestone) A future version by which the bug is to be fixed. e.g. The Bugzilla Project's milestones for future Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not @@ -396,29 +224,25 @@ Chapter: Using Bugzilla <listitem> <para> <emphasis>Reporter:</emphasis> - The person who filed the bug.</para> </listitem> <listitem> <para> <emphasis>CC list:</emphasis> - A list of people who get mail when the bug changes.</para> </listitem> <listitem> <para> <emphasis>Attachments:</emphasis> - You can attach files (e.g. testcases or patches) to bugs. If there are any attachments, they are listed in this section.</para> </listitem> <listitem> <para> - <emphasis>Dependencies:</emphasis> - + <emphasis>*Dependencies:</emphasis> If this bug cannot be fixed unless other bugs are fixed (depends on), or this bug stops other bugs being fixed (blocks), their numbers are recorded here.</para> @@ -426,15 +250,13 @@ Chapter: Using Bugzilla <listitem> <para> - <emphasis>Votes:</emphasis> - + <emphasis>*Votes:</emphasis> Whether this bug has any votes.</para> </listitem> <listitem> <para> <emphasis>Additional Comments:</emphasis> - You can add your two cents to the bug discussion here, if you have something worthwhile to say.</para> </listitem> @@ -447,8 +269,8 @@ Chapter: Using Bugzilla <para>The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You can play with it here: - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"> - landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/query.cgi"> + landfill.bugzilla.org/bugzilla-tip/query.cgi</ulink> .</para> @@ -460,7 +282,7 @@ Chapter: Using Bugzilla <para>Highly advanced querying is done using Boolean Charts, which have their own <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html"> + url="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html"> context-sensitive help</ulink> .</para> @@ -517,10 +339,9 @@ Chapter: Using Bugzilla <para>Years of bug writing experience has been distilled for your reading pleasure into the <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html"> - Bug Writing Guidelines</ulink> - - . While some of the advice is Mozilla-specific, the basic principles of + url="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html"> + Bug Writing Guidelines</ulink>. + 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 @@ -532,15 +353,13 @@ Chapter: Using Bugzilla <orderedlist> <listitem> <para>Go to - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"> Landfill</ulink> - in your browser and click <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> - Enter a new bug report</ulink> - - .</para> + url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi"> + Enter a new bug report</ulink>. + </para> </listitem> <listitem> @@ -560,29 +379,138 @@ Chapter: Using Bugzilla </section> </section> - <section id="init4me"> - <title>User Preferences</title> + <section id="hintsandtips"> + <title>Hints and Tips</title> + + <para>This section distills some Bugzilla tips and best practices + that have been developed.</para> + + <section> + <title>Autolinkification</title> + <para>Bugzilla comments are plain text - so posting HTML will result + in literal HTML tags rather than being interpreted by a browser. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + http://www.bugzilla.org will be turned into + <ulink url="http://www.bugzilla.org">http://www.bugzilla.org</ulink>. + Other strings which get linkified in the obvious manner are: + <simplelist> + <member>bug 12345</member> + <member>bug 23456, comment 53</member> + <member>attachment 4321</member> + <member>mailto:george@example.com</member> + <member>george@example.com</member> + <member>ftp://ftp.mozilla.org</member> + <member>Most other sorts of URL</member> + </simplelist> + </para> + + <para>A corollary here is that if you type a bug number in a comment, + you should put the word "bug" before it, so it gets autolinkified + for the convenience of others. + </para> + </section> - <para>You can customise various aspects of Bugzilla, via the "Edit prefs" - link in the page footer, once you have logged in, e.g. to - <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> - Landfill</ulink> + <section id="quicksearch"> + <title>Quicksearch</title> - . The preferences are split into four tabs.</para> + <para>Quicksearch is a single-text-box query tool which uses + metacharacters to indicate what is to be searched. For example, typing + "<filename>foo|bar</filename>" + into Quicksearch would search for "foo" or "bar" in the + summary and status whiteboard of a bug; adding + "<filename>:BazProduct</filename>" would + search only in that product. + </para> + + <para>You'll find the Quicksearch box on Bugzilla's + front page, along with a + <ulink url="../../quicksearch.html">Help</ulink> + link which details how to use it.</para> + </section> + + <section id="commenting"> + <title>Comments</title> + + <para>If you are changing the fields on a bug, only comment if + either you have something pertinent to say, or Bugzilla requires it. + Otherwise, you may spam people unnecessarily with bug mail. + To take an example: a user can set up their account to filter out messages + where someone just adds themselves to the CC field of a bug + (which happens a lot.) If you come along, add yourself to the CC field, + and add a comment saying "Adding self to CC", then that person + gets a pointless piece of mail they would otherwise have avoided. + </para> + + <para> + Don't use sigs in comments. Signing your name ("Bill") is acceptable, + particularly if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. + </para> + </section> + + <section id="attachments"> + <title>Attachments</title> + + <para> + Use attachments, rather than comments, for large chunks of ASCII data, + such as trace, debugging output files, or log files. That way, it doesn't + bloat the bug for everyone who wants to read it, and cause people to + receive fat, useless mails. + </para> + + <para>Trim screenshots. There's no need to show the whole screen if + you are pointing out a single-pixel problem. + </para> + + <para>Don't attach simple test cases (e.g. one HTML file, one + CSS file and an image) as a ZIP file. Instead, upload them in + reverse order and edit the referring file so that they point to the + attached files. This way, the test case works immediately + out of the bug. + </para> + </section> + + <section> + <title>Filing Bugs</title> + + <para>Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + </para> + + <para> + You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + </para> + + <para>If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + </para> + </section> + </section> + + <section id="userpreferences"> + <title>User Preferences</title> + + <para>Once you have logged in, you can customise various aspects of + Bugzilla via the "Edit prefs" link in the page footer. + The preferences are split into four tabs:</para> <section id="accountsettings" xreflabel="Account Settings"> <title>Account Settings</title> - <para>On this tab, you can change your basic Account Settings, + <para>On this tab, you can change your basic account information, including your password, email address and real name. For security reasons, in order to change anything on this page you must type your <emphasis>current</emphasis> - password into the <quote>Password</quote> - - field. If you attempt to change your email address, a confirmation + field at the top of the page. + If you attempt to change your email address, a confirmation email is sent to both the old and new addresses, with a link to use to confirm the change. This helps to prevent account hijacking.</para> </section> @@ -600,28 +528,27 @@ Chapter: Using Bugzilla "Users to watch" text entry box you can receive a copy of all the bugmail of other users (security settings permitting.) 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.</para> + projects or users go on holiday.</para> <note> - <para>This option may not be available in all Bugzilla installations. - Ask your administrator.</para> + <para>The ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator.</para> </note> </section> <section id="footersettings"> <title>Page Footer</title> - - <para>By default, this page is quite barren. However, if you explore - the Search 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. Once you have a stored query, you can come + + <para>On the Search page, you can store queries in Bugzilla, so if you + regularly run a particular query it is just a drop-down menu away. + Once you have a stored query, you can come here to request that it also be displayed in your page footer.</para> </section> <section id="permissionsettings"> <title>Permissions</title> - + <para>This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you are in, and whether you can edit bugs or perform various administration diff --git a/docs/xml/variants.xml b/docs/xml/variants.xml index 5fbea801f..73f6822fb 100644 --- a/docs/xml/variants.xml +++ b/docs/xml/variants.xml @@ -1,5 +1,5 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">--> -<chapter id="variants" xreflabel="Bugzilla Variants and Competitors"> +<appendix id="variants" xreflabel="Bugzilla Variants and Competitors"> <title>Bugzilla Variants and Competitors</title> <para>I created this section to answer questions about Bugzilla competitors @@ -13,13 +13,12 @@ <section id="rhbugzilla" xreflabel="Red Hat Bugzilla"> <title>Red Hat Bugzilla</title> - <para>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 + <para>Red Hat Bugzilla is a fork of Bugzilla 2.8. + One of its major benefits 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.</para> + back-end, instead of just MySQL. Dave Lawrence of Red Hat is + active in the Bugzilla community, and we hope to see a reunification + of the fork before too long.</para> <para>URL: <ulink url="http://bugzilla.redhat.com/bugzilla/"> @@ -30,38 +29,26 @@ <section id="variant-fenris" xreflabel="Loki Bugzilla, a.k.a. Fenris"> <title>Loki Bugzilla (Fenris)</title> - <para>Fenris can be found at - <ulink url="http://fenris.lokigames.com/"> - http://fenris.lokigames.com</ulink> - - . It is a fork from Bugzilla.</para> + <para>Fenris was a fork from Bugzilla made by Loki Games; when + Loki went into receivership, it died. While Loki's other code lives on, + its custodians recommend Bugzilla for future bug-tracker deployments. + </para> </section> <section id="variant-issuezilla" xreflabel="Issuezilla"> <title>Issuezilla</title> - <para>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, - <xref linkend="variant-scarab" /> - - , is under heavy development and looks promising!</para> - - <para>URL: - <ulink url="http://issuezilla.tigris.org/servlets/ProjectHome"> - http://issuezilla.tigris.org/servlets/ProjectHome</ulink> - </para> + <para>Issuezilla was another fork from Bugzilla, made by collab.net and + hosted at tigris.org. It is also dead; the primary focus of bug-tracking + at tigris.org is their Java-based bug-tracker, + <xref linkend="variant-scarab"/>.</para> </section> - <section id="variant-scarab" - xreflabel="Scarab, a newfangled Java-based issue tracker"> + <section id="variant-scarab" xreflabel="Scarab"> <title>Scarab</title> - <para>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.</para> + <para>Scarab is a new open source bug-tracking system built using Java + Serlet technology. It is currently at version 1.0 beta 8.</para> <para>URL: <ulink url="http://scarab.tigris.org/">http://scarab.tigris.org</ulink> @@ -72,32 +59,29 @@ <title>Perforce SCM</title> <para>Although Perforce isn't really a bug tracker, it can be used as - such through the - <quote>jobs</quote> - + such through the <quote>jobs</quote> functionality.</para> - <para> + <para>URL: <ulink url="http://www.perforce.com/perforce/technotes/note052.html"> + http://www.perforce.com/perforce/technotes/note052.html </ulink> - - http://www.perforce.com/perforce/technotes/note052.html</para> + </para> </section> <section id="variant-sourceforge" xreflabel="SourceForge"> <title>SourceForge</title> - <para>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!</para> + <para>SourceForge is a way of coordinating geographically + distributed free software and open source projects over the Internet. + It has a built-in bug tracker, but it's not highly thought of.</para> <para>URL: <ulink url="http://www.sourceforge.net"> http://www.sourceforge.net</ulink> </para> </section> -</chapter> +</appendix> <!-- Keep this comment at the end of the file Local variables: |