></A
>The Bugzilla Team</H3
><P
+CLASS="edition"
+>2.17.3 Development Release Edition </P
+><P
CLASS="pubdate"
>2003-01-02<BR></P
><DIV
><DIV
CLASS="abstract"
><A
-NAME="AEN14"
+NAME="AEN15"
></A
><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 bug filed in
- <A
+ to a bug filed in the <A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation"
TARGET="_top"
->mozilla.org's Bugzilla</A
->.
+>Bugzilla Documentation</A
+> compontent.
</P
><P
>This is a development version of this guide. Information in it
></DT
><DT
>4.3. <A
-HREF="#win32"
->Win32 Installation Notes</A
+HREF="#os-specific"
+>OS Specific Installation Notes</A
></DT
><DT
>4.4. <A
-HREF="#osx"
->Mac OS X Installation Notes</A
+HREF="#http"
+>HTTP Server Configuration</A
></DT
><DT
>4.5. <A
></DL
></DD
><DT
+>E. <A
+HREF="#gfdl"
+>GNU Free Documentation License</A
+></DT
+><DD
+><DL
+><DT
+>0. <A
+HREF="#gfdl-0"
+>PREAMBLE</A
+></DT
+><DT
+>1. <A
+HREF="#gfdl-1"
+>APPLICABILITY AND DEFINITIONS</A
+></DT
+><DT
+>2. <A
+HREF="#gfdl-2"
+>VERBATIM COPYING</A
+></DT
+><DT
+>3. <A
+HREF="#gfdl-3"
+>COPYING IN QUANTITY</A
+></DT
+><DT
+>4. <A
+HREF="#gfdl-4"
+>MODIFICATIONS</A
+></DT
+><DT
+>5. <A
+HREF="#gfdl-5"
+>COMBINING DOCUMENTS</A
+></DT
+><DT
+>6. <A
+HREF="#gfdl-6"
+>COLLECTIONS OF DOCUMENTS</A
+></DT
+><DT
+>7. <A
+HREF="#gfdl-7"
+>AGGREGATION WITH INDEPENDENT WORKS</A
+></DT
+><DT
+>8. <A
+HREF="#gfdl-8"
+>TRANSLATION</A
+></DT
+><DT
+>9. <A
+HREF="#gfdl-9"
+>TERMINATION</A
+></DT
+><DT
+>10. <A
+HREF="#gfdl-10"
+>FUTURE REVISIONS OF THIS LICENSE</A
+></DT
+><DT
+><A
+HREF="#gfdl-howto"
+>How to use this License for your documents</A
+></DT
+></DL
+></DD
+><DT
><A
HREF="#glossary"
>Glossary</A
></DT
><DT
>4-1. <A
-HREF="#AEN1032"
->Installing ActivePerl ppd Modules on Microsoft
- Windows</A
-></DT
-><DT
->4-2. <A
-HREF="#AEN1045"
->Installing OpenInteract ppd Modules manually on Microsoft
- Windows</A
-></DT
-><DT
->4-3. <A
-HREF="#AEN1211"
->Removing encrypt() for Windows NT Bugzilla version 2.12 or
- earlier</A
+HREF="#http-apache-htaccess"
+><TT
+CLASS="filename"
+>.htaccess</TT
+> files for Apache</A
></DT
><DT
>5-1. <A
></A
>1.1. Copyright Information</H1
><A
-NAME="AEN33"
+NAME="AEN34"
></A
><TABLE
BORDER="0"
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 below.
+ the license is included in <A
+HREF="#gfdl"
+>Appendix E</A
+>.
</P
></TD
><TD
VALIGN="TOP"
>--<SPAN
CLASS="attribution"
->Copyright (c) 2000-2002 Matthew P. Barnson and The Bugzilla Team</SPAN
+>Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla Team</SPAN
></TD
><TD
WIDTH="10%"
copyright, or publishing this document in non-electronic form,
please contact The Bugzilla Team.
</P
+></DIV
><DIV
CLASS="section"
-><HR><H2
+><HR><H1
CLASS="section"
><A
-NAME="gfdl"
+NAME="disclaimer"
></A
->1.1.1. GNU Free Documentation License</H2
+>1.2. Disclaimer</H1
><P
->Version 1.1, March 2000</P
-><A
-NAME="AEN40"
-></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
+> No liability for the contents of this document can be accepted.
+ Use the 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.
+ </P
><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"
-></A
->0. PREAMBLE</H3
+> All copyrights are held by their respective owners, unless
+ specifically noted otherwise. Use of a term in this document
+ should not be regarded as affecting the validity of any
+ trademark or service mark.
+ </P
><P
->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
+> Naming of particular products or brands should not be seen as
+ 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
+ environment for Bugzilla.
+ </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
+> You are strongly recommended to make a backup of your system
+ before installing Bugzilla and at regular intervals thereafter.
+ If you implement any suggestion in this Guide, implement this one!
+ </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
+> Although the Bugzilla development team has taken great care to
+ ensure that all easily-exploitable bugs or options are
+ documented or fixed in the code, security holes surely exist.
+ Great care should be taken both in the installation and usage of
+ this software. Carefully consider the implications of installing
+ other network services with Bugzilla. The Bugzilla development
+ team members, Netscape Communications, America Online Inc., and
+ any affiliated developers or sponsors assume no liability for
+ your use of this product. You have the source code to this
+ product, and are responsible for auditing it yourself to ensure
+ your security needs are met.
+ </P
></DIV
><DIV
CLASS="section"
-><HR><H3
+><HR><H1
CLASS="section"
><A
-NAME="gfdl-1"
+NAME="newversions"
></A
->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
+>1.3. New Versions</H1
><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
+> This is the 2.17.3 version of The Bugzilla Guide. It is so named
+ to match the current version of Bugzilla.
+
+ This version of the guide, like its associated Bugzilla version is a
+ development version. Information is subject to change between now and
+ when 2.18 is released.
+
+ If you are
+ reading this from any source other than those below, please
+ check one of these mirrors to make sure you are reading an
+ up-to-date version of the Guide.
+ </P
><P
->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
+> The newest version of this guide can always be found at <A
+HREF="http://www.bugzilla.org"
+TARGET="_top"
+>bugzilla.org</A
+>; including
+ documentation for past releases and the current development version.
+ </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
+> The documentation for the most recent stable release of Bugzilla can also
+ be found at
+ <A
+HREF="http://www.tldp.org"
+TARGET="_top"
+>The Linux Documentation Project</A
+>.
+ </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
+> 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
+CLASS="filename"
+>mozilla/webtools/bugzilla/docs/</TT
+>
+ subtree.
+ </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
+> 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
CLASS="section"
-><HR><H3
+><HR><H1
CLASS="section"
><A
-NAME="gfdl-2"
+NAME="credits"
></A
->2. VERBATIM COPYING</H3
+>1.4. Credits</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
+> The people listed below have made enormous contributions to the
+ 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
->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"
-></A
->3. COPYING IN QUANTITY</H3
+> <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
->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
+> <A
+HREF="mailto://terry@mozilla.org"
+TARGET="_top"
+>Terry Weissman</A
+>
+ for initially writing Bugzilla and creating the
+ README upon which the UNIX installation documentation is largely based.
+ </P
><P
->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
+> <A
+HREF="mailto://tara@tequilarista.org"
+TARGET="_top"
+>Tara Hernandez</A
+>
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
+ </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
+> <A
+HREF="mailto://dkl@redhat.com"
+TARGET="_top"
+>Dave Lawrence</A
+>
+ for providing insight into the key differences between Red Hat's
+ customized Bugzilla, and being largely responsible for the "Red
+ Hat Bugzilla" appendix
+ </P
><P
->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
+> <A
+HREF="mailto://endico@mozilla.org"
+TARGET="_top"
+>Dawn Endico</A
+> for
+ being a hacker extraordinaire and putting up with my incessant
+ questions and arguments on irc.mozilla.org in #mozwebtools
+ </P
+><P
+> Last but not least, all the members of the
+ <A
+HREF="news://news.mozilla.org/netscape/public/mozilla/webtools"
+TARGET="_top"
+> netscape.public.mozilla.webtools</A
+> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
+ </P
+><P
+> Thanks also go to the following people for significant contributions
+ to this documentation (in no particular order):
+ </P
+><P
+> Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
+ </P
></DIV
><DIV
CLASS="section"
-><HR><H3
+><HR><H1
CLASS="section"
><A
-NAME="gfdl-4"
+NAME="conventions"
></A
->4. MODIFICATIONS</H3
+>1.5. Document Conventions</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
+>This document uses the following conventions:</P
+><DIV
+CLASS="informaltable"
+><A
+NAME="AEN80"
+></A
><P
></P
-><OL
-TYPE="A"
-><LI
+><TABLE
+BORDER="0"
+CLASS="CALSTABLE"
+><THEAD
+><TR
+><TH
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Descriptions</TH
+><TH
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Appearance</TH
+></TR
+></THEAD
+><TBODY
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Warnings</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <DIV
+CLASS="caution"
><P
->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
+><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
->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
+>Don't run with scissors!</P
+></TD
+></TR
+></TABLE
+></DIV
+>
+ </TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Hint</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <DIV
+CLASS="tip"
><P
->State on the Title page the name of the publisher of the
- Modified Version, as the publisher.</P
-></LI
-><LI
+></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
->Preserve all the copyright notices of the Document.</P
-></LI
-><LI
+>Would you like a breath mint?</P
+></TD
+></TR
+></TABLE
+></DIV
+>
+ </TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Notes</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <DIV
+CLASS="note"
><P
->Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.</P
-></LI
-><LI
+></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
->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"
-></A
->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"
-></A
->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"
-></A
->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"
-></A
->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"
-></A
->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"
-></A
->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"
-></A
->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="AEN130"
-></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
-><P
->Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
- distribute and/or modify this document under the terms of the GNU Free
- Documentation License, Version 1.1 or any later version published by
- the Free Software Foundation; with the Invariant Sections being LIST
- THEIR TITLES, with the Front-Cover Texts being LIST, and with the
- Back-Cover Texts being LIST. A copy of the license is included in the
- section entitled "GNU Free Documentation License".</P
-></BLOCKQUOTE
-><P
->If you have no Invariant Sections, write "with no Invariant
- Sections" instead of saying which ones are invariant. If you have no
- Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover
- Texts being LIST"; likewise for Back-Cover Texts.</P
-><P
->If your document contains nontrivial examples of program code, we
- recommend releasing these examples in parallel under your choice of free
- software license, such as the GNU General Public License, to permit their
- use in free software.</P
-></DIV
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="disclaimer"
-></A
->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.
- 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
- specifically noted otherwise. Use of a term in this document
- should not be regarded as affecting the validity of any
- trademark or service mark.
- </P
-><P
-> Naming of particular products or brands should not be seen as
- endorsements, with the exception of the term "GNU/Linux". 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.
- </P
-><P
-> You are strongly recommended to make a backup of your system
- before installing Bugzilla and at regular intervals thereafter.
- If you implement any suggestion in this Guide, implement this one!
- </P
-><P
-> Although the Bugzilla development team has taken great care to
- ensure that all easily-exploitable bugs or options are
- documented or fixed in the code, security holes surely exist.
- Great care should be taken both in the installation and usage of
- this software. Carefully consider the implications of installing
- other network services with Bugzilla. The Bugzilla development
- team members, Netscape Communications, America Online Inc., and
- any affiliated developers or sponsors assume no liability for
- your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to ensure
- your security needs are met.
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="newversions"
-></A
->1.3. New Versions</H1
-><P
-> This is the 2.17.3 version of The Bugzilla Guide. It is so named
- to match the current version of Bugzilla.
-
- This version of the guide, like its associated Bugzilla version is a
- development version. Information is subject to change between now and
- when 2.18 is released.
-
- If you are
- reading this from any source other than those below, please
- check one of these mirrors to make sure you are reading an
- up-to-date version of the Guide.
- </P
-><P
-> The newest version of this guide can always be found at <A
-HREF="http://www.bugzilla.org"
-TARGET="_top"
->bugzilla.org</A
->; including
- documentation for past releases and the current development version.
- </P
-><P
-> The documentation for the most recent stable release of Bugzilla can also
- be found at
- <A
-HREF="http://www.tldp.org"
-TARGET="_top"
->The Linux Documentation Project</A
->.
- </P
-><P
-> 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
-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
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="credits"
-></A
->1.4. Credits</H1
-><P
-> The people listed below have made enormous contributions to the
- 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
->
- for initially writing Bugzilla and creating the
- README upon which the UNIX installation documentation is largely based.
- </P
-><P
-> <A
-HREF="mailto://tara@tequilarista.org"
-TARGET="_top"
->Tara Hernandez</A
->
- for keeping Bugzilla development going
- strong after Terry left mozilla.org
- </P
-><P
-> <A
-HREF="mailto://dkl@redhat.com"
-TARGET="_top"
->Dave Lawrence</A
->
- for providing insight into the key differences between Red Hat's
- customized Bugzilla, and being largely responsible for the "Red
- Hat Bugzilla" appendix
- </P
-><P
-> <A
-HREF="mailto://endico@mozilla.org"
-TARGET="_top"
->Dawn Endico</A
-> for
- being a hacker extraordinaire and putting up with my incessant
- questions and arguments on irc.mozilla.org in #mozwebtools
- </P
-><P
-> Last but not least, all the members of the
- <A
-HREF="news://news.mozilla.org/netscape/public/mozilla/webtools"
-TARGET="_top"
-> netscape.public.mozilla.webtools</A
-> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
- </P
-><P
-> Thanks also go to the following people for significant contributions
- to this documentation (in no particular order):
- </P
-><P
-> Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="conventions"
-></A
->1.5. Document Conventions</H1
-><P
->This document uses the following conventions:</P
-><DIV
-CLASS="informaltable"
-><A
-NAME="AEN175"
-></A
-><P
-></P
-><TABLE
-BORDER="0"
-CLASS="CALSTABLE"
-><THEAD
-><TR
-><TH
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Descriptions</TH
-><TH
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Appearance</TH
-></TR
-></THEAD
-><TBODY
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Warnings</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <DIV
-CLASS="caution"
-><P
-></P
-><TABLE
-CLASS="caution"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/caution.gif"
-HSPACE="5"
-ALT="Caution"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Don't run with scissors!</P
-></TD
-></TR
-></TABLE
-></DIV
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Hint</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <DIV
-CLASS="tip"
-><P
-></P
-><TABLE
-CLASS="tip"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/tip.gif"
-HSPACE="5"
-ALT="Tip"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Would you like a breath mint?</P
-></TD
-></TR
-></TABLE
-></DIV
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Notes</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Dear John...</P
-></TD
-></TR
-></TABLE
-></DIV
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Information requiring special attention</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <DIV
-CLASS="warning"
-><P
-></P
-><TABLE
-CLASS="warning"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/warning.gif"
-HSPACE="5"
-ALT="Warning"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Read this or the cat gets it.</P
-></TD
-></TR
-></TABLE
-></DIV
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->File Names</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <TT
-CLASS="filename"
->filename</TT
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Directory Names</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <TT
-CLASS="filename"
->directory</TT
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Commands to be typed</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <B
-CLASS="command"
->command</B
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Applications Names</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <SPAN
-CLASS="application"
->application</SPAN
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <I
-CLASS="foreignphrase"
->Prompt</I
->
-
- of users command under bash shell</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->bash$</TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <I
-CLASS="foreignphrase"
->Prompt</I
->
-
- of root users command under bash shell</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->bash#</TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <I
-CLASS="foreignphrase"
->Prompt</I
->
-
- of user command under tcsh shell</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->tcsh$</TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Environment Variables</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <TT
-CLASS="envar"
->VARIABLE</TT
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Emphasized word</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <EM
->word</EM
->
- </TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
->Code Example</TD
-><TD
-ALIGN="LEFT"
-VALIGN="MIDDLE"
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-><TT
-CLASS="sgmltag"
-><para></TT
->
-Beginning and end of paragraph
-<TT
-CLASS="sgmltag"
-></para></TT
-></PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </TD
-></TR
-></TBODY
-></TABLE
-><P
-></P
-></DIV
-></DIV
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="introduction"
-></A
->Chapter 2. Introduction</H1
-><DIV
-CLASS="section"
-><H1
-CLASS="section"
-><A
-NAME="whatis"
-></A
->2.1. What is Bugzilla?</H1
-><P
-> 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 boasts many advanced features. These include:
- <P
-></P
-><UL
-><LI
-><P
->Powerful searching</P
-></LI
-><LI
-><P
->User-configurable email notifications of bug changes</P
-></LI
-><LI
-><P
->Full change history</P
-></LI
-><LI
-><P
->Inter-bug dependency tracking and graphing</P
-></LI
-><LI
-><P
->Excellent attachment management</P
-></LI
-><LI
-><P
->Integrated, product-based, granular security schema</P
-></LI
-><LI
-><P
->Fully security-audited, and runs under Perl's taint mode</P
-></LI
-><LI
-><P
->A robust, stable RDBMS back-end</P
-></LI
-><LI
-><P
->Web, XML, email and console interfaces</P
-></LI
-><LI
-><P
->Completely customisable and/or localisable web user
- interface</P
-></LI
-><LI
-><P
->Extensive configurability</P
-></LI
-><LI
-><P
->Smooth upgrade pathway between versions</P
-></LI
-></UL
->
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="why"
-></A
->2.2. Why Should We Use Bugzilla?</H1
-><P
->For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor the status of defects. This procedure
- is error-prone and tends to cause those bugs judged least significant by
- developers to be dropped or ignored.</P
-><P
->These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.</P
-><P
->But why should
- <EM
->you</EM
->
-
- use Bugzilla?</P
-><P
->Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration deployment
- management, chip design and development problem tracking (both
- pre-and-post fabrication), and software and hardware bug tracking for
- luminaries such as Redhat, 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 follow the discussion trail
- that led to critical decisions.</P
-><P
->Ultimately, Bugzilla puts the power in your hands to improve your
- value to your employer or business while providing a usable framework for
- your natural attention to detail and knowledge store to flourish.</P
-></DIV
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="using"
-></A
->Chapter 3. Using Bugzilla</H1
-><DIV
-CLASS="section"
-><H1
-CLASS="section"
-><A
-NAME="how"
-></A
->3.1. How do I use Bugzilla?</H1
-><P
->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 (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"
-></A
->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.bugzilla.org/bugzilla-tip/</A
->
- </P
-><P
-></P
-><OL
-TYPE="1"
-><LI
-><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 can be
- changed to something more memorable.</P
-></LI
-><LI
-><P
->Click the
- <SPAN
-CLASS="QUOTE"
->"Log In"</SPAN
->
- link in the yellow area at the bottom of the page in your browser,
- enter your email address and password into the spaces provided, and
- click
- <SPAN
-CLASS="QUOTE"
->"Login"</SPAN
->.
- </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
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="bug_page"
-></A
->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.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1"
-TARGET="_top"
-> 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
->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.</TD
-></TR
-><TR
-><TD
-> <EM
->Bugzilla-General:</EM
->
- Anything that doesn't fit in the other components, or spans
- multiple components.</TD
-></TR
-><TR
-><TD
-> <EM
->Creating/Changing Bugs:</EM
->
- Creating, changing, and viewing bugs.</TD
-></TR
-><TR
-><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.</TD
-></TR
-><TR
-><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.</TD
-></TR
-><TR
-><TD
-> <EM
->Reporting/Charting:</EM
->
- Getting reports from Bugzilla.</TD
-></TR
-><TR
-><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
+>Dear John...</P
+></TD
></TR
-></TBODY
></TABLE
-><P
-></P
->
- </P
-></LI
-><LI
-><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
-></LI
-><LI
-><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
-></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
-></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
-></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"
-></A
->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.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"
-></A
->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
+>
+ </TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Information requiring special attention</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <DIV
+CLASS="warning"
><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
+CLASS="warning"
+WIDTH="100%"
BORDER="0"
-><TBODY
><TR
><TD
-> <EM
->Long Format:</EM
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/warning.gif"
+HSPACE="5"
+ALT="Warning"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>Read this or the cat gets it.</P
+></TD
+></TR
+></TABLE
+></DIV
>
-
- this gives you a large page with a non-editable summary of the fields
- of each bug.</TD
+ </TD
></TR
><TR
><TD
-> <EM
->Change Columns:</EM
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>File Names</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <TT
+CLASS="filename"
+>filename</TT
>
-
- change the bug attributes which appear in the list.</TD
+ </TD
></TR
><TR
><TD
-> <EM
->Change several bugs at once:</EM
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Directory Names</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <TT
+CLASS="filename"
+>directory</TT
>
-
- 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
+ </TD
></TR
><TR
><TD
-> <EM
->Send mail to bug owners:</EM
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Commands to be typed</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <B
+CLASS="command"
+>command</B
>
-
- Sends mail to the owners of all bugs on the list.</TD
+ </TD
></TR
><TR
><TD
-> <EM
->Edit this query:</EM
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Applications Names</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <SPAN
+CLASS="application"
+>application</SPAN
>
-
- 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
+ </TD
></TR
-></TBODY
-></TABLE
-><P
-></P
->
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="bugreports"
-></A
->3.1.5. Filing Bugs</H2
-><P
->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
-><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.bugzilla.org/bugzilla-tip/"
-TARGET="_top"
-> 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
->.
- </P
-></LI
-><LI
-><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
-></LI
-><LI
-><P
->Select "Commit" and send in your bug report.</P
-></LI
-></OL
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
-><A
-NAME="hintsandtips"
-></A
->3.2. Hints and Tips</H1
-><P
->This section distills some Bugzilla tips and best practices
- that have been developed.</P
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN431"
-></A
->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
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <I
+CLASS="foreignphrase"
+>Prompt</I
+>
+
+ of users command under bash shell</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>bash$</TD
></TR
><TR
><TD
->bug 23456, comment 53</TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <I
+CLASS="foreignphrase"
+>Prompt</I
+>
+
+ of root users command under bash shell</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>bash#</TD
></TR
><TR
><TD
->attachment 4321</TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <I
+CLASS="foreignphrase"
+>Prompt</I
+>
+
+ of user command under tcsh shell</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>tcsh$</TD
></TR
><TR
><TD
->mailto:george@example.com</TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Environment Variables</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <TT
+CLASS="envar"
+>VARIABLE</TT
+>
+ </TD
></TR
><TR
><TD
->george@example.com</TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Emphasized word</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <EM
+>word</EM
+>
+ </TD
></TR
><TR
><TD
->ftp://ftp.mozilla.org</TD
-></TR
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+>Code Example</TD
+><TD
+ALIGN="LEFT"
+VALIGN="MIDDLE"
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
->Most other sorts of URL</TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+><TT
+CLASS="sgmltag"
+><para></TT
+>
+Beginning and end of paragraph
+<TT
+CLASS="sgmltag"
+></para></TT
+></PRE
+></FONT
+></TD
+></TR
+></TABLE
+>
+ </TD
></TR
></TBODY
></TABLE
><P
></P
->
- </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
></DIV
><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
+CLASS="chapter"
+><HR><H1
><A
-NAME="quicksearch"
+NAME="introduction"
></A
->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
+>Chapter 2. Introduction</H1
><DIV
CLASS="section"
-><HR><H2
+><H1
CLASS="section"
><A
-NAME="commenting"
+NAME="whatis"
></A
->3.2.3. Comments</H2
+>2.1. What is Bugzilla?</H1
><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
+> 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
-> 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
+>Bugzilla boasts many advanced features. These include:
+ <P
+></P
+><UL
+><LI
+><P
+>Powerful searching</P
+></LI
+><LI
+><P
+>User-configurable email notifications of bug changes</P
+></LI
+><LI
+><P
+>Full change history</P
+></LI
+><LI
+><P
+>Inter-bug dependency tracking and graphing</P
+></LI
+><LI
+><P
+>Excellent attachment management</P
+></LI
+><LI
+><P
+>Integrated, product-based, granular security schema</P
+></LI
+><LI
+><P
+>Fully security-audited, and runs under Perl's taint mode</P
+></LI
+><LI
+><P
+>A robust, stable RDBMS back-end</P
+></LI
+><LI
+><P
+>Web, XML, email and console interfaces</P
+></LI
+><LI
+><P
+>Completely customisable and/or localisable web user
+ interface</P
+></LI
+><LI
+><P
+>Extensive configurability</P
+></LI
+><LI
+><P
+>Smooth upgrade pathway between versions</P
+></LI
+></UL
+>
+ </P
></DIV
><DIV
CLASS="section"
-><HR><H2
+><HR><H1
CLASS="section"
><A
-NAME="attachments"
+NAME="why"
></A
->3.2.4. Attachments</H2
+>2.2. Why Should We Use Bugzilla?</H1
><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
+>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
->Trim screenshots. There's no need to show the whole screen if
- you are pointing out a single-pixel problem.
- </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
->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
+>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, 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 follow the discussion trail
+ that led to critical decisions.</P
+><P
+>Ultimately, Bugzilla puts the power in your hands to improve your
+ value to your employer or business while providing a usable framework for
+ your natural attention to detail and knowledge store to flourish.</P
+></DIV
></DIV
><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
+CLASS="chapter"
+><HR><H1
><A
-NAME="AEN460"
+NAME="using"
></A
->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
+>Chapter 3. Using Bugzilla</H1
><DIV
CLASS="section"
-><HR><H1
+><H1
CLASS="section"
><A
-NAME="userpreferences"
+NAME="how"
></A
->3.3. User Preferences</H1
+>3.1. How do I use Bugzilla?</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
+>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 (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="accountsettings"
+NAME="myaccount"
></A
->3.3.1. Account Settings</H2
+>3.1.1. Create a Bugzilla Account</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
+>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.bugzilla.org/bugzilla-tip/</A
>
- password into the
- <SPAN
+ </P
+><P
+></P
+><OL
+TYPE="1"
+><LI
+><P
+>Click the
+ <SPAN
CLASS="QUOTE"
->"Password"</SPAN
+>"Open a new Bugzilla account"</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
+
+ 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 can be
+ changed to something more memorable.</P
+></LI
+><LI
+><P
+>Click the
+ <SPAN
+CLASS="QUOTE"
+>"Log In"</SPAN
+>
+ link in the yellow area at the bottom of the page in your browser,
+ enter your email address and password into the spaces provided, and
+ click
+ <SPAN
+CLASS="QUOTE"
+>"Login"</SPAN
+>.
+ </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
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
-NAME="emailsettings"
+NAME="bug_page"
></A
->3.3.2. Email Settings</H2
+>3.1.2. Anatomy of a Bug</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
+>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 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
->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
+><OL
+TYPE="1"
+><LI
><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
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
+> <EM
+>Administration:</EM
+>
+ Administration of a Bugzilla installation.</TD
+></TR
+><TR
><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
+> <EM
+>Bugzilla-General:</EM
+>
+ Anything that doesn't fit in the other components, or spans
+ multiple components.</TD
></TR
-></TABLE
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="footersettings"
-></A
->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><H2
-CLASS="section"
-><A
-NAME="permissionsettings"
-></A
->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
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="installation"
-></A
->Chapter 4. Installation</H1
-><DIV
-CLASS="section"
-><H1
-CLASS="section"
-><A
-NAME="stepbystep"
-></A
->4.1. Step-by-step Install</H1
-><DIV
-CLASS="section"
-><H2
-CLASS="section"
-><A
-NAME="AEN489"
-></A
->4.1.1. Introduction</H2
-><P
->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
+><TR
+><TD
+> <EM
+>Creating/Changing Bugs:</EM
+>
+ Creating, changing, and viewing bugs.</TD
+></TR
+><TR
+><TD
+> <EM
+>Documentation:</EM
>
- for further advice on getting Bugzilla to work on Microsoft
- Windows.</P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN493"
-></A
->4.1.2. Package List</H2
-><DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
+ The Bugzilla documentation, including The Bugzilla Guide.</TD
+></TR
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
+> <EM
+>Email:</EM
+>
+ Anything to do with email sent by Bugzilla.</TD
+></TR
+><TR
><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
-> 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
-></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.</TD
+></TR
+><TR
+><TD
+> <EM
+>Reporting/Charting:</EM
+>
+ Getting reports from Bugzilla.</TD
+></TR
+><TR
+><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
></TR
+></TBODY
></TABLE
-></DIV
><P
->The software packages necessary for the proper running of
- Bugzilla (with download links) are:
- <P
></P
-><OL
-TYPE="1"
+>
+ </P
+></LI
><LI
><P
-> <A
-HREF="http://www.mysql.com/"
-TARGET="_top"
->MySQL database server</A
+> <EM
+>Status and Resolution:</EM
>
- (3.23.41 or greater)
- </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
-HREF="http://www.perl.org"
-TARGET="_top"
->Perl</A
+> <EM
+>Assigned To:</EM
>
- (5.6, 5.6.1 is recommended if you wish to
- use Bundle::Bugzilla)
- </P
+ The person responsible for fixing the bug.</P
></LI
><LI
><P
->Perl Modules (minimum version):
- <P
-></P
-><OL
-TYPE="a"
+> <EM
+>*URL:</EM
+>
+ A URL associated with the bug, if any.</P
+></LI
><LI
><P
-> <A
-HREF="http://www.template-toolkit.org"
-TARGET="_top"
->Template</A
+> <EM
+>Summary:</EM
>
- (v2.08)
- </P
+ A one-sentence summary of the problem.</P
></LI
><LI
><P
-> <A
-HREF="http://www.perldoc.com/perl5.6/lib/File/Temp.html"
-TARGET="_top"
-> File::Temp</A
+> <EM
+>*Status Whiteboard:</EM
>
- (1.804) (Prerequisite for Template)
- </P
+ (a.k.a. Whiteboard) A free-form text area for adding short notes
+ and tags to a bug.</P
></LI
><LI
><P
-> <A
-HREF="http://www.cpan.org/modules/by-module/AppConfig/"
-TARGET="_top"
->AppConfig
- </A
+> <EM
+>*Keywords:</EM
>
- (1.52)
- </P
+ 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
-> <A
-HREF="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz"
-TARGET="_top"
->Text::Wrap</A
->
- (2001.0131)
- </P
+> <EM
+>Platform and OS:</EM
+>
+ These indicate the computing environment where the bug was
+ found.</P
></LI
><LI
><P
-> <A
-HREF="http://search.cpan.org/search?dist=File-Spec"
-TARGET="_top"
->File::Spec
- </A
+> <EM
+>Version:</EM
>
- (0.82)
- </P
+ 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
-> <A
-HREF="http://www.cpan.org/modules/by-module/Data/"
-TARGET="_top"
->Data::Dumper
- </A
->
- (any)
- </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
-> <A
-HREF="http://www.cpan.org/modules/by-module/Mysql/"
-TARGET="_top"
->DBD::mysql
- </A
->
- (1.2209)
- </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
-> <A
-HREF="http://www.cpan.org/modules/by-module/DBI/"
-TARGET="_top"
->DBI</A
->
- (1.13)
- </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
-> <A
-HREF="http://www.cpan.org/modules/by-module/Date/"
-TARGET="_top"
->Date::Parse
- </A
->
- (any)
- </P
+> <EM
+>*Votes:</EM
+>
+ Whether this bug has any votes.</P
></LI
><LI
><P
-> <A
-HREF="http://www.cpan.org/modules/by-module/CGI/"
-TARGET="_top"
->CGI
- </A
->
- (2.88)
- </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"
+></A
+>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.bugzilla.org/bugzilla-tip/query.cgi"
+TARGET="_top"
+> landfill.bugzilla.org/bugzilla-tip/query.cgi</A
>
- and, optionally:
- <P
-></P
-><OL
-TYPE="a"
-><LI
+
+ .</P
><P
-> <A
-HREF="http://www.cpan.org/modules/by-module/GD/"
+>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"
->GD</A
+> context-sensitive help</A
>
- (1.20) for bug charting
- </P
-></LI
-><LI
+
+ .</P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="list"
+></A
+>3.1.4. Bug Lists</H2
><P
-> GD::Graph
- (any) for bug charting
- </P
-></LI
-><LI
+>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
-> GD::Text::Align
- (any) for bug charting
+>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
+></TR
+><TR
+><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
+></TR
+><TR
+><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
+><P
+></P
+>
</P
-></LI
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="bugreports"
+></A
+>3.1.5. Filing Bugs</H2
+><P
+>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
+><P
+>The procedure for filing a test bug is as follows:</P
+><P
+></P
+><OL
+TYPE="1"
><LI
><P
-> <A
-HREF="http://www.cpan.org/modules/by-module/Chart/"
+>Go to
+ <A
+HREF="http://landfill.bugzilla.org/bugzilla-tip/"
TARGET="_top"
->Chart::Base
- </A
+> Landfill</A
>
- (0.99c) for bug charting
- </P
+ in your browser and click
+ <A
+HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi"
+TARGET="_top"
+> Enter a new bug report</A
+>.
+ </P
></LI
><LI
><P
-> XML::Parser
- (any) for the XML interface
- </P
+>Select a product - any one will do.</P
></LI
><LI
><P
-> MIME::Parser
- (any) for the email interface
- </P
-></LI
-></OL
->
- </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
-> The web server of your choice.
- <A
-HREF="http://www.apache.org/"
-TARGET="_top"
->Apache</A
->
- is highly recommended.
- </P
+>Select "Commit" and send in your bug report.</P
></LI
></OL
->
-
- <DIV
-CLASS="warning"
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="hintsandtips"
+></A
+>3.2. Hints and Tips</H1
+><P
+>This section distills some Bugzilla tips and best practices
+ that have been developed.</P
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="AEN336"
+></A
+>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
-CLASS="warning"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/warning.gif"
-HSPACE="5"
-ALT="Warning"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->It is a good idea, while installing Bugzilla, to ensure 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
+>bug 12345</TD
></TR
-></TABLE
-></DIV
->
-
- <DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Linux-Mandrake 8.0 includes every
- required and optional library for Bugzilla. The easiest way to
- install them is by using the
- <TT
-CLASS="filename"
->urpmi</TT
->
-
- utility. If you follow these commands, you should have everything you
- need for Bugzilla, and
- <TT
-CLASS="filename"
->checksetup.pl</TT
->
-
- should not complain about any missing libraries. You may already have
- some of these installed.</P
-><P
-></P
-><TABLE
-BORDER="0"
-><TBODY
+>bug 23456, comment 53</TD
+></TR
><TR
><TD
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->urpmi perl-mysql</B
->
- </TD
+>attachment 4321</TD
></TR
><TR
><TD
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->urpmi perl-chart</B
->
- </TD
+>mailto:george@example.com</TD
></TR
><TR
><TD
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->urpmi perl-gd</B
->
- </TD
+>george@example.com</TD
></TR
><TR
><TD
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->urpmi perl-MailTools</B
->
-
- (for Bugzilla email integration)</TD
+>ftp://ftp.mozilla.org</TD
></TR
><TR
><TD
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->urpmi apache-modules</B
->
- </TD
+>Most other sorts of URL</TD
></TR
></TBODY
></TABLE
><P
-></P
-></TD
-></TR
-></TABLE
-></DIV
+></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="quicksearch"
+></A
+>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"
+><HR><H2
+CLASS="section"
+><A
+NAME="commenting"
+></A
+>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"
+><HR><H2
+CLASS="section"
+><A
+NAME="attachments"
+></A
+>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"
+><HR><H2
+CLASS="section"
+><A
+NAME="AEN365"
+></A
+>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="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="userpreferences"
+></A
+>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"
+><HR><H2
+CLASS="section"
+><A
+NAME="accountsettings"
+></A
+>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
>
- </P
+ 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="install-mysql"
+NAME="emailsettings"
></A
->4.1.3. MySQL</H2
+>3.3.2. Email Settings</H2
><P
->Visit the MySQL homepage at
- <A
-HREF="http://www.mysql.com"
-TARGET="_top"
->www.mysql.com</A
->
- to grab and install the latest stable release of the server.
- </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
ALIGN="LEFT"
VALIGN="TOP"
><P
-> Many of the binary
- versions of MySQL store their data files in
- <TT
-CLASS="filename"
->/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"
->configure</TT
->
- if you build MySQL from source yourself.</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"
+><HR><H2
+CLASS="section"
+><A
+NAME="footersettings"
+></A
+>3.3.3. Page Footer</H2
><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
-><P
->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
+>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><H2
CLASS="section"
><A
-NAME="install-perl"
+NAME="permissionsettings"
></A
->4.1.4. Perl</H2
+>3.3.4. Permissions</H2
><P
->Any machine that doesn't have Perl on it is a sad machine indeed.
- Perl can be got in source form from
+>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"
+></A
+>Chapter 4. Installation</H1
+><DIV
+CLASS="section"
+><H1
+CLASS="section"
+><A
+NAME="stepbystep"
+></A
+>4.1. Step-by-step Install</H1
+><DIV
+CLASS="section"
+><H2
+CLASS="section"
+><A
+NAME="intstall-into"
+></A
+>4.1.1. Introduction</H2
+><P
+>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
<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 perl 5.6,
- 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.8.</P
+HREF="#os-win32"
+>Section 4.3.1</A
+>
+ for further advice on getting Bugzilla to work on Microsoft
+ Windows.</P
+></DIV
><DIV
-CLASS="tip"
+CLASS="section"
+><HR><H2
+CLASS="section"
><A
-NAME="bundlebugzilla"
+NAME="install-package-list"
></A
+>4.1.2. Package List</H2
+><DIV
+CLASS="note"
><P
></P
><TABLE
-CLASS="tip"
+CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
ALIGN="CENTER"
VALIGN="TOP"
><IMG
-SRC="../images/tip.gif"
+SRC="../images/note.gif"
HSPACE="5"
-ALT="Tip"></TD
+ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
->You can skip the following Perl module installation steps by
- installing
- <SPAN
-CLASS="productname"
->Bundle::Bugzilla</SPAN
->
-
- from
+> 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="#gloss-cpan"
-><I
-CLASS="glossterm"
->CPAN</I
-></A
->,
- which installs all required modules for you.</P
+HREF="#bundlebugzilla"
+>Using Bundle::Bugzilla instead of manually installing Perl modules</A
+>.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
+><P
+>The software packages necessary for the proper running of
+ Bugzilla (with download links) are:
+ <P
+></P
+><OL
+TYPE="1"
+><LI
+><P
+> <A
+HREF="http://www.mysql.com/"
+TARGET="_top"
+>MySQL database server</A
+>
+ (3.23.41 or greater)
+ </P
+></LI
+><LI
+><P
+> <A
+HREF="http://www.perl.org"
+TARGET="_top"
+>Perl</A
+>
+ (5.6, 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
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->perl -MCPAN -e 'install "Bundle::Bugzilla"'</B
+> <A
+HREF="http://www.template-toolkit.org"
+TARGET="_top"
+>Template</A
>
- </TT
+ (v2.08)
+ </P
+></LI
+><LI
+><P
+> <A
+HREF="http://www.perldoc.com/perl5.6/lib/File/Temp.html"
+TARGET="_top"
+> File::Temp</A
>
- </P
+ (1.804) (Prerequisite for Template)
+ </P
+></LI
+><LI
><P
->Bundle::Bugzilla doesn't include GD, Chart::Base, or
- MIME::Parser, which are not essential to a basic Bugzilla install. If
- installing this bundle fails, you should install each module
- individually to isolate the problem.</P
-></TD
-></TR
-></TABLE
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="perl-modules"
-></A
->4.1.5. Perl Modules</H2
+> <A
+HREF="http://www.cpan.org/modules/by-module/AppConfig/"
+TARGET="_top"
+>AppConfig
+ </A
+>
+ (1.52)
+ </P
+></LI
+><LI
><P
+> <A
+HREF="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz"
+TARGET="_top"
+>Text::Wrap</A
>
- All Perl modules can be found on the
- <A
-HREF="http://www.cpan.org"
+ (2001.0131)
+ </P
+></LI
+><LI
+><P
+> <A
+HREF="http://search.cpan.org/search?dist=File-Spec"
TARGET="_top"
->Comprehensive Perl
- Archive Network</A
-> (CPAN). The
- CPAN servers have a real tendency to bog down, so please use mirrors.
- </P
+>File::Spec
+ </A
+>
+ (0.82)
+ </P
+></LI
+><LI
><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:
+> <A
+HREF="http://www.cpan.org/modules/by-module/Data/"
+TARGET="_top"
+>Data::Dumper
+ </A
+>
+ (any)
</P
+></LI
+><LI
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
- <B
-CLASS="command"
->perl -MCPAN -e 'install "<modulename>"'</B
->
- </TT
->
+> <A
+HREF="http://www.cpan.org/modules/by-module/Mysql/"
+TARGET="_top"
+>DBD::mysql
+ </A
+>
+ (2.1010)
</P
+></LI
+><LI
><P
-> To do it the hard way:
+> <A
+HREF="http://www.cpan.org/modules/by-module/DBI/"
+TARGET="_top"
+>DBI</A
+>
+ (1.32)
</P
+></LI
+><LI
><P
->Untar the module tarball -- it should create its own
- directory</P
+> <A
+HREF="http://www.cpan.org/modules/by-module/Date/"
+TARGET="_top"
+>Date::Parse
+ </A
+>
+ (any)
+ </P
+></LI
+><LI
><P
->CD to the directory just created, and enter the following
- commands:
- <P
+> <A
+HREF="http://www.cpan.org/modules/by-module/CGI/"
+TARGET="_top"
+>CGI
+ </A
+>
+ (2.88)
+ </P
+></LI
+></OL
+>
+ and, optionally:
+ <P
></P
><OL
-TYPE="1"
+TYPE="a"
><LI
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->perl Makefile.PL</B
->
- </TT
+> <A
+HREF="http://www.cpan.org/modules/by-module/GD/"
+TARGET="_top"
+>GD</A
>
- </P
+ (1.20) for bug charting
+ </P
></LI
><LI
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->make</B
->
- </TT
->
- </P
+> GD::Graph
+ (any) for bug charting
+ </P
></LI
><LI
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->make test</B
->
- </TT
->
- </P
+> GD::Text::Align
+ (any) for bug charting
+ </P
></LI
><LI
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->make install</B
->
- </TT
+> <A
+HREF="http://www.cpan.org/modules/by-module/Chart/"
+TARGET="_top"
+>Chart::Base
+ </A
>
- </P
+ (0.99c) for bug charting
+ </P
></LI
-></OL
->
+><LI
+><P
+> XML::Parser
+ (any) for the XML interface
</P
-><DIV
+></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
CLASS="warning"
><P
></P
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
->
- the local UNIX sysadmin, please consult the newsgroup/mailing list
- for further assistance or hire someone to help you out.</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
-CLASS="section"
-><HR><H3
-CLASS="section"
-><A
-NAME="AEN647"
-></A
->4.1.5.1. DBI</H3
-><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="AEN650"
-></A
->4.1.5.2. Data::Dumper</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
-></DIV
-><DIV
-CLASS="section"
-><HR><H3
-CLASS="section"
-><A
-NAME="AEN653"
-></A
->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
-></DIV
-><DIV
-CLASS="section"
-><HR><H3
-CLASS="section"
-><A
-NAME="AEN658"
-></A
->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><H3
-CLASS="section"
-><A
-NAME="AEN661"
-></A
->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
+>
+
+ <DIV
CLASS="note"
><P
></P
ALIGN="LEFT"
VALIGN="TOP"
><P
->The Perl GD library requires some other libraries that may or
- may not be installed on your system, including
+>Linux-Mandrake 8.0 includes every
+ required and optional library for Bugzilla. The easiest way to
+ install them is by using the
<TT
-CLASS="classname"
->libpng</TT
+CLASS="filename"
+>urpmi</TT
>
- and
+
+ utility. If you follow these commands, you should have everything you
+ need for Bugzilla, and
<TT
-CLASS="classname"
->libgd</TT
->.
- 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
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H3
-CLASS="section"
-><A
-NAME="AEN668"
-></A
->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><H3
-CLASS="section"
-><A
-NAME="AEN671"
-></A
->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.
- </P
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN674"
-></A
->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 run the web server on a
- different machine than MySQL, but need to adjust the MySQL
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
+CLASS="filename"
+>checksetup.pl</TT
>
- user permissions accordingly.
- <DIV
-CLASS="note"
+
+ should not complain about any missing libraries. You may already have
+ some of these installed.</P
><P
></P
><TABLE
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->We 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
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- </P
-><P
->You'll want to make sure that your web server will <EM
->run</EM
+
+ <B
+CLASS="command"
+>urpmi perl-mysql</B
>
- any file
- with the .cgi extension as a CGI program and not simply display the source
- code. If you're
- using Apache that means uncommenting the following line in the httpd.conf
- file:
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+ </TD
+></TR
><TR
><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> AddHandler cgi-script .cgi
- </PRE
-></FONT
-></TD
+> <TT
+CLASS="prompt"
+>bash#</TT
+>
+
+ <B
+CLASS="command"
+>urpmi perl-chart</B
+>
+ </TD
></TR
-></TABLE
+><TR
+><TD
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- </P
-><P
->With Apache you'll also want to make sure that within the
- httpd.conf file these lines:
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+
+ <B
+CLASS="command"
+>urpmi perl-gd</B
+>
+ </TD
+></TR
><TR
><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> Options +ExecCGI
-AllowOverride Limit
-</PRE
-></FONT
-></TD
-></TR
-></TABLE
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- are in the stanza that covers the directories into which you intend to
- put the bugzilla .html and .cgi files.
+ <B
+CLASS="command"
+>urpmi perl-MailTools</B
+>
- <DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
+ (for Bugzilla email integration)</TD
+></TR
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl</P
-><P
->Users of older versions of Apache may find the above lines
- in the srm.conf and access.conf files, respectively.</P
-></TD
+> <TT
+CLASS="prompt"
+>bash#</TT
+>
+
+ <B
+CLASS="command"
+>urpmi apache-modules</B
+>
+ </TD
></TR
+></TBODY
></TABLE
-></DIV
->
- </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
->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
->
- directory and the
- <SPAN
-CLASS="QUOTE"
->"localconfig"</SPAN
->
- 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; the checksetup.pl
- script should create appropriate .htaccess files for you.</P
></TD
></TR
></TABLE
></DIV
+>
+ </P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
-NAME="AEN693"
+NAME="install-mysql"
></A
->4.1.7. Bugzilla</H2
+>4.1.3. MySQL</H2
><P
->You should untar the Bugzilla files into a directory that you're
- willing to make writable by the default web server user (probably
- <SPAN
-CLASS="QUOTE"
->"nobody"</SPAN
->).
- You may decide to put the files in the main web space for your
- web server or perhaps in
- <TT
-CLASS="filename"
->/usr/local</TT
+>Visit the MySQL homepage at
+ <A
+HREF="http://www.mysql.com"
+TARGET="_top"
+>www.mysql.com</A
>
- with a symbolic link in the web space that points to the Bugzilla
- directory.</P
+ to grab and install the latest stable release of the server.
+ </P
><DIV
-CLASS="tip"
+CLASS="note"
><P
></P
><TABLE
-CLASS="tip"
+CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
ALIGN="CENTER"
VALIGN="TOP"
><IMG
-SRC="../images/tip.gif"
+SRC="../images/note.gif"
HSPACE="5"
-ALT="Tip"></TD
+ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
->If you symlink the bugzilla directory into your Apache's HTML
- heirarchy, you may receive
- <SPAN
-CLASS="errorname"
->Forbidden</SPAN
->
- errors unless you add the
- <SPAN
-CLASS="QUOTE"
->"FollowSymLinks"</SPAN
+> Many of the binary
+ versions of MySQL store their data files in
+ <TT
+CLASS="filename"
+>/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"
+>configure</TT
>
- directive to the <Directory> entry for the HTML root
- in httpd.conf.</P
+ if you build MySQL from source yourself.</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
+>If you install from something other than an RPM or Debian
+ package, you will need to add <TT
CLASS="filename"
->checksetup.pl</TT
+>mysqld</TT
>
- script, which locks down your installation.</P
+ 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
><P
->Lastly, you'll need to set up a symbolic link to
+>Change your init script to start
<TT
CLASS="filename"
->/usr/bonsaitools/bin/perl</TT
+>mysqld</TT
>
- for the correct location of your Perl executable (probably
+ with the ability to accept large packets. By default,
<TT
CLASS="filename"
->/usr/bin/perl</TT
->).
- 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
-><DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
-><SPAN
-CLASS="QUOTE"
->"Bonsaitools"</SPAN
-> is the name Terry Weissman, the
- original author of Bugzilla, created
- for his suite of webtools at the time he created Bugzilla and several
- other tools in use at mozilla.org. He created a directory,
- <TT
-CLASS="filename"
->/usr/bonsaitools</TT
-> to house his specific versions
- of perl and other utilities. This usage is still current at
- <A
-HREF="http://bugzilla.mozilla.org/"
-TARGET="_top"
->bugzilla.mozilla.org</A
->,
- but in general most other places do not use it. You can either edit
- the paths at the start of each perl file to the correct location of
- perl on your system, or simply bow to history and create a
- <TT
-CLASS="filename"
->/usr/bonsaitools</TT
-> and <TT
-CLASS="filename"
->/usr/bonsaitools/bin
- </TT
-> directory, placing a symlink to perl on your system
- inside <TT
+>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"
->/usr/bonsaitools/bin</TT
+>mysqld</TT
>
- </P
-></TD
-></TR
-></TABLE
-></DIV
+ (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
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm processmail syncshadowdb
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
+>If you plan on running Bugzilla and MySQL on the same machine,
+ consider using the
+ <TT
+CLASS="option"
+>--skip-networking</TT
>
-
- Change <TT
-CLASS="filename"
->/usr/bin/perl</TT
-> to match the location
- of Perl on your machine.
- </P
+ 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="AEN718"
+NAME="install-perl"
></A
->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 the back end to
- a high quality bug tracker.</P
+>4.1.4. Perl</H2
><P
->First, you'll want to fix MySQL permissions to allow access from
- Bugzilla. For the purpose of this Installation section, the Bugzilla
- username will be
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->, and will have minimal permissions.
- </P
+>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 perl 5.6,
+ 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.8.</P
+><DIV
+CLASS="tip"
+><A
+NAME="bundlebugzilla"
+></A
><P
->Begin by giving the MySQL root user a password. MySQL passwords are limited
- to 16 characters.
- <P
></P
><TABLE
+CLASS="tip"
+WIDTH="100%"
BORDER="0"
-><TBODY
><TR
><TD
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/tip.gif"
+HSPACE="5"
+ALT="Tip"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>You can skip the following Perl module installation steps by
+ installing
+ <SPAN
+CLASS="productname"
+>Bundle::Bugzilla</SPAN
+>
+
+ from
+ <A
+HREF="#gloss-cpan"
+><I
+CLASS="glossterm"
+>CPAN</I
+></A
+>,
+ which installs all required modules for you.</P
+><P
> <TT
CLASS="computeroutput"
> <TT
<B
CLASS="command"
->mysql -u root mysql</B
+>perl -MCPAN -e 'install "Bundle::Bugzilla"'</B
>
</TT
>
- </TD
+ </P
+><P
+>Bundle::Bugzilla doesn't include GD, Chart::Base, or
+ MIME::Parser, which are not essential to a basic Bugzilla install. If
+ installing this bundle fails, you should install each module
+ individually to isolate the problem.</P
+></TD
></TR
-><TR
-><TD
-> <TT
+></TABLE
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="perl-modules"
+></A
+>4.1.5. Perl Modules</H2
+><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.
+ To use the CPAN shell to install a module:
+ </P
+><P
+> <TT
CLASS="computeroutput"
-> <TT
+> <TT
CLASS="prompt"
->mysql></TT
+>bash#</TT
>
-
- <B
+ <B
CLASS="command"
->UPDATE user SET Password=PASSWORD('<new_password'>)
- WHERE user='root';</B
+>perl -MCPAN -e 'install "<modulename>"'</B
>
- </TT
+ </TT
>
- </TD
-></TR
-><TR
-><TD
-> <TT
-CLASS="computeroutput"
+ </P
+><P
+> To do it the hard way:
+ </P
+><P
+>Untar the module tarball -- it should create its own
+ directory</P
+><P
+>CD to the directory just created, and enter the following
+ commands:
+ <P
+></P
+><OL
+TYPE="1"
+><LI
+><P
> <TT
+CLASS="computeroutput"
+> <TT
CLASS="prompt"
->mysql></TT
+>bash#</TT
>
- <B
+ <B
CLASS="command"
->FLUSH PRIVILEGES;</B
+>perl Makefile.PL</B
>
- </TT
+ </TT
>
- </TD
-></TR
-></TBODY
-></TABLE
+ </P
+></LI
+><LI
><P
-></P
->
-
- From this point on, if you need to access MySQL as the MySQL root user,
- you will need to use
- <B
-CLASS="command"
->mysql -u root -p</B
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- and enter <new_password>. Remember that MySQL user names have
- nothing to do with Unix user names (login names).</P
-><P
->Next, we use an SQL <B
+ <B
CLASS="command"
->GRANT</B
-> command to create a
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
+>make</B
>
-
- 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
+ </TT
>
- user to operations within a database called
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->, and only allows the account to connect from
- <SPAN
-CLASS="QUOTE"
->"localhost"</SPAN
->.
- Modify it to reflect your setup if you will be connecting from
- another machine or as a different user.</P
+ </P
+></LI
+><LI
><P
->Remember to set <bugs_password> to some unique password.
- <P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
-> <TT
-CLASS="computeroutput"
> <TT
+CLASS="computeroutput"
+> <TT
CLASS="prompt"
->mysql></TT
+>bash#</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
+>make test</B
>
- </TT
+ </TT
>
- </TD
-></TR
-><TR
-><TD
-> <TT
-CLASS="computeroutput"
+ </P
+></LI
+><LI
+><P
> <TT
+CLASS="computeroutput"
+> <TT
CLASS="prompt"
->mysql></TT
+>bash#</TT
>
- <B
+ <B
CLASS="command"
->FLUSH PRIVILEGES;</B
+>make install</B
>
- </TT
+ </TT
>
- </TD
-></TR
-></TBODY
-></TABLE
+ </P
+></LI
+></OL
+>
+ </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 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
>
+ 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><H3
+CLASS="section"
+><A
+NAME="AEN552"
+></A
+>4.1.5.1. DBI</H3
+><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="AEN555"
+></A
+>4.1.5.2. Data::Dumper</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
+></DIV
+><DIV
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="AEN558"
+></A
+>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
></DIV
><DIV
CLASS="section"
-><HR><H2
+><HR><H3
CLASS="section"
><A
-NAME="AEN754"
+NAME="AEN563"
></A
->4.1.9. <TT
-CLASS="filename"
->checksetup.pl</TT
-></H2
+>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><H3
+CLASS="section"
+><A
+NAME="AEN566"
+></A
+>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 programmatic 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
->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
></P
><TABLE
+CLASS="note"
+WIDTH="100%"
BORDER="0"
-><TBODY
><TR
><TD
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->./checksetup.pl</B
->
- </TT
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/note.gif"
+HSPACE="5"
+ALT="Note"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>The Perl GD library requires some other libraries that may or
+ may not be installed on your system, including
+ <TT
+CLASS="classname"
+>libpng</TT
>
- </TD
+ and
+ <TT
+CLASS="classname"
+>libgd</TT
+>.
+ 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
-></TBODY
></TABLE
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="AEN573"
+></A
+>4.1.5.6. Chart::Base (optional)</H3
><P
-></P
->
-
- The first time you run it, it will create a file called
- <TT
-CLASS="filename"
->localconfig</TT
->.</P
-><P
->This file contains a variety of settings you may need to tweak
- including how Bugzilla should connect to the MySQL database.</P
-><P
->The connection settings include:
- <P
-></P
-><OL
-TYPE="1"
-><LI
-><P
->server's host: just use
- <SPAN
-CLASS="QUOTE"
->"localhost"</SPAN
->
- if the MySQL server is local</P
-></LI
-><LI
-><P
->database name:
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->
- if you're following these directions</P
-></LI
-><LI
-><P
->MySQL username:
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->
- if you're following these directions</P
-></LI
-><LI
+>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><H3
+CLASS="section"
+><A
+NAME="AEN576"
+></A
+>4.1.5.7. Template Toolkit</H3
><P
->Password for the
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->
- MySQL account; (<bugs_password>) above</P
-></LI
-></OL
->
+>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.
</P
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="sbs-http"
+></A
+>4.1.6. HTTP Server</H2
><P
->Once you are happy with the settings,
- <TT
-CLASS="filename"
->su</TT
-> to the user
- your web server runs as, and re-run
- <TT
-CLASS="filename"
->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
+>You have freedom of choice here, pretty much any web server that
+ is capable of running <A
+HREF="#gloss-cgi"
+><I
+CLASS="glossterm"
+>CGI</I
+></A
+>
+ scripts will work. <A
+HREF="#http"
+>Section 4.4</A
+> has more information about
+ configuring web servers to work with Bugzilla.
+ </P
><DIV
CLASS="note"
><P
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
+>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
><HR><H2
CLASS="section"
><A
-NAME="AEN786"
+NAME="AEN586"
></A
->4.1.10. Securing MySQL</H2
+>4.1.7. Bugzilla</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
+>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 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.</P
+><DIV
+CLASS="tip"
><P
->Most MySQL installs have "interesting" default security
- parameters:
- <P
></P
><TABLE
+CLASS="tip"
+WIDTH="100%"
BORDER="0"
-><TBODY
-><TR
-><TD
->mysqld defaults to running as root</TD
-></TR
-><TR
-><TD
->it defaults to allowing external network connections</TD
-></TR
-><TR
-><TD
->it has a known port number, and is easy to detect</TD
-></TR
><TR
><TD
->it defaults to no passwords whatsoever</TD
-></TR
-><TR
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/tip.gif"
+HSPACE="5"
+ALT="Tip"></TD
><TD
->it defaults to allowing "File_Priv"</TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>If you symlink the bugzilla directory into your Apache's HTML
+ hierarchy, you may receive
+ <SPAN
+CLASS="errorname"
+>Forbidden</SPAN
+>
+ errors unless you add the
+ <SPAN
+CLASS="QUOTE"
+>"FollowSymLinks"</SPAN
+>
+ directive to the <Directory> entry for the HTML root
+ in httpd.conf.</P
+></TD
></TR
-></TBODY
></TABLE
+></DIV
><P
-></P
+>Once all the files are in a web accessible directory, make that
+ directory writable by your webserver's user. This is a temporary step
+ until you run the post-install
+ <TT
+CLASS="filename"
+>checksetup.pl</TT
>
- </P
+ script, which locks down your installation.</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
+>Lastly, you'll need to set up a symbolic link to
+ <TT
+CLASS="filename"
+>/usr/bonsaitools/bin/perl</TT
+>
+ for the correct location of your Perl executable (probably
+ <TT
+CLASS="filename"
+>/usr/bin/perl</TT
+>).
+ Otherwise you must hack all the .cgi files to change where they look
+ for Perl. This can be done using the following Perl one-liner, but
+ I suggest using the symlink approach to avoid upgrade hassles.
+ </P
+><DIV
+CLASS="note"
><P
->To see your permissions do:
- <P
></P
><TABLE
+CLASS="note"
+WIDTH="100%"
BORDER="0"
-><TBODY
><TR
><TD
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->mysql -u root -p</B
->
- </TT
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/note.gif"
+HSPACE="5"
+ALT="Note"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+><SPAN
+CLASS="QUOTE"
+>"Bonsaitools"</SPAN
+> is the name Terry Weissman, the
+ original author of Bugzilla, created
+ for his suite of webtools at the time he created Bugzilla and several
+ other tools in use at mozilla.org. He created a directory,
+ <TT
+CLASS="filename"
+>/usr/bonsaitools</TT
+> to house his specific versions
+ of perl and other utilities. This usage is still current at
+ <A
+HREF="http://bugzilla.mozilla.org/"
+TARGET="_top"
+>bugzilla.mozilla.org</A
+>,
+ but in general most other places do not use it. You can either edit
+ the paths at the start of each perl file to the correct location of
+ perl on your system, or simply bow to history and create a
+ <TT
+CLASS="filename"
+>/usr/bonsaitools</TT
+> and <TT
+CLASS="filename"
+>/usr/bonsaitools/bin
+ </TT
+> directory, placing a symlink to perl on your system
+ inside <TT
+CLASS="filename"
+>/usr/bonsaitools/bin</TT
>
- </TD
+ </P
+></TD
></TR
+></TABLE
+></DIV
+><P
+>
+ <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm processmail syncshadowdb
+ </PRE
+></FONT
+></TD
+></TR
+></TABLE
>
- <B
-CLASS="command"
->use mysql;</B
->
- </TT
->
- </TD
-></TR
+ 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="AEN611"
+></A
+>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 the back end to
+ a high quality bug tracker.</P
+><P
+>First, you'll want to fix MySQL permissions to allow access from
+ Bugzilla. For the purpose of this Installation section, the Bugzilla
+ username will be
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
+>, and will have minimal permissions.
+ </P
+><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
CLASS="computeroutput"
> <TT
CLASS="prompt"
->mysql></TT
+>bash#</TT
>
<B
CLASS="command"
->show tables;</B
+>mysql -u root mysql</B
>
</TT
>
<B
CLASS="command"
->select * from user;</B
+>UPDATE user SET Password=PASSWORD('<new_password'>)
+ WHERE user='root';</B
>
</TT
>
<B
CLASS="command"
->select * from db;</B
+>FLUSH PRIVILEGES;</B
>
</TT
>
><P
></P
>
- </P
-><P
->To fix the gaping holes:
- <P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
->DELETE FROM user WHERE User='';</TD
-></TR
-><TR
-><TD
->UPDATE user SET Password=PASSWORD('new_password') WHERE
- user='root';</TD
-></TR
-><TR
-><TD
->FLUSH PRIVILEGES;</TD
-></TR
-></TBODY
-></TABLE
-><P
-></P
->
- </P
-><P
->If you're not running "mit-pthreads" you can use:
- <P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
->GRANT USAGE ON *.* TO bugs@localhost;</TD
-></TR
-><TR
-><TD
->GRANT ALL ON bugs.* TO bugs@localhost;</TD
-></TR
-><TR
-><TD
->REVOKE DROP ON bugs.* FROM bugs@localhost;</TD
-></TR
-><TR
-><TD
->FLUSH PRIVILEGES;</TD
-></TR
-></TBODY
-></TABLE
-><P
-></P
->
- </P
-><P
->With "mit-pthreads" you'll need to modify the "globals.pl"
- Mysql->Connect line to specify a specific host name instead of
- "localhost", and accept external connections:
- <P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
->GRANT USAGE ON *.* TO bugs@bounce.hop.com;</TD
-></TR
-><TR
-><TD
->GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</TD
-></TR
-><TR
-><TD
->REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</TD
-></TR
-><TR
-><TD
->FLUSH PRIVILEGES;</TD
-></TR
-></TBODY
-></TABLE
-><P
-></P
->
- </P
-><P
->Consider also:
- <P
-></P
-><OL
-TYPE="1"
-><LI
-><P
->Turning off external networking with "--skip-networking",
- unless you have "mit-pthreads", in which case you can't. Without
- networking, MySQL connects with a Unix domain socket.</P
-></LI
-><LI
-><P
->using the --user= option to mysqld to run it as an
- unprivileged user.</P
-></LI
-><LI
-><P
->running MySQL in a chroot jail</P
-></LI
-><LI
-><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
-></LI
-><LI
-><P
->running MySQL on a separate untrusted machine</P
-></LI
-><LI
-><P
->making backups ;-)</P
-></LI
-></OL
->
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN852"
-></A
->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="extraconfig"
-></A
->4.2. Optional Additional Configuration</H1
-><DIV
-CLASS="section"
-><H2
-CLASS="section"
-><A
-NAME="AEN858"
-></A
->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"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN873"
-></A
->4.2.2. Bug Graphs</H2
+
+ 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 <new_password>. Remember that MySQL user names have
+ nothing to do with Unix user names (login names).</P
><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
+>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
+CLASS="QUOTE"
+>"bugs"</SPAN
+>
+ user to operations within a database called
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
+>, and only allows the account to connect from
+ <SPAN
+CLASS="QUOTE"
+>"localhost"</SPAN
+>.
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.</P
><P
->Add a cron entry like this to run
- <TT
-CLASS="filename"
->collectstats.pl</TT
->
- daily at 5 after midnight:
+>Remember to set <bugs_password> to some unique password.
<P
></P
><TABLE
CLASS="computeroutput"
> <TT
CLASS="prompt"
->bash#</TT
+>mysql></TT
>
<B
CLASS="command"
->crontab -e</B
+>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
+ ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost
+ IDENTIFIED BY '<bugs_password>';</B
>
</TT
>
><TD
> <TT
CLASS="computeroutput"
->5 0 * * * cd <your-bugzilla-directory> ;
- ./collectstats.pl</TT
+> <TT
+CLASS="prompt"
+>mysql></TT
+>
+
+ <B
+CLASS="command"
+>FLUSH PRIVILEGES;</B
+>
+ </TT
>
</TD
></TR
></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="AEN886"
+NAME="AEN647"
></A
->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
+>4.1.9. <TT
+CLASS="filename"
+>checksetup.pl</TT
+></H2
><P
-> This can be done by
- adding the following command as a daily crontab entry (for help on that
- see that crontab man page):
+>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
></P
><TABLE
><TD
> <TT
CLASS="computeroutput"
-> <B
+> <TT
+CLASS="prompt"
+>bash#</TT
+>
+
+ <B
CLASS="command"
->cd <your-bugzilla-directory> ;
- ./whineatnews.pl</B
+>./checksetup.pl</B
>
</TT
>
><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="bzldap"
-></A
->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
-><P
->You can also try using <A
-HREF="http://www.openldap.org/"
-TARGET="_top"
-> OpenLDAP</A
-> with Bugzilla, using any of a number of administration
- tools. You should apply the patch attached this bug:
- <A
-HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=158630"
-TARGET="_top"
-> http://bugzilla.mozilla.org/show_bug.cgi?id=158630</A
->, then set
- the following object classes for your users:
+ The first time you run it, it will create a file called
+ <TT
+CLASS="filename"
+>localconfig</TT
+>.</P
+><P
+>This file contains a variety of settings you may need to tweak
+ including how Bugzilla should connect to the MySQL database.</P
+><P
+>The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
->objectClass: person</P
-></LI
-><LI
-><P
->objectClass: organizationalPerson</P
-></LI
-><LI
-><P
->objectClass: inetOrgPerson</P
+>server's host: just use
+ <SPAN
+CLASS="QUOTE"
+>"localhost"</SPAN
+>
+ if the MySQL server is local</P
></LI
><LI
><P
->objectClass: top</P
+>database name:
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
+>
+ if you're following these directions</P
></LI
><LI
><P
->objectClass: posixAccount</P
+>MySQL username:
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
+>
+ if you're following these directions</P
></LI
><LI
><P
->objectClass: shadowAccount</P
+>Password for the
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
+>
+ MySQL account; (<bugs_password>) above</P
></LI
></OL
>
-
- Please note that this patch <EM
->has not</EM
-> yet been
- accepted by the Bugzilla team, and so you may need to do some
- manual tweaking. That said, it looks like Net::LDAP is probably
- the way to go in the future.
</P
+><P
+>Once you are happy with the settings,
+ <TT
+CLASS="filename"
+>su</TT
+> to the user
+ your web server runs as, and re-run
+ <TT
+CLASS="filename"
+>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
+></P
+><TABLE
+CLASS="note"
+WIDTH="100%"
+BORDER="0"
+><TR
+><TD
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/note.gif"
+HSPACE="5"
+ALT="Note"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>The checksetup.pl script is designed so that you can run it at
+ any time without causing harm. You should run it after any upgrade to
+ Bugzilla.</P
+></TD
+></TR
+></TABLE
+></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
-NAME="content-type"
+NAME="AEN679"
></A
->4.2.5. Preventing untrusted Bugzilla content from executing malicious
- Javascript code</H2
+>4.1.10. Securing MySQL</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
+>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
-> <TABLE
+>Most MySQL installs have "interesting" default security
+ parameters:
+ <P
+></P
+><TABLE
BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+><TBODY
><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
+>mysqld defaults to running as root</TD
+></TR
+><TR
+><TD
+>it defaults to allowing external network connections</TD
+></TR
+><TR
+><TD
+>it has a known port number, and is easy to detect</TD
+></TR
+><TR
+><TD
+>it defaults to no passwords whatsoever</TD
+></TR
+><TR
+><TD
+>it defaults to allowing "File_Priv"</TD
></TR
+></TBODY
></TABLE
+><P
+></P
>
</P
><P
->All this one-liner command does is search for all instances of
- <SPAN
-CLASS="QUOTE"
->"Content-type: text/html"</SPAN
+>This means anyone from anywhere on the Internet can not only drop
+ the database with one SQL command, and they can write as root to the
+ system.</P
+><P
+>To see your permissions do:
+ <P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- and replaces it with
- <SPAN
-CLASS="QUOTE"
->"Content-Type: text/html; charset=ISO-8859-1"</SPAN
+ <B
+CLASS="command"
+>mysql -u root -p</B
+>
+ </TT
+>
+ </TD
+></TR
+><TR
+><TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>mysql></TT
+>
+
+ <B
+CLASS="command"
+>use mysql;</B
+>
+ </TT
+>
+ </TD
+></TR
+><TR
+><TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>mysql></TT
+>
+
+ <B
+CLASS="command"
+>show tables;</B
+>
+ </TT
+>
+ </TD
+></TR
+><TR
+><TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>mysql></TT
+>
+
+ <B
+CLASS="command"
+>select * from user;</B
+>
+ </TT
+>
+ </TD
+></TR
+><TR
+><TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>mysql></TT
+>
+
+ <B
+CLASS="command"
+>select * from db;</B
+>
+ </TT
+>
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
>
-
- . 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
-CLASS="note"
+ </P
><P
+>To fix the gaping holes:
+ <P
></P
><TABLE
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
+>DELETE FROM user WHERE User='';</TD
+></TR
+><TR
><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->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. See
- <A
-HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=126266"
-TARGET="_top"
->bug
- 126266</A
-> for more information including progress toward making
- bugzilla charset aware by default.
- </P
-></TD
+>UPDATE user SET Password=PASSWORD('new_password') WHERE
+ user='root';</TD
+></TR
+><TR
+><TD
+>FLUSH PRIVILEGES;</TD
></TR
+></TBODY
></TABLE
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="htaccess"
-></A
->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
+></P
>
-
- 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
+>If you're not running "mit-pthreads" you can use:
+ <P
></P
><TABLE
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
+>GRANT USAGE ON *.* TO bugs@localhost;</TD
+></TR
+><TR
><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
+>GRANT ALL ON bugs.* TO bugs@localhost;</TD
></TR
+><TR
+><TD
+>REVOKE DROP ON bugs.* FROM bugs@localhost;</TD
+></TR
+><TR
+><TD
+>FLUSH PRIVILEGES;</TD
+></TR
+></TBODY
></TABLE
-></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
+></P
>
-
- file:</P
+ </P
><P
->
-<TABLE
+>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"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+><TBODY
><TR
><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> <Directory /usr/local/bugzilla/>
- Options +FollowSymLinks +Indexes +Includes +ExecCGI
- AllowOverride All
-</Directory>
-</PRE
-></FONT
-></TD
+>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</TD
+></TR
+><TR
+><TD
+>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</TD
+></TR
+><TR
+><TD
+>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</TD
+></TR
+><TR
+><TD
+>FLUSH PRIVILEGES;</TD
></TR
+></TBODY
></TABLE
+><P
+></P
>
-
</P
><P
->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
+>Consider also:
+ <P
+></P
+><OL
+TYPE="1"
+><LI
+><P
+>Turning off external networking with "--skip-networking",
+ unless you have "mit-pthreads", in which case you can't. Without
+ networking, MySQL connects with a Unix domain socket.</P
+></LI
+><LI
+><P
+>using the --user= option to mysqld to run it as an
+ unprivileged user.</P
+></LI
+><LI
+><P
+>running MySQL in a chroot jail</P
+></LI
+><LI
+><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
+></LI
+><LI
+><P
+>running MySQL on a separate untrusted machine</P
+></LI
+><LI
><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
+>making backups ;-)</P
+></LI
+></OL
>
- variable to
- <TT
-CLASS="parameter"
-><I
->0</I
-></TT
->.
</P
></DIV
><DIV
><HR><H2
CLASS="section"
><A
-NAME="directoryindex"
+NAME="AEN745"
></A
->4.2.7. <TT
-CLASS="filename"
->directoryindex</TT
-> for the Bugzilla default page.</H2
+>4.1.11. Configuring Bugzilla</H2
><P
->You should modify the <DirectoryIndex> parameter for
- the Apache virtual host running your Bugzilla installation to
- allow <TT
-CLASS="filename"
->index.cgi</TT
-> as the index page for a
- directory, as well as the usual <TT
-CLASS="filename"
->index.html</TT
->,
- <TT
-CLASS="filename"
->index.htm</TT
->, and so forth. </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><H2
+><HR><H1
CLASS="section"
><A
-NAME="mod_perl"
+NAME="extraconfig"
></A
->4.2.8. Bugzilla and <TT
-CLASS="filename"
->mod_perl</TT
-></H2
-><P
->Bugzilla is unsupported under mod_perl. Effort is underway
- to make it work cleanly in a mod_perl environment, but it is
- slow going.
- </P
-></DIV
+>4.2. Optional Additional Configuration</H1
><DIV
CLASS="section"
-><HR><H2
+><H2
CLASS="section"
><A
-NAME="mod-throttle"
+NAME="AEN751"
></A
->4.2.9. <TT
-CLASS="filename"
->mod_throttle</TT
->
-
- and Security</H2
+>4.2.1. Dependency Charts</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
+>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
>
-
- which can limit connections by ip-address. You may download this module
- at
+ </P
+><P
+>So, to get this working, install
<A
-HREF="http://www.snert.com/Software/Throttle/"
+HREF="http://www.graphviz.org/"
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
+>GraphViz</A
+>. If you
+ do that, you need to
<A
-HREF="http://www.snert.com/Software/Throttle/"
+HREF="http://httpd.apache.org/docs/mod/mod_imap.html"
TARGET="_top"
->Module
- Instructions</A
->
- for more information.</P
-></DIV
+>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 HARTS.
+ </P
></DIV
><DIV
CLASS="section"
-><HR><H1
+><HR><H2
CLASS="section"
><A
-NAME="win32"
+NAME="AEN766"
></A
->4.3. Win32 Installation Notes</H1
+>4.2.2. Bug Graphs</H2
><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"
+>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
-CLASS="warning"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/warning.gif"
-HSPACE="5"
-ALT="Warning"></TD
+> <TT
+CLASS="computeroutput"
+> <TT
+CLASS="prompt"
+>bash#</TT
+>
+
+ <B
+CLASS="command"
+>crontab -e</B
+>
+ </TT
+>
+ </TD
+></TR
+><TR
><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
+> <TT
+CLASS="computeroutput"
+>5 0 * * * cd <your-bugzilla-directory> ;
+ ./collectstats.pl</TT
+>
+ </TD
></TR
+></TBODY
></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
+></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="wininstall"
+NAME="AEN779"
></A
->4.3.1. Win32 Installation: Step-by-step</H2
+>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="note"
+CLASS="tip"
><P
></P
><TABLE
-CLASS="note"
+CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
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
->You should be familiar with, and cross-reference, the rest of
- the
- <A
-HREF="#installation"
->Bugzilla Installation</A
->
-
- section while performing your Win32 installation.</P
-><P
->Making Bugzilla work on Microsoft Windows is no picnic. Support
- for Win32 has improved dramatically in the last few releases, but, if
- you choose to proceed, you should be a
- <EM
->very</EM
->
-
- skilled Windows Systems Administrator with strong troubleshooting
- abilities, a high tolerance for pain, and moderate perl skills.
- Bugzilla on NT requires hacking source code and implementing some
- advanced utilities. What follows is the recommended installation
- procedure for Win32; additional suggestions are provided in
- <A
-HREF="#faq"
->Appendix A</A
+>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
+ </P
></TD
></TR
></TABLE
></DIV
+></DIV
><DIV
-CLASS="procedure"
-><OL
-TYPE="1"
-><LI
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="bzldap"
+></A
+>4.2.4. LDAP Authentication</H2
><P
->Install
- <A
-HREF="http://www.apache.org/"
-TARGET="_top"
->Apache Web Server</A
->
-
- for Windows, and copy the Bugzilla files somewhere Apache can serve
- them. Please follow all the instructions referenced in
- <A
-HREF="#installation"
->Bugzilla Installation</A
->
-
- regarding your Apache configuration, particularly instructions
- regarding the
- <SPAN
-CLASS="QUOTE"
->"AddHandler"</SPAN
->
-
- parameter and
- <SPAN
-CLASS="QUOTE"
->"ExecCGI"</SPAN
->
-
- .</P
-><DIV
-CLASS="note"
+> <DIV
+CLASS="warning"
><P
></P
><TABLE
-CLASS="note"
+CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
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
->You may also use Internet Information Server or Personal
- Web Server for this purpose. However, setup is quite different.
- If ActivePerl doesn't seem to handle your file associations
- correctly (for .cgi and .pl files), please consult
- <A
-HREF="#faq"
->Appendix A</A
->
-
- .</P
-><P
->If you are going to use IIS, if on Windows NT you must be
- updated to at least Service Pack 4. Windows 2000 ships with a
- sufficient version of IIS.</P
+>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
-></LI
-><LI
+>
+ </P
><P
->Install
- <A
-HREF="http://www.activestate.com/"
+> 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"
->ActivePerl</A
->
-
- for Windows. Check
- <A
-HREF="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/"
+>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
+><P
+>You can also try using <A
+HREF="http://www.openldap.org/"
TARGET="_top"
-> http://aspn.activestate.com/ASPN/Downloads/ActivePerl</A
->
+> OpenLDAP</A
+> with Bugzilla, using any of a number of administration
+ tools. You should apply the patch attached this bug:
+ <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=158630"
+TARGET="_top"
+> http://bugzilla.mozilla.org/show_bug.cgi?id=158630</A
+>, then set
+ the following object classes for your users:
- for a current compiled binary.</P
+ <P
+></P
+><OL
+TYPE="1"
+><LI
><P
->Please also check the following links to fully understand the
- status of ActivePerl on Win32:
- <A
-HREF="http://language.perl.com/newdocs/pod/perlport.html"
-TARGET="_top"
-> Perl Porting</A
+>objectClass: person</P
+></LI
+><LI
+><P
+>objectClass: organizationalPerson</P
+></LI
+><LI
+><P
+>objectClass: inetOrgPerson</P
+></LI
+><LI
+><P
+>objectClass: top</P
+></LI
+><LI
+><P
+>objectClass: posixAccount</P
+></LI
+><LI
+><P
+>objectClass: shadowAccount</P
+></LI
+></OL
>
- , and
- <A
-HREF="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"
+ Please note that this patch <EM
+>has not</EM
+> yet been
+ accepted by the Bugzilla team, and so you may need to do some
+ manual tweaking. That said, it looks like Net::LDAP is probably
+ the way to go in the future.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="content-type"
+></A
+>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"
-> Perl on Win32 FAQ</A
+> 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
-></LI
-><LI
+ </P
><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
-HREF="http://openinteract.sourceforge.net/"
-TARGET="_top"
->the
- instructions on the Template Toolkit web site</A
+>All this one-liner command does is search for all instances of
+ <SPAN
+CLASS="QUOTE"
+>"Content-type: text/html"</SPAN
>
- .</P
+ 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
CLASS="note"
><P
ALIGN="LEFT"
VALIGN="TOP"
><P
->You can find a list of modules at
- <A
-HREF="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"
-TARGET="_top"
-> http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</A
->
-
- or
- <A
-HREF="http://www.activestate.com/PPMPackages/5.6plus"
+>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. See
+ <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=126266"
TARGET="_top"
-> http://www.activestate.com/PPMPackages/5.6plus</A
->
- </P
+>bug
+ 126266</A
+> for more information including progress toward making
+ bugzilla charset aware by default.
+ </P
></TD
></TR
></TABLE
></DIV
-><P
->The syntax for ppm is:
- <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->C:></TT
->
-
- <B
-CLASS="command"
->ppm <modulename></B
->
- </TT
->
- </P
+></DIV
><DIV
-CLASS="example"
+CLASS="section"
+><HR><H2
+CLASS="section"
><A
-NAME="AEN1032"
+NAME="htaccess"
></A
-><P
-><B
->Example 4-1. Installing ActivePerl ppd Modules on Microsoft
- Windows</B
-></P
-><P
-> <TT
-CLASS="prompt"
->C:></TT
->
-
- <B
-CLASS="command"
->ppm
- <TT
-CLASS="option"
->DBD-Mysql</TT
->
- </B
->
- </P
-><P
->Watch your capitalization!</P
-></DIV
-><P
->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
->
- </P
-><P
->If so, download both
- <A
-HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz"
-TARGET="_top"
-> the tarball</A
->
-
- and
- <A
-HREF="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd"
-TARGET="_top"
-> the ppd</A
+>4.2.6. <TT
+CLASS="filename"
+>.htaccess</TT
>
-
- 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="AEN1045"
-></A
-><P
-><B
->Example 4-2. Installing OpenInteract ppd Modules manually on Microsoft
- Windows</B
-></P
+ files and security</H2
><P
-> <TT
-CLASS="computeroutput"
-> <B
-CLASS="command"
->install
- <TT
+>To enhance the security of your Bugzilla installation, Bugzilla's
+ <TT
CLASS="filename"
->C:\AppConfig.ppd</TT
->
- </B
->
- </TT
+>checksetup.pl</TT
+> script will generate
+ <I
+CLASS="glossterm"
+> <TT
+CLASS="filename"
+>.htaccess</TT
>
- </P
-></DIV
+ </I
>
- </P
-></LI
-><LI
-><P
->Install MySQL for NT.
+
+ 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
ALIGN="LEFT"
VALIGN="TOP"
><P
->You can download MySQL for Windows NT from
- <A
-HREF="http://www.mysql.com/"
-TARGET="_top"
->MySQL.com</A
->
-
- . Some find it helpful to use the WinMySqlAdmin utility, included
- with the download, to set up the database.</P
-></TD
-></TR
-></TABLE
-></DIV
->
- </P
-></LI
-><LI
-><P
->Setup MySQL</P
-><OL
-CLASS="SUBSTEPS"
-TYPE="a"
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->C:></TT
->
-
- <B
-CLASS="command"
->C:\mysql\bin\mysql -u root mysql</B
->
- </TT
->
- </P
-></LI
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
->
-
- <B
-CLASS="command"
->DELETE FROM user WHERE Host='localhost' AND
- User='';</B
->
- </TT
->
- </P
-></LI
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
->
-
- <B
-CLASS="command"
->UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';</B
->
- </TT
->
- </P
-><P
-> <SPAN
-CLASS="QUOTE"
->"new_password"</SPAN
->
-
- , above, indicates whatever password you wish to use for your
- <SPAN
-CLASS="QUOTE"
->"root"</SPAN
->
-
- user.</P
-></LI
-><LI
-><A
-NAME="ntbugs-password"
-></A
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
->
-
- <B
-CLASS="command"
->GRANT SELECT, INSERT, UPDATE, DELETE, INDEX,
- ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost
- IDENTIFIED BY 'bugs_password';</B
->
- </TT
->
- </P
-><P
-> <SPAN
-CLASS="QUOTE"
->"bugs_password"</SPAN
->
-
- , above, indicates whatever password you wish to use for your
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->
-
- user.</P
-></LI
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
+>If you are using an alternate provider of
+ <SPAN
+CLASS="productname"
+>webdot</SPAN
>
- <B
-CLASS="command"
->FLUSH PRIVILEGES;</B
->
- </TT
->
- </P
-></LI
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
+ services for graphing (as described when viewing
+ <TT
+CLASS="filename"
+>editparams.cgi</TT
>
- <B
-CLASS="command"
->create database bugs;</B
->
- </TT
->
- </P
-></LI
-><LI
-><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->mysql></TT
+ in your web browser), you will need to change the ip address in
+ <TT
+CLASS="filename"
+>data/webdot/.htaccess</TT
>
- <B
-CLASS="command"
->exit;</B
->
- </TT
->
- </P
-></LI
-><LI
+ to the ip address of the webdot server that you are using.</P
+></TD
+></TR
+></TABLE
+></DIV
+>
+ </P
><P
-> <TT
-CLASS="computeroutput"
-> <TT
-CLASS="prompt"
->C:></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
>
- <B
-CLASS="command"
->C:\mysql\bin\mysqladmin -u root -p
- reload</B
->
- </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
>
- </P
-></LI
-></OL
-></LI
-><LI
-><P
->Edit
- <TT
+
+ . You should have this <Directory> entry in your
+ <TT
CLASS="filename"
->checksetup.pl</TT
+>httpd.conf</TT
>
- in your Bugzilla directory. Change this line:</P
+ file:</P
><P
-> <TABLE
+>
+<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
COLOR="#000000"
><PRE
CLASS="programlisting"
->my $webservergid =
- getgrnam($my_webservergroup);</PRE
+> <Directory /usr/local/bugzilla/>
+ Options +FollowSymLinks +Indexes +Includes +ExecCGI
+ AllowOverride All
+</Directory>
+</PRE
></FONT
></TD
></TR
></TABLE
>
- </P
-><P
->to</P
+
+ </P
><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
->my $webservergid =
- $my_webservergroup;</PRE
-></FONT
-></TD
-></TR
-></TABLE
+>The important part above is
+ <SPAN
+CLASS="QUOTE"
+>"AllowOverride All"</SPAN
>
- or the name of the group you wish to own the files explicitly:
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
->my $webservergid =
- 'Administrators'</PRE
-></FONT
-></TD
-></TR
-></TABLE
+ . Without that, the
+ <TT
+CLASS="filename"
+>.htaccess</TT
>
- </P
-></LI
-><LI
-><P
->Run
- <TT
+
+ file created by
+ <TT
CLASS="filename"
>checksetup.pl</TT
>
- from the Bugzilla directory.</P
-></LI
-><LI
+ will not have sufficient permissions to protect your Bugzilla
+ installation.</P
><P
->Edit
- <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
CLASS="filename"
>localconfig</TT
>
-
- to suit your requirements. Set
- <TT
+ and setting the
+ <TT
CLASS="varname"
->$db_pass</TT
+>$create_htaccess</TT
>
-
- to your
- <SPAN
-CLASS="QUOTE"
->"bugs_password"</SPAN
+ variable to
+ <TT
+CLASS="parameter"
+><I
+>0</I
+></TT
+>.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="directoryindex"
+></A
+>4.2.7. <TT
+CLASS="filename"
+>directoryindex</TT
+> for the Bugzilla default page.</H2
+><P
+>You should modify the <DirectoryIndex> parameter for
+ the Apache virtual host running your Bugzilla installation to
+ allow <TT
+CLASS="filename"
+>index.cgi</TT
+> as the index page for a
+ directory, as well as the usual <TT
+CLASS="filename"
+>index.html</TT
+>,
+ <TT
+CLASS="filename"
+>index.htm</TT
+>, and so forth. </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="mod_perl"
+></A
+>4.2.8. Bugzilla and <TT
+CLASS="filename"
+>mod_perl</TT
+></H2
+><P
+>Bugzilla is unsupported under mod_perl. Effort is underway
+ to make it work cleanly in a mod_perl environment, but it is
+ slow going.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="mod-throttle"
+></A
+>4.2.9. <TT
+CLASS="filename"
+>mod_throttle</TT
>
- from
- <A
-HREF="#ntbugs-password"
->step 5.d</A
+ 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
>
- , and
- <TT
-CLASS="varname"
->$webservergroup</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
>
-
- to
- <SPAN
-CLASS="QUOTE"
->"8"</SPAN
+ You may use the
+ <B
+CLASS="command"
+>ThrottleClientIP</B
>
- .</P
+ 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="note"
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="os-specific"
+></A
+>4.3. OS Specific Installation Notes</H1
+><P
+>Many aspects of the Bugzilla installation can be affected by the
+ the operating system you choose to install it on. Sometimes it can be made
+ easier and others more difficult. This section will attempt to help you
+ understand both the difficulties of running on specific operating systems
+ and the utilities available to make it easier.
+ </P
+><P
+>If you have anything to add or notes for an operating system not
+ covered, please file a bug in <A
+HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation"
+TARGET="_top"
+>Bugzilla Documentation</A
+>.
+ </P
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="os-win32"
+></A
+>4.3.1. Microsoft Windows</H2
+><P
+>Making Bugzilla work on windows is still a very painful processes.
+ The Bugzilla Team is working to make it easier, but that goal is not
+ considered a top priority. If you wish to run Bugzilla, we still
+ recommend doing so on a Unix based system such as GNU/Linux. As of this
+ writing, all members of the Bugzilla team and all known large installations
+ run on Unix based systems.
+ </P
+><P
+>If after hearing all that, you have enough pain tolerance to attempt
+ installing Bugzilla on Win32, here are some pointers.
+
+ Because this is a development version of the guide, these instructions
+ are subject to change without notice. In fact, the Bugzilla Team hopes
+ they do as we would like to have Bugzilla resonabally close to "out of
+ the box" compatibility by the 2.18 release.
+
+ </P
+><DIV
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="win32-perl"
+></A
+>4.3.1.1. Win32 Perl</H3
+><P
+>Perl for Windows can be obtained from <A
+HREF="http://www.activestate.com/"
+TARGET="_top"
+>ActiveState</A
+>. You should be
+ able to find a compiled binary at <A
+HREF="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/"
+TARGET="_top"
+>http://aspn.activestate.com/ASPN/Downloads/ActivePerl/</A
+>.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="win32-perl-modules"
+></A
+>4.3.1.2. Perl Modules on Win32</H3
><P
-></P
+>Bugzilla on Windows requires the same perl modules found in
+ <A
+HREF="#install-package-list"
+>Section 4.1.2</A
+>. The main difference is that
+ windows uses <B
+CLASS="command"
+>ppm</B
+> instead of CPAN.
+ </P
><TABLE
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Not sure on the
- <SPAN
-CLASS="QUOTE"
->"8"</SPAN
->
-
- for
- <TT
-CLASS="varname"
->$webservergroup</TT
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> C:\perl> <B
+CLASS="command"
+>ppm <module name></B
>
-
- above. If it's wrong, please send corrections.</P
+ </PRE
+></FONT
></TD
></TR
></TABLE
-></DIV
-></LI
-><LI
-><P
->Edit
- <TT
-CLASS="filename"
->defparams.pl</TT
->
-
- to suit your requirements. Particularly, set
- <TT
-CLASS="varname"
->DefParam("maintainer")</TT
->
-
- and
- <TT
-CLASS="varname"
->DefParam("urlbase") to match your install.</TT
->
- </P
><DIV
CLASS="note"
><P
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
+>The above syntax should work for all modules with the exception
+ of Template Toolkit. The <A
+HREF="http://tt2.org/download.html#win32"
+TARGET="_top"
+>Template Toolkit website</A
+>
+ suggests using the instructions on <A
+HREF="http://openinteract.sourceforge.net/"
+TARGET="_top"
+>OpenInteract's website</A
+>.
+ </P
></TD
></TR
></TABLE
></DIV
-></LI
-><LI
><DIV
CLASS="note"
><P
ALIGN="LEFT"
VALIGN="TOP"
><P
->There are several alternatives to Sendmail that will work
- on Win32. The one mentioned here is a
- <EM
->suggestion</EM
->
-
- , not a requirement. Some other mail packages that can work
- include
- <A
-HREF="http://www.blat.net/"
-TARGET="_top"
->BLAT</A
->
-
- ,
- <A
-HREF="http://www.geocel.com/windmail/"
-TARGET="_top"
->Windmail</A
->
-
- ,
- <A
-HREF="http://www.dynamicstate.com/"
+>A complete list of modules that can be installed using ppm can
+ be found at <A
+HREF="http://www.activestate.com/PPMPackages/5.6plus"
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
+>http://www.activestate.com/PPMPackages/5.6plus</A
+>.
+ </P
></TD
></TR
></TABLE
></DIV
+></DIV
><DIV
-CLASS="procedure"
-><OL
-TYPE="1"
-><LI
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="win32-code-changes"
+></A
+>4.3.1.3. Code changes required to run on win32</H3
><P
->Download NTsendmail, available from
- <A
-HREF="http://www.ntsendmail.com/"
+>Unfortunately, Bugzilla still doesn't run "out of the box" on
+ Windows. There is work in progress to make this easier, but until that
+ happens code will have to be modified. This section is an attempt to
+ list the required changes. It is an attempt to be all inclusive, but
+ there may be other changes required. If you find something is missing,
+ please file a bug in <A
+HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation"
TARGET="_top"
-> www.ntsendmail.com</A
->
-
- . You must have a "real" mail server which allows you to relay
- off it in your $ENV{"NTsendmail"} (which you should probably
- place in globals.pl)</P
-></LI
-><LI
-><P
->Put ntsendmail.pm into your .\perl\lib directory.</P
-></LI
-><LI
+>Bugzilla Documentation</A
+>.
+ </P
+><DIV
+CLASS="section"
+><HR><H4
+CLASS="section"
+><A
+NAME="win32-code-checksetup"
+></A
+>4.3.1.3.1. Changes to <TT
+CLASS="filename"
+>checksetup.pl</TT
+></H4
><P
->Add to globals.pl:</P
+>In <TT
+CLASS="filename"
+>checksetup.pl</TT
+>, the line reading:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
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
+> my $mysql_binaries = `which mysql`;
+ </PRE
></FONT
></TD
></TR
></TABLE
-><DIV
-CLASS="note"
><P
-></P
+>to</P
><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Some mention to also edit
- <TT
-CLASS="varname"
->$db_pass</TT
->
-
- in
- <TT
-CLASS="filename"
->globals.pl</TT
->
-
- to be your
- <SPAN
-CLASS="QUOTE"
->"bugs_password"</SPAN
->
-
- . Although this may get you around some problem
- authenticating to your database, since globals.pl is not
- normally restricted by
- <TT
-CLASS="filename"
->.htaccess</TT
->
-
- , your database password is exposed to whoever uses your web
- server.</P
-></TD
-></TR
-></TABLE
-></DIV
-></LI
-><LI
-><P
->Find and comment out all occurences of
- <SPAN
-CLASS="QUOTE"
->"
- <B
-CLASS="command"
->open(SENDMAIL</B
->
- "</SPAN
->
-
- in your Bugzilla directory. Then replace them with:
- <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
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
+> my $mysql_binaries = "D:\\mysql\\bin\\mysql";
+ </PRE
></FONT
></TD
></TR
></TABLE
->
- </P
-><DIV
-CLASS="note"
><P
-></P
+>And you'll also need to change:</P
><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Some have found success using the commercial product,
- <SPAN
-CLASS="productname"
->Windmail</SPAN
->
-
- . You could try replacing your sendmail calls with:
- <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
COLOR="#000000"
><PRE
CLASS="programlisting"
->open SENDMAIL,
- "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
- mail.log";</PRE
+> my $webservergid = getgrnam($my_webservergroup)
+ </PRE
></FONT
></TD
></TR
></TABLE
->
-
- or something to that effect.</P
-></TD
-></TR
-></TABLE
-></DIV
-></LI
-></OL
-></DIV
-></LI
-><LI
-><P
->Change all references in all files from
- <TT
-CLASS="filename"
->processmail</TT
->
-
- to
- <TT
-CLASS="filename"
->processmail.pl</TT
->
-
- , and rename
- <TT
-CLASS="filename"
->processmail</TT
->
-
- to
- <TT
-CLASS="filename"
->processmail.pl</TT
->
-
- .</P
-><DIV
-CLASS="note"
><P
-></P
+>to</P
><TABLE
-CLASS="note"
-WIDTH="100%"
BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->Many think this may be a change we want to make for
- main-tree Bugzilla. It's painless for the UNIX folks, and will
- make the Win32 people happier.</P
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> my $webservergid = '8'
+ </PRE
+></FONT
></TD
></TR
></TABLE
></DIV
><DIV
-CLASS="note"
-><P
-></P
-><TABLE
-CLASS="note"
-WIDTH="100%"
-BORDER="0"
-><TR
-><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/note.gif"
-HSPACE="5"
-ALT="Note"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
+CLASS="section"
+><HR><H4
+CLASS="section"
+><A
+NAME="win32-code-mail"
+></A
+>4.3.1.3.2. Making mail work</H4
><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
+>The easiest way to get mail working is to use the mail patches
+ on <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=124174"
+TARGET="_top"
+>bug
+ 124174</A
+>. With any luck, this patch will receive the required
+ reviews and integrated into the main Bugzilla distribution very soon.
+ Until that happens, there's at least one report of this patch working
+ well on Windows.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H4
+CLASS="section"
+><A
+NAME="AEN926"
+></A
+>4.3.1.3.3. System Calls</H4
+><P
+>In order to get system calls to work on win32's perl, you need
+ to tell the windows shell what interpreter to use. This is done by
+ changing the <TT
+CLASS="function"
+>system</TT
+> calls. You will need to
+ search all of Bugzilla's code for <TT
+CLASS="function"
+>system</TT
+> calls.
+ To tell perl your interpreter, it needs to be the first argument to
+ the <TT
+CLASS="function"
+>system</TT
+> call. For example, you'll need to
+ change:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
COLOR="#000000"
><PRE
CLASS="programlisting"
->
-
-my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server
-$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
-$smtp->to($tolist); # recipient's address
-$smtp->data(); # Start the mail
-$smtp->datasend($msg);
-$smtp->dataend(); # Finish sending the mail
-$smtp->quit; # Close the SMTP connection
-$logstr = "$logstr; mail sent to $tolist $cclist";
-}
-
-
- </PRE
+> system("./processmail", $id, $exporter);
+ </PRE
></FONT
></TD
></TR
></TABLE
->
-
- here is a test mail program for Net::SMTP:
- <TABLE
+><P
+>with</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
COLOR="#000000"
><PRE
CLASS="programlisting"
->
-
-use Net::SMTP;
- my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
-=> 1, ); # connect to SMTP server
- $smtp->auth;
- $smtp->mail('you@yourcompany.com');# use the sender's adress
-here
- $smtp->to('someotherAddress@someotherdomain.com'); #
-recipient's address
- $smtp->data(); # Start the mail
- $smtp->datasend('test');
- $smtp->dataend(); # Finish sending the mail
- $smtp->quit; # Close the SMTP connection
-exit;
-
-
- </PRE
+> system("C:\\perl\\bin\\perl", "processmail", $id, $exporter);
+ </PRE
></FONT
></TD
></TR
></TABLE
->
+><P
+>Notice that the <TT
+CLASS="computeroutput"
+>./</TT
+> is also
+ removed.
+ </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
+>The <B
+CLASS="command"
+>grep</B
+> command is very helpful in finding
+ these <TT
+CLASS="function"
+>system</TT
+> calls, assuming you have the
+ <SPAN
+CLASS="productname"
+>cygwin</SPAN
+> utilities.
</P
></TD
></TR
></TABLE
></DIV
-></LI
-><LI
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H3
+CLASS="section"
+><A
+NAME="win32-http"
+></A
+>4.3.1.4. Serving the web pages</H3
+><P
+>As is the case on Unix based systems, any web server should be
+ able to handle Bugzilla; however, the Bugzilla Team still recommends
+ Apache whenever asked. No matter what web server you choose, be sure
+ to pay attention to the security notes in <A
+HREF="#security"
+>Section 5.6</A
+>.
+ More information on configuring specific web servers can be found in
+ <A
+HREF="#http"
+>Section 4.4</A
+>.
+ </P
><DIV
CLASS="note"
><P
ALIGN="LEFT"
VALIGN="TOP"
><P
->This step is optional if you are using IIS or another web
- server which only decides on an interpreter based upon the file
- extension (.pl), rather than the
- <SPAN
-CLASS="QUOTE"
->"shebang"</SPAN
+>If using Apache on windows, you can set the <A
+HREF="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource"
+TARGET="_top"
+>ScriptInterpreterSource</A
>
-
- line (#/usr/bonsaitools/bin/perl)</P
+ directive in your Apache config, if you don't do this, you'll have
+ to modify the first line of every script to contain your path to
+ perl instead of <TT
+CLASS="filename"
+>/usr/bonsaitools/bin/perl</TT
+>.
+ </P
></TD
></TR
></TABLE
></DIV
+></DIV
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="os-macosx"
+></A
+>4.3.2. <SPAN
+CLASS="productname"
+>Mac OS X</SPAN
+></H2
><P
->Modify the path to perl on the first line (#!) of all files
- to point to your Perl installation, and add
- <SPAN
-CLASS="QUOTE"
->"perl"</SPAN
+>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
+ <A
+HREF="http://sourceforge.net/projects/fink/"
+TARGET="_top"
+>http://sourceforge.net/projects/fink/</A
+>.</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
>
-
- 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
+ </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"
->"setperl.csh"</SPAN
+>"install GD"</SPAN
>
-
- utility to speed part of this procedure, available in the
- <A
-HREF="#patches"
->Useful Patches and Utilities for Bugzilla</A
+ at the
+ <TT
+CLASS="prompt"
+>cpan></TT
>
-
- 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/"
+ 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"
->http://www.cygwin.com/</A
->
-
- for details on obtaining Cygwin.</P
-></LI
-><LI
+>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
->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:
+>Then, run these commands to finish the installation of the GD
+ module:
+ <P
+></P
BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+><TBODY
><TR
><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
->
-system ("./processmail",@ARGLIST);
- </programlisting> to
- <programlisting>
-system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
+> <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
+>
- </PRE
-></FONT
-></TD
+ to get back to CPAN.</TD
></TR
+></TBODY
></TABLE
+><P
+></P
>
- </P
-></LI
-></OL
+ </P
+></DIV
></DIV
><DIV
-CLASS="tip"
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="http"
+></A
+>4.4. HTTP Server Configuration</H1
><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"
+>The Bugzilla Team recommends Apache when using Bugzilla, however, any web server
+ that can be configured to run <A
+HREF="#gloss-cgi"
+><I
+CLASS="glossterm"
+>CGI</I
+></A
+> scripts
+ should be able to handle Bugzilla. No matter what web server you choose, but
+ especially if you choose something other than Apache, you should be sure to read
+ <A
+HREF="#security"
+>Section 5.6</A
+>.
+ </P
+><P
+>The plan for this section is to eventually document the specifics of how to lock
+ down permissions on individual web servers.
+ </P
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="http-apache"
+></A
+>4.4.1. Apache <SPAN
+CLASS="productname"
+>httpd</SPAN
+></H2
+><P
+>As mentioned above, the Bugzilla Team recommends Apache for use
+ with Bugzilla. You will have to make sure that Apache is properly
+ configured to run the Bugzilla CGI scripts. You also need to make sure
+ that the <TT
+CLASS="filename"
+>.htaccess</TT
+> files created by
+ <B
+CLASS="command"
+>./checksetup.pl</B
+> (shown in <A
+HREF="#http-apache-htaccess"
+>Example 4-1</A
+>
+ for the curious) are allowed to override Apache's normal access
+ permissions or else important password information may be exposed to the
+ Internet.
+ </P
><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
+>Many Apache installations are not configured to run scripts
+ anywhere but in the <TT
+CLASS="filename"
+>cgi-bin</TT
+>
+ directory; however, we recommend that Bugzilla not be installed in the
+ <TT
+CLASS="filename"
+>cgi-bin</TT
+>, otherwise the static
+ files such as images and <A
+HREF="#gloss-javascript"
+><I
+CLASS="glossterm"
+>JavaScript</I
+></A
+>
+ will not work correctly. To allow scripts to run in the normal
+ web space, the following changes should be made to your
+ <TT
+CLASS="filename"
+>httpd.conf</TT
+> file.
+ </P
><P
-> <TABLE
+>To allow files with a .cgi extension to be run, make sure the
+ following line exists and is uncommented:</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
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
+> AddHandler cgi-script .cgi
+ </PRE
></FONT
></TD
></TR
></TABLE
+><P
+>To allow <TT
+CLASS="filename"
+>.htaccess</TT
+> files to override
+ permissions and .cgi files to run in the Bugzilla directory, make sure
+ the following two lines are in a <TT
+CLASS="computeroutput"
+>Directory</TT
>
-
- Change the path to Perl to match your install, of course.</P
+ directive that applies to the Bugzilla directory on your system
+ (either the Bugzilla directory or one of its parents).
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> Options +ExecCGI
+AllowOverride Limit
+ </PRE
+></FONT
></TD
></TR
></TABLE
-></DIV
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="addlwintips"
-></A
->4.3.2. Additional Windows Tips</H2
><DIV
-CLASS="tip"
+CLASS="note"
><P
></P
><TABLE
-CLASS="tip"
+CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
ALIGN="CENTER"
VALIGN="TOP"
><IMG
-SRC="../images/tip.gif"
+SRC="../images/note.gif"
HSPACE="5"
-ALT="Tip"></TD
+ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
->From Andrew Pearson:
- <A
-NAME="AEN1199"
+>For more information on Apache and its directives, see the
+ glossary entry on <A
+HREF="#gloss-apache"
+><I
+CLASS="glossterm"
+>Apache</I
></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
-><P
->You can make Bugzilla work with Personal Web Server for
- Windows 98 and higher, as well as for IIS 4.0. Microsoft has
- information available at
- <A
-HREF=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"
-TARGET="_top"
-> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</A
->
+>.
</P
+></TD
+></TR
+></TABLE
+></DIV
+><DIV
+CLASS="example"
+><A
+NAME="http-apache-htaccess"
+></A
><P
->Basically you need to add two String Keys in the registry at
- the following location:</P
+><B
+>Example 4-1. <TT
+CLASS="filename"
+>.htaccess</TT
+> files for Apache</B
+></P
><P
-> <TABLE
+><TT
+CLASS="filename"
+>$BUGZILLA_HOME/.htaccess</TT
+>
+ <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
COLOR="#000000"
><PRE
CLASS="programlisting"
-> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</PRE
+> # don't allow people to retrieve non-cgi executable files or our private data
+<FilesMatch ^(.*\.pl|.*localconfig.*|processmail|runtests.sh)$>
+ deny from all
+</FilesMatch>
+<FilesMatch ^(localconfig.js|localconfig.rdf)$>
+ allow from all
+</FilesMatch>
+ </PRE
></FONT
></TD
></TR
></TABLE
->
- </P
-><P
->The keys should be called ".pl" and ".cgi", and both should
- have a value something like:
- <B
-CLASS="command"
->c:/perl/bin/perl.exe "%s" "%s"</B
->
+>
</P
><P
->The KB article only talks about .pl, but it goes into more
- detail and provides a perl test script.</P
-></BLOCKQUOTE
->
- </P
-></TD
-></TR
-></TABLE
-></DIV
-><DIV
-CLASS="tip"
-><P
-></P
-><TABLE
-CLASS="tip"
-WIDTH="100%"
+><TT
+CLASS="filename"
+>$BUGZILLA_HOME/data/.htaccess</TT
+>
+ <TABLE
BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/tip.gif"
-HSPACE="5"
-ALT="Tip"></TD
-><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
->If attempting to run Bugzilla 2.12 or older, you will need to
- remove encrypt() calls from the Perl source. This is
- <EM
->not necessary</EM
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> # nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory; the only exception is duplicates.rdf, which is used by
+# duplicates.xul and must be loadable over the web
+deny from all
+<Files duplicates.rdf>
+ allow from all
+</Files>
+ </PRE
+></FONT
+></TD
+></TR
+></TABLE
>
-
- for Bugzilla 2.13 and later, which includes the current release,
- Bugzilla &bz-ver;.
- <DIV
-CLASS="example"
-><A
-NAME="AEN1211"
-></A
-><P
-><B
->Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or
- earlier</B
-></P
+ </P
><P
->Replace this:
+><TT
+CLASS="filename"
+>$BUGZILLA_HOME/data/webdot</TT
+>
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
COLOR="#000000"
><PRE
CLASS="programlisting"
->SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
- ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
- $enteredcryptpwd = FetchOneColumn();</PRE
+> # Restrict access to .dot files to the public webdot server at research.att.com
+# if research.att.com ever changed their IP, or if you use a different
+# webdot server, you'll need to edit this
+<FilesMatch ^[0-9]+\.dot$>
+ Allow from 192.20.225.10
+ Deny from all
+</FilesMatch>
+
+# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
+# .map files
+<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
+ Allow from all
+</FilesMatch>
+
+# And no directory listings, either.
+Deny from all
+ </PRE
></FONT
></TD
></TR
></TABLE
>
-
- with this:
+ </P
+><P
+><TT
+CLASS="filename"
+>$BUGZILLA_HOME/Bugzilla/.htaccess</TT
+>
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
COLOR="#000000"
><PRE
CLASS="programlisting"
->my $enteredcryptpwd = $enteredpwd</PRE
+> # nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory
+deny from all
+ </PRE
></FONT
></TD
></TR
></TABLE
>
-
- in cgi.pl.</P
-></DIV
+ </P
+><P
+><TT
+CLASS="filename"
+>$BUGZILLA_HOME/template/.htaccess</TT
>
- </P
+ <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> # nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory
+deny from all
+ </PRE
+></FONT
></TD
></TR
></TABLE
-></DIV
+>
+ </P
></DIV
></DIV
><DIV
CLASS="section"
-><HR><H1
+><HR><H2
CLASS="section"
><A
-NAME="osx"
+NAME="http-iis"
></A
->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
+>4.4.2. Microsoft <SPAN
+CLASS="productname"
+>Internet Information Services</SPAN
+></H2
><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
+>If you need, or for some reason even want, to use Microsoft's
+ <SPAN
+CLASS="productname"
+>Internet Information Services</SPAN
+> or
+ <SPAN
+CLASS="productname"
+>Personal Web Server</SPAN
+> you should be able
+ to. You will need to configure them to know how to run CGI scripts,
+ however. This is described in Microsoft Knowledge Base article
+ <A
+HREF="http://support.microsoft.com/support/kb/articles/Q245/2/25.asp"
+TARGET="_top"
+>Q245225 </A
+>
+ for <SPAN
+CLASS="productname"
+>Internet Information Services</SPAN
+> and
+ <A
+HREF="http://support.microsoft.com/support/kb/articles/Q231/9/98.asp"
+TARGET="_top"
+>Q231998</A
+>
+ for <SPAN
+CLASS="productname"
+>Personal Web Server</SPAN
+>.
+ </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
+>Also, and this can't be stressed enough, make sure that files such as
+ <TT
+CLASS="filename"
+>localconfig</TT
+> and your <TT
+CLASS="filename"
+>data</TT
>
- </P
+ directory are secured as described in <A
+HREF="#security"
+>Section 5.6</A
+>.
+ </P
+></DIV
+><DIV
+CLASS="section"
+><HR><H2
+CLASS="section"
+><A
+NAME="http-aol"
+></A
+>4.4.3. AOL Server</H2
><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
+>Ben FrantzDale reported success using AOL Server with Bugzilla. He
+ reported his experience and what appears below is based on that.
+ </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
+>AOL Server will have to be configured to run
+ <A
+HREF="#gloss-cgi"
+><I
+CLASS="glossterm"
+>CGI</I
+></A
+> scripts, please consult
+ the documentation that came with your server for more information on
+ how to do this.
+ </P
><P
->Instead of typing
- <SPAN
-CLASS="QUOTE"
->"install GD"</SPAN
+>Because AOL Server doesn't support <TT
+CLASS="filename"
+>.htaccess</TT
>
- at the
- <TT
-CLASS="prompt"
->cpan></TT
+ files, you'll have to create a <A
+HREF="#gloss-tcl"
+><I
+CLASS="glossterm"
+>TCL</I
+></A
>
- 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
+ script. You should create an <TT
+CLASS="filename"
+>aolserver/modules/tcl/filter.tcl</TT
+>
+ file (the filename shouldn't matter) with the following contents (change
+ <TT
+CLASS="computeroutput"
+>/bugzilla/</TT
+> to the web-based path to
+ your Bugzilla installation):
+ </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
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
><TR
><TD
-> <B
-CLASS="command"
->make test</B
->
- </TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/*.pl filter_deny
+ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/processmail filter_deny
+ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
+ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
+
+proc filter_deny { why } {
+ ns_log Notice "filter_deny"
+ return "filter_return"
+}
+ </PRE
+></FONT
+></TD
></TR
+></TABLE
+><DIV
+CLASS="warning"
+><P
+></P
+><TABLE
+CLASS="warning"
+WIDTH="100%"
+BORDER="0"
><TR
><TD
-> <B
-CLASS="command"
->make install</B
->
- </TD
-></TR
-><TR
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/warning.gif"
+HSPACE="5"
+ALT="Warning"></TD
><TD
->And don't forget to run
- <B
-CLASS="command"
->exit</B
->
-
- to get back to CPAN.</TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>This doesn't appear to account for everything mentioned in
+ <A
+HREF="#security"
+>Section 5.6</A
+>. In particular, it doesn't block access
+ to the <TT
+CLASS="filename"
+>data</TT
+> or
+ <TT
+CLASS="filename"
+>template</TT
+> directories. It also
+ doesn't account for the editor backup files that were the topic of
+ <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=186383"
+TARGET="_top"
+>bug
+ 186383</A
+>, <A
+HREF="http://online.securityfocus.com/bid/6501"
+TARGET="_top"
+>Bugtraq ID 6501</A
+>,
+ and a partial cause for the 2.16.2 release.
+ </P
+></TD
></TR
-></TBODY
></TABLE
-><P
-></P
->
- </P
+></DIV
+></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
-NAME="AEN1245"
+NAME="AEN1059"
></A
>4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2
><P
><HR><H2
CLASS="section"
><A
-NAME="AEN1250"
+NAME="AEN1064"
></A
>4.5.2. DBD::Sponge::db prepare failed</H2
><P
is provided for those that want to know exactly what is created.
</P
><P
->Note the instructions which follow are Apache-specific. If you
+>FIX ME BEFORE RELEASE!!!!!
+ 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
-><TT
-CLASS="filename"
->$BUGZILLA_HOME/.htaccess</TT
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> # don't allow people to retrieve non-cgi executable files or our private data
-<FilesMatch ^(.*\.pl|.*localconfig.*|processmail|runtests.sh)$>
- deny from all
-</FilesMatch>
-<FilesMatch ^(localconfig.js|localconfig.rdf)$>
- allow from all
-</FilesMatch>
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </P
-><P
-><TT
-CLASS="filename"
->$BUGZILLA_HOME/data/.htaccess</TT
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> # nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory; the only exception is duplicates.rdf, which is used by
-# duplicates.xul and must be loadable over the web
-deny from all
-<Files duplicates.rdf>
- allow from all
-</Files>
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </P
-><P
-><TT
-CLASS="filename"
->$BUGZILLA_HOME/data/webdot</TT
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> # Restrict access to .dot files to the public webdot server at research.att.com
-# if research.att.com ever changed their IP, or if you use a different
-# webdot server, you'll need to edit this
-<FilesMatch ^[0-9]+\.dot$>
- Allow from 192.20.225.10
- Deny from all
-</FilesMatch>
-
-# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
-# .map files
-<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
- Allow from all
-</FilesMatch>
-
-# And no directory listings, either.
-Deny from all
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </P
-><P
-><TT
-CLASS="filename"
->$BUGZILLA_HOME/Bugzilla/.htaccess</TT
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> # nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </P
-><P
-><TT
-CLASS="filename"
->$BUGZILLA_HOME/template/.htaccess</TT
->
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> # nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
- </PRE
-></FONT
-></TD
-></TR
-></TABLE
->
- </P
></LI
></OL
>
><HR><H2
CLASS="section"
><A
-NAME="AEN1610"
+NAME="AEN1409"
></A
>5.7.1. What to Edit</H2
><P
><HR><H2
CLASS="section"
><A
-NAME="AEN1629"
+NAME="AEN1428"
></A
>5.7.2. How To Edit Templates</H2
><P
><HR><H2
CLASS="section"
><A
-NAME="AEN1639"
+NAME="AEN1438"
></A
>5.7.3. Template Formats</H2
><P
><HR><H2
CLASS="section"
><A
-NAME="AEN1652"
+NAME="AEN1451"
></A
>5.7.4. Particular Templates</H2
><P
><DL
><DT
>A.1.1. <A
-HREF="#AEN1813"
+HREF="#AEN1612"
> Where can I find information about Bugzilla?</A
></DT
><DT
>A.1.2. <A
-HREF="#AEN1819"
+HREF="#AEN1618"
> What license is Bugzilla distributed under?
</A
></DT
><DT
>A.1.3. <A
-HREF="#AEN1825"
+HREF="#AEN1624"
> How do I get commercial support for Bugzilla?
</A
></DT
><DT
>A.1.4. <A
-HREF="#AEN1834"
+HREF="#AEN1633"
> What major companies or projects are currently using Bugzilla
for bug-tracking?
</A
></DT
><DT
>A.1.5. <A
-HREF="#AEN1858"
+HREF="#AEN1657"
> Who maintains Bugzilla?
</A
></DT
><DT
>A.1.6. <A
-HREF="#AEN1864"
+HREF="#AEN1663"
> How does Bugzilla stack up against other bug-tracking databases?
</A
></DT
><DT
>A.1.7. <A
-HREF="#AEN1870"
+HREF="#AEN1669"
> Why doesn't Bugzilla offer this or that feature or compatibility
with this other tracking software?
</A
></DT
><DT
>A.1.8. <A
-HREF="#AEN1877"
+HREF="#AEN1676"
> Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL.
</A
></DT
><DT
>A.1.9. <A
-HREF="#AEN1886"
+HREF="#AEN1685"
> Why do the scripts say "/usr/bonsaitools/bin/perl" instead of
"/usr/bin/perl" or something else?
</A
></DT
><DT
>A.1.10. <A
-HREF="#AEN1892"
+HREF="#AEN1691"
> Is there an easy way to change the Bugzilla cookie name?
</A
></DT
><DL
><DT
>A.2.1. <A
-HREF="#AEN1902"
+HREF="#AEN1701"
> Is Bugzilla web-based, or do you have to have specific software or
a specific operating system on your machine?
</A
></DT
><DT
>A.2.2. <A
-HREF="#AEN1907"
+HREF="#AEN1706"
> Can Bugzilla integrate with
Perforce (SCM software)?
</A
></DT
><DT
>A.2.3. <A
-HREF="#AEN1912"
+HREF="#AEN1711"
> Does Bugzilla allow the user to track multiple projects?
</A
></DT
><DT
>A.2.4. <A
-HREF="#AEN1917"
+HREF="#AEN1716"
> 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.2.5. <A
-HREF="#AEN1922"
+HREF="#AEN1721"
> Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
are there any that are NOT allowed?
</A
></DT
><DT
>A.2.6. <A
-HREF="#AEN1927"
+HREF="#AEN1726"
> 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?
></DT
><DT
>A.2.7. <A
-HREF="#AEN1934"
+HREF="#AEN1733"
> Does Bugzilla provide any reporting features, metrics, graphs, etc? You
know, the type of stuff that management likes to see. :)
</A
></DT
><DT
>A.2.8. <A
-HREF="#AEN1941"
+HREF="#AEN1740"
> Is there email notification and if so, what do you see when you get an
email?
</A
></DT
><DT
>A.2.9. <A
-HREF="#AEN1946"
+HREF="#AEN1745"
> 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.2.10. <A
-HREF="#AEN1951"
+HREF="#AEN1750"
> Do users have to have any particular
type of email application?
</A
></DT
><DT
>A.2.11. <A
-HREF="#AEN1958"
+HREF="#AEN1757"
> 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
></DT
><DT
>A.2.12. <A
-HREF="#AEN1970"
+HREF="#AEN1769"
> Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</A
></DT
><DT
>A.2.13. <A
-HREF="#AEN1977"
+HREF="#AEN1776"
> Can a user create and save reports? Can they do this in Word format?
Excel format?
</A
></DT
><DT
>A.2.14. <A
-HREF="#AEN1982"
+HREF="#AEN1781"
> Does Bugzilla have the ability to search by word, phrase, compound
search?
</A
></DT
><DT
>A.2.15. <A
-HREF="#AEN1987"
+HREF="#AEN1786"
> 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?
></DT
><DT
>A.2.16. <A
-HREF="#AEN1992"
+HREF="#AEN1791"
> Are there any backup features provided?
</A
></DT
><DT
>A.2.17. <A
-HREF="#AEN1998"
+HREF="#AEN1797"
> Can users be on the system while a backup is in progress?
</A
></DT
><DT
>A.2.18. <A
-HREF="#AEN2003"
+HREF="#AEN1802"
> 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
></DT
><DT
>A.2.19. <A
-HREF="#AEN2009"
+HREF="#AEN1808"
> 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
></DT
><DT
>A.2.20. <A
-HREF="#AEN2014"
+HREF="#AEN1813"
> 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
><DL
><DT
>A.3.1. <A
-HREF="#AEN2021"
+HREF="#AEN1820"
> How do I completely disable MySQL security if it's giving me problems
(I've followed the instructions in the installation section of this guide)?
</A
></DT
><DT
>A.3.2. <A
-HREF="#AEN2027"
+HREF="#AEN1826"
> Are there any security problems with Bugzilla?
</A
></DT
><DT
>A.3.3. <A
-HREF="#AEN2032"
+HREF="#AEN1831"
> 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.
><DL
><DT
>A.4.1. <A
-HREF="#AEN2039"
+HREF="#AEN1838"
> 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.4.2. <A
-HREF="#AEN2045"
+HREF="#AEN1844"
> 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.4.3. <A
-HREF="#AEN2050"
+HREF="#AEN1849"
> I want whineatnews.pl to whine at something more, or other than, only new
bugs. How do I do it?
</A
></DT
><DT
>A.4.4. <A
-HREF="#AEN2056"
+HREF="#AEN1855"
> 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.4.5. <A
-HREF="#AEN2063"
+HREF="#AEN1862"
> How do I set up the email interface to submit/change bugs via email?
</A
></DT
><DT
>A.4.6. <A
-HREF="#AEN2068"
+HREF="#AEN1867"
> Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
What gives?
</A
></DT
><DT
>A.4.7. <A
-HREF="#AEN2075"
+HREF="#AEN1874"
> How come email from Bugzilla changes never reaches me?
</A
></DT
><DL
><DT
>A.5.1. <A
-HREF="#AEN2083"
+HREF="#AEN1882"
> I've heard Bugzilla can be used with Oracle?
</A
></DT
><DT
>A.5.2. <A
-HREF="#AEN2088"
+HREF="#AEN1887"
> I think my database might be corrupted, or contain invalid entries. What
do I do?
</A
></DT
><DT
>A.5.3. <A
-HREF="#AEN2096"
+HREF="#AEN1895"
> I want to manually edit some entries in my database. How?
</A
></DT
><DT
>A.5.4. <A
-HREF="#AEN2104"
+HREF="#AEN1903"
> I think I've set up MySQL permissions correctly, but Bugzilla still can't
connect.
</A
></DT
><DT
>A.5.5. <A
-HREF="#AEN2112"
+HREF="#AEN1911"
> How do I synchronize bug information among multiple different Bugzilla
databases?
</A
><DL
><DT
>A.6.1. <A
-HREF="#AEN2121"
+HREF="#AEN1920"
> What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</A
></DT
><DT
>A.6.2. <A
-HREF="#AEN2126"
+HREF="#AEN1925"
> Is there a "Bundle::Bugzilla" equivalent for Win32?
</A
></DT
><DT
>A.6.3. <A
-HREF="#AEN2131"
+HREF="#AEN1930"
> CGI's are failing with a "something.cgi is not a valid Windows NT
application" error. Why?
</A
></DT
><DT
>A.6.4. <A
-HREF="#AEN2139"
+HREF="#AEN1938"
> I'm having trouble with the perl modules for NT not being able to talk to
to the database.
</A
><DL
><DT
>A.7.1. <A
-HREF="#AEN2160"
+HREF="#AEN1959"
> How do I change my user name (email address) in Bugzilla?
</A
></DT
><DT
>A.7.2. <A
-HREF="#AEN2165"
+HREF="#AEN1964"
> The query page is very confusing. Isn't there a simpler way to query?
</A
></DT
><DT
>A.7.3. <A
-HREF="#AEN2170"
+HREF="#AEN1969"
> 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.7.4. <A
-HREF="#AEN2180"
+HREF="#AEN1979"
> I can't upload anything into the database via the "Create Attachment"
link. What am I doing wrong?
</A
></DT
><DT
>A.7.5. <A
-HREF="#AEN2185"
+HREF="#AEN1984"
> How do I change a keyword in Bugzilla, once some bugs are using it?
</A
></DT
><DL
><DT
>A.8.1. <A
-HREF="#AEN2192"
+HREF="#AEN1991"
> What kind of style should I use for templatization?
</A
></DT
><DT
>A.8.2. <A
-HREF="#AEN2200"
+HREF="#AEN1999"
> What bugs are in Bugzilla right now?
</A
></DT
><DT
>A.8.3. <A
-HREF="#AEN2209"
+HREF="#AEN2008"
> 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.8.4. <A
-HREF="#AEN2215"
+HREF="#AEN2014"
> What's the best way to submit patches? What guidelines should I follow?
</A
></DT
CLASS="question"
><P
><A
-NAME="AEN1813"
+NAME="AEN1612"
></A
><B
>A.1.1. </B
CLASS="question"
><P
><A
-NAME="AEN1819"
+NAME="AEN1618"
></A
><B
>A.1.2. </B
CLASS="question"
><P
><A
-NAME="AEN1825"
+NAME="AEN1624"
></A
><B
>A.1.3. </B
CLASS="question"
><P
><A
-NAME="AEN1834"
+NAME="AEN1633"
></A
><B
>A.1.4. </B
CLASS="question"
><P
><A
-NAME="AEN1858"
+NAME="AEN1657"
></A
><B
>A.1.5. </B
CLASS="question"
><P
><A
-NAME="AEN1864"
+NAME="AEN1663"
></A
><B
>A.1.6. </B
CLASS="question"
><P
><A
-NAME="AEN1870"
+NAME="AEN1669"
></A
><B
>A.1.7. </B
CLASS="question"
><P
><A
-NAME="AEN1877"
+NAME="AEN1676"
></A
><B
>A.1.8. </B
CLASS="question"
><P
><A
-NAME="AEN1886"
+NAME="AEN1685"
></A
><B
>A.1.9. </B
CLASS="question"
><P
><A
-NAME="AEN1892"
+NAME="AEN1691"
></A
><B
>A.1.10. </B
CLASS="question"
><P
><A
-NAME="AEN1902"
+NAME="AEN1701"
></A
><B
>A.2.1. </B
CLASS="question"
><P
><A
-NAME="AEN1907"
+NAME="AEN1706"
></A
><B
>A.2.2. </B
CLASS="question"
><P
><A
-NAME="AEN1912"
+NAME="AEN1711"
></A
><B
>A.2.3. </B
CLASS="question"
><P
><A
-NAME="AEN1917"
+NAME="AEN1716"
></A
><B
>A.2.4. </B
CLASS="question"
><P
><A
-NAME="AEN1922"
+NAME="AEN1721"
></A
><B
>A.2.5. </B
CLASS="question"
><P
><A
-NAME="AEN1927"
+NAME="AEN1726"
></A
><B
>A.2.6. </B
CLASS="question"
><P
><A
-NAME="AEN1934"
+NAME="AEN1733"
></A
><B
>A.2.7. </B
CLASS="question"
><P
><A
-NAME="AEN1941"
+NAME="AEN1740"
></A
><B
>A.2.8. </B
CLASS="question"
><P
><A
-NAME="AEN1946"
+NAME="AEN1745"
></A
><B
>A.2.9. </B
CLASS="question"
><P
><A
-NAME="AEN1951"
+NAME="AEN1750"
></A
><B
>A.2.10. </B
CLASS="question"
><P
><A
-NAME="AEN1958"
+NAME="AEN1757"
></A
><B
>A.2.11. </B
CLASS="question"
><P
><A
-NAME="AEN1970"
+NAME="AEN1769"
></A
><B
>A.2.12. </B
CLASS="question"
><P
><A
-NAME="AEN1977"
+NAME="AEN1776"
></A
><B
>A.2.13. </B
CLASS="question"
><P
><A
-NAME="AEN1982"
+NAME="AEN1781"
></A
><B
>A.2.14. </B
CLASS="question"
><P
><A
-NAME="AEN1987"
+NAME="AEN1786"
></A
><B
>A.2.15. </B
CLASS="question"
><P
><A
-NAME="AEN1992"
+NAME="AEN1791"
></A
><B
>A.2.16. </B
CLASS="question"
><P
><A
-NAME="AEN1998"
+NAME="AEN1797"
></A
><B
>A.2.17. </B
CLASS="question"
><P
><A
-NAME="AEN2003"
+NAME="AEN1802"
></A
><B
>A.2.18. </B
CLASS="question"
><P
><A
-NAME="AEN2009"
+NAME="AEN1808"
></A
><B
>A.2.19. </B
CLASS="question"
><P
><A
-NAME="AEN2014"
+NAME="AEN1813"
></A
><B
>A.2.20. </B
CLASS="question"
><P
><A
-NAME="AEN2021"
+NAME="AEN1820"
></A
><B
>A.3.1. </B
CLASS="question"
><P
><A
-NAME="AEN2027"
+NAME="AEN1826"
></A
><B
>A.3.2. </B
CLASS="question"
><P
><A
-NAME="AEN2032"
+NAME="AEN1831"
></A
><B
>A.3.3. </B
CLASS="question"
><P
><A
-NAME="AEN2039"
+NAME="AEN1838"
></A
><B
>A.4.1. </B
CLASS="question"
><P
><A
-NAME="AEN2045"
+NAME="AEN1844"
+></A
+><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?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:",
+ replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>".
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1849"
+></A
+><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?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ Try Klaas Freitag's excellent patch for "whineatassigned" functionality.
+ You can find it at<A
+HREF=" http://bugzilla.mozilla.org/show_bug.cgi?id=6679"
+TARGET="_top"
+> http://bugzilla.mozilla.org/show_bug.cgi?id=6679</A
+>. This
+ patch is against an older version of Bugzilla, so you must apply
+ the diffs manually.
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1855"
+></A
+><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?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ You can call bug_email.pl directly from your aliases file, with
+ an entry like this:
+ <A
+NAME="AEN1859"
+></A
+><BLOCKQUOTE
+CLASS="BLOCKQUOTE"
+><P
+> bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl"
+ </P
+></BLOCKQUOTE
+>
+ However, this is fairly nasty and subject to problems; you also
+ need to set up your smrsh (sendmail restricted shell) to allow
+ it. In a pinch, though, it can work.
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1862"
+></A
+><B
+>A.4.5. </B
+>
+ How do I set up the email interface to submit/change bugs via email?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ You can find an updated README.mailif file in the contrib/ directory
+ of your Bugzilla distribution that walks you through the setup.
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1867"
+></A
+><B
+>A.4.6. </B
+>
+ Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
+ What gives?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ If you are using an alternate Mail Transport Agent (MTA other than
+ sendmail), make sure the options given in the "processmail" and other
+ scripts for all
+ instances of "sendmail" are correct for your MTA.
+ </P
+><P
+> If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi.
+ If you are using Postfix, you will also need to enable <SPAN
+CLASS="QUOTE"
+>"sendmailnow"</SPAN
+>.
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1874"
+></A
+><B
+>A.4.7. </B
+>
+ How come email from Bugzilla changes never reaches me?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ Double-check that you have not turned off email in your user preferences.
+ Confirm that Bugzilla is able to send email by visiting the "Log In"
+ link of your Bugzilla installation and clicking the "Email me a password"
+ button after entering your email address.
+ </P
+><P
+> If you never receive mail from Bugzilla, chances you do not have
+ sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
+ to, "/usr/lib/sendmail".
+ </P
+></DIV
+></DIV
+></DIV
+><DIV
+CLASS="qandadiv"
+><H3
+><A
+NAME="faq-db"
+></A
+>5. Bugzilla Database</H3
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1882"
+></A
+><B
+>A.5.1. </B
+>
+ I've heard Bugzilla can be used with Oracle?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle.
+ Red Hat's newer version (based on 2.17.1 and soon to be merged into
+ the main distribution) runs on PostgreSQL. At this time we know of
+ no recent ports of Bugzilla to Oracle but do intend to support it
+ in the future (possibly the 2.20 time-frame).
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1887"
+></A
+><B
+>A.5.2. </B
+>
+ I think my database might be corrupted, or contain invalid entries. What
+ do I do?
+ </P
+></DIV
+><DIV
+CLASS="answer"
+><P
+><B
+> </B
+>
+ Run the <SPAN
+CLASS="QUOTE"
+>"sanity check"</SPAN
+> utility
+ (<TT
+CLASS="filename"
+>./sanitycheck.cgi</TT
+> in the
+ Bugzilla_home directory) from your web browser to see! If
+ it finishes without errors, you're
+ <EM
+>probably</EM
+> OK. If it doesn't come back
+ OK (i.e. any red letters), there are certain things
+ Bugzilla can recover from and certain things it can't. If
+ it can't auto-recover, I hope you're familiar with
+ mysqladmin commands or have installed another way to
+ manage your database. Sanity Check, although it is a good
+ basic check on your database integrity, by no means is a
+ substitute for competent database administration and
+ avoiding deletion of data. It is not exhaustive, and was
+ created to do a basic check for the most common problems
+ in Bugzilla databases.
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN1895"
></A
><B
->A.4.2. </B
+>A.5.3. </B
>
- I'm evaluating/testing Bugzilla, and don't want it to send email to
- anyone but me. How do I do it?
+ I want to manually edit some entries in my database. How?
</P
></DIV
><DIV
><B
> </B
>
- Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:",
- replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>".
+ There is no facility in Bugzilla itself to do this. It's also generally
+ not a smart thing to do if you don't know exactly what you're doing.
+ However, if you understand SQL you can use the <B
+CLASS="command"
+>mysql</B
+>
+ command line utility to manually insert, delete and modify table
+ information. There are also more intuitive GUI clients available.
+ Personal favorites of the Bugzilla team are <A
+HREF="http://www.phpmyadmin.net/"
+TARGET="_top"
+>phpMyAdmin</A
+> and <A
+HREF="http://www.mysql.com/downloads/gui-mycc.html"
+TARGET="_top"
+>MySQL Control
+ Center</A
+>.
</P
></DIV
></DIV
CLASS="question"
><P
><A
-NAME="AEN2050"
+NAME="AEN1903"
></A
><B
->A.4.3. </B
+>A.5.4. </B
>
- I want whineatnews.pl to whine at something more, or other than, only new
- bugs. How do I do it?
+ I think I've set up MySQL permissions correctly, but Bugzilla still can't
+ connect.
</P
></DIV
><DIV
><B
> </B
>
- Try Klaas Freitag's excellent patch for "whineatassigned" functionality.
- You can find it at<A
-HREF=" http://bugzilla.mozilla.org/show_bug.cgi?id=6679"
-TARGET="_top"
-> http://bugzilla.mozilla.org/show_bug.cgi?id=6679</A
->. This
- patch is against an older version of Bugzilla, so you must apply
- the diffs manually.
- </P
+ Try running MySQL from its binary: "mysqld --skip-grant-tables". This
+ will allow you to completely rule out grant tables as the cause of your
+ frustration. If this Bugzilla is able to connect at this point then
+ you need to check that you have granted proper permission to the user
+ password combo defined in <TT
+CLASS="filename"
+>localconfig</TT
+>.
+ </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
+> Running MySQL with this command line option is very insecure and
+ should only be done when not connected to the external network
+ as a troubleshooting step.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
></DIV
></DIV
><DIV
CLASS="question"
><P
><A
-NAME="AEN2056"
+NAME="AEN1911"
></A
><B
->A.4.4. </B
+>A.5.5. </B
>
- I don't like/want to use Procmail to hand mail off to bug_email.pl.
- What alternatives do I have?
+ How do I synchronize bug information among multiple different Bugzilla
+ databases?
</P
></DIV
><DIV
><B
> </B
>
- You can call bug_email.pl directly from your aliases file, with
- an entry like this:
- <A
-NAME="AEN2060"
-></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
+ Well, you can synchronize or you can move bugs. Synchronization will
+ only work one way -- you can create a read-only copy of the database
+ at one site, and have it regularly updated at intervals from the main
+ database.
+ </P
><P
-> bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl"
- </P
-></BLOCKQUOTE
->
- However, this is fairly nasty and subject to problems; you also
- need to set up your smrsh (sendmail restricted shell) to allow
- it. In a pinch, though, it can work.
+> MySQL has some synchronization features builtin to the latest releases.
+ It would be great if someone looked into the possibilities there
+ and provided a report to the newsgroup on how to effectively
+ synchronize two Bugzilla installations.
+ </P
+><P
+> If you simply need to transfer bugs from one Bugzilla to another,
+ checkout the "move.pl" script in the Bugzilla distribution.
</P
></DIV
></DIV
+></DIV
+><DIV
+CLASS="qandadiv"
+><H3
+><A
+NAME="faq-nt"
+></A
+>6. Bugzilla and Win32</H3
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
-NAME="AEN2063"
+NAME="AEN1920"
></A
><B
->A.4.5. </B
+>A.6.1. </B
>
- How do I set up the email interface to submit/change bugs via email?
+ What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</P
></DIV
><DIV
><B
> </B
>
- You can find an updated README.mailif file in the contrib/ directory
- of your Bugzilla distribution that walks you through the setup.
+ Remove Windows. Install Linux. Install Bugzilla.
+ The boss will never know the difference.
</P
></DIV
></DIV
CLASS="question"
><P
><A
-NAME="AEN2068"
+NAME="AEN1925"
></A
><B
->A.4.6. </B
+>A.6.2. </B
>
- Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
- What gives?
+ Is there a "Bundle::Bugzilla" equivalent for Win32?
</P
></DIV
><DIV
><B
> </B
>
- If you are using an alternate Mail Transport Agent (MTA other than
- sendmail), make sure the options given in the "processmail" and other
- scripts for all
- instances of "sendmail" are correct for your MTA.
- </P
-><P
-> If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi.
- If you are using Postfix, you will also need to enable <SPAN
-CLASS="QUOTE"
->"sendmailnow"</SPAN
->.
+ Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
+ installation on UNIX systems. If someone can volunteer to
+ create a suitable PPM bundle for Win32, it would be appreciated.
</P
></DIV
></DIV
CLASS="question"
><P
><A
-NAME="AEN2075"
+NAME="AEN1930"
></A
><B
->A.4.7. </B
+>A.6.3. </B
>
- How come email from Bugzilla changes never reaches me?
+ CGI's are failing with a "something.cgi is not a valid Windows NT
+ application" error. Why?
</P
></DIV
><DIV
><B
> </B
>
- Double-check that you have not turned off email in your user preferences.
- Confirm that Bugzilla is able to send email by visiting the "Log In"
- link of your Bugzilla installation and clicking the "Email me a password"
- button after entering your email address.
+ Depending on what Web server you are using, you will have to configure
+ the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by
+ adding *.cgi to the App Mappings with the <path>\perl.exe %s %s as the
+ executable.
</P
><P
-> If you never receive mail from Bugzilla, chances you do not have
- sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
- to, "/usr/lib/sendmail".
+> Microsoft has some advice on this matter, as well:
+ <A
+NAME="AEN1935"
+></A
+><BLOCKQUOTE
+CLASS="BLOCKQUOTE"
+><P
+> "Set application mappings. In the ISM, map the extension for the script
+ file(s) to the executable for the script interpreter. For example, you might
+ map the extension .py to Python.exe, the executable for the Python script
+ interpreter. Note For the ActiveState Perl script interpreter, the extension
+ .pl is associated with PerlIS.dll by default. If you want to change the
+ association of .pl to perl.exe, you need to change the application mapping.
+ In the mapping, you must add two percent (%) characters to the end of the
+ pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s"
+ </P
+></BLOCKQUOTE
+>
</P
></DIV
></DIV
-></DIV
-><DIV
-CLASS="qandadiv"
-><H3
-><A
-NAME="faq-db"
-></A
->5. Bugzilla Database</H3
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
-NAME="AEN2083"
+NAME="AEN1938"
></A
><B
->A.5.1. </B
+>A.6.4. </B
>
- I've heard Bugzilla can be used with Oracle?
+ I'm having trouble with the perl modules for NT not being able to talk to
+ to the database.
</P
></DIV
><DIV
><B
> </B
>
- Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle.
- Red Hat's newer version (based on 2.17.1 and soon to be merged into
- the main distribution) runs on PostgreSQL. At this time we know of
- no recent ports of Bugzilla to Oracle but do intend to support it
- in the future (possibly the 2.20 time-frame).
+ Your modules may be outdated or inaccurate. Try:
+ <P
+></P
+><OL
+TYPE="1"
+><LI
+><P
+> Hitting http://www.activestate.com/ActivePerl
+ </P
+></LI
+><LI
+><P
+> Download ActivePerl
+ </P
+></LI
+><LI
+><P
+> Go to your prompt
+ </P
+></LI
+><LI
+><P
+> Type 'ppm'
+ </P
+></LI
+><LI
+><P
+> <TT
+CLASS="prompt"
+>PPM></TT
+> <B
+CLASS="command"
+>install DBI DBD-mysql GD</B
+>
+ </P
+></LI
+></OL
+>
+ I reckon TimeDate and Data::Dumper come with the activeperl. You can check
+ the ActiveState site for packages for installation through PPM.
+ <A
+HREF=" http://www.activestate.com/Packages/"
+TARGET="_top"
+> http://www.activestate.com/Packages/</A
+>
</P
></DIV
></DIV
+></DIV
+><DIV
+CLASS="qandadiv"
+><H3
+><A
+NAME="faq-use"
+></A
+>7. Bugzilla Usage</H3
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
-NAME="AEN2088"
+NAME="AEN1959"
></A
><B
->A.5.2. </B
+>A.7.1. </B
>
- I think my database might be corrupted, or contain invalid entries. What
- do I do?
+ How do I change my user name (email address) in Bugzilla?
</P
></DIV
><DIV
><B
> </B
>
- Run the <SPAN
-CLASS="QUOTE"
->"sanity check"</SPAN
-> utility
- (<TT
-CLASS="filename"
->./sanitycheck.cgi</TT
-> in the
- Bugzilla_home directory) from your web browser to see! If
- it finishes without errors, you're
- <EM
->probably</EM
-> OK. If it doesn't come back
- OK (i.e. any red letters), there are certain things
- Bugzilla can recover from and certain things it can't. If
- it can't auto-recover, I hope you're familiar with
- mysqladmin commands or have installed another way to
- manage your database. Sanity Check, although it is a good
- basic check on your database integrity, by no means is a
- substitute for competent database administration and
- avoiding deletion of data. It is not exhaustive, and was
- created to do a basic check for the most common problems
- in Bugzilla databases.
+ New in 2.16 - go to the Account section of the Preferences. You will
+ be emailed at both addresses for confirmation.
</P
></DIV
></DIV
CLASS="question"
><P
><A
-NAME="AEN2096"
+NAME="AEN1964"
></A
><B
->A.5.3. </B
+>A.7.2. </B
>
- I want to manually edit some entries in my database. How?
+ The query page is very confusing. Isn't there a simpler way to query?
</P
></DIV
><DIV
><B
> </B
>
- There is no facility in Bugzilla itself to do this. It's also generally
- not a smart thing to do if you don't know exactly what you're doing.
- However, if you understand SQL you can use the <B
-CLASS="command"
->mysql</B
->
- command line utility to manually insert, delete and modify table
- information. There are also more intuitive GUI clients available.
- Personal favorites of the Bugzilla team are <A
-HREF="http://www.phpmyadmin.net/"
-TARGET="_top"
->phpMyAdmin</A
-> and <A
-HREF="http://www.mysql.com/downloads/gui-mycc.html"
-TARGET="_top"
->MySQL Control
- Center</A
->.
+ 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
CLASS="question"
><P
><A
-NAME="AEN2104"
+NAME="AEN1969"
></A
><B
->A.5.4. </B
+>A.7.3. </B
>
- I think I've set up MySQL permissions correctly, but Bugzilla still can't
- connect.
+ I'm confused by the behavior of the "accept" button in the Show Bug form.
+ Why doesn't it assign the bug to me when I accept it?
</P
></DIV
><DIV
><B
> </B
>
- Try running MySQL from its binary: "mysqld --skip-grant-tables". This
- will allow you to completely rule out grant tables as the cause of your
- frustration. If this Bugzilla is able to connect at this point then
- you need to check that you have granted proper permission to the user
- password combo defined in <TT
-CLASS="filename"
->localconfig</TT
->.
- </P
-><DIV
-CLASS="warning"
-><P
+ The current behavior is acceptable to bugzilla.mozilla.org and most
+ users. You have your choice of patches
+ to change this behavior, however.
+ <P
></P
><TABLE
-CLASS="warning"
-WIDTH="100%"
BORDER="0"
+><TBODY
><TR
><TD
-WIDTH="25"
-ALIGN="CENTER"
-VALIGN="TOP"
-><IMG
-SRC="../images/warning.gif"
-HSPACE="5"
-ALT="Warning"></TD
+><A
+HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"
+TARGET="_top"
+> Add a "and accept bug" radio button</A
+></TD
+></TR
+><TR
><TD
-ALIGN="LEFT"
-VALIGN="TOP"
-><P
-> Running MySQL with this command line option is very insecure and
- should only be done when not connected to the external network
- as a troubleshooting step.
- </P
+><A
+HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"
+TARGET="_top"
+> "Accept" button automatically assigns to you</A
></TD
></TR
+></TBODY
></TABLE
-></DIV
+><P
+></P
+>
+ Note that these patches are somewhat dated. You will need to apply
+ them manually.
+ </P
></DIV
></DIV
><DIV
CLASS="question"
><P
><A
-NAME="AEN2112"
+NAME="AEN1979"
></A
><B
->A.5.5. </B
+>A.7.4. </B
>
- How do I synchronize bug information among multiple different Bugzilla
- databases?
+ I can't upload anything into the database via the "Create Attachment"
+ link. What am I doing wrong?
</P
></DIV
><DIV
><B
> </B
>
- Well, you can synchronize or you can move bugs. Synchronization will
- only work one way -- you can create a read-only copy of the database
- at one site, and have it regularly updated at intervals from the main
- database.
- </P
-><P
-> MySQL has some synchronization features builtin to the latest releases.
- It would be great if someone looked into the possibilities there
- and provided a report to the newsgroup on how to effectively
- synchronize two Bugzilla installations.
- </P
-><P
-> If you simply need to transfer bugs from one Bugzilla to another,
- checkout the "move.pl" script in the Bugzilla distribution.
+ The most likely cause is a very old browser or a browser that is
+ incompatible with file upload via POST. Download the latest Netscape,
+ Microsoft, or Mozilla browser to handle uploads correctly.
</P
></DIV
></DIV
-></DIV
-><DIV
-CLASS="qandadiv"
-><H3
-><A
-NAME="faq-nt"
-></A
->6. Bugzilla and Win32</H3
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
-NAME="AEN2121"
+NAME="AEN1984"
></A
><B
->A.6.1. </B
+>A.7.5. </B
>
- What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
+ How do I change a keyword in Bugzilla, once some bugs are using it?
</P
></DIV
><DIV
><B
> </B
>
- Remove Windows. Install Linux. Install Bugzilla.
- The boss will never know the difference.
+ In the Bugzilla administrator UI, edit the keyword and it will let you
+ replace the old keyword name with a new one. This will cause a problem
+ with the keyword cache. Run sanitycheck.cgi to fix it.
</P
></DIV
></DIV
+></DIV
+><DIV
+CLASS="qandadiv"
+><H3
+><A
+NAME="faq-hacking"
+></A
+>8. Bugzilla Hacking</H3
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
-NAME="AEN2126"
+NAME="AEN1991"
></A
><B
->A.6.2. </B
+>A.8.1. </B
>
- Is there a "Bundle::Bugzilla" equivalent for Win32?
+ What kind of style should I use for templatization?
</P
></DIV
><DIV
><B
> </B
>
- Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
- installation on UNIX systems. If someone can volunteer to
- create a suitable PPM bundle for Win32, it would be appreciated.
- </P
+ Gerv and Myk suggest a 2-space indent, with embedded code sections on
+ their own line, in line with outer tags. Like this:</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> <fred>
+[% IF foo %]
+ <bar>
+ [% FOREACH x = barney %]
+ <tr>
+ <td>
+ [% x %]
+ </td>
+ <tr>
+ [% END %]
+[% END %]
+</fred>
+</PRE
+></FONT
+></TD
+></TR
+></TABLE
+><P
+> Myk also recommends you turn on PRE_CHOMP in the template
+ initialization to prevent bloating of HTML with unnecessary whitespace.
+ </P
+><P
+>Please note that many have differing opinions on this subject,
+ and the existing templates in Bugzilla espouse both this and a 4-space
+ style. Either is acceptable; the above is preferred.</P
></DIV
></DIV
><DIV
CLASS="question"
><P
><A
-NAME="AEN2131"
+NAME="AEN1999"
></A
><B
->A.6.3. </B
+>A.8.2. </B
>
- CGI's are failing with a "something.cgi is not a valid Windows NT
- application" error. Why?
+ What bugs are in Bugzilla right now?
</P
></DIV
><DIV
><B
> </B
>
- Depending on what Web server you are using, you will have to configure
- the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by
- adding *.cgi to the App Mappings with the <path>\perl.exe %s %s as the
- executable.
+ Try <A
+HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla"
+TARGET="_top"
+> this link</A
+> to view current bugs or requests for
+ enhancement for Bugzilla.
</P
><P
-> Microsoft has some advice on this matter, as well:
+> You can view bugs marked for 2.18 release
+ <A
+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.18 release that have already
+ been fixed and checked into CVS. Please consult the
<A
-NAME="AEN2136"
+HREF="http://www.mozilla.org/projects/bugzilla/"
+TARGET="_top"
+> Bugzilla Project Page</A
+> for details on how to
+ check current sources out of CVS so you can have these
+ bug fixes early!
+ </P
+></DIV
+></DIV
+><DIV
+CLASS="qandaentry"
+><DIV
+CLASS="question"
+><P
+><A
+NAME="AEN2008"
></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
+><B
+>A.8.3. </B
+>
+ How can I change the default priority to a null value? For instance, have the default
+ priority be "---" instead of "P2"?
+ </P
+></DIV
+><DIV
+CLASS="answer"
><P
-> "Set application mappings. In the ISM, map the extension for the script
- file(s) to the executable for the script interpreter. For example, you might
- map the extension .py to Python.exe, the executable for the Python script
- interpreter. Note For the ActiveState Perl script interpreter, the extension
- .pl is associated with PerlIS.dll by default. If you want to change the
- association of .pl to perl.exe, you need to change the application mapping.
- In the mapping, you must add two percent (%) characters to the end of the
- pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s"
- </P
-></BLOCKQUOTE
+><B
+> </B
>
+ This is well-documented here: <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"
+TARGET="_top"
+> http://bugzilla.mozilla.org/show_bug.cgi?id=49862</A
+>. Ultimately, it's as easy
+ as adding the "---" priority field to your localconfig file in the appropriate area,
+ re-running checksetup.pl, and then changing the default priority in your browser using
+ "editparams.cgi".
</P
></DIV
></DIV
CLASS="question"
><P
><A
-NAME="AEN2139"
+NAME="AEN2014"
></A
><B
->A.6.4. </B
+>A.8.4. </B
>
- I'm having trouble with the perl modules for NT not being able to talk to
- to the database.
+ What's the best way to submit patches? What guidelines should I follow?
</P
></DIV
><DIV
><P
><B
> </B
->
- Your modules may be outdated or inaccurate. Try:
- <P
+><P
></P
><OL
TYPE="1"
><LI
><P
-> Hitting http://www.activestate.com/ActivePerl
+> Enter a bug into bugzilla.mozilla.org for the <SPAN
+CLASS="QUOTE"
+>"<A
+HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
+TARGET="_top"
+>Bugzilla</A
+>"</SPAN
+>
+ product.
</P
></LI
><LI
><P
-> Download ActivePerl
+> 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" checkbox
+ to indicate the text you are sending is a patch!
</P
></LI
><LI
><P
-> Go to your prompt
+> Announce your patch and the associated URL
+ (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.
</P
></LI
><LI
><P
-> Type 'ppm'
+> If it passes muster with minimal modification, the person to whom
+ the bug is assigned in Bugzilla is responsible for seeing the patch
+ is checked into CVS.
</P
></LI
><LI
><P
-> <TT
-CLASS="prompt"
->PPM></TT
-> <B
-CLASS="command"
->install DBI DBD-mysql GD</B
->
+> Bask in the glory of the fact that you helped write the most successful
+ open-source bug-tracking software on the planet :)
</P
></LI
></OL
->
- I reckon TimeDate and Data::Dumper come with the activeperl. You can check
- the ActiveState site for packages for installation through PPM.
- <A
-HREF=" http://www.activestate.com/Packages/"
-TARGET="_top"
-> http://www.activestate.com/Packages/</A
->
- </P
+></P
+></DIV
+></DIV
></DIV
></DIV
></DIV
><DIV
-CLASS="qandadiv"
-><H3
+CLASS="appendix"
+><HR><H1
><A
-NAME="faq-use"
+NAME="database"
></A
->7. Bugzilla Usage</H3
-><DIV
-CLASS="qandaentry"
+>Appendix B. The Bugzilla Database</H1
><DIV
-CLASS="question"
+CLASS="note"
><P
-><A
-NAME="AEN2160"
-></A
-><B
->A.7.1. </B
->
- How do I change my user name (email address) in Bugzilla?
- </P
-></DIV
-><DIV
-CLASS="answer"
+></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
-><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
+>This document really needs to be updated with more fleshed out
+ information about primary keys, interrelationships, and maybe some nifty
+ tables to document dependencies. Any takers?</P
+></TD
+></TR
+></TABLE
></DIV
><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
+CLASS="section"
+><HR><H1
+CLASS="section"
><A
-NAME="AEN2165"
+NAME="dbmodify"
></A
-><B
->A.7.2. </B
+>B.1. Modifying Your Running System</H1
+><P
+>Bugzilla optimizes database lookups by storing all relatively
+ static information in the
+ <TT
+CLASS="filename"
+>versioncache</TT
+> file, located in the
+ <TT
+CLASS="filename"
+>data/</TT
>
- The query page is very confusing. Isn't there a simpler way to query?
- </P
-></DIV
-><DIV
-CLASS="answer"
+ subdirectory under your installation directory.</P
><P
-><B
-> </B
+>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
>
- 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
+
+ encoded in <TT
+CLASS="filename"
+>defparams.pl</TT
+>, 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
+> <TT
+CLASS="filename"
+>versioncache</TT
+>
+ 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="qandaentry"
-><DIV
-CLASS="question"
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="dbdoc"
+></A
+>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="AEN2170"
+NAME="AEN2057"
></A
-><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?
- </P
-></DIV
-><DIV
-CLASS="answer"
+>B.2.1. Bugzilla Database Basics</H2
><P
-><B
-> </B
+>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
>
- The current behavior is acceptable to bugzilla.mozilla.org and most
- users. You have your choice of patches
- to change this behavior, however.
- <P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
-><A
-HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"
-TARGET="_top"
-> Add a "and accept bug" radio button</A
-></TD
-></TR
-><TR
-><TD
-><A
-HREF="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"
+
+ and a
+ <SPAN
+CLASS="QUOTE"
+>"tinyint"</SPAN
+>
+
+ entry in MySQL. I recommend you refer to the MySQL documentation,
+ available at
+ <A
+HREF="http://www.mysql.com/doc.html"
TARGET="_top"
-> "Accept" button automatically assigns to you</A
-></TD
-></TR
-></TBODY
-></TABLE
+>MySQL.com</A
+>
+
+ . Below are the basics you need to know about the Bugzilla database.
+ Check the chart above for more details.</P
><P
+> <P
></P
+><OL
+TYPE="1"
+><LI
+><P
+>To connect to your database:</P
+><P
+> <TT
+CLASS="prompt"
+>bash#</TT
>
- Note that these patches are somewhat dated. You will need to apply
- them manually.
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
+
+ <B
+CLASS="command"
+>mysql</B
+>
+
+ <TT
+CLASS="parameter"
+><I
+>-u root</I
+></TT
+>
+ </P
><P
-><A
-NAME="AEN2180"
-></A
-><B
->A.7.4. </B
+>If this works without asking you for a password,
+ <EM
+>shame on you</EM
>
- I can't upload anything into the database via the "Create Attachment"
- link. What am I doing wrong?
- </P
-></DIV
-><DIV
-CLASS="answer"
+
+ ! 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
-><B
-> </B
+>You should now be at a prompt that looks like this:</P
+><P
+> <TT
+CLASS="prompt"
+>mysql></TT
>
- The most likely cause is a very old browser or a browser that is
- incompatible with file upload via POST. Download the latest Netscape,
- Microsoft, or Mozilla browser to handle uploads correctly.
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
+ </P
><P
-><A
-NAME="AEN2185"
-></A
-><B
->A.7.5. </B
+>At the prompt, if
+ <SPAN
+CLASS="QUOTE"
+>"bugs"</SPAN
>
- How do I change a keyword in Bugzilla, once some bugs are using it?
- </P
-></DIV
-><DIV
-CLASS="answer"
+
+ is the name you chose in the
+ <TT
+CLASS="filename"
+>localconfig</TT
+>
+
+ file for your Bugzilla database, type:</P
><P
-><B
-> </B
+> <TT
+CLASS="prompt"
+>mysql</TT
>
- In the Bugzilla administrator UI, edit the keyword and it will let you
- replace the old keyword name with a new one. This will cause a problem
- with the keyword cache. Run sanitycheck.cgi to fix it.
- </P
-></DIV
-></DIV
-></DIV
+
+ <B
+CLASS="command"
+>use bugs;</B
+>
+ </P
+></LI
+></OL
+>
+ </P
><DIV
-CLASS="qandadiv"
-><H3
+CLASS="section"
+><HR><H3
+CLASS="section"
><A
-NAME="faq-hacking"
+NAME="AEN2084"
></A
->8. Bugzilla Hacking</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
+>B.2.1.1. Bugzilla Database Tables</H3
><P
-><A
-NAME="AEN2192"
-></A
-><B
->A.8.1. </B
+>Imagine your MySQL database as a series of spreadsheets, and
+ you won't be too far off. If you use this command:</P
+><P
+> <TT
+CLASS="prompt"
+>mysql></TT
>
- What kind of style should I use for templatization?
- </P
-></DIV
-><DIV
-CLASS="answer"
+ <B
+CLASS="command"
+>show tables from bugs;</B
+>
+ </P
><P
-><B
-> </B
+>you'll be able to see the names of all the
+ <SPAN
+CLASS="QUOTE"
+>"spreadsheets"</SPAN
>
- Gerv and Myk suggest a 2-space indent, with embedded code sections on
- their own line, in line with outer tags. Like this:</P
-><TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> <fred>
-[% IF foo %]
- <bar>
- [% FOREACH x = barney %]
- <tr>
- <td>
- [% x %]
- </td>
- <tr>
- [% END %]
-[% END %]
-</fred>
+ (tables) in your database.</P
+><P
+>From the command issued above, ou should have some
+ output that looks like this:
+<TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> +-------------------+
+| Tables in bugs |
++-------------------+
+| attachments |
+| bugs |
+| bugs_activity |
+| cc |
+| components |
+| dependencies |
+| fielddefs |
+| groups |
+| keyworddefs |
+| keywords |
+| logincookies |
+| longdescs |
+| milestones |
+| namedqueries |
+| products |
+| profiles |
+| profiles_activity |
+| tokens |
+| versions |
+| votes |
+| watch |
++-------------------+
</PRE
></FONT
></TD
></TR
></TABLE
-><P
-> Myk also recommends you turn on PRE_CHOMP in the template
- initialization to prevent bloating of HTML with unnecessary whitespace.
- </P
-><P
->Please note that many have differing opinions on this subject,
- and the existing templates in Bugzilla espouse both this and a 4-space
- style. Either is acceptable; the above is preferred.</P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN2200"
-></A
-><B
->A.8.2. </B
->
- What bugs are in Bugzilla right now?
- </P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
>
- Try <A
-HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla"
-TARGET="_top"
-> this link</A
-> to view current bugs or requests for
- enhancement for Bugzilla.
- </P
-><P
-> You can view bugs marked for 2.18 release
- <A
-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.18 release that have already
- been fixed and checked into CVS. Please consult the
- <A
-HREF="http://www.mozilla.org/projects/bugzilla/"
-TARGET="_top"
-> Bugzilla Project Page</A
-> for details on how to
- check current sources out of CVS so you can have these
- bug fixes early!
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
+</P
><P
-><A
-NAME="AEN2209"
-></A
-><B
->A.8.3. </B
->
- How can I change the default priority to a null value? For instance, have the default
- priority be "---" instead of "P2"?
- </P
+CLASS="literallayout"
+><br>
+ Here's an overview of what each table does. Most columns in each table have<br>
+descriptive names that make it fairly trivial to figure out their jobs.<br>
+<br>
+attachments: This table stores all attachments to bugs. It tends to be your<br>
+largest table, yet also generally has the fewest entries because file<br>
+attachments are so (relatively) large.<br>
+<br>
+bugs: This is the core of your system. The bugs table stores most of the<br>
+current information about a bug, with the exception of the info stored in the<br>
+other tables.<br>
+<br>
+bugs_activity: This stores information regarding what changes are made to bugs<br>
+when -- a history file.<br>
+<br>
+cc: This tiny table simply stores all the CC information for any bug which has<br>
+any entries in the CC field of the bug. Note that, like most other tables in<br>
+Bugzilla, it does not refer to users by their user names, but by their unique<br>
+userid, stored as a primary key in the profiles table.<br>
+<br>
+components: This stores the programs and components (or products and<br>
+components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"<br>
+(product) field is the full name of the product, rather than some other unique<br>
+identifier, like bug_id and user_id are elsewhere in the database.<br>
+<br>
+dependencies: Stores data about those cool dependency trees.<br>
+<br>
+fielddefs: A nifty table that defines other tables. For instance, when you<br>
+submit a form that changes the value of "AssignedTo" this table allows<br>
+translation to the actual field name "assigned_to" for entry into MySQL.<br>
+<br>
+groups: defines bitmasks for groups. A bitmask is a number that can uniquely<br>
+identify group memberships. For instance, say the group that is allowed to<br>
+tweak parameters is assigned a value of "1", the group that is allowed to edit<br>
+users is assigned a "2", and the group that is allowed to create new groups is<br>
+assigned the bitmask of "4". By uniquely combining the group bitmasks (much<br>
+like the chmod command in UNIX,) you can identify a user is allowed to tweak<br>
+parameters and create groups, but not edit users, by giving him a bitmask of<br>
+"5", or a user allowed to edit users and create groups, but not tweak<br>
+parameters, by giving him a bitmask of "6" Simple, huh?<br>
+ If this makes no sense to you, try this at the mysql prompt:<br>
+mysql> select * from groups;<br>
+ You'll see the list, it makes much more sense that way.<br>
+<br>
+keyworddefs: Definitions of keywords to be used<br>
+<br>
+keywords: Unlike what you'd think, this table holds which keywords are<br>
+associated with which bug id's.<br>
+<br>
+logincookies: This stores every login cookie ever assigned to you for every<br>
+machine you've ever logged into Bugzilla from. Curiously, it never does any<br>
+housecleaning -- I see cookies in this file I've not used for months. However,<br>
+since Bugzilla never expires your cookie (for convenience' sake), it makes<br>
+sense.<br>
+<br>
+longdescs: The meat of bugzilla -- here is where all user comments are stored!<br>
+You've only got 2^24 bytes per comment (it's a mediumtext field), so speak<br>
+sparingly -- that's only the amount of space the Old Testament from the Bible<br>
+would take (uncompressed, 16 megabytes). Each comment is keyed to the<br>
+bug_id to which it's attached, so the order is necessarily chronological, for<br>
+comments are played back in the order in which they are received.<br>
+<br>
+milestones: Interesting that milestones are associated with a specific product<br>
+in this table, but Bugzilla does not yet support differing milestones by<br>
+product through the standard configuration interfaces.<br>
+<br>
+namedqueries: This is where everybody stores their "custom queries". Very<br>
+cool feature; it beats the tar out of having to bookmark each cool query you<br>
+construct.<br>
+<br>
+products: What products you have, whether new bug entries are allowed for the<br>
+product, what milestone you're working toward on that product, votes, etc. It<br>
+will be nice when the components table supports these same features, so you<br>
+could close a particular component for bug entry without having to close an<br>
+entire product...<br>
+<br>
+profiles: Ahh, so you were wondering where your precious user information was<br>
+stored? Here it is! With the passwords in plain text for all to see! (but<br>
+sshh... don't tell your users!)<br>
+<br>
+profiles_activity: Need to know who did what when to who's profile? This'll<br>
+tell you, it's a pretty complete history.<br>
+<br>
+versions: Version information for every product<br>
+<br>
+votes: Who voted for what when<br>
+<br>
+watch: Who (according to userid) is watching who's bugs (according to their<br>
+userid).<br>
+<br>
+<br>
+===<br>
+THE DETAILS<br>
+===<br>
+<br>
+ Ahh, so you're wondering just what to do with the information above? At the<br>
+mysql prompt, you can view any information about the columns in a table with<br>
+this command (where "table" is the name of the table you wish to view):<br>
+<br>
+mysql> show columns from table;<br>
+<br>
+ You can also view all the data in a table with this command:<br>
+<br>
+mysql> select * from table;<br>
+<br>
+ -- note: this is a very bad idea to do on, for instance, the "bugs" table if<br>
+you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or<br>
+50,000 bugs play across your screen.<br>
+<br>
+ You can limit the display from above a little with the command, where<br>
+"column" is the name of the column for which you wish to restrict information:<br>
+<br>
+mysql> select * from table where (column = "some info");<br>
+<br>
+ -- or the reverse of this<br>
+<br>
+mysql> select * from table where (column != "some info");<br>
+<br>
+ Let's take our example from the introduction, and assume you need to change<br>
+the word "verified" to "approved" in the resolution field. We know from the<br>
+above information that the resolution is likely to be stored in the "bugs"<br>
+table. Note we'll need to change a little perl code as well as this database<br>
+change, but I won't plunge into that in this document. Let's verify the<br>
+information is stored in the "bugs" table:<br>
+<br>
+mysql> show columns from bugs<br>
+<br>
+ (exceedingly long output truncated here)<br>
+| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||<br>
+<br>
+ Sorry about that long line. We see from this that the "bug status" column is<br>
+an "enum field", which is a MySQL peculiarity where a string type field can<br>
+only have certain types of entries. While I think this is very cool, it's not<br>
+standard SQL. Anyway, we need to add the possible enum field entry<br>
+'APPROVED' by altering the "bugs" table.<br>
+<br>
+mysql> ALTER table bugs CHANGE bug_status bug_status<br>
+ -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",<br>
+ -> "VERIFIED", "APPROVED", "CLOSED") not null;<br>
+<br>
+ (note we can take three lines or more -- whatever you put in before the<br>
+semicolon is evaluated as a single expression)<br>
+<br>
+Now if you do this:<br>
+<br>
+mysql> show columns from bugs;<br>
+<br>
+ you'll see that the bug_status field has an extra "APPROVED" enum that's<br>
+available! Cool thing, too, is that this is reflected on your query page as<br>
+well -- you can query by the new status. But how's it fit into the existing<br>
+scheme of things?<br>
+ Looks like you need to go back and look for instances of the word "verified"<br>
+in the perl code for Bugzilla -- wherever you find "verified", change it to<br>
+"approved" and you're in business (make sure that's a case-insensitive search).<br>
+Although you can query by the enum field, you can't give something a status<br>
+of "APPROVED" until you make the perl changes. Note that this change I<br>
+mentioned can also be done by editing checksetup.pl, which automates a lot of<br>
+this. But you need to know this stuff anyway, right?<br>
+ </P
+></DIV
></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- This is well-documented here: <A
-HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"
-TARGET="_top"
-> http://bugzilla.mozilla.org/show_bug.cgi?id=49862</A
->. Ultimately, it's as easy
- as adding the "---" priority field to your localconfig file in the appropriate area,
- re-running checksetup.pl, and then changing the default priority in your browser using
- "editparams.cgi".
- </P
></DIV
></DIV
><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
+CLASS="appendix"
+><HR><H1
+><A
+NAME="patches"
+></A
+>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
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
><A
-NAME="AEN2215"
+NAME="rewrite"
></A
-><B
->A.8.4. </B
+>C.1. Apache
+ <TT
+CLASS="filename"
+>mod_rewrite</TT
>
- What's the best way to submit patches? What guidelines should I follow?
- </P
-></DIV
-><DIV
-CLASS="answer"
+
+ magic</H1
><P
-><B
-> </B
+>Apache's
+ <TT
+CLASS="filename"
+>mod_rewrite</TT
+>
+
+ module lets you do some truly amazing things with URL rewriting. Here are
+ a couple of examples of what you can do.</P
><P
></P
><OL
TYPE="1"
><LI
><P
-> Enter a bug into bugzilla.mozilla.org for the <SPAN
-CLASS="QUOTE"
->"<A
-HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
-TARGET="_top"
->Bugzilla</A
->"</SPAN
+>Make it so if someone types
+ <TT
+CLASS="computeroutput"
+>http://www.foo.com/12345</TT
>
- product.
- </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"
+WIDTH="100%"
+><TR
+><TD
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="programlisting"
+> <VirtualHost 12.34.56.78>
+RewriteEngine On
+RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
+</VirtualHost>
+</PRE
+></FONT
+></TD
+></TR
+></TABLE
></LI
><LI
><P
-> 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" checkbox
- to indicate the text you are sending is a patch!
- </P
+>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
></LI
-><LI
+></OL
+></DIV
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="cmdline"
+></A
+>C.2. Command-line Bugzilla Queries</H1
><P
-> Announce your patch and the associated URL
- (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.
- </P
-></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
-> If it passes muster with minimal modification, the person to whom
- the bug is assigned in Bugzilla is responsible for seeing the patch
- is checked into CVS.
- </P
-></LI
-><LI
+><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
-> Bask in the glory of the fact that you helped write the most successful
- open-source bug-tracking software on the planet :)
- </P
-></LI
-></OL
-></P
-></DIV
-></DIV
-></DIV
+><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 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="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
+>
+ </P
+><P
+>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
></DIV
><DIV
CLASS="appendix"
><HR><H1
><A
-NAME="database"
+NAME="variants"
></A
->Appendix B. The Bugzilla Database</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"
+>Appendix D. Bugzilla Variants and Competitors</H1
><P
->This document really needs to be updated with more fleshed out
- information about primary keys, interrelationships, and maybe some nifty
- tables to document dependencies. Any takers?</P
-></TD
-></TR
-></TABLE
-></DIV
+>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="dbmodify"
+NAME="rhbugzilla"
></A
->B.1. Modifying Your Running System</H1
+>D.1. Red Hat Bugzilla</H1
><P
->Bugzilla optimizes database lookups by storing all relatively
- static information in the
- <TT
-CLASS="filename"
->versioncache</TT
-> file, located in the
- <TT
-CLASS="filename"
->data/</TT
->
- subdirectory under your installation directory.</P
+>Red Hat's old fork of Bugzilla which was based on version 2.8 is now
+ obsolete. The newest version in use is based on version 2.17.1 and is in
+ the process of being integrated into the main Bugzilla source tree. The
+ back-end is modified to work with PostgreSQL instead of MySQL and they have
+ custom templates to get their desired look and feel, but other than that it
+ is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of
+ effort to make sure that the changes he made could be integrated back into
+ the main tree.
+ <A
+HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=98304"
+TARGET="_top"
+>Bug
+ 98304</A
+> exists to track this integration.
+ </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 <TT
-CLASS="filename"
->defparams.pl</TT
->, you will need to remove
- the cached content from the data directory (by doing a
- <SPAN
-CLASS="QUOTE"
->"rm data/versioncache"</SPAN
+>URL:
+ <A
+HREF="http://bugzilla.redhat.com/bugzilla/"
+TARGET="_top"
+> http://bugzilla.redhat.com/bugzilla/</A
>
-
- ), or your changes won't show up.</P
+ </P
><P
-> <TT
-CLASS="filename"
->versioncache</TT
->
- 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
+>This section last updated 24 Dec 2002</P
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
-NAME="dbdoc"
+NAME="variant-fenris"
></A
->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
+>D.2. Loki Bugzilla (Fenris)</H1
><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
+>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
><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
+>This section last updated 27 Jul 2002</P
+></DIV
><DIV
CLASS="section"
-><HR><H2
+><HR><H1
CLASS="section"
><A
-NAME="AEN2258"
+NAME="variant-issuezilla"
></A
->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
-CLASS="QUOTE"
->"bigint"</SPAN
->
-
- and a
- <SPAN
-CLASS="QUOTE"
->"tinyint"</SPAN
->
-
- entry in MySQL. I recommend you refer to the MySQL documentation,
- available at
- <A
-HREF="http://www.mysql.com/doc.html"
-TARGET="_top"
->MySQL.com</A
->
-
- . Below are the basics you need to know about the Bugzilla database.
- Check the chart above for more details.</P
+>D.3. Issuezilla</H1
><P
-> <P
-></P
-><OL
-TYPE="1"
-><LI
+>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
><P
->To connect to your database:</P
+>This section last updated 27 Jul 2002</P
+></DIV
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="variant-scarab"
+></A
+>D.4. Scarab</H1
><P
-> <TT
-CLASS="prompt"
->bash#</TT
->
-
- <B
-CLASS="command"
->mysql</B
->
-
- <TT
-CLASS="parameter"
-><I
->-u root</I
-></TT
->
- </P
+>Scarab is a new open source bug-tracking system built using Java
+ Servlet technology. It is currently at version 1.0 beta 13.</P
><P
->If this works without asking you for a password,
- <EM
->shame on you</EM
->
-
- ! You should have locked your security down like the installation
- instructions told you to. You can find details on locking down
- your database in the Bugzilla FAQ in this directory (under
- "Security"), or more robust security generalities in the
- <A
-HREF="http://www.mysql.com/php/manual.php3?section=Privilege_system"
+>URL:
+ <A
+HREF="http://scarab.tigris.org/"
TARGET="_top"
->MySQL
- searchable documentation</A
->.
- </P
-></LI
-><LI
-><P
->You should now be at a prompt that looks like this:</P
-><P
-> <TT
-CLASS="prompt"
->mysql></TT
->
- </P
-><P
->At the prompt, if
- <SPAN
-CLASS="QUOTE"
->"bugs"</SPAN
->
-
- is the name you chose in the
- <TT
-CLASS="filename"
->localconfig</TT
->
-
- file for your Bugzilla database, type:</P
-><P
-> <TT
-CLASS="prompt"
->mysql</TT
->
-
- <B
-CLASS="command"
->use bugs;</B
->
- </P
-></LI
-></OL
+>http://scarab.tigris.org</A
>
- </P
+ </P
+><P
+>This section last updated 18 Jan 2003</P
+></DIV
><DIV
CLASS="section"
-><HR><H3
+><HR><H1
CLASS="section"
><A
-NAME="AEN2285"
+NAME="variant-perforce"
></A
->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
-><P
-> <TT
-CLASS="prompt"
->mysql></TT
->
- <B
-CLASS="command"
->show tables from bugs;</B
->
- </P
+>D.5. Perforce SCM</H1
><P
->you'll be able to see the names of all the
- <SPAN
+>Although Perforce isn't really a bug tracker, it can be used as
+ such through the <SPAN
CLASS="QUOTE"
->"spreadsheets"</SPAN
+>"jobs"</SPAN
>
- (tables) in your database.</P
+ functionality.</P
><P
->From the command issued above, ou should have some
- output that looks like this:
-<TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> +-------------------+
-| Tables in bugs |
-+-------------------+
-| attachments |
-| bugs |
-| bugs_activity |
-| cc |
-| components |
-| dependencies |
-| fielddefs |
-| groups |
-| keyworddefs |
-| keywords |
-| logincookies |
-| longdescs |
-| milestones |
-| namedqueries |
-| products |
-| profiles |
-| profiles_activity |
-| tokens |
-| versions |
-| votes |
-| watch |
-+-------------------+
-</PRE
-></FONT
-></TD
-></TR
-></TABLE
+>URL:
+ <A
+HREF="http://www.perforce.com/perforce/technotes/note052.html"
+TARGET="_top"
+> http://www.perforce.com/perforce/technotes/note052.html
+ </A
>
-</P
+ </P
><P
-CLASS="literallayout"
-><br>
- Here's an overview of what each table does. Most columns in each table have<br>
-descriptive names that make it fairly trivial to figure out their jobs.<br>
-<br>
-attachments: This table stores all attachments to bugs. It tends to be your<br>
-largest table, yet also generally has the fewest entries because file<br>
-attachments are so (relatively) large.<br>
-<br>
-bugs: This is the core of your system. The bugs table stores most of the<br>
-current information about a bug, with the exception of the info stored in the<br>
-other tables.<br>
-<br>
-bugs_activity: This stores information regarding what changes are made to bugs<br>
-when -- a history file.<br>
-<br>
-cc: This tiny table simply stores all the CC information for any bug which has<br>
-any entries in the CC field of the bug. Note that, like most other tables in<br>
-Bugzilla, it does not refer to users by their user names, but by their unique<br>
-userid, stored as a primary key in the profiles table.<br>
-<br>
-components: This stores the programs and components (or products and<br>
-components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"<br>
-(product) field is the full name of the product, rather than some other unique<br>
-identifier, like bug_id and user_id are elsewhere in the database.<br>
-<br>
-dependencies: Stores data about those cool dependency trees.<br>
-<br>
-fielddefs: A nifty table that defines other tables. For instance, when you<br>
-submit a form that changes the value of "AssignedTo" this table allows<br>
-translation to the actual field name "assigned_to" for entry into MySQL.<br>
-<br>
-groups: defines bitmasks for groups. A bitmask is a number that can uniquely<br>
-identify group memberships. For instance, say the group that is allowed to<br>
-tweak parameters is assigned a value of "1", the group that is allowed to edit<br>
-users is assigned a "2", and the group that is allowed to create new groups is<br>
-assigned the bitmask of "4". By uniquely combining the group bitmasks (much<br>
-like the chmod command in UNIX,) you can identify a user is allowed to tweak<br>
-parameters and create groups, but not edit users, by giving him a bitmask of<br>
-"5", or a user allowed to edit users and create groups, but not tweak<br>
-parameters, by giving him a bitmask of "6" Simple, huh?<br>
- If this makes no sense to you, try this at the mysql prompt:<br>
-mysql> select * from groups;<br>
- You'll see the list, it makes much more sense that way.<br>
-<br>
-keyworddefs: Definitions of keywords to be used<br>
-<br>
-keywords: Unlike what you'd think, this table holds which keywords are<br>
-associated with which bug id's.<br>
-<br>
-logincookies: This stores every login cookie ever assigned to you for every<br>
-machine you've ever logged into Bugzilla from. Curiously, it never does any<br>
-housecleaning -- I see cookies in this file I've not used for months. However,<br>
-since Bugzilla never expires your cookie (for convenience' sake), it makes<br>
-sense.<br>
-<br>
-longdescs: The meat of bugzilla -- here is where all user comments are stored!<br>
-You've only got 2^24 bytes per comment (it's a mediumtext field), so speak<br>
-sparingly -- that's only the amount of space the Old Testament from the Bible<br>
-would take (uncompressed, 16 megabytes). Each comment is keyed to the<br>
-bug_id to which it's attached, so the order is necessarily chronological, for<br>
-comments are played back in the order in which they are received.<br>
-<br>
-milestones: Interesting that milestones are associated with a specific product<br>
-in this table, but Bugzilla does not yet support differing milestones by<br>
-product through the standard configuration interfaces.<br>
-<br>
-namedqueries: This is where everybody stores their "custom queries". Very<br>
-cool feature; it beats the tar out of having to bookmark each cool query you<br>
-construct.<br>
-<br>
-products: What products you have, whether new bug entries are allowed for the<br>
-product, what milestone you're working toward on that product, votes, etc. It<br>
-will be nice when the components table supports these same features, so you<br>
-could close a particular component for bug entry without having to close an<br>
-entire product...<br>
-<br>
-profiles: Ahh, so you were wondering where your precious user information was<br>
-stored? Here it is! With the passwords in plain text for all to see! (but<br>
-sshh... don't tell your users!)<br>
-<br>
-profiles_activity: Need to know who did what when to who's profile? This'll<br>
-tell you, it's a pretty complete history.<br>
-<br>
-versions: Version information for every product<br>
-<br>
-votes: Who voted for what when<br>
-<br>
-watch: Who (according to userid) is watching who's bugs (according to their<br>
-userid).<br>
-<br>
-<br>
-===<br>
-THE DETAILS<br>
-===<br>
-<br>
- Ahh, so you're wondering just what to do with the information above? At the<br>
-mysql prompt, you can view any information about the columns in a table with<br>
-this command (where "table" is the name of the table you wish to view):<br>
-<br>
-mysql> show columns from table;<br>
-<br>
- You can also view all the data in a table with this command:<br>
-<br>
-mysql> select * from table;<br>
-<br>
- -- note: this is a very bad idea to do on, for instance, the "bugs" table if<br>
-you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or<br>
-50,000 bugs play across your screen.<br>
-<br>
- You can limit the display from above a little with the command, where<br>
-"column" is the name of the column for which you wish to restrict information:<br>
-<br>
-mysql> select * from table where (column = "some info");<br>
-<br>
- -- or the reverse of this<br>
-<br>
-mysql> select * from table where (column != "some info");<br>
-<br>
- Let's take our example from the introduction, and assume you need to change<br>
-the word "verified" to "approved" in the resolution field. We know from the<br>
-above information that the resolution is likely to be stored in the "bugs"<br>
-table. Note we'll need to change a little perl code as well as this database<br>
-change, but I won't plunge into that in this document. Let's verify the<br>
-information is stored in the "bugs" table:<br>
-<br>
-mysql> show columns from bugs<br>
-<br>
- (exceedingly long output truncated here)<br>
-| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||<br>
-<br>
- Sorry about that long line. We see from this that the "bug status" column is<br>
-an "enum field", which is a MySQL peculiarity where a string type field can<br>
-only have certain types of entries. While I think this is very cool, it's not<br>
-standard SQL. Anyway, we need to add the possible enum field entry<br>
-'APPROVED' by altering the "bugs" table.<br>
-<br>
-mysql> ALTER table bugs CHANGE bug_status bug_status<br>
- -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",<br>
- -> "VERIFIED", "APPROVED", "CLOSED") not null;<br>
-<br>
- (note we can take three lines or more -- whatever you put in before the<br>
-semicolon is evaluated as a single expression)<br>
-<br>
-Now if you do this:<br>
-<br>
-mysql> show columns from bugs;<br>
-<br>
- you'll see that the bug_status field has an extra "APPROVED" enum that's<br>
-available! Cool thing, too, is that this is reflected on your query page as<br>
-well -- you can query by the new status. But how's it fit into the existing<br>
-scheme of things?<br>
- Looks like you need to go back and look for instances of the word "verified"<br>
-in the perl code for Bugzilla -- wherever you find "verified", change it to<br>
-"approved" and you're in business (make sure that's a case-insensitive search).<br>
-Although you can query by the enum field, you can't give something a status<br>
-of "APPROVED" until you make the perl changes. Note that this change I<br>
-mentioned can also be done by editing checksetup.pl, which automates a lot of<br>
-this. But you need to know this stuff anyway, right?<br>
- </P
+>This section last updated 27 Jul 2002</P
+></DIV
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="variant-sourceforge"
+></A
+>D.6. SourceForge</H1
+><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
+HREF="http://www.sourceforge.net"
+TARGET="_top"
+> http://www.sourceforge.net</A
+>
+ </P
+><P
+>This section last updated 27 Jul 2002</P
></DIV
></DIV
+><DIV
+CLASS="appendix"
+><HR><H1
+><A
+NAME="gfdl"
+></A
+>Appendix E. GNU Free Documentation License</H1
+><P
+>Version 1.1, March 2000</P
+><A
+NAME="AEN2172"
+></A
+><BLOCKQUOTE
+CLASS="BLOCKQUOTE"
+><P
+>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
+ Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and
+ distribute verbatim copies of this license document, but changing it is
+ not allowed.</P
+></BLOCKQUOTE
+><DIV
+CLASS="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="gfdl-0"
+></A
+>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="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="gfdl-1"
+></A
+>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="appendix"
+CLASS="section"
><HR><H1
+CLASS="section"
><A
-NAME="patches"
+NAME="gfdl-2"
></A
->Appendix C. Useful Patches and Utilities for Bugzilla</H1
+>2. VERBATIM COPYING</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
+>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><H1
CLASS="section"
><A
-NAME="rewrite"
+NAME="gfdl-3"
></A
->C.1. Apache
- <TT
-CLASS="filename"
->mod_rewrite</TT
->
-
- magic</H1
+>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="section"
+><HR><H1
+CLASS="section"
+><A
+NAME="gfdl-4"
+></A
+>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
->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
+>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
-></P
-><OL
-TYPE="1"
+>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
->Make it so if someone types
- <TT
-CLASS="computeroutput"
->http://www.foo.com/12345</TT
->
-
- , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
- setting up your VirtualHost section for Bugzilla with a rule like
- this:</P
-><TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><FONT
-COLOR="#000000"
-><PRE
-CLASS="programlisting"
-> <VirtualHost 12.34.56.78>
-RewriteEngine On
-RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
-</VirtualHost>
-</PRE
-></FONT
-></TD
-></TR
-></TABLE
+>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
->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
+>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><H1
CLASS="section"
><A
-NAME="cmdline"
+NAME="gfdl-5"
></A
->C.2. Command-line Bugzilla Queries</H1
-><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
-><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="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
+>5. COMBINING DOCUMENTS</H1
><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
+>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
-><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
->
- </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
->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
+>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="appendix"
+CLASS="section"
><HR><H1
+CLASS="section"
><A
-NAME="variants"
+NAME="gfdl-6"
></A
->Appendix D. Bugzilla Variants and Competitors</H1
+>6. COLLECTIONS OF DOCUMENTS</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
+>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><H1
CLASS="section"
><A
-NAME="rhbugzilla"
+NAME="gfdl-7"
></A
->D.1. Red Hat Bugzilla</H1
-><P
->Red Hat's old fork of Bugzilla which was based on version 2.8 is now
- obsolete. The newest version in use is based on version 2.17.1 and is in
- the process of being integrated into the main Bugzilla source tree. The
- back-end is modified to work with PostgreSQL instead of MySQL and they have
- custom templates to get their desired look and feel, but other than that it
- is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of
- effort to make sure that the changes he made could be integrated back into
- the main tree.
- <A
-HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=98304"
-TARGET="_top"
->Bug
- 98304</A
-> exists to track this integration.
- </P
+>7. AGGREGATION WITH INDEPENDENT WORKS</H1
><P
->URL:
- <A
-HREF="http://bugzilla.redhat.com/bugzilla/"
-TARGET="_top"
-> http://bugzilla.redhat.com/bugzilla/</A
->
- </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
->This section last updated 24 Dec 2002</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><H1
CLASS="section"
><A
-NAME="variant-fenris"
+NAME="gfdl-8"
></A
->D.2. Loki Bugzilla (Fenris)</H1
-><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
+>8. TRANSLATION</H1
><P
->This section last updated 27 Jul 2002</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><H1
CLASS="section"
><A
-NAME="variant-issuezilla"
+NAME="gfdl-9"
></A
->D.3. Issuezilla</H1
-><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
+>9. TERMINATION</H1
><P
->This section last updated 27 Jul 2002</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><H1
CLASS="section"
><A
-NAME="variant-scarab"
+NAME="gfdl-10"
></A
->D.4. Scarab</H1
+>10. FUTURE REVISIONS OF THIS LICENSE</H1
><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:
+>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://scarab.tigris.org/"
+HREF="http://www.gnu.org/copyleft/"
TARGET="_top"
->http://scarab.tigris.org</A
+> http://www.gnu.org/copyleft/</A
>
- </P
+
+ .</P
><P
->This section last updated 27 Jul 2002</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><H1
CLASS="section"
><A
-NAME="variant-perforce"
+NAME="gfdl-howto"
></A
->D.5. Perforce SCM</H1
-><P
->Although Perforce isn't really a bug tracker, it can be used as
- such through the <SPAN
-CLASS="QUOTE"
->"jobs"</SPAN
->
- functionality.</P
-><P
->URL:
- <A
-HREF="http://www.perforce.com/perforce/technotes/note052.html"
-TARGET="_top"
-> http://www.perforce.com/perforce/technotes/note052.html
- </A
->
- </P
+>How to use this License for your documents</H1
><P
->This section last updated 27 Jul 2002</P
-></DIV
-><DIV
-CLASS="section"
-><HR><H1
-CLASS="section"
+>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="variant-sourceforge"
+NAME="AEN2262"
></A
->D.6. SourceForge</H1
+><BLOCKQUOTE
+CLASS="BLOCKQUOTE"
><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
+>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
->URL:
- <A
-HREF="http://www.sourceforge.net"
-TARGET="_top"
-> http://www.sourceforge.net</A
->
- </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
->This section last updated 27 Jul 2002</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
><H1
CLASS="glossdiv"
><A
-NAME="AEN2371"
+NAME="AEN2267"
></A
>0-9, high ascii</H1
><DL
>A</H1
><DL
><DT
+><A
+NAME="gloss-apache"
+></A
><B
>Apache</B
></DT
><DD
><P
>In this context, Apache is the web server most commonly used
- for serving up
- <I
-CLASS="glossterm"
->Bugzilla</I
->
-
+ for serving up Bugzilla
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
CLASS="QUOTE"
>"a patchy"</SPAN
>
-
version of the original
<SPAN
CLASS="acronym"
>NCSA</SPAN
>
-
world-wide-web server.</P
+><P
+></P
+><DIV
+CLASS="variablelist"
+><P
+><B
+>Useful Directives when configuring Bugzilla</B
+></P
+><DL
+><DT
+><TT
+CLASS="computeroutput"
+><A
+HREF="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler"
+TARGET="_top"
+>AddHandler</A
+></TT
+></DT
+><DD
+><P
+>Tell Apache that it's OK to run CGI scripts.</P
+></DD
+><DT
+><TT
+CLASS="computeroutput"
+><A
+HREF="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride"
+TARGET="_top"
+>AllowOverride</A
+></TT
+>, <TT
+CLASS="computeroutput"
+><A
+HREF="http://httpd.apache.org/docs-2.0/mod/core.html#options"
+TARGET="_top"
+>Options</A
+></TT
+></DT
+><DD
+><P
+>These directives are used to tell Apache many things about
+ the directory they apply to. For Bugzilla's purposes, we need
+ them to allow script execution and <TT
+CLASS="filename"
+>.htaccess</TT
+>
+ overrides.
+ </P
+></DD
+><DT
+><TT
+CLASS="computeroutput"
+><A
+HREF="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex"
+TARGET="_top"
+>DirectoryIndex</A
+></TT
+></DT
+><DD
+><P
+>Used to tell Apache what files are indexes. If you can
+ not add <TT
+CLASS="filename"
+>index.cgi</TT
+> to the list of valid files,
+ you'll need to set <TT
+CLASS="computeroutput"
+>$index_html</TT
+> to
+ 1 in <TT
+CLASS="filename"
+>localconfig</TT
+> so
+ <B
+CLASS="command"
+>./checksetup.pl</B
+> will create an
+ <TT
+CLASS="filename"
+>index.html</TT
+> that redirects to
+ <TT
+CLASS="filename"
+>index.cgi</TT
+>.
+ </P
+></DD
+><DT
+><TT
+CLASS="computeroutput"
+><A
+HREF="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource"
+TARGET="_top"
+>ScriptInterpreterSource</A
+></TT
+></DT
+><DD
+><P
+>Used when running Apache on windows so the shebang line
+ doesn't have to be changed in every Bugzilla script.
+ </P
+></DD
+></DL
+></DIV
+><P
+>For more information about how to configure Apache for Bugzilla,
+ see <A
+HREF="#http-apache"
+>Section 4.4.1</A
+>.
+ </P
></DD
></DL
></DIV
><DL
><DT
><A
+NAME="gloss-cgi"
+></A
+><B
+>Common Gateway Interface</B
+></DT
+> (CGI)<DD
+><P
+><SPAN
+CLASS="acronym"
+>CGI</SPAN
+> is an acronym for Common Gateway Interface. This is
+ a standard for interfacing an external application with a web server. Bugzilla
+ is an example of a <SPAN
+CLASS="acronym"
+>CGI</SPAN
+> application.
+ </P
+></DD
+><DT
+><A
NAME="gloss-component"
></A
><B
><A
NAME="gloss-g"
></A
-></H1
+>G</H1
><DL
><DT
+><A
+NAME="gloss-groups"
+></A
><B
>Groups</B
></DT
><H1
CLASS="glossdiv"
><A
+NAME="gloss-j"
+></A
+>J</H1
+><DL
+><DT
+><A
+NAME="gloss-javascript"
+></A
+><B
+>JavaScript</B
+></DT
+><DD
+><P
+>JavaScript is cool, we should talk about it.
+ </P
+></DD
+></DL
+></DIV
+><DIV
+CLASS="glossdiv"
+><H1
+CLASS="glossdiv"
+><A
NAME="gloss-m"
></A
>M</H1
giving you the ability to declare by which milestone a bug will be
fixed, or an enhancement will be implemented.</P
></DD
+><DT
+><A
+NAME="gloss-tcl"
+></A
+><B
+>Tool Command Language</B
+></DT
+> (TCL)<DD
+><P
+>TCL is an open source scripting language available for Windows,
+ Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
+ never released. The first release of Bugzilla was 2.0, which was when
+ it was ported to perl.
+ </P
+></DD
></DL
></DIV
><DIV
The Bugzilla Team
+ 2.17.3 Development Release Edition
+
2003-01-02
This is the documentation for Bugzilla, the mozilla.org bug-tracking
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.
+ filed in the Bugzilla Documentation compontent.
This is a development version of this guide. Information in it is
subject to change before the 2.18 release of this guide (which will
4.1. Step-by-step Install
4.2. Optional Additional Configuration
- 4.3. Win32 Installation Notes
- 4.4. Mac OS X Installation Notes
+ 4.3. OS Specific Installation Notes
+ 4.4. HTTP Server Configuration
4.5. Troubleshooting
5. Administering Bugzilla
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
- 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
-
- 5-1. Upgrading using CVS
- 5-2. Upgrading using the tarball
- 5-3. Upgrading using patches
- _________________________________________________________________
-
-Chapter 1. About This Guide
-
-1.1. Copyright Information
-
-
-
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.1 or
- any later version published by the Free Software Foundation; with no
- Invariant Sections, no Front-Cover Texts, and with no Back-Cover
- Texts. A copy of the license is included 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
-
- 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.
- _________________________________________________________________
-
-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.
- _________________________________________________________________
+ C.2. Command-line Bugzilla Queries
-9. TERMINATION
+ D. Bugzilla Variants and Competitors
- 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.
- _________________________________________________________________
+ D.1. Red Hat Bugzilla
+ D.2. Loki Bugzilla (Fenris)
+ D.3. Issuezilla
+ D.4. Scarab
+ D.5. Perforce SCM
+ D.6. SourceForge
-10. FUTURE REVISIONS OF THIS LICENSE
+ 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
- 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/ .
+ Glossary
- 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.
+ List of Examples
+ 4-1. .htaccess files for Apache
+ 5-1. Upgrading using CVS
+ 5-2. Upgrading using the tarball
+ 5-3. Upgrading using patches
_________________________________________________________________
-How to use this License for your documents
+Chapter 1. About This Guide
- 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:
+1.1. Copyright Information
- 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.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.1 or
+ any later version published by the Free Software Foundation; with no
+ Invariant Sections, no Front-Cover Texts, and with no Back-Cover
+ Texts. A copy of the license is included in Appendix E.
+
+ --Copyright (c) 2000-2003 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.2. Disclaimer
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 Win32 Installation Notes for further
- advice on getting Bugzilla to work on Microsoft Windows.
+ it working fine. Please see Section 4.3.1 for further advice on
+ getting Bugzilla to work on Microsoft Windows.
_________________________________________________________________
4.1.2. Package List
d. Text::Wrap (2001.0131)
e. File::Spec (0.82)
f. Data::Dumper (any)
- g. DBD::mysql (1.2209)
- h. DBI (1.13)
+ g. DBD::mysql (2.1010)
+ h. DBI (1.32)
i. Date::Parse (any)
j. CGI (2.88)
and, optionally:
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.
+ defacto standard for programmatic 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.
Note
4.1.6. HTTP Server
- 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 "bugs" user
- permissions accordingly.
+ You have freedom of choice here, pretty much any web server that is
+ capable of running CGI scripts will work. Section 4.4 has more
+ information about configuring web servers to work with Bugzilla.
Note
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.
-
- You'll want to make sure that your web server will run any file with
- the .cgi extension as a CGI program and not simply display the source
- code. 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 httpd.conf
- file these lines:
-Options +ExecCGI
-AllowOverride Limit
-
- are in the stanza that covers the directories into which you intend to
- put the bugzilla .html and .cgi files.
-
- Note
-
- AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
-
- Users of older versions of Apache may find the above lines in the
- srm.conf and access.conf files, respectively.
-
- Warning
-
- There are important files and directories that should not be a served
- by the HTTP server - most files in the "data" directory 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.
_________________________________________________________________
4.1.7. Bugzilla
Tip
If you symlink the bugzilla directory into your Apache's HTML
- heirarchy, you may receive Forbidden errors unless you add the
+ hierarchy, you may receive Forbidden errors unless you add the
"FollowSymLinks" directive to the <Directory> entry for the HTML root
in httpd.conf.
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
+ 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.
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.
+ Bugzilla is only accessible using HARTS.
_________________________________________________________________
4.2.2. Bug Graphs
for more information.
_________________________________________________________________
-4.3. Win32 Installation Notes
+4.3. OS Specific Installation Notes
- 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.
+ Many aspects of the Bugzilla installation can be affected by the the
+ operating system you choose to install it on. Sometimes it can be made
+ easier and others more difficult. This section will attempt to help
+ you understand both the difficulties of running on specific operating
+ systems and the utilities available to make it easier.
- 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.
+ If you have anything to add or notes for an operating system not
+ covered, please file a bug in Bugzilla Documentation.
_________________________________________________________________
-4.3.1. Win32 Installation: Step-by-step
-
- Note
-
- You should be familiar with, and cross-reference, the rest of the
- Bugzilla Installation section while performing your Win32
- installation.
-
- 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 very 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 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" .
-
- 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
- of IIS.
- 2. Install ActivePerl for Windows. Check
- 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
- 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 .
-
- Note
-
- You can find a list of modules at
- 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 4-1. Installing ActivePerl ppd Modules on Microsoft
- Windows
- 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
- version at OpenInteract:
- 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
- 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 4-2. Installing OpenInteract ppd Modules manually on
- Microsoft Windows
- 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,
- 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')
- WHERE user='root';
- "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
- IDENTIFIED BY 'bugs_password';
- "bugs_password" , above, indicates whatever password you wish
- to use for your "bugs" user.
- e. mysql> FLUSH PRIVILEGES;
- f. mysql> create database bugs;
- g. mysql> exit;
- 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);
-
- to
-
-my $webservergid =
- $my_webservergroup;
-
- or the name of the group you wish to own the files explicitly:
-
-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" .
-
- Note
-
- 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
- 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
- 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
- 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
- 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;
-
- 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
- uses your web server.
- 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);
-
- Note
+4.3.1. Microsoft Windows
+
+ Making Bugzilla work on windows is still a very painful processes. The
+ Bugzilla Team is working to make it easier, but that goal is not
+ considered a top priority. If you wish to run Bugzilla, we still
+ recommend doing so on a Unix based system such as GNU/Linux. As of
+ this writing, all members of the Bugzilla team and all known large
+ installations run on Unix based systems.
+
+ If after hearing all that, you have enough pain tolerance to attempt
+ installing Bugzilla on Win32, here are some pointers. Because this is
+ a development version of the guide, these instructions are subject to
+ change without notice. In fact, the Bugzilla Team hopes they do as we
+ would like to have Bugzilla resonabally close to "out of the box"
+ compatibility by the 2.18 release.
+ _________________________________________________________________
- 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";
+4.3.1.1. Win32 Perl
- or something to that effect.
- 11. Change all references in all files from processmail to
- processmail.pl , and rename processmail to processmail.pl .
+ Perl for Windows can be obtained from ActiveState. You should be able
+ to find a compiled binary at
+ http://aspn.activestate.com/ASPN/Downloads/ActivePerl/.
+ _________________________________________________________________
- Note
+4.3.1.2. Perl Modules on 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.
+ Bugzilla on Windows requires the same perl modules found in Section
+ 4.1.2. The main difference is that windows uses ppm instead of CPAN.
+C:\perl> ppm <module name>
Note
- 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
-ver
-$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
-$smtp->to($tolist); # recipient's address
-$smtp->data(); # Start the mail
-$smtp->datasend($msg);
-$smtp->dataend(); # Finish sending the mail
-$smtp->quit; # Close the SMTP connection
-$logstr = "$logstr; mail sent to $tolist $cclist";
-}
-
-
-
-
- here is a test mail program for Net::SMTP:
-
-use Net::SMTP;
- my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
-=> 1, ); # connect to SMTP server
- $smtp->auth;
- $smtp->mail('you@yourcompany.com');# use the sender's adress
-here
- $smtp->to('someotherAddress@someotherdomain.com'); #
-recipient's address
- $smtp->data(); # Start the mail
- $smtp->datasend('test');
- $smtp->dataend(); # Finish sending the mail
- $smtp->quit; # Close the SMTP connection
-exit;
-
-
-
-
- 12.
+ The above syntax should work for all modules with the exception of
+ Template Toolkit. The Template Toolkit website suggests using the
+ instructions on OpenInteract's website.
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),
- 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
- requires the Cygwin GNU-compatible environment for Win32 be set up
- 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
- processmail:
-
+ A complete list of modules that can be installed using ppm can be
+ found at http://www.activestate.com/PPMPackages/5.6plus.
+ _________________________________________________________________
-system ("./processmail",@ARGLIST);
- </programlisting> to
- <programlisting>
-system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
+4.3.1.3. Code changes required to run on win32
+ Unfortunately, Bugzilla still doesn't run "out of the box" on Windows.
+ There is work in progress to make this easier, but until that happens
+ code will have to be modified. This section is an attempt to list the
+ required changes. It is an attempt to be all inclusive, but there may
+ be other changes required. If you find something is missing, please
+ file a bug in Bugzilla Documentation.
+ _________________________________________________________________
+4.3.1.3.1. Changes to checksetup.pl
- Tip
+ In checksetup.pl, the line reading:
+my $mysql_binaries = `which mysql`;
- 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:
+ to
+my $mysql_binaries = "D:\\mysql\\bin\\mysql";
-.cgi to: <perl install directory>\perl.exe %s
- %s .pl to: <perl install directory>\perl.exe %s %s
- GET,HEAD,POST
+ And you'll also need to change:
+my $webservergid = getgrnam($my_webservergroup)
- Change the path to Perl to match your install, of course.
+ to
+my $webservergid = '8'
_________________________________________________________________
-4.3.2. Additional Windows Tips
-
- Tip
-
- From Andrew Pearson:
+4.3.1.3.2. Making mail work
- 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
- http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP
+ The easiest way to get mail working is to use the mail patches on bug
+ 124174. With any luck, this patch will receive the required reviews
+ and integrated into the main Bugzilla distribution very soon. Until
+ that happens, there's at least one report of this patch working well
+ on Windows.
+ _________________________________________________________________
- Basically you need to add two String Keys in the registry at the
- following location:
+4.3.1.3.3. System Calls
- HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Paramete
-rs\ScriptMap
+ In order to get system calls to work on win32's perl, you need to tell
+ the windows shell what interpreter to use. This is done by changing
+ the system calls. You will need to search all of Bugzilla's code for
+ system calls. To tell perl your interpreter, it needs to be the first
+ argument to the system call. For example, you'll need to change:
+system("./processmail", $id, $exporter);
- The keys should be called ".pl" and ".cgi", and both should have a
- value something like: c:/perl/bin/perl.exe "%s" "%s"
+ with
+system("C:\\perl\\bin\\perl", "processmail", $id, $exporter);
- The KB article only talks about .pl, but it goes into more detail
- and provides a perl test script.
+ Notice that the ./ is also removed.
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
- &bz-ver;.
+ The grep command is very helpful in finding these system calls,
+ assuming you have the cygwin utilities.
+ _________________________________________________________________
- Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12
- or earlier
+4.3.1.4. Serving the web pages
- Replace this:
-SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
- ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
- $enteredcryptpwd = FetchOneColumn();
+ As is the case on Unix based systems, any web server should be able to
+ handle Bugzilla; however, the Bugzilla Team still recommends Apache
+ whenever asked. No matter what web server you choose, be sure to pay
+ attention to the security notes in Section 5.6. More information on
+ configuring specific web servers can be found in Section 4.4.
- with this:
- my $enteredcryptpwd = $enteredpwd
+ Note
- in cgi.pl.
+ If using Apache on windows, you can set the ScriptInterpreterSource
+ directive in your Apache config, if you don't do this, you'll have to
+ modify the first line of every script to contain your path to perl
+ instead of /usr/bonsaitools/bin/perl.
_________________________________________________________________
-4.4. Mac OS X Installation Notes
+4.3.2. Mac OS X
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
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/>.
+ 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
And don't forget to run exit to get back to CPAN.
_________________________________________________________________
+4.4. HTTP Server Configuration
+
+ The Bugzilla Team recommends Apache when using Bugzilla, however, any
+ web server that can be configured to run CGI scripts should be able to
+ handle Bugzilla. No matter what web server you choose, but especially
+ if you choose something other than Apache, you should be sure to read
+ Section 5.6.
+
+ The plan for this section is to eventually document the specifics of
+ how to lock down permissions on individual web servers.
+ _________________________________________________________________
+
+4.4.1. Apache httpd
+
+ As mentioned above, the Bugzilla Team recommends Apache for use with
+ Bugzilla. You will have to make sure that Apache is properly
+ configured to run the Bugzilla CGI scripts. You also need to make sure
+ that the .htaccess files created by ./checksetup.pl (shown in Example
+ 4-1 for the curious) are allowed to override Apache's normal access
+ permissions or else important password information may be exposed to
+ the Internet.
+
+ Many Apache installations are not configured to run scripts anywhere
+ but in the cgi-bin directory; however, we recommend that Bugzilla not
+ be installed in the cgi-bin, otherwise the static files such as images
+ and JavaScript will not work correctly. To allow scripts to run in the
+ normal web space, the following changes should be made to your
+ httpd.conf file.
+
+ To allow files with a .cgi extension to be run, make sure the
+ following line exists and is uncommented:
+AddHandler cgi-script .cgi
+
+ To allow .htaccess files to override permissions and .cgi files to run
+ in the Bugzilla directory, make sure the following two lines are in a
+ Directory directive that applies to the Bugzilla directory on your
+ system (either the Bugzilla directory or one of its parents).
+Options +ExecCGI
+AllowOverride Limit
+
+ Note
+
+ For more information on Apache and its directives, see the glossary
+ entry on Apache.
+
+ Example 4-1. .htaccess files for Apache
+
+ $BUGZILLA_HOME/.htaccess
+# don't allow people to retrieve non-cgi executable files or our private data
+<FilesMatch ^(.*\.pl|.*localconfig.*|processmail|runtests.sh)$>
+ deny from all
+</FilesMatch>
+<FilesMatch ^(localconfig.js|localconfig.rdf)$>
+ allow from all
+</FilesMatch>
+
+ $BUGZILLA_HOME/data/.htaccess
+# nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory; the only exception is duplicates.rdf, which is used by
+# duplicates.xul and must be loadable over the web
+deny from all
+<Files duplicates.rdf>
+ allow from all
+</Files>
+
+ $BUGZILLA_HOME/data/webdot
+# Restrict access to .dot files to the public webdot server at research.att.com
+
+# if research.att.com ever changed their IP, or if you use a different
+# webdot server, you'll need to edit this
+<FilesMatch ^[0-9]+\.dot$>
+ Allow from 192.20.225.10
+ Deny from all
+</FilesMatch>
+
+# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
+# .map files
+<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
+ Allow from all
+</FilesMatch>
+
+# And no directory listings, either.
+Deny from all
+
+ $BUGZILLA_HOME/Bugzilla/.htaccess
+# nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory
+deny from all
+
+ $BUGZILLA_HOME/template/.htaccess
+# nothing in this directory is retrievable unless overriden by an .htaccess
+# in a subdirectory
+deny from all
+ _________________________________________________________________
+
+4.4.2. Microsoft Internet Information Services
+
+ If you need, or for some reason even want, to use Microsoft's Internet
+ Information Services or Personal Web Server you should be able to. You
+ will need to configure them to know how to run CGI scripts, however.
+ This is described in Microsoft Knowledge Base article Q245225 for
+ Internet Information Services and Q231998 for Personal Web Server.
+
+ Also, and this can't be stressed enough, make sure that files such as
+ localconfig and your data directory are secured as described in
+ Section 5.6.
+ _________________________________________________________________
+
+4.4.3. AOL Server
+
+ Ben FrantzDale reported success using AOL Server with Bugzilla. He
+ reported his experience and what appears below is based on that.
+
+ AOL Server will have to be configured to run CGI scripts, please
+ consult the documentation that came with your server for more
+ information on how to do this.
+
+ Because AOL Server doesn't support .htaccess files, you'll have to
+ create a TCL script. You should create an
+ aolserver/modules/tcl/filter.tcl file (the filename shouldn't matter)
+ with the following contents (change /bugzilla/ to the web-based path
+ to your Bugzilla installation):
+ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/*.pl filter_deny
+ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/processmail filter_deny
+ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
+ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
+
+proc filter_deny { why } {
+ ns_log Notice "filter_deny"
+ return "filter_return"
+}
+
+ Warning
+
+ This doesn't appear to account for everything mentioned in Section
+ 5.6. In particular, it doesn't block access to the data or template
+ directories. It also doesn't account for the editor backup files that
+ were the topic of bug 186383, Bugtraq ID 6501, and a partial cause for
+ the 2.16.2 release.
+ _________________________________________________________________
+
4.5. Troubleshooting
This section gives solutions to common Bugzilla installation problems.
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 Bugs 57161 and 186383 for the
- localconfig file, and Bug 65572 for adequate protection in your
- data/ directory. Also, don't forget about the template/ and
- Bugzilla/ directories and to allow access to the data/webdot
- directory for the 192.20.225.10 IP address if you are using webdot
- from research.att.com. The easiest way to accomplish this is to
- set $create_htaccess to 1 in localconfig. However, the information
- below is provided for those that want to know exactly what is
- created.
- 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.
- $BUGZILLA_HOME/.htaccess
-
-# don't allow people to retrieve non-cgi executable files or our private data
-<FilesMatch ^(.*\.pl|.*localconfig.*|processmail|runtests.sh)$>
- deny from all
-</FilesMatch>
-<FilesMatch ^(localconfig.js|localconfig.rdf)$>
- allow from all
-</FilesMatch>
-
-
- $BUGZILLA_HOME/data/.htaccess
-
-# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory; the only exception is duplicates.rdf, which is used by
-# duplicates.xul and must be loadable over the web
-deny from all
-<Files duplicates.rdf>
- allow from all
-</Files>
-
-
- $BUGZILLA_HOME/data/webdot
-
-# Restrict access to .dot files to the public webdot server at research.att.com
-
-# if research.att.com ever changed their IP, or if you use a different
-# webdot server, you'll need to edit this
-<FilesMatch ^[0-9]+\.dot$>
- Allow from 192.20.225.10
- Deny from all
-</FilesMatch>
-
-# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
-# .map files
-<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
- Allow from all
-</FilesMatch>
-
-# And no directory listings, either.
-Deny from all
-
-
- $BUGZILLA_HOME/Bugzilla/.htaccess
-
-# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
-
- $BUGZILLA_HOME/template/.htaccess
-
-# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
+ On Apache, you can use .htaccess files to protect access to these
+ directories, as outlined in Bugs 57161 and 186383 for the
+ localconfig file, and Bug 65572 for adequate protection in your
+ data/ directory. Also, don't forget about the template/ and
+ Bugzilla/ directories and to allow access to the data/webdot
+ directory for the 192.20.225.10 IP address if you are using webdot
+ from research.att.com. The easiest way to accomplish this is to
+ set $create_htaccess to 1 in localconfig. However, the information
+ below is provided for those that want to know exactly what is
+ created.
+ FIX ME BEFORE RELEASE!!!!! 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.
_________________________________________________________________
5.7. Template Customization
(post-templatisation.). There are three files - query.conf, buglist
and bugs.
- 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".
+ 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 "-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=".
+
+ 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.
+
+ 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 sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'
+
+ Akkana Peck says she has good results piping buglist output through
+ w3m -T text/html -dump
+ _________________________________________________________________
+
+Appendix D. Bugzilla Variants and Competitors
+
+ 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
+ _________________________________________________________________
+
+D.1. Red Hat Bugzilla
+
+ Red Hat's old fork of Bugzilla which was based on version 2.8 is now
+ obsolete. The newest version in use is based on version 2.17.1 and is
+ in the process of being integrated into the main Bugzilla source tree.
+ The back-end is modified to work with PostgreSQL instead of MySQL and
+ they have custom templates to get their desired look and feel, but
+ other than that it is Bugzilla 2.17.1. Dave Lawrence of Red Hat put
+ forth a great deal of effort to make sure that the changes he made
+ could be integrated back into the main tree. Bug 98304 exists to track
+ this integration.
+
+ URL: http://bugzilla.redhat.com/bugzilla/
+
+ This section last updated 24 Dec 2002
+ _________________________________________________________________
+
+D.2. Loki Bugzilla (Fenris)
+
+ 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.
+
+ This section last updated 27 Jul 2002
+ _________________________________________________________________
+
+D.3. Issuezilla
+
+ 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.
+
+ This section last updated 27 Jul 2002
+ _________________________________________________________________
+
+D.4. Scarab
+
+ Scarab is a new open source bug-tracking system built using Java
+ Servlet technology. It is currently at version 1.0 beta 13.
+
+ URL: http://scarab.tigris.org
+
+ This section last updated 18 Jan 2003
+ _________________________________________________________________
+
+D.5. Perforce SCM
+
+ Although Perforce isn't really a bug tracker, it can be used as such
+ through the "jobs" functionality.
+
+ URL: http://www.perforce.com/perforce/technotes/note052.html
+
+ This section last updated 27 Jul 2002
+ _________________________________________________________________
+
+D.6. SourceForge
+
+ 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.
+
+ URL: http://www.sourceforge.net
+
+ This section last updated 27 Jul 2002
+ _________________________________________________________________
+
+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.
+
+ 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
- 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=".
+ 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:
- 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.
+ 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.
- 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 sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'
+ 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.
- Akkana Peck says she has good results piping buglist output through
- w3m -T text/html -dump
- _________________________________________________________________
+ 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.
-Appendix D. Bugzilla Variants and Competitors
+ 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.
- 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
+ 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.
_________________________________________________________________
-D.1. Red Hat Bugzilla
+5. COMBINING DOCUMENTS
- Red Hat's old fork of Bugzilla which was based on version 2.8 is now
- obsolete. The newest version in use is based on version 2.17.1 and is
- in the process of being integrated into the main Bugzilla source tree.
- The back-end is modified to work with PostgreSQL instead of MySQL and
- they have custom templates to get their desired look and feel, but
- other than that it is Bugzilla 2.17.1. Dave Lawrence of Red Hat put
- forth a great deal of effort to make sure that the changes he made
- could be integrated back into the main tree. Bug 98304 exists to track
- this integration.
+ 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.
- URL: http://bugzilla.redhat.com/bugzilla/
+ 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.
- This section last updated 24 Dec 2002
+ 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."
_________________________________________________________________
-D.2. Loki Bugzilla (Fenris)
+6. COLLECTIONS OF DOCUMENTS
- 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.
+ 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.
- This section last updated 27 Jul 2002
+ 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.
_________________________________________________________________
-D.3. Issuezilla
+7. AGGREGATION WITH INDEPENDENT WORKS
- 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.
+ 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.
- This section last updated 27 Jul 2002
+ 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.
_________________________________________________________________
-D.4. Scarab
+8. TRANSLATION
- Scarab is a new open source bug-tracking system built using Java
- Serlet technology. It is currently at version 1.0 beta 8.
+ 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.
+ _________________________________________________________________
- URL: http://scarab.tigris.org
+9. TERMINATION
- This section last updated 27 Jul 2002
+ 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.
_________________________________________________________________
-D.5. Perforce SCM
-
- Although Perforce isn't really a bug tracker, it can be used as such
- through the "jobs" functionality.
+10. FUTURE REVISIONS OF THIS LICENSE
- URL: http://www.perforce.com/perforce/technotes/note052.html
+ 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/ .
- This section last updated 27 Jul 2002
+ 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.
_________________________________________________________________
-D.6. SourceForge
+How to use this License for your documents
- 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.
+ 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:
- URL: http://www.sourceforge.net
+ 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".
- This section last updated 27 Jul 2002
+ 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.
Glossary
fact that it was "a patchy" version of the original NCSA
world-wide-web server.
+ Useful Directives when configuring Bugzilla
+
+ AddHandler
+ Tell Apache that it's OK to run CGI scripts.
+
+ AllowOverride, Options
+ These directives are used to tell Apache many things
+ about the directory they apply to. For Bugzilla's
+ purposes, we need them to allow script execution and
+ .htaccess overrides.
+
+ DirectoryIndex
+ Used to tell Apache what files are indexes. If you can
+ not add index.cgi to the list of valid files, you'll need
+ to set $index_html to 1 in localconfig so ./checksetup.pl
+ will create an index.html that redirects to index.cgi.
+
+ ScriptInterpreterSource
+ Used when running Apache on windows so the shebang line
+ doesn't have to be changed in every Bugzilla script.
+
+ For more information about how to configure Apache for
+ Bugzilla, see Section 4.4.1.
+
B
Bug
Bugzilla is the world-leading free software bug tracking
system.
+ Common Gateway Interface (CGI)
+ CGI is an acronym for Common Gateway Interface. This is a
+ standard for interfacing an external application with a web
+ server. Bugzilla is an example of a CGI application.
+
Component
A Component is a subsection of a Product. It should be a narrow
category, tailored to your organization. All Products must
mysqld, the MySQL server, and apache, a web server, are
generally run as daemons.
+G
+
Groups
The word "Groups" 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 Products in the Bugzilla database.
+J
+
+ JavaScript
+ JavaScript is cool, we should talk about it.
+
M
mysqld
to declare by which milestone a bug will be fixed, or an
enhancement will be implemented.
+ Tool Command Language (TCL)
+ TCL is an open source scripting language available for Windows,
+ Macintosh, and Unix based systems. Bugzilla 1.0 was written in
+ TCL but never released. The first release of Bugzilla was 2.0,
+ which was when it was ported to perl.
+
Z
Zarro Boogs Found
projects / thirdparty / bugzilla.git / commitdiff
