Commit a07f84f3 authored by barnboy%trilobyte.net's avatar barnboy%trilobyte.net

Checkin for 2.14 release. Still some problems; this cannot yet

be used for 2.14 documentation due to inconsistencies.
parent d87cf85f
<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Include macros --> <!-- Include macros -->
<!ENTITY about SYSTEM "about.sgml"> <!ENTITY about SYSTEM "about.sgml">
...@@ -17,99 +17,156 @@ ...@@ -17,99 +17,156 @@
<!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml"> <!ENTITY variants SYSTEM "variants.sgml">
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> <!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.mozilla.org/projects/bugzilla">
<!ENTITY bz-ver "2.14">
<!ENTITY bz-cvs-ver "2.15">
<!ENTITY bzg-date "August 10, 2001">
<!ENTITY bzg-ver "2.14.0">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">
]> ]>
<!-- Coding standards for this document
1. Preface new or modified sections with a comment stating who
modified it and when; please also use the "authorinitials" tag.
2. There is no "two".
3. Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
4. Use Entities to include files for new chapters in Bugzilla-Guide.sgml.
5. Ensure all documents compile cleanly to HTML after modification.
The errors "DTD Declaration not allowed here" and "DTDDECL catalog types not supported"
are normal errors to be expected when compiling the whole guide.
6. Try to index important terms wherever possible.
7. Follow coding standards at http://www.linuxdoc.org. <!-- Coding standards for this document
8. All tags should be lowercase (needsfix)
9. Code being submitted for review should use the
"review" tag. Documentation on this is available at
http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html
under section 4.9.4, "Making notes on the text while it's being written".
10. Please use sensible spacing. The comments at the very end of each Guide * Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
file define reasonable defaults for PSGML mode in EMACS. * Use Entities to include files for new chapters in Bugzilla-Guide.sgml.
Double-indent tags, use double spacing whenever possible, * Try to use Entities for frequently-used passages of text as well.
try to avoid clutter and feel free to waste space in the code to make it more readable. * Ensure all documents compile cleanly to HTML after modification.
The warning, "DTDDECL catalog types not supported" is normal.
* Try to index important terms wherever possible.
* Use "glossterm" whenever you introduce a new term.
* Follow coding standards at http://www.linuxdoc.org, and
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
* All tags should be lowercase (needsfix)
* Please use sensible spacing. The comments at the very end of each
file define reasonable defaults for PSGML mode in EMACS.
Double-indent tags, use double spacing whenever possible, and
try to avoid clutter and feel free to waste space in the code to make it more readable.
--> -->
<BOOK ID="index"> <book id="index">
<!-- Header --> <!-- Header -->
<BOOKINFO> <bookinfo>
<TITLE>The Bugzilla Guide</TITLE> <title>The Bugzilla Guide</title>
<PUBDATE>2001-04-25</PUBDATE> <pubdate>2001-04-25</pubdate>
<AUTHOR> <revhistory>
<FIRSTNAME>Matthew</FIRSTNAME> <revision>
<OTHERNAME>P.</OTHERNAME> <revnumber>v2.11</revnumber>
<SURNAME>Barnson</SURNAME> <date>20 December 2000</date>
<affiliation> <authorinitials>MPB</authorinitials>
<address><email>barnboy@trilobyte.net</email></address> <revremark>
</affiliation> Converted the README, FAQ, and DATABASE information into
</AUTHOR> SGML docbook format.
</revremark>
<ABSTRACT> </revision>
<PARA>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</PARA>
</ABSTRACT>
<REVHISTORY>
<REVISION>
<REVNUMBER>v2.11</REVNUMBER>
<DATE>20 December 2000</DATE>
<AUTHORINITIALS>MPB</AUTHORINITIALS>
<REVREMARK>Converted the README, FAQ, and DATABASE information into SGML
docbook format.</REVREMARK>
</REVISION>
<revision> <revision>
<revnumber>2.11.1</revnumber> <revnumber>2.11.1</revnumber>
<date>06 March 2001</date> <date>06 March 2001</date>
<authorinitials>MPB</authorinitials> <authorinitials>MPB</authorinitials>
<revremark> <revremark>
Took way too long to revise this for 2.12 release. Took way too long to revise this for 2.12 release. Updated
Updated FAQ to use qandaset tags instead of literallayout, FAQ to use qandaset tags instead of literallayout, cleaned
cleaned up administration section, added User Guide section, up administration section, added User Guide section,
miscellaneous FAQ updates and third-party integration information. miscellaneous FAQ updates and third-party integration
From this point on all new tags are lowercase in preparation for the information. From this point on all new tags are lowercase
2.13 release of the Guide in XML format instead of SGML. in preparation for the 2.13 release of the Guide in XML
format instead of SGML.
</revremark> </revremark>
</revision> </revision>
<revision> <revision>
<revnumber>2.12.0</revnumber> <revnumber>2.12.0</revnumber>
<date>24 April 2001</date> <date>24 April 2001</date>
<authorinitials>MPB</authorinitials> <authorinitials>MPB</authorinitials>
<revremark> <revremark>
Things fixed this release: Elaborated on queryhelp interface, added FAQ regarding Things fixed this release: Elaborated on queryhelp
moving bugs from one keyword to another, clarified possible problems with the Landfill interface, added FAQ regarding moving bugs from one keyword
tutorial, fixed a boatload of typos and unclear sentence structures. Incorporated the to another, clarified possible problems with the Landfill
README into the UNIX installation section, and changed the README to indicate the deprecated tutorial, fixed a boatload of typos and unclear sentence
status. Things I know need work: Used "simplelist" a lot, where I should have used structures. Incorporated the README into the UNIX
"procedure" to tag things. Need to lowercase all tags to be XML compliant. installation section, and changed the README to indicate the
deprecated status. Things I know need work: Used
"simplelist" a lot, where I should have used "procedure" to
tag things. Need to lowercase all tags to be XML compliant.
</revremark> </revremark>
</revision> </revision>
</REVHISTORY>
<revision>
<revnumber>2.14.0</revnumber>
<date>07 August 2001</date>
<authorinitials>MPB</authorinitials>
<revremark>
Attempted to integrate relevant portions of the UNIX and
Windows installation instructions, moved some data from FAQ
to Install, removed references to README from text, added
Mac OS X install instructions, fixed a bunch
of tpyos (Mark Harig), linked text that referenced other
parts of the Guide, and nuked the old MySQL permissions
section.
</revremark>
</revision>
</revhistory>
<authorgroup>
<author>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
<affiliation>
<address><email>barnboy@NOSPAM.trilobyte.net</email></address>
</affiliation>
</author>
<collab>
<collabname>Zach Lipton</collabname>
<affiliation>
<address><email>zach@NOSPAM.zachlipton.com</email></address>
</affiliation>
</collab>
<editor>
<firstname>I.</firstname>
<surname>Freely</surname>
<othername>P.</othername>
<affiliation>
<address><email>ipfreely@freely.eye-p.net</email></address>
</affiliation>
</editor>
</authorgroup>
<abstract>
<para>
This is the documentation for Bugzilla, the Mozilla
bug-tracking system.
</para>
<para>
Bugzilla is an enterprise-class set of software utilities
that, when used together, power issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
While it is easy to use and quite flexible, it is very
difficult for a novice to install and maintain. Although we
have provided step-by-step directions, Bugzilla is not always
easy to get working. Please be sure the person responsible
for installing and maintaining this software is a qualified
professional on operating system upon which you install
Bugzilla.
</para>
</abstract>
<KEYWORDSET> <KEYWORDSET>
<KEYWORD>Bugzilla</KEYWORD> <KEYWORD>Bugzilla</KEYWORD>
...@@ -127,15 +184,15 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html ...@@ -127,15 +184,15 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html
<!-- About This Guide --> <!-- About This Guide -->
&about; &about;
<!-- Using Bugzilla -->
&using;
<!-- Installing Bugzilla --> <!-- Installing Bugzilla -->
&installation; &installation;
<!-- Administering Bugzilla --> <!-- Administering Bugzilla -->
&administration; &administration;
<!-- Using Bugzilla -->
&using;
<!-- Integrating Bugzilla with Third-Party Tools --> <!-- Integrating Bugzilla with Third-Party Tools -->
&integration; &integration;
...@@ -166,31 +223,26 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html ...@@ -166,31 +223,26 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html
<!-- Index --> <!-- Index -->
&index; &index;
</BOOK>
</book>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY conventions SYSTEM "conventions.sgml"> ] > <!ENTITY conventions SYSTEM "conventions.sgml"> ] > -->
<CHAPTER ID="about"> <chapter id="about">
<TITLE>About This Guide</TITLE> <title>About This Guide</title>
<SECTION ID="aboutthisguide"> <section id="aboutthisguide">
<TITLE>Purpose and Scope of this Guide</TITLE> <title>Purpose and Scope of this Guide</title>
<PARA> <para>
This document was started on September 17, 2000 This document was started on September 17, 2000 by Matthew P.
by Matthew P. Barnson after a great deal of procrastination updating the Bugzilla FAQ, Barnson after a great deal of procrastination updating the
which I left untouched for nearly half a year. Bugzilla FAQ, which I left untouched for nearly half a year.
After numerous complete rewrites and reformatting, it is the document you see today. After numerous complete rewrites and reformatting, it is the
</PARA> document you see today.
<PARA> </para>
Despite the lack of updates, Bugzilla is simply the best piece of bug-tracking software <para>
the world has ever seen. This document is intended to be the comprehensive guide to Despite the lack of updates, Bugzilla is simply the best piece
the installation, administration, maintenance, and use of the Bugzilla bug-tracking system. of bug-tracking software the world has ever seen. This document
</PARA> is intended to be the comprehensive guide to the installation,
<PARA> administration, maintenance, and use of the Bugzilla
This release of the Bugzilla Guide is the <EMPHASIS>2.11</EMPHASIS> release. bug-tracking system.
It is so named that it may match the current version of Bugzilla. </para>
The numbering tradition stems from that used for many free software projects, <para>
in which <EMPHASIS>even-numbered</EMPHASIS> point releases (1.2, 1.14, etc.) This release of the Bugzilla Guide is the
are considered "stable releases", intended for public consumption; on the other <emphasis>&bzg-ver;</emphasis> release. It is so named that it
hand, <EMPHASIS>odd-numbered</EMPHASIS> point releases (1.3, 2.09, etc.) may match the current version of Bugzilla. The numbering
are considered unstable <EMPHASIS>development</EMPHASIS> releases intended tradition stems from that used for many free software projects,
for advanced users, systems administrators, developers, and those who enjoy in which <emphasis>even-numbered</emphasis> point releases (1.2,
a lot of pain. 1.14, etc.) are considered "stable releases", intended for
</PARA> public consumption; on the other hand,
<PARA> <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09,
Newer revisions of the Bugzilla Guide will follow the numbering conventions of etc.) are considered unstable <emphasis>development</emphasis>
the main-tree Bugzilla releases, available at releases intended for advanced users, systems administrators,
<ULINK URL="http://www.mozilla.org/bugs/source.html">Mozilla.org</ULINK>, with developers, and those who enjoy a lot of pain.
the exception that intermediate releases will have a minor revision number </para>
following a period. For instance, if the current version of Bugzilla is 4.2, <para>
the current "stable" version of the Bugzilla guide, in, say, it's fifth revision, Newer revisions of the Bugzilla Guide follow the numbering
would be numbered "4.2.5". Got it? Good. conventions of the main-tree Bugzilla releases, available at
</PARA> <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have
<PARA> a minor revision number following a period. The current version
I wrote this in response to the enormous demand for decent Bugzilla documentation. of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
I have incorporated instructions from the Bugzilla README, Frequently Asked Questions, something were seriously wrong with that edition of the Guide,
Database Schema Document, and various mailing lists to create it. subsequent releases would receive an additional dotted-decimal
Chances are, there are glaring errors in this documentation; please contact digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
<EMAIL>barnboy@trilobyte.net</EMAIL> to correct them. Got it? Good.
</PARA> </para>
</SECTION> <para>
I wrote this in response to the enormous demand for decent
Bugzilla documentation. I have incorporated instructions from
the Bugzilla README, Frequently Asked Questions, Database Schema
Document, and various mailing lists to create it. Chances are,
there are glaring errors in this documentation; please contact
&bzg-auth-email; to correct them.
</para>
</section>
<SECTION ID="copyright"> <section id="copyright">
<TITLE>Copyright Information</TITLE> <title>Copyright Information</title>
<BLOCKQUOTE> <blockquote>
<ATTRIBUTION>Copyright (c) 2000-2001 Matthew P. Barnson</ATTRIBUTION> <attribution>Copyright (c) 2000-2001 &bzg-auth;</attribution>
<PARA> <para>
Permission is granted to copy, distribute and/or modify this document under thei Permission is granted to copy, distribute and/or modify this
terms of the GNU Free Documentation License, Version 1.1 or any later version published document under the terms of the GNU Free Documentation
by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and License, Version 1.1 or any later version published by the
with no Back-Cover Texts. A copy of the license is included in the section entitled Free Software Foundation; with no Invariant Sections, no
"GNU Free Documentation LIcense". Front-Cover Texts, and with no Back-Cover Texts. A copy of
</PARA> the license is included in the section entitled "GNU Free
</BLOCKQUOTE> Documentation LIcense".
<PARA> </para>
If you have any questions regarding this document, its' copyright, or publishing this </blockquote>
document in non-electronic form, please contact <EMAIL>barnboy@trilobyte.net</EMAIL> <para>
</PARA> If you have any questions regarding this document, its
</SECTION> copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;. Remove "NOSPAM" from email address
to send.
</para>
</section>
<SECTION ID="disclaimer"> <section id="disclaimer">
<TITLE>Disclaimer</TITLE> <title>Disclaimer</title>
<PARA> <para>
No liability for the contents of this document can be accepted. No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk. Use the concepts, examples, and other content at your own risk.
As this is a new edition of this document, there may be errors As this is a new edition of this document, there may be errors
and inaccuracies that may damage your system. Use of this document and inaccuracies that may damage your system. Use of this
may cause your girlfriend to leave you, your cats to pee on your document may cause your girlfriend to leave you, your cats to
furniture and clothing, your computer to cease functioning, your pee on your furniture and clothing, your computer to cease
boss to fire you, and global thermonuclear war. Proceed with caution. functioning, your boss to fire you, and global thermonuclear
</PARA> war. Proceed with caution.
<PARA> </para>
All copyrights are held by their respective owners, unless specifically <para>
noted otherwise. Use of a term in this document should not be regarded All copyrights are held by their respective owners, unless
as affecting the validity of any trademark or service mark. specifically noted otherwise. Use of a term in this document
In particular, I like to put down Microsoft(tm). Live with it. should not be regarded as affecting the validity of any
</PARA> trademark or service mark.
<PARA> </para>
Naming of particular products or brands should not be seen as endorsements, <para>
with the exception of the term "GNU/Linux". Naming of particular products or brands should not be seen as
Use GNU/Linux. Love it. Bathe with it. It is life and happiness. endorsements, with the exception of the term "GNU/Linux". I
I endorse it wholeheartedly and encourage you to do the same. wholeheartedly endorse the use of GNU/Linux in every situation
</PARA> where it is appropriate. It is an extremely versatile, stable,
<PARA> and robust operating system that offers an ideal operating
You are strongly recommended to make a backup of your system before environment for Bugzilla.
installing Bugzilla and at regular intervals thereafter. Heaven knows </para>
it's saved my bacon time after time; if you implement any suggestion in <para>
this Guide, implement this one! You are strongly recommended to make a backup of your system
</PARA> before installing Bugzilla and at regular intervals thereafter.
<PARA> Heaven knows it's saved my bacon time after time; if you
Bugzilla has not undergone a complete security review. implement any suggestion in this Guide, implement this one!
Security holes probably exist in the code. </para>
Great care should be taken both in the installation and usage of this software. <para>
Carefully consider the implications of installing other network services with Bugzilla. Although the Bugzilla development team has taken great care to
</PARA> ensure that all easily-exploitable bugs or options are
</SECTION> documented or fixed in the code, security holes surely exist.
Great care should be taken both in the installation and usage of
this software. Carefully consider the implications of installing
other network services with Bugzilla. The Bugzilla development
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
product, and are responsible for auditing it yourself to insure
your security needs are met.
</para>
</section>
<!-- Section 2: New Versions --> <!-- Section 2: New Versions -->
<SECTION ID="newversions"> <section id="newversions">
<TITLE>New Versions</TITLE> <title>New Versions</title>
<PARA> <para>
This is the initial release of the Bugzilla Guide. This is the &bzg-ver; version of The Bugzilla Guide. If you are
</PARA> reading this from any source other than those below, please
<PARA> check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
</para>
<para>
This document can be found in the following places: This document can be found in the following places:
</PARA> </para>
<PARA> <para>
<ITEMIZEDLIST> <itemizedlist>
<LISTITEM> <listitem>
<PARA> <para>
<ULINK URL="http://www.trilobyte.net/barnsons/">TriloBYTE</ULINK> <ulink url="http://www.trilobyte.net/barnsons/">TriloBYTE</ulink>
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
<ULINK URL="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ULINK> <ulink url="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ulink>
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
<ULINK URL="http://www.linuxdoc.org/">The Linux Documentation Project</ULINK> <ulink url="http://www.linuxdoc.org/">The Linux
</PARA> Documentation Project</ulink>
</LISTITEM> </para>
</ITEMIZEDLIST> </listitem>
</PARA> </itemizedlist>
<PARA> </para>
<para>
The latest version of this document can be checked out via CVS. The latest version of this document can be checked out via CVS.
Please follow the instructions available at Please follow the instructions available at <ulink
<ULINK URL="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ULINK>, url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the mozilla/webtools/bugzilla/docs/ branch.
and check out the mozilla/webtools/bugzilla/docs/ branch. </para>
</PARA> </section>
</SECTION>
<SECTION ID="credits"> <section id="credits">
<TITLE>Credits</TITLE> <title>Credits</title>
<PARA> <para>
The people listed below have made enormous contributions to the creation The people listed below have made enormous contributions to the
of this Guide, through their dedicated hacking efforts, creation of this Guide, through their dedicated hacking efforts,
numerous e-mail and IRC support sessions, numerous e-mail and IRC support sessions, and overall excellent
and overall excellent contribution to the Bugzilla community: contribution to the Bugzilla community:
</PARA> </para>
<PARA> <para>
<ULINK URL="mailto://terry@mozilla.org">Terry Weissman</ULINK> <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
for initially converting Bugzilla from BugSplat! for initially converting Bugzilla from BugSplat! and writing the
and writing the README upon which this documentation is largely based. README upon which this documentation is largely based.
</PARA> </para>
<PARA> <para>
<ULINK URL="mailto://tara@tequilarista.org">Tara Hernandez</ULINK> <ulink url="mailto://tara@tequilarista.org">Tara
for keeping Bugzilla development going strong after Terry left Mozilla.org Hernandez</ulink> for keeping Bugzilla development going
</PARA> strong after Terry left Mozilla.org
<PARA> </para>
<ULINK URL="mailto://dkl@redhat.com">Dave Lawrence</ULINK> <para>
for providing insight into the key differences between Red Hat's <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for
customized Bugzilla, and being largely responsible for the providing insight into the key differences between Red Hat's
"Red Hat Bugzilla" appendix customized Bugzilla, and being largely responsible for the "Red
</PARA> Hat Bugzilla" appendix
<PARA> </para>
<ULINK URL="mailto://endico@mozilla.org">Dawn Endico</ULINK> <para>
for being a hacker extraordinaire and putting up with my incessant <ulink url="mailto://endico@mozilla.org">Dawn Endico</ulink> for
being a hacker extraordinaire and putting up with my incessant
questions and arguments on irc.mozilla.org in #mozwebtools questions and arguments on irc.mozilla.org in #mozwebtools
</PARA> </para>
<PARA> <para>
Last but not least, all the members of the Last but not least, all the members of the <ulink
<ULINK URL="news://news.mozilla.org/netscape/public/mozilla/webtools"> url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
netscape.public.mozilla.webtools</ULINK> newsgroup. Without your </para>
discussions, insight, suggestions, and patches, this could never have happened. </section>
</PARA>
</SECTION>
<SECTION id="contributors">
<TITLE>Contributors</TITLE>
<PARA>
Thanks go to these people for significant contributions
to this documentation (in no particular order):
</PARA>
<PARA>
Zach Lipton (significant textual contributions),
Andrew Pearson,
Spencer Smith,
Eric Hanson,
Kevin Brannen,
</PARA>
</SECTION>
<SECTION ID="feedback">
<TITLE>Feedback</TITLE>
<PARA>
I welcome feedback on this document. Without your submissions and input,
this Guide cannot continue to exist. Please mail additions, comments, criticisms, etc.
to <EMAIL>barnboy@trilobyte.net</EMAIL>. Please send flames to
<EMAIL>devnull@localhost</EMAIL>
</PARA>
</SECTION>
<SECTION ID="translations"> <section id="contributors">
<TITLE>Translations</TITLE> <title>Contributors</title>
<PARA> <para>
The Bugzilla Guide needs translators! Thanks go to these people for significant contributions to this
Please volunteer your translation into the language of your choice. documentation (in no particular order):
If you will translate this Guide, please notify the members of the mozilla-webtools mailing list at </para>
<email>mozilla-webtools@mozilla.org</email>. Since The Bugzilla Guide is also hosted on the <para>
Linux Documentation Project, you would also do well to notify Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum
</PARA> </para>
</SECTION> </section>
<section id="feedback">
<title>Feedback</title>
<para>
I welcome feedback on this document. Without your submissions
and input, this Guide cannot continue to exist. Please mail
additions, comments, criticisms, etc. to
<email>barnboy@trilobyte.net</email>. Please send flames to
<email>devnull@localhost</email>
</para>
</section>
<section id="translations">
<title>Translations</title>
<para>
The Bugzilla Guide needs translators! Please volunteer your
translation into the language of your choice. If you will
translate this Guide, please notify the members of the
mozilla-webtools mailing list at
<email>mozilla-webtools@mozilla.org</email>, and arrange with
Matt Barnson to check it into CVS.
</para>
</section>
<!-- conventions used here (didn't want to give it a chapter of its own) --> <!-- conventions used here (didn't want to give it a chapter of its own) -->
&conventions; &conventions;
</chapter>
</CHAPTER> <!-- Keep this comment at the end of the file
Local variables:
mode: sgml
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:upper
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:Bugzilla-Guide\.sgml
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-doctype:"<!DOCTYPE chapter PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\">" sgml-minimize-attributes:nil
End: sgml-namecase-general:t
--> sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<!-- TOC <chapter id="administration">
Chapter: Administration <title>Administering Bugzilla</title>
Localconfig and Checksetup.pl customizations <subtitle>
The Email Gateway Or, I just got this cool thing installed. Now what the heck do I
Editing parameters do with it?
Deciding your site policies </subtitle>
The Shadow Database
Customizing password mail & layout <para>
The Whining Cron So you followed the installation instructions to the letter, and
Why you shouldn't allow deletion just logged into bugzilla with your super-duper god account and
User administration you are sitting at the query screen. Yet, you have nothing to
Creating Users query. Your first act of business needs to be to setup the
Disabling Users operating parameters for bugzilla.
User Permissions </para>
Product Administration
Creating products
Creating components
Assigning default owners and Q/A contacts to components
Product Milestones
Product Versions
Voting
-->
<CHAPTER id="administration">
<TITLE>Administering Bugzilla</TITLE>
<SUBTITLE>Or, I just got this cool thing installed. Now what the heck do I do with it?</SUBTITLE>
<PARA>
So you followed the README isntructions to the letter, and
just logged into bugzilla with your super-duper god account and you are sitting at the query
screen. Yet, you have nothing to query. Your first act of business needs to be to setup the
operating parameters for bugzilla.</PARA>
<SECTION id="postinstall-check"> <section id="postinstall-check">
<TITLE>Post-Installation Checklist</TITLE> <title>Post-Installation Checklist</title>
<PARA> <para>
After installation, follow the checklist below to ensure that After installation, follow the checklist below to ensure that
you have a successful installation. you have a successful installation. If you do not see a
If you do not see a recommended setting for a parameter, recommended setting for a parameter, consider leaving it at the
consider leaving it at the default default while you perform your initial tests on your Bugzilla
while you perform your initial tests on your Bugzilla setup. setup.
</PARA> </para>
<INDEXTERM> <indexterm>
<PRIMARY>checklist</PRIMARY> <primary>checklist</primary>
</INDEXTERM> </indexterm>
<PROCEDURE> <procedure>
<STEP> <step>
<PARA> <para>
Bring up "editparams.cgi" in your web browser. For instance, to edit parameters Bring up "editparams.cgi" in your web browser. For
at mozilla.org, the URL would be <ULINK URL="http://bugzilla.mozilla.org/editparams.cgi"> instance, to edit parameters at mozilla.org, the URL would
http://bugzilla.mozilla.org/editparams.cgi</ULINK>, also available under the "edit parameters" be <ulink url="http://bugzilla.mozilla.org/editparams.cgi">
link on your query page. http://bugzilla.mozilla.org/editparams.cgi</ulink>, also
</PARA> available under the "edit parameters" link on your query
</STEP> page.
<STEP> </para>
<PARA> </step>
Set "maintainer" to <EMPHASIS>your</EMPHASIS> email address. <step>
This allows Bugzilla's error messages <para>
to display your email Set "maintainer" to <emphasis>your</emphasis> email address.
This allows Bugzilla's error messages to display your email
address and allow people to contact you for help. address and allow people to contact you for help.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Set "urlbase" to the URL reference for your Bugzilla installation. Set "urlbase" to the URL reference for your Bugzilla
If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi, installation. If your bugzilla query page is at
your url base is http://www.foo.com/bugzilla/ http://www.foo.com/bugzilla/query.cgi, your url base is
</PARA> http://www.foo.com/bugzilla/
</STEP> </para>
<STEP> </step>
<PARA> <step>
Set "usebuggroups" to "1" <EMPHASIS>only</EMPHASIS> <para>
if you need to restrict access to products. Set "usebuggroups" to "on" <emphasis>only</emphasis> if you
I suggest leaving this parameter <EMPHASIS>off</EMPHASIS> need to restrict access to products. I suggest leaving this
while initially testing your Bugzilla. parameter <emphasis>off</emphasis> while initially testing
</PARA> your Bugzilla.
</STEP> </para>
<STEP> </step>
<PARA> <step>
Set "usebuggroupsentry" to "1" if you want to restrict access to products. <para>
Once again, if you are simply testing your installation, I suggest against Set "usebuggroupsentry" to "on" if you want to restrict
turning this parameter on; the strict security checking may stop you from access to products. Once again, if you are simply testing
being able to modify your new entries. your installation, I suggest against turning this parameter
</PARA> on; the strict security checking may stop you from being
</STEP> able to modify your new entries.
<STEP> </para>
<PARA> </step>
Set "shadowdb" to "bug_shadowdb" if you will be <step>
running a *very* large installation of Bugzilla. <para>
The shadow database enables many simultaneous users Set "shadowdb" to "bug_shadowdb" if you will be running a
to read and write to the database *very* large installation of Bugzilla. The shadow database
without interfering with one another. enables many simultaneous users to read and write to the
<NOTE> database without interfering with one another.
<PARA> <note>
<para>
Enabling "shadowdb" can adversely affect the stability Enabling "shadowdb" can adversely affect the stability
of your installation of Bugzilla. of your installation of Bugzilla. You may frequently
You may frequently need to manually synchronize your databases, need to manually synchronize your databases, or schedule
or schedule nightly syncs nightly syncs via "cron"
via "cron" </para>
</PARA> </note> Once again, in testing you should avoid this option
</NOTE> -- use it if or when you <emphasis>need</emphasis> to use
Once again, in testing you should it, and have repeatedly run into the problem it was designed
avoid this option -- use it if or when you <EMPHASIS>need</EMPHASIS> to use it, and have to solve -- very long wait times while attempting to commit
repeatedly run into the problem it was designed to solve -- very long wait times while a change to the database.
attempting to commit a change to the database. </para>
</PARA> <para>
<PARA> If you use the "shadowdb" option, it is only natural that
If you use the "shadowdb" option, you should turn the "queryagainstshadowdb" option "On" as
it is only natural that you should turn the "queryagainstshadowdb" well. Otherwise you are replicating data into a shadow
option "On" as well. Otherwise you are replicating data into a shadow database for no reason! database for no reason!
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
If you have custom logos or HTML you must put in place to fit within your site design guidelines, If you have custom logos or HTML you must put in place to
place the code in the "headerhtml", "footerhtml", "errorhtml", fit within your site design guidelines, place the code in
"bannerhtml", or "blurbhtml" text boxes. the "headerhtml", "footerhtml", "errorhtml", "bannerhtml",
<NOTE> or "blurbhtml" text boxes.
<PARA> <note>
<para>
The "headerhtml" text box is the HTML printed out The "headerhtml" text box is the HTML printed out
<EMPHASIS>before</EMPHASIS> any other code on the page. <emphasis>before</emphasis> any other code on the page.
If you have a special banner, put the code for it in "bannerhtml". If you have a special banner, put the code for it in
You may want to leave these "bannerhtml". You may want to leave these settings at
settings at the defaults initially. the defaults initially.
</PARA> </para>
</NOTE> </note>
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Add any text you wish to the "passwordmail" parameter box. For instance, Add any text you wish to the "passwordmail" parameter box.
many people choose to use this box to give a quick training blurb about how to For instance, many people choose to use this box to give a
use Bugzilla at your site. quick training blurb about how to use Bugzilla at your site.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Ensure "newemailtech" is "on". Ensure "newemailtech" is "on". Your users will thank you.
Your users will thank you. This is the default in the post-2.12 world, and is This is the default in the post-2.12 world, and is only an
only an issue if you are upgrading. issue if you are upgrading.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Do you want to use the qa contact ("useqacontact") Do you want to use the QA Contact ("useqacontact") and
and status whiteboard ("usestatuswhiteboard") fields? status whiteboard ("usestatuswhiteboard") fields? These
These fields are useful because they allow for more flexibility, fields are useful because they allow for more flexibility,
particularly when you have an existing particularly when you have an existing Quality Assurance
Quality Assurance and/or Release Engineering team, and/or Release Engineering team, but they may not be needed
but they may not be needed for smaller installations. for smaller installations.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Set "whinedays" to the amount of days you want to let bugs go Set "whinedays" to the amount of days you want to let bugs
in the "New" or "Reopened" state before go in the "New" or "Reopened" state before notifying people
notifying people they have untouched new bugs. If you do not plan to use this feature, simply do they have untouched new bugs. If you do not plan to use
not set up the whining cron job described in the README, or set this value to "0". this feature, simply do not set up the whining cron job
</PARA> described in the installation instructions, or set this
</STEP> value to "0".
<STEP> </para>
<PARA> </step>
<step>
<para>
Set the "commenton" options according to your site policy. Set the "commenton" options according to your site policy.
It is a wise idea to require comments when users It is a wise idea to require comments when users resolve,
resolve, reassign, or reopen bugs. reassign, or reopen bugs.
<NOTE> <note>
<PARA> <para>
It is generally far better to require a developer comment when resolving bugs than not. It is generally far better to require a developer
Few things are more annoying to bug database users than having a developer comment when resolving bugs than not. Few things are
mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) more annoying to bug database users than having a
</PARA> developer mark a bug "fixed" without any comment as to
</NOTE> what the fix was (or even that it was truly fixed!)
</PARA> </para>
</STEP> </note>
<STEP> </para>
<PARA> </step>
Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their <step>
respective areas, and can offer many other benefits, such as allowing a developer to pick up a <para>
former engineer's bugs without requiring her to change all the information in the bug. Set "supportwatchers" to "On". This feature is helpful for
</PARA> team leads to monitor progress in their respective areas,
</STEP> and can offer many other benefits, such as allowing a
</PROCEDURE> developer to pick up a former engineer's bugs without
</SECTION> requiring her to change all the information in the bug.
</para>
</step>
</procedure>
</section>
<SECTION id="useradmin"> <section id="useradmin">
<TITLE>User Administration</TITLE> <title>User Administration</title>
<PARA> <para>
User administration is one of the easiest parts of Bugzilla. User administration is one of the easiest parts of Bugzilla.
Keeping it from getting out of hand, however, can become a challenge. Keeping it from getting out of hand, however, can become a
</PARA> challenge.
</para>
<SECTION id="defaultuser"> <section id="defaultuser">
<TITLE>Creating the Default User</TITLE> <title>Creating the Default User</title>
<PARA> <para>
When you first run checksetup.pl after installing Bugzilla, it will prompt you When you first run checksetup.pl after installing Bugzilla, it
for the administrative username (email address) and password for this "super user". will prompt you for the administrative username (email
If for some reason you were to delete the "super user" account, re-running address) and password for this "super user". If for some
checksetup.pl will again prompt you for this username and password. reason you were to delete the "super user" account, re-running
</PARA> checksetup.pl will again prompt you for this username and
<TIP> password.
<PARA> </para>
If you wish to add more administrative users, you must use the MySQL interface. <tip>
Run "mysql" from the command line, and use these commands ("mysql>" denotes the <para>
mysql prompt, not something you should type in): If you wish to add more administrative users, you must use the
<COMMAND><PROMPT>mysql></PROMPT> use bugs;</COMMAND> MySQL interface. Run "mysql" from the command line, and use
<COMMAND><PROMPT>mysql></PROMPT> update profiles set groupset=0x7ffffffffffffff these commands ("mysql>" denotes the mysql prompt, not
where login_name = "(user's login name)"; </COMMAND> something you should type in):
</PARA> <command><prompt>mysql></prompt> use bugs;</command>
</TIP> <command><prompt>mysql></prompt> update profiles set
</SECTION> groupset=0x7ffffffffffffff where login_name = "(user's
login name)"; </command>
</para>
</tip>
</section>
<SECTION id="manageusers"> <section id="manageusers">
<TITLE>Managing Other Users</TITLE> <title>Managing Other Users</title>
<SECTION id="login"> <section id="login">
<TITLE>Logging In</TITLE> <title>Logging In</title>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Open the index.html page for your Bugzilla installation in your browser window. Open the index.html page for your Bugzilla installation
</PARA> in your browser window.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Click the "Query Existing Bug Reports" link. Click the "Query Existing Bug Reports" link.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Click the "Log In" link at the foot of the page. Click the "Log In" link at the foot of the page.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Type your email address, and the password which was emailed to you when you Type your email address, and the password which was
created your Bugzilla account, into the spaces provided. emailed to you when you created your Bugzilla account,
</PARA> into the spaces provided.
</LISTITEM> </para>
</ORDEREDLIST> </listitem>
<PARA>Congratulations, you are logged in!</PARA> </orderedlist>
</SECTION> <para>Congratulations, you are logged in!</para>
</section>
<SECTION id="createnewusers"> <section id="createnewusers">
<TITLE>Creating new users</TITLE> <title>Creating new users</title>
<PARA> <para>
Your users can create their own user accounts by clicking the "New Account" Your users can create their own user accounts by clicking
link at the bottom of each page. the "New Account" link at the bottom of each page. However,
However, should you desire to create user accounts ahead of time, here is how you do it. should you desire to create user accounts ahead of time,
</PARA> here is how you do it.
<ORDEREDLIST> </para>
<LISTITEM> <orderedlist>
<PARA> <listitem>
After logging in, click the "Users" link at the footer of the query page. <para>
</PARA> After logging in, click the "Users" link at the footer
</LISTITEM> of the query page.
<LISTITEM> </para>
<PARA> </listitem>
To see a specific user, type a portion of their login name <listitem>
in the box provided and click "submit". <para>
To see all users, simply click the "submit" button. To see a specific user, type a portion of their login
You must click "submit" here to be able to add a new user. name in the box provided and click "submit". To see all
</PARA> users, simply click the "submit" button. You must click
<TIP> "submit" here to be able to add a new user.
<PARA> </para>
More functionality is available via the list on the right-hand side <tip>
of the text entry box. <para>
You can match what you type as a case-insensitive substring (the default) More functionality is available via the list on the
of all users on your system, a case-sensitive regular expression right-hand side of the text entry box. You can match
(please see the "man regexp" manual page for details on regular expression syntax), what you type as a case-insensitive substring (the
or a <EMPHASIS>reverse</EMPHASIS> regular expression match, default) of all users on your system, a case-sensitive
where every user name which does NOT match the regular expression regular expression (please see the "man regexp" manual
is selected. page for details on regular expression syntax), or a
</PARA> <emphasis>reverse</emphasis> regular expression match,
</TIP> where every user name which does NOT match the regular
</LISTITEM> expression is selected.
<LISTITEM> </para>
<PARA> </tip>
Click the "Add New User" link at the bottom of the user list </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Click the "Add New User" link at the bottom of the user
<PARA> list
Fill out the form presented. This page is self-explanatory. When done, click "submit". </para>
</PARA> </listitem>
<NOTE> <listitem>
<PARA> <para>
Adding a user this way will <EMPHASIS>not</EMPHASIS> send an email Fill out the form presented. This page is
informing them of their username and password. self-explanatory. When done, click "submit".
In general, it is preferable to log out and use the "New Account" </para>
button to create users, as it will pre-populate all the required fields and also notify <note>
the user of her account name and password. <para>
</PARA> Adding a user this way will <emphasis>not</emphasis>
</NOTE> send an email informing them of their username and
</LISTITEM> password. In general, it is preferable to log out and
</ORDEREDLIST> use the "New Account" button to create users, as it
</SECTION> will pre-populate all the required fields and also
notify the user of her account name and password.
</para>
</note>
</listitem>
</orderedlist>
</section>
<SECTION id="disableusers"> <section id="disableusers">
<TITLE>Disabling Users</TITLE> <title>Disabling Users</title>
<PARA> <para>
I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen, I bet you noticed that big "Disabled Text" entry box
when you edit an account? available from the "Add New User" screen, when you edit an
By entering any text in this box and selecting "submit", account? By entering any text in this box and selecting
you have prevented the user from using Bugzilla via the web interface. "submit", you have prevented the user from using Bugzilla
Your explanation, written in this text box, will be presented to the user via the web interface. Your explanation, written in this
the next time she attempts to use the system. text box, will be presented to the user the next time she
<WARNING> attempts to use the system.
<PARA> <warning>
Don't disable your own administrative account, or you will hate life! <para>
</PARA> Don't disable your own administrative account, or you
</WARNING> will hate life!
</PARA> </para>
</SECTION> </warning>
</para>
</section>
<SECTION id="modifyusers"> <section id="modifyusers">
<TITLE>Modifying Users</TITLE> <title>Modifying Users</title>
<PARA> <para>
Here I will attempt to describe the function of each option on the user edit screen. Here I will attempt to describe the function of each option
</PARA> on the Edit User screen.
<ITEMIZEDLIST> </para>
<LISTITEM> <itemizedlist>
<PARA> <listitem>
<EMPHASIS>Login Name</EMPHASIS>: This is generally the user's email address. <para>
However, if you have edited your system parameters, <emphasis>Login Name</emphasis>: This is generally the
this may just be the user's login name or some other identifier. user's email address. However, if you have edited your
<TIP> system parameters, this may just be the user's login
<PARA> name or some other identifier.
For compatability reasons, you should probably <tip>
stick with email addresses as user login names. It will make your life easier. <para>
</PARA> For compatability reasons, you should probably stick
</TIP> with email addresses as user login names. It will
</PARA> make your life easier.
</LISTITEM> </para>
<LISTITEM> </tip>
<PARA> </para>
<EMPHASIS>Real Name</EMPHASIS>: Duh! </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> <emphasis>Real Name</emphasis>: Duh!
<PARA> </para>
<EMPHASIS>Password</EMPHASIS>: You will only see asterisks in versions </listitem>
of Bugzilla newer than 2.10 or early 2.11. You can change the user password here. <listitem>
</PARA> <para>
</LISTITEM> <emphasis>Password</emphasis>: You will only see
<LISTITEM> asterisks in versions of Bugzilla newer than 2.10 or
<PARA> early 2.11. You can change the user password here.
<EMPHASIS>Email Notification</EMPHASIS>: You may choose from one of three options: </para>
<ORDEREDLIST> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
<emphasis>Email Notification</emphasis>: You may choose
from one of three options:
<orderedlist>
<listitem>
<para>
All qualifying bugs except those which I change: All qualifying bugs except those which I change:
The user will be notified of any change to any bug The user will be notified of any change to any bug
for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher". for which she is the reporter, assignee, QA
</PARA> Contact, CC recipient, or "watcher".
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Only those bugs which I am listed on the CC line: Only those bugs which I am listed on the CC line:
The user will not be notified of changes to bugs where she is the assignee, The user will not be notified of changes to bugs
reporter, or Q/A contact, but will receive them if she is on the CC list. where she is the assignee, reporter, or QA
<NOTE> Contact, but will receive them if she is on the CC
<PARA> list.
She will still receive whining cron emails if you set up the "whinemail" feature. <note>
</PARA> <para>
</NOTE> She will still receive whining cron emails if
</PARA> you set up the "whinemail" feature.
</LISTITEM> </para>
<LISTITEM> </note>
<PARA> </para>
<EMPHASIS>All Qualifying Bugs</EMPHASIS>: This user is a glutton for punishment. </listitem>
If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher", <listitem>
she will get email updates regarding the bug. <para>
</PARA> <emphasis>All Qualifying Bugs</emphasis>: This
</LISTITEM> user is a glutton for punishment. If her name is
</ORDEREDLIST> in the reporter, QA Contact, CC, assignee, or is a
</PARA> "watcher", she will get email updates regarding
<PARA> the bug.
<EMPHASIS>Disable Text</EMPHASIS>: If you type anything in this box, </para>
including just a space, the user account is disabled from making any changes </listitem>
to bugs via the web interface, and what you type in this box is presented as the reason. </orderedlist>
<WARNING> </para>
<PARA>Don't disable the administrator account!</PARA> <para>
</WARNING> <emphasis>Disable Text</emphasis>: If you type anything
<NOTE> in this box, including just a space, the user account is
<PARA> disabled from making any changes to bugs via the web
As of this writing, the user can still submit bugs via the e-mail gateway, interface, and what you type in this box is presented as
if you set it up, despite the disabled text field. The e-mail gateway should the reason.
<EMPHASIS>not</EMPHASIS> be enabled for secure installations of Bugzilla. <warning>
</PARA> <para>Don't disable the administrator account!</para>
</NOTE> </warning>
</PARA> <note>
</LISTITEM> <para>
<LISTITEM> As of this writing, the user can still submit bugs
<PARA> via the e-mail gateway, if you set it up, despite
<EMPHASIS>CanConfirm</EMPHASIS>: This field is only used if you have enabled the disabled text field. The e-mail gateway should
"unconfirmed" status in your parameters screen. If you enable this for a user, <emphasis>not</emphasis> be enabled for secure
that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status). installations of Bugzilla.
Be judicious about allowing users to turn this bit on for other users. </para>
</PARA> </note>
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<EMPHASIS>Creategroups</EMPHASIS>: This option will allow a user to create and <para>
destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security <emphasis>CanConfirm</emphasis>: This field is only used
option "usebuggroupsentry" in your parameters, this setting has no effect. if you have enabled "unconfirmed" status in your
</PARA> parameters screen. If you enable this for a user, that
</LISTITEM> user can then move bugs from "Unconfirmed" to
<LISTITEM> "Confirmed" status (e.g.: "New" status). Be judicious
<PARA> about allowing users to turn this bit on for other
<EMPHASIS>Editbugs</EMPHASIS>: Unless a user has this bit set, they can only edit users.
those bugs for which they are the assignee or the reporter. </para>
<NOTE> </listitem>
<PARA> <listitem>
Leaving this option unchecked does not prevent users from adding <para>
comments to a bug! They simply cannot change a bug priority, severity, <emphasis>Creategroups</emphasis>: This option will
etc. unless they are the assignee or reporter. allow a user to create and destroy groups in Bugzilla.
</PARA> Unless you are using the Bugzilla GroupSentry security
</NOTE> option "usebuggroupsentry" in your parameters, this
</PARA> setting has no effect.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<EMPHASIS>Editcomponents</EMPHASIS>: This flag allows a user to create new <para>
products and components, as well as modify and destroy those that have no bugs <emphasis>Editbugs</emphasis>: Unless a user has this
associated with them. If a product or component has bugs associated with it, bit set, they can only edit those bugs for which they
those bugs must be moved to a different product or component before Bugzilla are the assignee or the reporter.
will allow them to be destroyed. The name of a product or component can be <note>
changed without affecting the associated bugs, but it tends to annoy <para>
the hell out of your users when these change a lot. Leaving this option unchecked does not prevent users
</PARA> from adding comments to a bug! They simply cannot
</LISTITEM> change a bug priority, severity, etc. unless they
<LISTITEM> are the assignee or reporter.
<PARA> </para>
<EMPHASIS>Editkeywords</EMPHASIS>: If you use Bugzilla's keyword functionality, </note>
enabling this feature allows a user can create and destroy keywords. </para>
As always, the keywords for existing bugs containing the keyword </listitem>
the user wishes to destroy must be changed before Bugzilla will allow it to die. <listitem>
You must be very careful about creating too many new keywords <para>
if you run a very large Bugzilla installation; keywords are global variables <emphasis>Editcomponents</emphasis>: This flag allows a
across products, and you can often run into a phenomenon called "keyword bloat". user to create new products and components, as well as
This confuses users, and then the feature goes unused. modify and destroy those that have no bugs associated
</PARA> with them. If a product or component has bugs
</LISTITEM> associated with it, those bugs must be moved to a
<LISTITEM> different product or component before Bugzilla will
<PARA> allow them to be destroyed. The name of a product or
<EMPHASIS>Editusers</EMPHASIS>: This flag allows a user do what you're doing component can be changed without affecting the
right now: edit other users. associated bugs, but it tends to annoy the hell out of
This will allow those with the right to do so to remove administrator your users when these change a lot.
priveleges from other users or grant them to themselves. Enable with care. </para>
</PARA> </listitem>
</LISTITEM> <listitem>
<LISTITEM> <para>
<PARA> <emphasis>Editkeywords</emphasis>: If you use Bugzilla's
<EMPHASIS>PRODUCT</EMPHASIS>: PRODUCT bugs access. This allows an administrator, keyword functionality, enabling this feature allows a
with product-level granularity, to specify in which products a user can edit bugs. user can create and destroy keywords. As always, the
The user must still have the "editbugs" privelege to edit bugs in this area; keywords for existing bugs containing the keyword the
this simply restricts them from even seeing bugs outside these boundaries if the administrator user wishes to destroy must be changed before Bugzilla
has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups, will allow it to die. You must be very careful about
creating too many new keywords if you run a very large
Bugzilla installation; keywords are global variables
across products, and you can often run into a phenomenon
called "keyword bloat". This confuses users, and then
the feature goes unused.
</para>
</listitem>
<listitem>
<para>
<emphasis>Editusers</emphasis>: This flag allows a user
do what you're doing right now: edit other users. This
will allow those with the right to do so to remove
administrator priveleges from other users or grant them
to themselves. Enable with care.
</para>
</listitem>
<listitem>
<para>
<emphasis>PRODUCT</emphasis>: PRODUCT bugs access. This
allows an administrator, with product-level granularity,
to specify in which products a user can edit bugs. The
user must still have the "editbugs" privelege to edit
bugs in this area; this simply restricts them from even
seeing bugs outside these boundaries if the
administrator has enabled the group sentry parameter
"usebuggroupsentry". Unless you are using bug groups,
this option has no effect. this option has no effect.
</PARA> </para>
</LISTITEM> </listitem>
</ITEMIZEDLIST> </itemizedlist>
</SECTION> </section>
</SECTION> </section>
</SECTION> </section>
<SECTION id="programadmin"> <section id="programadmin">
<TITLE>Product, Component, Milestone, and Version Administration</TITLE> <title>Product, Component, Milestone, and Version
<EPIGRAPH> Administration</title>
<PARA> <epigraph>
<para>
Dear Lord, we have to get our users to do WHAT? Dear Lord, we have to get our users to do WHAT?
</PARA> </para>
</EPIGRAPH> </epigraph>
<SECTION id="products"> <section id="products">
<TITLE>Products</TITLE> <title>Products</title>
<SUBTITLE>Formerly, and in some spots still, called "Programs"</SUBTITLE> <subtitle>Formerly, and in some spots still, called
<PARA> "Programs"</subtitle>
<GLOSSTERM baseform="product" linkend="gloss_product">Products</GLOSSTERM> are the <para>
broadest category in Bugzilla, and you should have the least of these. <glossterm linkend="gloss_product" baseform="product">Products</glossterm> are
If your company makes computer games, you should have one product per game, the broadest category in Bugzilla, and you should have the
and possibly a few special products least of these. If your company makes computer games, you
(website, meetings...) should have one product per game, and possibly a few special
</PARA> products (website, meetings...)
<PARA> </para>
A Product (formerly called "Program", and still referred to that way <para>
in some portions of the source code) controls some very important functions. A Product (formerly called "Program", and still referred to
The number of "votes" available for users to vote for the most important bugs that way in some portions of the source code) controls some
is set per-product, as is the number of votes required to move a bug automatically very important functions. The number of "votes" available for
from the UNCONFIRMED status to the NEW status. One can close a Product for further users to vote for the most important bugs is set per-product,
bug entry and define various Versions available from the Edit Product screen. as is the number of votes required to move a bug automatically
</PARA> from the UNCONFIRMED status to the NEW status. One can close
<PARA>To create a new product:</PARA> a Product for further bug entry and define various Versions
<ORDEREDLIST> available from the Edit product screen.
<LISTITEM> </para>
<PARA> <para>To create a new product:</para>
<orderedlist>
<listitem>
<para>
Select "components" from the yellow footer Select "components" from the yellow footer
</PARA> </para>
<TIP> <tip>
<PARA> <para>
It may seem counterintuitive to click "components" when you want It may seem counterintuitive to click "components" when
to edit the properties associated with Products. This is one of a long you want to edit the properties associated with
list of things we want in Bugzilla 3.0... Products. This is one of a long list of things we want
</PARA> in Bugzilla 3.0...
</TIP> </para>
</LISTITEM> </tip>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Select the "Add" link to the right of "Add a new product". Select the "Add" link to the right of "Add a new product".
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Enter the name of the product and a description. Enter the name of the product and a description. The
The Description field is free-form. Description field is free-form.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
<TIP> <tip>
<PARA> <para>
Don't worry about the "Closed for bug entry", "Maximum Votes per person", Don't worry about the "Closed for bug entry", "Maximum Votes
"Maximum votes a person can put on a single bug", "Number of votes a bug in per person", "Maximum votes a person can put on a single
this Product needs to automatically get out of the UNCOMFIRMED state", bug", "Number of votes a bug in this Product needs to
and "Version" options yet. automatically get out of the UNCOMFIRMED state", and
We'll cover those in a few moments. "Version" options yet. We'll cover those in a few moments.
</PARA> </para>
</TIP> </tip>
</SECTION> </section>
<SECTION id="components"> <section id="components">
<TITLE>Components</TITLE> <title>Components</title>
<PARA> <para>
Components are subsections of a Product. Components are subsections of a Product.
<EXAMPLE> <example>
<TITLE>Creating some Components</TITLE> <title>Creating some Components</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
The computer game you are designing may a "UI" component, an "API" component, The computer game you are designing may have a "UI"
a "Sound System" component, and a "Plugins" component, each overseen by a different component, an "API" component, a "Sound System"
programmer. It often makes sense to divide Components in Bugzilla according to the component, and a "Plugins" component, each overseen by
natural divisions of responsibility within your Product or company. a different programmer. It often makes sense to divide
</PARA> Components in Bugzilla according to the natural
</INFORMALEXAMPLE> divisions of responsibility within your Product or
</EXAMPLE> company.
</para>
Each component has a owner and (if you turned it on in the parameters), a qa </informalexample>
contact. The owner should be the primary person who fixes bugs in that component. The QA </example> Each component has a owner and (if you turned it on
Contact should be the person who will ensure these bugs are completely fixed. The Owner, in the parameters), a QA Contact. The owner should be the
QA Contact, and Reporter will get email when new bugs are created in this Component and primary person who fixes bugs in that component. The QA
when these bugs change. Default Owner and Default QA Contact fields only dictate the Contact should be the person who will ensure these bugs are
<EMPHASIS>default assignments</EMPHASIS>; the Owner and Q/A Contact fields in a bug completely fixed. The Owner, QA Contact, and Reporter will get
are otherwise unrelated to the Component. email when new bugs are created in this Component and when
</PARA> these bugs change. Default Owner and Default QA Contact fields
only dictate the <emphasis>default assignments</emphasis>; the
Owner and QA Contact fields in a bug are otherwise unrelated
to the Component.
</para>
<PARA> <para>
To create a new Component: To create a new Component:
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Select the "Edit components" link from the "Edit Product" page Select the "Edit components" link from the "Edit product"
</PARA> page
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
Select the "Add" link to the right of the "Add a new component" text <para>
on the "Select Component" page. Select the "Add" link to the right of the "Add a new
</PARA> component" text on the "Select Component" page.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
Fill out the "Component" field, a short "Description", and the "Initial Owner". <para>
The "Component" field should not contain a space. The "Description" field is Fill out the "Component" field, a short "Description", and
free-form. The "Initial Owner" field must be that of a valid user already the "Initial Owner". The Component and Description fields
existing in the database. If the initial owner does not exist, Bugzilla are free-form; the "Initial Owner" field must be that of a
will refuse to create the component. user ID already existing in the database. If the initial
<TIP> owner does not exist, Bugzilla will refuse to create the
<PARA> component.
Is your "Default Owner" a user who is not yet in the database? <tip>
No problem. <para>
<ORDEREDLIST> Is your "Default Owner" a user who is not yet in the
<LISTITEM> database? No problem.
<PARA> <orderedlist>
Select the "Log out" link on the footer of the page. <listitem>
</PARA> <para>
</LISTITEM> Select the "Log out" link on the footer of the
<LISTITEM> page.
<PARA> </para>
Select the "New Account" link on the footer of the "Relogin" page </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Select the "New Account" link on the footer of
<PARA> the "Relogin" page
Type in the email address of the default owner you want to create </para>
in the "E-mail address" field, and her full name in the "Real name" </listitem>
<listitem>
<para>
Type in the email address of the default owner
you want to create in the "E-mail address"
field, and her full name in the "Real name"
field, then select the "Submit Query" button. field, then select the "Submit Query" button.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Now select "Log in" again, type in your login information, and you Now select "Log in" again, type in your login
can modify the product to use the Default Owner information information, and you can modify the product to
you require. use the Default Owner information you require.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
</PARA> </para>
</TIP> </tip>
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Either "edit" more components or return to the "query" page on the ensuing Either Edit more components or return to the Bugzilla
"Addming new component" page. To return to the Product you were editing, you Query Page. To return to the Product you were editing, you
must select the "components" link as before. must select the Components link as before.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
</SECTION> </section>
<SECTION id="versions"> <section id="versions">
<TITLE>Versions</TITLE> <title>Versions</title>
<PARA> <para>
Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", Versions are the revisions of the product, such as "Flinders
and "Flinders 2000". Using Versions helps you isolate code changes and are an aid 3.1", "Flinders 95", and "Flinders 2000". Using Versions
in reporting. helps you isolate code changes and are an aid in reporting.
<EXAMPLE> <example>
<TITLE>Common Use of Versions</TITLE> <title>Common Use of Versions</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
A user reports a bug A user reports a bug against Version "Beta 2.0" of your
against Version "Beta 2.0" of your product. The current Version of your software product. The current Version of your software is
is "Release Candidate 1", and no longer has the bug. This will "Release Candidate 1", and no longer has the bug. This
help you triage and classify bugs according to their relevance. It is also will help you triage and classify bugs according to
possible people may report bugs against bleeding-edge beta versions that are their relevance. It is also possible people may report
not evident in older versions of the software. This can help isolate code bugs against bleeding-edge beta versions that are not
changes that caused the bug evident in older versions of the software. This can
</PARA> help isolate code changes that caused the bug
</INFORMALEXAMPLE> </para>
</EXAMPLE> </informalexample>
<EXAMPLE> </example>
<TITLE>A Different Use of Versions</TITLE> <example>
<INFORMALEXAMPLE> <title>A Different Use of Versions</title>
<PARA> <informalexample>
This field has been used to good effect by an online service provider in a slightly <para>
different way. They had three versions of the product: "Production", "QA", This field has been used to good effect by an online
and "Dev". Although it may be the same product, a bug in the development service provider in a slightly different way. They had
environment is not normally as critical as a Production bug, nor does it three versions of the product: "Production", "QA", and
need to be reported publicly. When used in conjunction with Target Milestones, "Dev". Although it may be the same product, a bug in
one can easily specify the environment where a bug can be reproduced, and the development environment is not normally as critical
the Milestone by which it will be fixed. as a Production bug, nor does it need to be reported
</PARA> publicly. When used in conjunction with Target
</INFORMALEXAMPLE> Milestones, one can easily specify the environment where
</EXAMPLE> a bug can be reproduced, and the Milestone by which it
</PARA> will be fixed.
<PARA> </para>
</informalexample>
</example>
</para>
<para>
To create and edit Versions: To create and edit Versions:
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
From the "Edit Product" screen, select "Edit Versions" From the "Edit product" screen, select "Edit Versions"
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
You will notice that the product already has the default version "undefined". You will notice that the product already has the default
If your product doesn't use version numbers, you may want to leave this as it is version "undefined". If your product doesn't use version
or edit it so that it is "---". You can then go back to the edit versions page numbers, you may want to leave this as it is or edit it so
and add new versions to your product. that it is "---". You can then go back to the edit
</PARA> versions page and add new versions to your product.
<PARA> </para>
Otherwise, click the "Add" button to the right of the "Add a new version" text. <para>
</PARA> Otherwise, click the "Add" button to the right of the "Add
</LISTITEM> a new version" text.
<LISTITEM> </para>
<PARA> </listitem>
Enter the name of the Version. This can be free-form characters up to the limit of the <listitem>
text box. Then select the "Add" button. <para>
</PARA> Enter the name of the Version. This can be free-form
</LISTITEM> characters up to the limit of the text box. Then select
<LISTITEM> the "Add" button.
<PARA> </para>
At this point you can select "Edit" to edit more Versions, or return to the "Query" </listitem>
page, from which you can navigate back to the product through the "components" link <listitem>
at the foot of the Query page. <para>
</PARA> At this point you can select "Edit" to edit more Versions,
</LISTITEM> or return to the "Query" page, from which you can navigate
</ORDEREDLIST> back to the product through the "components" link at the
</SECTION> foot of the Query page.
</para>
</listitem>
</orderedlist>
</section>
<SECTION id="milestones"> <section id="milestones">
<TITLE>Milestones</TITLE> <title>Milestones</title>
<PARA> <para>
Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that Milestones are "targets" that you plan to get a bug fixed by.
you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a For example, you have a bug that you plan to fix for your 3.0
bug that you plan to fix for 2.8, this would have a milestone of 2.8. release, it would be assigned the milestone of 3.0. Or, you
</PARA> have a bug that you plan to fix for 2.8, this would have a
<NOTE> milestone of 2.8.
<PARA> </para>
Milestone options will only appear for a Product if you turned the "usetargetmilestone" field <note>
in the "Edit Parameters" screen "On". <para>
</PARA> Milestone options will only appear for a Product if you
</NOTE> turned the "usetargetmilestone" field in the "Edit
<PARA> Parameters" screen "On".
To create new Milestones, set Default Milestones, and set Milestone URL: </para>
</PARA> </note>
<ORDEREDLIST> <para>
<LISTITEM> To create new Milestones, set Default Milestones, and set
<PARA> Milestone URL:
</para>
<orderedlist>
<listitem>
<para>
Select "edit milestones" Select "edit milestones"
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Select "Add" to the right of the "Add a new milestone" text Select "Add" to the right of the "Add a new milestone"
</PARA> text
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Enter the name of the Milestone in the "Milestone" field. Enter the name of the Milestone in the "Milestone" field.
You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255) You can optionally set the "Sortkey", which is a positive
that defines where in the list this particular milestone appears. or negative number (-255 to 255) that defines where in the
Select "Add". list this particular milestone appears. Select "Add".
</PARA> </para>
<EXAMPLE> <example>
<TITLE>Using SortKey with Target Milestone</TITLE> <title>Using SortKey with Target Milestone</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". Let's say you create a target milestone called
Later, you realize that you will have a public beta, called "Beta1". "Release 1.0", with Sortkey set to "0". Later, you
You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure realize that you will have a public beta, called
people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0" "Beta1". You can create a Milestone called "Beta1",
</PARA> with a Sortkey of "-1" in order to ensure people will
</INFORMALEXAMPLE> see the Target Milestone of "Beta1" earlier on the
</EXAMPLE> list than "Release 1.0"
</LISTITEM> </para>
<LISTITEM> </informalexample>
<PARA> </example>
If you want to add more milestones, select the "Edit" link. </listitem>
If you don't, well shoot, you have to go back to the "query" page and select "components" <listitem>
again, and make your way back to the Product you were editing. <para>
<NOTE> If you want to add more milestones, select the "Edit"
<PARA> link. If you don't, well shoot, you have to go back to the
This is another in the list of unusual user interface decisions that "query" page and select "components" again, and make your
we'd like to get cleaned up. Shouldn't there be a link to the effect of way back to the Product you were editing.
"edit the Product I was editing when I ended up here"? In any case, <note>
clicking "components" in the footer takes you back to the "Select product" <para>
screen, from which you can begin editing your product again. This is another in the list of unusual user interface
</PARA> decisions that we'd like to get cleaned up. Shouldn't
</NOTE> there be a link to the effect of "edit the Product I
</PARA> was editing when I ended up here"? In any case,
</LISTITEM> clicking "components" in the footer takes you back to
<LISTITEM> the "Select product" screen, from which you can begin
<PARA> editing your product again.
From the Edit Product screen again (once you've made your way back), enter the URL </para>
for a description of what your milestones are for this product in the "Milestone URL" field. </note>
It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" </para>
</PARA> </listitem>
<PARA> <listitem>
Some common uses of this field include product descriptions, product roadmaps, <para>
and of course a simple description of the meaning of each milestone. From the Edit product screen again (once you've made your
</PARA> way back), enter the URL for a description of what your
</LISTITEM> milestones are for this product in the "Milestone URL"
<LISTITEM> field. It should be of the format
<PARA> "http://www.foo.com/bugzilla/product_milestones.html"
If you're using Target Milestones, the "Default Milestone" field must have some </para>
kind of entry. If you really don't care if people set coherent Target Milestones, <para>
simply leave this at the default, "---". However, controlling and regularly updating the Default Some common uses of this field include product
Milestone field is a powerful tool when reporting the status of projects. descriptions, product roadmaps, and of course a simple
</PARA> description of the meaning of each milestone.
<PARA>Select the "Update" button when you are done.</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
If you're using Target Milestones, the "Default Milestone"
</PARA> field must have some kind of entry. If you really don't
</LISTITEM> care if people set coherent Target Milestones, simply
</ORDEREDLIST> leave this at the default, "---". However, controlling
</SECTION> and regularly updating the Default Milestone field is a
powerful tool when reporting the status of projects.
</para>
<para>Select the "Update" button when you are done.</para>
</listitem>
</orderedlist>
</section>
<SECTION id="voting"> <section id="voting">
<TITLE>Voting</TITLE> <title>Voting</title>
<PARA> <para>
The concept of "voting" is a poorly understood, yet powerful feature for the management The concept of "voting" is a poorly understood, yet powerful
of open-source projects. Each user is assigned so many Votes per product, which they can feature for the management of open-source projects. Each user
freely reassign (or assign multiple votes to a single bug). is assigned so many Votes per product, which they can freely
This allows developers to gauge user need for a particular enhancement reassign (or assign multiple votes to a single bug). This
or bugfix. By allowing bugs with a certain number of votes to automatically move from allows developers to gauge user need for a particular
"UNCONFIRMED" to "NEW", users of the bug system can help high-priority bugs garner enhancement or bugfix. By allowing bugs with a certain number
of votes to automatically move from "UNCONFIRMED" to "NEW",
users of the bug system can help high-priority bugs garner
attention so they don't sit for a long time awaiting triage. attention so they don't sit for a long time awaiting triage.
</PARA> </para>
<PARA> <para>
The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you The daunting challenge of Votes is deciding where you draw the
only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED line for a "vocal majority". If you only have a user base of
to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be 100 users, setting a low threshold for bugs to move from
re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved, UNCONFIRMED to NEW makes sense. As the Bugzilla user base
and perhaps forego implementation until you have a critical mass of users who demand it. expands, however, these thresholds must be re-evaluated. You
</PARA> should gauge whether this feature is worth the time and close
<PARA>To modify Voting settings:</PARA> monitoring involved, and perhaps forego implementation until
<ORDEREDLIST> you have a critical mass of users who demand it.
<LISTITEM> </para>
<PARA> <para>To modify Voting settings:</para>
Navigate to the "Edit Product" screen for the Product you wish to modify <orderedlist>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Navigate to the "Edit product" screen for the Product you
<PARA> wish to modify
Set "Maximum Votes per person" to your calculated value. Setting this field </para>
to "0" disables voting. </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Set "Maximum Votes per person" to your calculated value.
<PARA> Setting this field to "0" disables voting.
Set "Maximum Votes a person can put on a single bug" to your calculated value. It </para>
should probably be some number lower than the "Maximum votes per person". </listitem>
Setting this field to "0" disables voting, but leaves the voting options open <listitem>
to the user. This is confusing. <para>
</PARA> Set "Maximum Votes a person can put on a single bug" to
</LISTITEM> your calculated value. It should probably be some number
<LISTITEM> lower than the "Maximum votes per person". Setting this
<PARA> field to "0" disables voting, but leaves the voting
Set "Number of votes a bug in this product needs to automatically get out of the options open to the user. This is confusing.
UNCONFIRMED state" to your calculated number. Setting this field to "0" </para>
disables the automatic move of bugs from UNCONFIRMED to NEW. Some people </listitem>
advocate leaving this at "0", but of what use are Votes if your Bugzilla <listitem>
user base is unable to affect which bugs appear on Development radar? <para>
<TIP> Set "Number of votes a bug in this product needs to
<PARA> automatically get out of the UNCONFIRMED state" to your
You should probably set this number to higher than a small coalition of calculated number. Setting this field to "0" disables
Bugzilla users can influence it. Most sites use this as a "referendum" the automatic move of bugs from UNCONFIRMED to NEW. Some
mechanism -- if users are able to vote a bug out of UNCONFIRMED, it people advocate leaving this at "0", but of what use are
is a <EMPHASIS>really</EMPHASIS> bad bug! Votes if your Bugzilla user base is unable to affect which
</PARA> bugs appear on Development radar?
</TIP> <tip>
</PARA> <para>
</LISTITEM> You should probably set this number to higher than a
<LISTITEM> small coalition of Bugzilla users can influence it.
<PARA> Most sites use this as a "referendum" mechanism -- if
Once you have adjusted the values to your preference, select the "Update" button. users are able to vote a bug out of UNCONFIRMED, it is
</PARA> a <emphasis>really</emphasis> bad bug!
</LISTITEM> </para>
</ORDEREDLIST> </tip>
</SECTION> </para>
</listitem>
<listitem>
<para>
Once you have adjusted the values to your preference,
select the "Update" button.
</para>
</listitem>
</orderedlist>
</section>
<SECTION id="groups"> <section id="groups">
<TITLE>Groups and Group Security</TITLE> <title>Groups and Group Security</title>
<PARA> <para>
Groups can be very useful in bugzilla, because they allow users to isolate Groups can be very useful in bugzilla, because they allow
bugs or products that should only be seen by certain people. Groups can also users to isolate bugs or products that should only be seen by
be a complicated minefield of interdependencies and weirdness if mismanaged. certain people. Groups can also be a complicated minefield of
interdependencies and weirdness if mismanaged.
<EXAMPLE> <example>
<TITLE>When to Use Group Security</TITLE> <title>When to Use Group Security</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
Many Bugzilla sites isolate "Security-related" bugs from all other bugs. Many Bugzilla sites isolate "Security-related" bugs from
This way, they can have a fix ready before the security vulnerability all other bugs. This way, they can have a fix ready
is announced to the world. You can create a "Security" product which, by before the security vulnerability is announced to the
default, has no members, and only add members to the group (in their individual world. You can create a "Security" product which, by
User page, as described under User Administration) who should have default, has no members, and only add members to the
priveleged access to "Security" bugs. Alternately, you may create a Group group (in their individual User page, as described under
independently of any Product, and change the Group mask on individual bugs User Administration) who should have priveleged access
to restrict access to members only of certain Groups. to "Security" bugs. Alternately, you may create a Group
</PARA> independently of any Product, and change the Group mask
</INFORMALEXAMPLE> on individual bugs to restrict access to members only of
</EXAMPLE> certain Groups.
</para>
Groups only work if you enable the "usebuggroups" paramater. </informalexample>
In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access </example> Groups only work if you enable the "usebuggroups"
to products by groups, so that only members of a product group are able to view paramater. In addition, if the "usebuggroupsentry" parameter
bugs within that product. is "On", one can restrict access to products by groups, so
Group security in Bugzilla can be divided into two categories: that only members of a product group are able to view bugs
Generic and Product-Based. within that product. Group security in Bugzilla can be divided
</PARA> into two categories: Generic and Product-Based.
<NOTE> </para>
<PARA> <note>
Groups in Bugzilla are a complicated beast that evolved out of very simple user <para>
permission bitmasks, apparently itself derived from common concepts in UNIX access Groups in Bugzilla are a complicated beast that evolved out
controls. A "bitmask" is a fixed-length number whose value can describe one, and of very simple user permission bitmasks, apparently itself
only one, set of states. For instance, UNIX file permissions are assigned bitmask derived from common concepts in UNIX access controls. A
values: "execute" has a value of 1, "write" has a value of 2, "bitmask" is a fixed-length number whose value can describe
and "read" has a value of 4. Add them together, one, and only one, set of states. For instance, UNIX file
and a file can be read, written to, and executed if it has a bitmask of "7". (This permissions are assigned bitmask values: "execute" has a
is a simplified example -- anybody who knows UNIX security knows there is much value of 1, "write" has a value of 2, and "read" has a
more to it than this. Please bear with me for the purpose of this note.) The only value of 4. Add them together, and a file can be read,
way a bitmask scheme can work is by doubling the bit count for each value. Thus written to, and executed if it has a bitmask of "7". (This
if UNIX wanted to offer another file permission, the next would have to be a value of is a simplified example -- anybody who knows UNIX security
8, then the next 16, the next 32, etc. knows there is much more to it than this. Please bear with
</PARA> me for the purpose of this note.) The only way a bitmask
<PARA> scheme can work is by doubling the bit count for each value.
Similarly, Bugzilla offers a bitmask to define group permissions, with an internal Thus if UNIX wanted to offer another file permission, the
limit of 64. Several are already occupied next would have to be a value of 8, then the next 16, the
by built-in permissions. The way around this limitation is next 32, etc.
to avoid assigning groups to products if you have many products, avoid bloating </para>
of group lists, and religiously prune irrelevant groups. In reality, most installations <para>
of Bugzilla support far fewer than 64 groups, so this limitation has not hit Similarly, Bugzilla offers a bitmask to define group
for most sites, but it is on the table to be revised for Bugzilla 3.0 permissions, with an internal limit of 64. Several are
because it interferes with the security schemes of some administrators. already occupied by built-in permissions. The way around
</PARA> this limitation is to avoid assigning groups to products if
</NOTE> you have many products, avoid bloating of group lists, and
<PARA> religiously prune irrelevant groups. In reality, most
installations of Bugzilla support far fewer than 64 groups,
so this limitation has not hit for most sites, but it is on
the table to be revised for Bugzilla 3.0 because it
interferes with the security schemes of some administrators.
</para>
</note>
<para>
To enable Generic Group Security ("usebuggroups"): To enable Generic Group Security ("usebuggroups"):
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Turn "On" "usebuggroups" in the "Edit Parameters" screen. Turn "On" "usebuggroups" in the "Edit Parameters" screen.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
You will generally have no groups set up. Select the "groups" link You will generally have no groups set up. Select the
in the footer. "groups" link in the footer.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Take a moment to understand the instructions on the "Edit Groups" screen. Take a moment to understand the instructions on the "Edit
Once you feel confident you understand what is expected of you, select the Groups" screen. Once you feel confident you understand
"Add Group" link. what is expected of you, select the "Add Group" link.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Fill out the "New Name" (remember, no spaces!), "New Description", and "New Fill out the "New Name" (remember, no spaces!), "New
User RegExp" fields. "New User RegExp" allows you to automatically place Description", and "New User RegExp" fields. "New User
all users who fulfill the Regular Expression into the new group. RegExp" allows you to automatically place all users who
fulfill the Regular Expression into the new group.
<EXAMPLE> <example>
<TITLE>Creating a New Group</TITLE> <title>Creating a New Group</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
I created a group called "DefaultGroup" with a description of "This is simply I created a group called DefaultGroup with a
a group to play with", and a "New User RegExp" of "*@velio.com". This description of <quote>This is simply a group to play
new group automatically includes all Bugzilla users with "@velio.com" at the with</quote>, and a New User RegExp of <quote>.*@mydomain.tld</quote>.
end of their user id. When I finished, my new group was assigned bit #128. This new group automatically includes all Bugzilla
</PARA> users with "@mydomain.tld" at the end of their user id.
</INFORMALEXAMPLE> When I finished, my new group was assigned bit #128.
</EXAMPLE> </para>
</informalexample>
When you have finished, select the "Add" button. </example> When you have finished, select the Add
</PARA> button.
</LISTITEM> </para>
</ORDEREDLIST> </listitem>
</orderedlist>
<PARA> <para>
To enable Product-Based Group Security ("usebuggroupsentry"): To enable Product-Based Group Security (usebuggroupsentry):
</PARA> </para>
<WARNING> <warning>
<PARA> <para>
Don't forget that you only have 64 groups masks available, total, for Don't forget that you only have 64 groups masks available,
your installation of Bugzilla! If you plan on having more than 50 total, for your installation of Bugzilla! If you plan on
products in your individual Bugzilla installation, and require group having more than 50 products in your individual Bugzilla
security for your products, you should installation, and require group security for your products,
consider either running multiple Bugzillas or using Generic Group Security you should consider either running multiple Bugzillas or
instead of Product-Based ("usebuggroupsentry") Group Security. using Generic Group Security instead of Product-Based
</PARA> ("usebuggroupsentry") Group Security.
</WARNING> </para>
<ORDEREDLIST> </warning>
<LISTITEM> <orderedlist>
<PARA> <listitem>
Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. <para>
</PARA> Turn "On" "usebuggroups" and "usebuggroupsentry" in the
<WARNING> "Edit Parameters" screen.
<PARA> </para>
"usebuggroupsentry" has the capacity to prevent the administrative user <warning>
from directly altering bugs because of conflicting group permissions. <para>
If you plan on using "usebuggroupsentry", you should plan on restricting administrative "usebuggroupsentry" has the capacity to prevent the
account usage to administrative duties only. administrative user from directly altering bugs because
In other words, manage bugs with an unpriveleged user account, and of conflicting group permissions. If you plan on using
manage users, groups, Products, etc. with the administrative account. "usebuggroupsentry", you should plan on restricting
</PARA> administrative account usage to administrative duties
</WARNING> only. In other words, manage bugs with an unpriveleged
</LISTITEM> user account, and manage users, groups, Products, etc.
<LISTITEM> with the administrative account.
<PARA> </para>
You will generally have no Groups set up, unless you enabled "usebuggroupsentry" </warning>
prior to creating any Products. To create "Generic Group Security" groups, </listitem>
follow the instructions given above. To create Product-Based Group security, <listitem>
simply follow the instructions for creating a new Product. If you need to <para>
add users to these new groups as you create them, you will find the option You will generally have no Groups set up, unless you
to add them to the group available under the "Edit User" screens. enabled "usebuggroupsentry" prior to creating any
</PARA> Products. To create "Generic Group Security" groups,
</LISTITEM> follow the instructions given above. To create
</ORDEREDLIST> Product-Based Group security, simply follow the
</SECTION> instructions for creating a new Product. If you need to
</SECTION> add users to these new groups as you create them, you will
find the option to add them to the group available under
the "Edit User" screens.
</para>
</listitem>
</orderedlist>
</section>
</section>
<SECTION id="security"> <section id="security">
<TITLE>Bugzilla Security</TITLE> <title>Bugzilla Security</title>
<EPIGRAPH> <epigraph>
<PARA> <para>
Putting your money in a wall safe is better protection than depending on the fact that Putting your money in a wall safe is better protection than
no one knows that you hide your money in a mayonnaise jar in your fridge. depending on the fact that no one knows that you hide your
</PARA> money in a mayonnaise jar in your fridge.
</EPIGRAPH> </para>
<NOTE> </epigraph>
<PARA> <note>
Poorly-configured MySQL, Bugzilla, and FTP installations have given attackers full <para>
access to systems in the past. Please take these guidelines seriously, even Poorly-configured MySQL, Bugzilla, and FTP installations have
for Bugzilla machines hidden away behind your firewall. 80% of all computer given attackers full access to systems in the past. Please
take these guidelines seriously, even for Bugzilla machines
hidden away behind your firewall. 80% of all computer
trespassers are insiders, not anonymous crackers. trespassers are insiders, not anonymous crackers.
</PARA> </para>
</NOTE> </note>
<PARA> <para>
First thing's first: Secure your installation. Secure your installation.
<NOTE> <note>
<PARA> <para>
These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different These instructions must, of necessity, be somewhat vague
platforms. If you have refinements of these directions for specific platforms, please since Bugzilla runs on so many different platforms. If you
submit them to <ULINK URL="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ULINK> have refinements of these directions for specific platforms,
</PARA> please submit them to <ulink url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ulink>
</NOTE> </para>
<ORDEREDLIST> </note>
<LISTITEM> <orderedlist>
<PARA> <listitem>
Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had <para>
notable security holes and poorly secured default configuration choices. Ensure you are running at least MysQL version 3.22.32 or
</PARA> newer. Earlier versions had notable security holes and
</LISTITEM> poorly secured default configuration choices.
<LISTITEM> </para>
<PARA><EMPHASIS>There is no substitute for understanding the tools on your system!</EMPHASIS> </listitem>
Read <ULINK URL="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> <listitem>
The MySQL Privelege System</ULINK> until you can recite it from memory!</PARA> <para><emphasis>There is no substitute for understanding the
<PARA> tools on your system!</emphasis> Read <ulink url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> The MySQL Privilege System</ulink> until you can recite it from memory!</para>
At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant <para>
table rights (consult the Keystone guide in Appendix C: The Bugzilla Database for some easy-to-use details) At the very least, ensure you password the "mysql -u root"
that do not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone account and the "bugs" account, establish grant table
advice back when I knew far less about security than I do now : ) rights (consult the Keystone guide in Appendix C: The
</PARA> Bugzilla Database for some easy-to-use details) that do
</LISTITEM> not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for
<LISTITEM> user "bugs". I wrote up the Keystone advice back when I
<PARA> knew far less about security than I do now : )
Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to </para>
port 25 for Sendmail </listitem>
<listitem>
<para>
Lock down /etc/inetd.conf. Heck, disable inet entirely on
this box. It should only listen to port 25 for Sendmail
and port 80 for Apache. and port 80 for Apache.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA>Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories. <para>
Run it, instead, as a user with a name, set via your httpd.conf file.</PARA> Do not run Apache as <quote>nobody</quote>. This will
</LISTITEM> require very lax permissions in your Bugzilla directories.
<LISTITEM> Run it, instead, as a user with a name, set via your
<PARA> httpd.conf file.
Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and <note>
$BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig and <para>
$BUGZILLA_HOME/globals.pl files. <quote>nobody</quote> is a real user on UNIX systems.
The localconfig file stores your "bugs" user password, Having a process run as user id <quote>nobody</quote>
which would be terrible to have in the hands is absolutely no protection against system crackers
of a criminal, while the "globals.pl" stores some default information regarding your versus using any other user account. As a general
installation which could aid a system cracker. security measure, I recommend you create unique user
In addition, some files under $BUGZILLA_HOME/data/ store sensitive information, and ID's for each daemon running on your system and, if
$BUGZILLA_HOME/shadow/ stores bug information for faster retrieval. If you fail to secure possible, use "chroot" to jail that process away from
these directories and this file, you will expose bug information to those who may not the rest of your system.
be allowed to see it. </para>
</PARA> </note>
<NOTE> </para>
<PARA> </listitem>
Bugzilla provides default .htaccess files to protect the most common Apache <listitem>
installations. However, you should verify these are adequate according to the site-wide <para>
security policy of your web server, and ensure that the .htaccess files are Ensure you have adequate access controls for the
allowed to "override" default permissions set in your Apache configuration files. $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/
Covering Apache security is beyond the scope of this Guide; please consult the Apache directories, as well as the $BUGZILLA_HOME/localconfig and
documentation for details. $BUGZILLA_HOME/globals.pl files. The localconfig file
</PARA> stores your "bugs" user password, which would be terrible
<PARA> to have in the hands of a criminal, while the "globals.pl"
If you are using a web server that does not support the .htaccess control method, stores some default information regarding your
<EMPHASIS>you are at risk!</EMPHASIS> After installing, check to see if you can installation which could aid a system cracker. In
view the file "localconfig" in your web browser (ergo: addition, some files under $BUGZILLA_HOME/data/ store
<ULINK URL="http://bugzilla.mozilla.org/localconfig"> sensitive information, and $BUGZILLA_HOME/shadow/ stores
http://bugzilla.mozilla.org/localconfig</ULINK>. If you can read the contents of this bug information for faster retrieval. If you fail to
file, your web server has not secured your bugzilla directory properly and you secure these directories and this file, you will expose
must fix this problem before deploying Bugzilla. If, however, it gives you a bug information to those who may not be allowed to see it.
"Forbidden" error, then it probably respects the .htaccess conventions and you </para>
are good to go. <note>
</PARA> <para>
</NOTE> Bugzilla provides default .htaccess files to protect the
<PARA> most common Apache installations. However, you should
On Apache, you can use .htaccess files to protect access to these directories, as outlined verify these are adequate according to the site-wide
in <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ULINK> for the security policy of your web server, and ensure that the
localconfig file, and <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> .htaccess files are allowed to "override" default
Bug 65572</ULINK> for adequate protection in your data/ and shadow/ directories. permissions set in your Apache configuration files.
</PARA> Covering Apache security is beyond the scope of this
<PARA> Guide; please consult the Apache documentation for
Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other details.
non-Apache web servers, please consult your system documentation for how to secure these </para>
files from being transmitted to curious users. <para>
</PARA> If you are using a web server that does not support the
<PARA> .htaccess control method, <emphasis>you are at
Place the following text into a file named ".htaccess", readable by your web server, risk!</emphasis> After installing, check to see if
in your $BUGZILLA_HOME/data directory. you can view the file "localconfig" in your web browser
<LITERALLAYOUT> (e.g.: <ulink url="http://bugzilla.mozilla.org/localconfig"> http://bugzilla.mozilla.org/localconfig</ulink>). If you can read the contents of this file, your web server has not secured your bugzilla directory properly and you must fix this problem before deploying Bugzilla. If, however, it gives you a "Forbidden" error, then it probably respects the .htaccess conventions and you are good to go.
&lt;Files comments&gt; </para>
allow from all </note>
&lt;/Files&gt; <para>
deny from all On Apache, you can use .htaccess files to protect access
</LITERALLAYOUT> to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories.
</PARA> </para>
<PARA> <para>
Place the following text into a file named ".htaccess", readable by your web server, Note the instructions which follow are Apache-specific.
in your $BUGZILLA_HOME/ directory. If you use IIS, Netscape, or other non-Apache web servers,
<LITERALLAYOUT> please consult your system documentation for how to secure
&lt;Files localconfig&gt; these files from being transmitted to curious users.
deny from all </para>
&lt;/Files&gt; <para>
allow from all Place the following text into a file named ".htaccess",
</LITERALLAYOUT> readable by your web server, in your $BUGZILLA_HOME/data
</PARA> directory. <literallayout> &lt;Files comments&gt; allow
<PARA> from all &lt;/Files&gt; deny from all </literallayout>
Place the following text into a file named ".htaccess", readable by your web server, </para>
in your $BUGZILLA_HOME/shadow directory. <para>
<LITERALLAYOUT> Place the following text into a file named ".htaccess",
deny from all readable by your web server, in your $BUGZILLA_HOME/
</LITERALLAYOUT> directory. <literallayout> &lt;Files localconfig&gt; deny
</PARA> from all &lt;/Files&gt; allow from all </literallayout>
</LISTITEM> </para>
</ORDEREDLIST> <para>
</PARA> Place the following text into a file named ".htaccess",
</SECTION> readable by your web server, in your $BUGZILLA_HOME/shadow
</CHAPTER> directory. <literallayout> deny from all </literallayout>
</para>
</listitem>
</orderedlist>
</para>
</section>
</chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:upper
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<section id="conventions"> <section id="conventions">
<title>Document Conventions</title> <title>Document Conventions</title>
<indexterm zone="conventions"> <indexterm zone="conventions">
<primary>conventions</primary> <primary>conventions</primary>
</indexterm> </indexterm>
<para>This document uses the following conventions:</para> <para>
This document uses the following conventions
</para>
<informaltable frame="none"> <informaltable frame="none">
<tgroup cols="2"> <tgroup cols="2">
<thead> <thead>
<row> <row>
<entry>Descriptions</entry> <entry>Descriptions</entry>
<entry>Appearance</entry> <entry>Appearance</entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry>Caution</entry> <entry>Warnings</entry>
<entry><caution>
<entry> <para>Warnings.</para>
<caution> </caution></entry>
<para>Don't run with scissors!</para>
</caution>
</entry>
</row> </row>
<row> <row>
<entry>Hint or Tip</entry> <entry>Hint</entry>
<entry><tip>
<entry> <para>Hint.</para>
<tip> </tip></entry>
<para>For best results... </para>
</tip>
</entry>
</row> </row>
<row> <row>
<entry>Note</entry> <entry>Notes</entry>
<entry><note>
<entry> <para>Note.</para>
<note> </note></entry>
<para>Dear John...</para>
</note>
</entry>
</row> </row>
<row> <row>
<entry>Warning</entry> <entry>Information requiring special attention</entry>
<entry><warning>
<entry> <para>Warning.</para>
<warning> </warning></entry>
<para>Read this or the cat gets it.</para>
</warning>
</entry>
</row> </row>
<row> <row>
<entry>File or directory name</entry> <entry>File Names</entry>
<entry><filename>file.extension</filename></entry>
<entry>
<filename>filename</filename>
</entry>
</row> </row>
<row> <row>
<entry>Command to be typed</entry> <entry>Directory Names</entry>
<entry><filename class="directory">directory</filename></entry>
<entry>
<command>command</command>
</entry>
</row> </row>
<row> <row>
<entry>Application name</entry> <entry>Commands to be typed</entry>
<entry><command>command</command></entry>
<entry>
<application>application</application>
</entry>
</row> </row>
<row> <row>
<entry> <entry>Applications Names</entry>
Normal user's prompt under bash shell</entry> <entry><application>application</application></entry>
</row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of users command under bash shell</entry>
<entry>bash$</entry> <entry>bash$</entry>
</row> </row>
<row> <row>
<entry> <entry><foreignphrase>Prompt</foreignphrase> of root users command under bash shell</entry>
Root user's prompt under bash shell</entry>
<entry>bash#</entry> <entry>bash#</entry>
</row> </row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row> <row>
<entry> <entry>Environment Variables</entry>
Normal user's prompt under tcsh shell</entry> <entry><envar>VARIABLE</envar></entry>
<entry>tcsh$</entry>
</row> </row>
<row> <row>
<entry>Environment variables</entry> <entry>Emphasized word</entry>
<entry><emphasis>word</emphasis></entry>
<entry>
<envar>VARIABLE</envar>
</entry>
</row> </row>
<row> <row>
<entry>Term found in the glossary</entry> <entry>Code Example</entry>
<entry><programlisting><sgmltag class="starttag">para</sgmltag>Beginning and end of paragraph<sgmltag class="endtag">para</sgmltag></programlisting></entry>
<entry>
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
</entry>
</row>
<row>
<entry>Code example</entry>
<entry>
<programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the &bzg-bugs; component.
</para>
</section> </section>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -156,9 +109,8 @@ sgml-local-ecat-files:nil ...@@ -156,9 +109,8 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) --> <!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" --> <!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- section>
<!-- sect1>
<title>GNU Free Documentation License</title --> <title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
<para>Version 1.1, March 2000</para>
<blockquote>
<para>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place, <blockquote>
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and <para>Copyright (C) 2000 Free Software Foundation, Inc.
distribute verbatim copies of this license document, but changing it is 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
not allowed.</para> Everyone is permitted to copy and distribute verbatim copies
</blockquote> of this license document, but changing it is not allowed.</para>
</blockquote>
<section label="0" id="gfdl-0">
<title>Preamble</title> <sect1 label="0" id="gfdl_0">
<title>PREAMBLE</title>
<para>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 <para>The purpose of this License is to make a manual, textbook,
effective freedom to copy and redistribute it, with or without modifying or other written document "free" in the sense of freedom: to
it, either commercially or noncommercially. Secondarily, this License assure everyone the effective freedom to copy and redistribute it,
preserves for the author and publisher a way to get credit for their with or without modifying it, either commercially or
work, while not being considered responsible for modifications made by 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.</para> others.</para>
<para>This License is a kind of "copyleft", which means that derivative <para>This License is a kind of "copyleft", which means that
works of the document must themselves be free in the same sense. It derivative works of the document must themselves be free in the
complements the GNU General Public License, which is a copyleft license same sense. It complements the GNU General Public License, which
designed for free software.</para> is a copyleft license designed for free software.</para>
<para>We have designed this License in order to use it for manuals for <para>We have designed this License in order to use it for manuals
free software, because free software needs free documentation: a free for free software, because free software needs free documentation:
program should come with manuals providing the same freedoms that the a free program should come with manuals providing the same
software does. But this License is not limited to software manuals; it freedoms that the software does. But this License is not limited
can be used for any textual work, regardless of subject matter or whether to software manuals; it can be used for any textual work,
it is published as a printed book. We recommend this License principally regardless of subject matter or whether it is published as a
for works whose purpose is instruction or reference.</para> printed book. We recommend this License principally for works
</section> whose purpose is instruction or reference.</para>
</sect1>
<section label="1" id="gfdl-1">
<title>Applicability and Definition</title> <sect1 label="1" id="gfdl_1">
<title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed under <para>This License applies to any manual or other work that
the terms of this License. The "Document", below, refers to any such contains a notice placed by the copyright holder saying it can be
manual or work. Any member of the public is a licensee, and is addressed distributed under the terms of this License. The "Document",
as "you".</para> below, refers to any such manual or work. Any member of the
public is a licensee, and is addressed as "you".</para>
<para>A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with <para>A "Modified Version" of the Document means any work
modifications and/or translated into another language.</para> containing the Document or a portion of it, either copied
verbatim, or with modifications and/or translated into another
<para>A "Secondary Section" is a named appendix or a front-matter section language.</para>
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject <para>A "Secondary Section" is a named appendix or a front-matter
(or to related matters) and contains nothing that could fall directly section of the Document that deals exclusively with the
within that overall subject. (For example, if the Document is in part a relationship of the publishers or authors of the Document to the
textbook of mathematics, a Secondary Section may not explain any Document's overall subject (or to related matters) and contains
mathematics.) The relationship could be a matter of historical connection nothing that could fall directly within that overall subject.
with the subject or with related matters, or of legal, commercial, (For example, if the Document is in part a textbook of
philosophical, ethical or political position regarding them.</para> mathematics, a Secondary Section may not explain any mathematics.)
The relationship could be a matter of historical connection with
<para>The "Invariant Sections" are certain Secondary Sections whose the subject or with related matters, or of legal, commercial,
titles are designated, as being those of Invariant Sections, in the philosophical, ethical or political position regarding
notice that says that the Document is released under this License.</para> them.</para>
<para>The "Cover Texts" are certain short passages of text that are <para>The "Invariant Sections" are certain Secondary Sections
listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says whose titles are designated, as being those of Invariant Sections,
that the Document is released under this License.</para> in the notice that says that the Document is released under this
License.</para>
<para>A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the general <para>The "Cover Texts" are certain short passages of text that
public, whose contents can be viewed and edited directly and are listed, as Front-Cover Texts or Back-Cover Texts, in the
straightforwardly with generic text editors or (for images composed of notice that says that the Document is released under this
pixels) generic paint programs or (for drawings) some widely available License.</para>
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 <para>A "Transparent" copy of the Document means a
formatters. A copy made in an otherwise Transparent file format whose machine-readable copy, represented in a format whose specification
markup has been designed to thwart or discourage subsequent modification is available to the general public, whose contents can be viewed
by readers is not Transparent. A copy that is not "Transparent" is called and edited directly and straightforwardly with generic text
"Opaque".</para> editors or (for images composed of pixels) generic paint programs
or (for drawings) some widely available drawing editor, and that
<para>Examples of suitable formats for Transparent copies include plain is suitable for input to text formatters or for automatic
ASCII without markup, Texinfo input format, LaTeX input format, SGML or translation to a variety of formats suitable for input to text
XML using a publicly available DTD, and standard-conforming simple HTML formatters. A copy made in an otherwise Transparent file format
designed for human modification. Opaque formats include PostScript, PDF, whose markup has been designed to thwart or discourage subsequent
proprietary formats that can be read and edited only by proprietary word modification by readers is not Transparent. A copy that is not
processors, SGML or XML for which the DTD and/or processing tools are not "Transparent" is called "Opaque".</para>
generally available, and the machine-generated HTML produced by some word
<para>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.</para> processors for output purposes only.</para>
<para>The "Title Page" means, for a printed book, the title page itself, <para>The "Title Page" means, for a printed book, the title page
plus such following pages as are needed to hold, legibly, the material itself, plus such following pages as are needed to hold, legibly,
this License requires to appear in the title page. For works in formats the material this License requires to appear in the title page.
which do not have any title page as such, "Title Page" means the text For works in formats which do not have any title page as such,
near the most prominent appearance of the work's title, preceding the "Title Page" means the text near the most prominent appearance of
beginning of the body of the text.</para> the work's title, preceding the beginning of the body of the
</section> text.</para>
</sect1>
<section label="2" id="gfdl-2">
<title>Verbatim Copying</title> <sect1 label="2" id="gfdl_2">
<title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the <para>You may copy and distribute the Document in any medium,
copyright notices, and the license notice saying this License applies to either commercially or noncommercially, provided that this
the Document are reproduced in all copies, and that you add no other License, the copyright notices, and the license notice saying this
conditions whatsoever to those of this License. You may not use technical License applies to the Document are reproduced in all copies, and
measures to obstruct or control the reading or further copying of the that you add no other conditions whatsoever to those of this
copies you make or distribute. However, you may accept compensation in License. You may not use technical measures to obstruct or
exchange for copies. If you distribute a large enough number of copies control the reading or further copying of the copies you make or
you must also follow the conditions in section 3.</para> distribute. However, you may accept compensation in exchange for
copies. If you distribute a large enough number of copies you
<para>You may also lend copies, under the same conditions stated above, must also follow the conditions in section 3.</para>
and you may publicly display copies.</para>
</section> <para>You may also lend copies, under the same conditions stated
above, and you may publicly display copies.</para>
<section label="3" id="gfdl-3"> </sect1>
<title>Copying in Quantity</title>
<sect1 label="3" id="gfdl_3">
<para>If you publish printed copies of the Document numbering more than <title>COPYING IN QUANTITY</title>
100, and the Document's license notice requires Cover Texts, you must
enclose the copies in covers that carry, clearly and legibly, all these <para>If you publish printed copies of the Document numbering more
Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts than 100, and the Document's license notice requires Cover Texts,
on the back cover. Both covers must also clearly and legibly identify you you must enclose the copies in covers that carry, clearly and
as the publisher of these copies. The front cover must present the full legibly, all these Cover Texts: Front-Cover Texts on the front
title with all words of the title equally prominent and visible. You may cover, and Back-Cover Texts on the back cover. Both covers must
add other material on the covers in addition. Copying with changes also clearly and legibly identify you as the publisher of these
limited to the covers, as long as they preserve the title of the Document copies. The front cover must present the full title with all
and satisfy these conditions, can be treated as verbatim copying in other words of the title equally prominent and visible. You may add
respects.</para> other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the
<para>If the required texts for either cover are too voluminous to fit Document and satisfy these conditions, can be treated as verbatim
legibly, you should put the first ones listed (as many as fit reasonably) copying in other respects.</para>
on the actual cover, and continue the rest onto adjacent pages.</para>
<para>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.</para>
<para>If you publish or distribute Opaque copies of the Document <para>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a machine-readable numbering more than 100, you must either include a
Transparent copy along with each Opaque copy, or state in or with each machine-readable Transparent copy along with each Opaque copy, or
Opaque copy a publicly-accessible computer-network location containing a state in or with each Opaque copy a publicly-accessible
complete Transparent copy of the Document, free of added material, which computer-network location containing a complete Transparent copy
the general network-using public has access to download anonymously at no of the Document, free of added material, which the general
charge using public-standard network protocols. If you use the latter network-using public has access to download anonymously at no
option, you must take reasonably prudent steps, when you begin charge using public-standard network protocols. If you use the
distribution of Opaque copies in quantity, to ensure that this latter option, you must take reasonably prudent steps, when you
Transparent copy will remain thus accessible at the stated location until begin distribution of Opaque copies in quantity, to ensure that
at least one year after the last time you distribute an Opaque copy this Transparent copy will remain thus accessible at the stated
(directly or through your agents or retailers) of that edition to the location until at least one year after the last time you
public.</para> distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.</para>
<para>It is requested, but not required, that you contact the authors of
the Document well before redistributing any large number of copies, to <para>It is requested, but not required, that you contact the
give them a chance to provide you with an updated version of the authors of the Document well before redistributing any large
Document.</para> number of copies, to give them a chance to provide you with an
</section> updated version of the Document.</para>
</sect1>
<section label="4" id="gfdl-4">
<title>Modifications</title> <sect1 label="4" id="gfdl_4">
<title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you release <para>You may copy and distribute a Modified Version of the
the Modified Version under precisely this License, with the Modified Document under the conditions of sections 2 and 3 above, provided
Version filling the role of the Document, thus licensing distribution and that you release the Modified Version under precisely this
modification of the Modified Version to whoever possesses a copy of it. License, with the Modified Version filling the role of the
In addition, you must do these things in the Modified Version:</para> 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:</para>
<orderedlist numeration="upperalpha"> <orderedlist numeration="upperalpha">
<listitem> <listitem><para>Use in the Title Page
<para>Use in the Title Page (and on the covers, if any) a title (and on the covers, if any) a title distinct from that of the
distinct from that of the Document, and from those of previous Document, and from those of previous versions (which should, if
versions (which should, if there were any, be listed in the History there were any, be listed in the History section of the
section of the Document). You may use the same title as a previous Document). You may use the same title as a previous version if
version if the original publisher of that version gives the original publisher of that version gives permission.</para>
permission.</para>
</listitem> </listitem>
<listitem> <listitem><para>List on the Title Page,
<para>List on the Title Page, as authors, one or more persons or as authors, one or more persons or entities responsible for
entities responsible for authorship of the modifications in the authorship of the modifications in the Modified Version,
Modified Version, together with at least five of the principal together with at least five of the principal authors of the
authors of the Document (all of its principal authors, if it has less Document (all of its principal authors, if it has less than
than five).</para> five).</para>
</listitem> </listitem>
<listitem> <listitem><para>State on the Title page
<para>State on the Title page the name of the publisher of the the name of the publisher of the Modified Version, as the
Modified Version, as the publisher.</para> publisher.</para>
</listitem> </listitem>
<listitem> <listitem><para>Preserve all the
<para>Preserve all the copyright notices of the Document.</para> copyright notices of the Document.</para>
</listitem> </listitem>
<listitem> <listitem><para>Add an appropriate
<para>Add an appropriate copyright notice for your modifications copyright notice for your modifications adjacent to the other
adjacent to the other copyright notices.</para> copyright notices.</para>
</listitem> </listitem>
<listitem> <listitem><para>Include, immediately
<para>Include, immediately after the copyright notices, a license after the copyright notices, a license notice giving the public
notice giving the public permission to use the Modified Version under permission to use the Modified Version under the terms of this
the terms of this License, in the form shown in the Addendum License, in the form shown in the Addendum below.</para>
below.</para>
</listitem> </listitem>
<listitem> <listitem><para>Preserve in that license
<para>Preserve in that license notice the full lists of Invariant notice the full lists of Invariant Sections and required Cover
Sections and required Cover Texts given in the Document's license Texts given in the Document's license notice.</para>
notice.</para>
</listitem> </listitem>
<listitem> <listitem><para>Include an unaltered
<para>Include an unaltered copy of this License.</para> copy of this License.</para>
</listitem> </listitem>
<listitem> <listitem><para>Preserve the section
<para>Preserve the section entitled "History", and its title, and add entitled "History", and its title, and add to it an item stating
to it an item stating at least the title, year, new authors, and at least the title, year, new authors, and publisher of the
publisher of the Modified Version as given on the Title Page. If Modified Version as given on the Title Page. If there is no
there is no section entitled "History" in the Document, create one section entitled "History" in the Document, create one stating
stating the title, year, authors, and publisher of the Document as the title, year, authors, and publisher of the Document as given
given on its Title Page, then add an item describing the Modified on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.</para> Version as stated in the previous sentence.</para>
</listitem> </listitem>
<listitem> <listitem><para>Preserve the network
<para>Preserve the network location, if any, given in the Document location, if any, given in the Document for public access to a
for public access to a Transparent copy of the Document, and likewise Transparent copy of the Document, and likewise the network
the network locations given in the Document for previous versions it locations given in the Document for previous versions it was
was based on. These may be placed in the "History" section. You may based on. These may be placed in the "History" section. You
omit a network location for a work that was published at least four may omit a network location for a work that was published at
years before the Document itself, or if the original publisher of the least four years before the Document itself, or if the original
version it refers to gives permission.</para> publisher of the version it refers to gives permission.</para>
</listitem> </listitem>
<listitem> <listitem><para>In any section entitled
<para>In any section entitled "Acknowledgements" or "Dedications", "Acknowledgements" or "Dedications", preserve the section's
preserve the section's title, and preserve in the section all the title, and preserve in the section all the substance and tone of
substance and tone of each of the contributor acknowledgements and/or each of the contributor acknowledgements and/or dedications
dedications given therein.</para> given therein.</para>
</listitem> </listitem>
<listitem> <listitem><para>Preserve all the
<para>Preserve all the Invariant Sections of the Document, unaltered Invariant Sections of the Document, unaltered in their text and
in their text and in their titles. Section numbers or the equivalent in their titles. Section numbers or the equivalent are not
are not considered part of the section titles.</para> considered part of the section titles.</para>
</listitem> </listitem>
<listitem> <listitem><para>Delete any section
<para>Delete any section entitled "Endorsements". Such a section may entitled "Endorsements". Such a section may not be included in
not be included in the Modified Version.</para> the Modified Version.</para>
</listitem> </listitem>
<listitem> <listitem><para>Do not retitle any
<para>Do not retitle any existing section as "Endorsements" or to existing section as "Endorsements" or to conflict in title with
conflict in title with any Invariant Section.</para> any Invariant Section.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>If the Modified Version includes new front-matter sections or <para>If the Modified Version includes new front-matter sections
appendices that qualify as Secondary Sections and contain no material or appendices that qualify as Secondary Sections and contain no
copied from the Document, you may at your option designate some or all of material copied from the Document, you may at your option
these sections as invariant. To do this, add their titles to the list of designate some or all of these sections as invariant. To do this,
Invariant Sections in the Modified Version's license notice. These titles add their titles to the list of Invariant Sections in the Modified
must be distinct from any other section titles.</para> Version's license notice. These titles must be distinct from any
other section titles.</para>
<para>You may add a section entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various parties--for <para>You may add a section entitled "Endorsements", provided it
example, statements of peer review or that the text has been approved by contains nothing but endorsements of your Modified Version by
an organization as the authoritative definition of a standard.</para> various parties--for example, statements of peer review or that
the text has been approved by an organization as the authoritative
<para>You may add a passage of up to five words as a Front-Cover Text, definition of a standard.</para>
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 <para>You may add a passage of up to five words as a Front-Cover
Front-Cover Text and one of Back-Cover Text may be added by (or through Text, and a passage of up to 25 words as a Back-Cover Text, to the
arrangements made by) any one entity. If the Document already includes a end of the list of Cover Texts in the Modified Version. Only one
cover text for the same cover, previously added by you or by arrangement passage of Front-Cover Text and one of Back-Cover Text may be
made by the same entity you are acting on behalf of, you may not add added by (or through arrangements made by) any one entity. If the
another; but you may replace the old one, on explicit permission from the Document already includes a cover text for the same cover,
previous publisher that added the old one.</para> 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
<para>The author(s) and publisher(s) of the Document do not by this replace the old one, on explicit permission from the previous
License give permission to use their names for publicity for or to assert publisher that added the old one.</para>
or imply endorsement of any Modified Version.</para>
</section> <para>The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for
<section label="5" id="gfdl-5"> or to assert or imply endorsement of any Modified Version.</para>
<title>Combining Documents</title> </sect1>
<para>You may combine the Document with other documents released under <sect1 label="5" id="gfdl_5">
this License, under the terms defined in section 4 above for modified <title>COMBINING DOCUMENTS</title>
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and list <para>You may combine the Document with other documents released
them all as Invariant Sections of your combined work in its license under this License, under the terms defined in section 4 above for
notice.</para> modified versions, provided that you include in the combination
all of the Invariant Sections of all of the original documents,
<para>The combined work need only contain one copy of this License, and unmodified, and list them all as Invariant Sections of your
multiple identical Invariant Sections may be replaced with a single copy. combined work in its license notice.</para>
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 <para>The combined work need only contain one copy of this
of it, in parentheses, the name of the original author or publisher of License, and multiple identical Invariant Sections may be replaced
that section if known, or else a unique number. Make the same adjustment with a single copy. If there are multiple Invariant Sections with
to the section titles in the list of Invariant Sections in the license the same name but different contents, make the title of each such
notice of the combined work.</para> 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.</para>
<para>In the combination, you must combine any sections entitled <para>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section entitled "History" in the various original documents, forming one section
"History"; likewise combine any sections entitled "Acknowledgements", and entitled "History"; likewise combine any sections entitled
any sections entitled "Dedications". You must delete all sections "Acknowledgements", and any sections entitled "Dedications". You
entitled "Endorsements."</para> must delete all sections entitled "Endorsements."</para>
</section> </sect1>
<section label="6" id="gfdl-6"> <sect1 label="6" id="gfdl_6">
<title>Collections of Documents</title> <title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and other <para>You may make a collection consisting of the Document and
documents released under this License, and replace the individual copies other documents released under this License, and replace the
of this License in the various documents with a single copy that is individual copies of this License in the various documents with a
included in the collection, provided that you follow the rules of this single copy that is included in the collection, provided that you
License for verbatim copying of each of the documents in all other follow the rules of this License for verbatim copying of each of
respects.</para> the documents in all other respects.</para>
<para>You may extract a single document from such a collection, and <para>You may extract a single document from such a collection,
distribute it individually under this License, provided you insert a copy and distribute it individually under this License, provided you
of this License into the extracted document, and follow this License in insert a copy of this License into the extracted document, and
all other respects regarding verbatim copying of that document.</para> follow this License in all other respects regarding verbatim
</section> copying of that document.</para>
</sect1>
<section label="7" id="gfdl-7">
<title>Aggregation with Independent Works</title> <sect1 label="7" id="gfdl_7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other <para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of a separate and independent documents or works, in or on a volume of
storage or distribution medium, does not as a whole count as a Modified a storage or distribution medium, does not as a whole count as a
Version of the Document, provided no compilation copyright is claimed for Modified Version of the Document, provided no compilation
the compilation. Such a compilation is called an "aggregate", and this copyright is claimed for the compilation. Such a compilation is
License does not apply to the other self-contained works thus compiled called an "aggregate", and this License does not apply to the
with the Document, on account of their being thus compiled, if they are other self-contained works thus compiled with the Document, on
not themselves derivative works of the Document.</para> account of their being thus compiled, if they are not themselves
derivative works of the Document.</para>
<para>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 <para>If the Cover Text requirement of section 3 is applicable to
the entire aggregate, the Document's Cover Texts may be placed on covers these copies of the Document, then if the Document is less than
that surround only the Document within the aggregate. Otherwise they must one quarter of the entire aggregate, the Document's Cover Texts
appear on covers around the whole aggregate.</para> may be placed on covers that surround only the Document within the
</section> aggregate. Otherwise they must appear on covers around the whole
aggregate.</para>
<section label="8" id="gfdl-8"> </sect1>
<title>Translation</title>
<sect1 label="8" id="gfdl_8">
<title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may <para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4. distribute translations of the Document under the terms of section
Replacing Invariant Sections with translations requires special 4. Replacing Invariant Sections with translations requires
permission from their copyright holders, but you may include translations special permission from their copyright holders, but you may
of some or all Invariant Sections in addition to the original versions of include translations of some or all Invariant Sections in addition
these Invariant Sections. You may include a translation of this License to the original versions of these Invariant Sections. You may
provided that you also include the original English version of this include a translation of this License provided that you also
License. In case of a disagreement between the translation and the include the original English version of this License. In case of
original English version of this License, the original English version a disagreement between the translation and the original English
will prevail.</para> version of this License, the original English version will
</section> prevail.</para>
</sect1>
<section label="9" id="gfdl-9">
<title>Termination</title> <sect1 label="9" id="gfdl_9">
<title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided for under this License. Any other attempt to <para>You may not copy, modify, sublicense, or distribute the
copy, modify, sublicense or distribute the Document is void, and will Document except as expressly provided for under this License. Any
automatically terminate your rights under this License. However, parties other attempt to copy, modify, sublicense or distribute the
who have received copies, or rights, from you under this License will not Document is void, and will automatically terminate your rights
have their licenses terminated so long as such parties remain in full 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.</para> compliance.</para>
</section> </sect1>
<section label="10" id="gfdl-10"> <sect1 label="10" id="gfdl_10">
<title>Future Revisions of this License</title> <title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised versions of <para>The Free Software Foundation may publish new, revised
the GNU Free Documentation License from time to time. Such new versions versions of the GNU Free Documentation License from time to time.
will be similar in spirit to the present version, but may differ in Such new versions will be similar in spirit to the present
detail to address new problems or concerns. See version, but may differ in detail to address new problems or
<ulink url="http://www.gnu.org/copyleft/"/>.</para> concerns. See <ulink
url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
<para>Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version of <para>Each version of the License is given a distinguishing
this License "or any later version" applies to it, you have the option of version number. If the Document specifies that a particular
following the terms and conditions either of that specified version or of numbered version of this License "or any later version" applies to
any later version that has been published (not as a draft) by the Free it, you have the option of following the terms and conditions
Software Foundation. If the Document does not specify a version number of either of that specified version or of any later version that has
this License, you may choose any version ever published (not as a draft) been published (not as a draft) by the Free Software Foundation.
by the Free Software Foundation.</para> If the Document does not specify a version number of this License,
</section> you may choose any version ever published (not as a draft) by the
Free Software Foundation.</para>
<section label="" id="gfdl-howto"> </sect1>
<sect1 label="" id="gfdl_howto">
<title>How to use this License for your documents</title> <title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include a copy <para>To use this License in a document you have written, include
of the License in the document and put the following copyright and a copy of the License in the document and put the following
license notices just after the title page:</para> copyright and license notices just after the title page:</para>
<blockquote> <blockquote><para>
<para>Copyright (c) YEAR YOUR NAME. Permission is granted to copy, Copyright (c) YEAR YOUR NAME.
distribute and/or modify this document under the terms of the GNU Free Permission is granted to copy, distribute and/or modify this document
Documentation License, Version 1.1 or any later version published by under the terms of the GNU Free Documentation License, Version 1.1
the Free Software Foundation; with the Invariant Sections being LIST or any later version published by the Free Software Foundation;
THEIR TITLES, with the Front-Cover Texts being LIST, and with the with the Invariant Sections being LIST THEIR TITLES, with the
Back-Cover Texts being LIST. A copy of the license is included in the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
section entitled "GNU Free Documentation License".</para> A copy of the license is included in the section entitled "GNU
</blockquote> Free Documentation License".
</para></blockquote>
<para>If you have no Invariant Sections, write "with no Invariant <para>If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you have no Sections" instead of saying which ones are invariant. If you have
Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover no Front-Cover Texts, write "no Front-Cover Texts" instead of
Texts being LIST"; likewise for Back-Cover Texts.</para> "Front-Cover Texts being LIST"; likewise for Back-Cover
Texts.</para>
<para>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of free <para>If your document contains nontrivial examples of program
software license, such as the GNU General Public License, to permit their code, we recommend releasing these examples in parallel under your
use in free software.</para> choice of free software license, such as the GNU General Public
</section> License, to permit their use in free software.</para>
</sect1>
</appendix> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -437,9 +467,8 @@ sgml-local-ecat-files:nil ...@@ -437,9 +467,8 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<glossary id="glossary">
<glossdiv>
<title>0-9, high ascii</title>
<glossentry id="gloss-htaccess"> <glossary id="glossary">
<glossterm>.htaccess</glossterm> <glossdiv>
<title>0-9, high ascii</title>
<glossdef> <glossentry>
<para>Apache web server, and other NCSA-compliant web servers, <glossterm>.htaccess</glossterm>
observe the convention of using files in directories called <glossdef>
<filename>.htaccess</filename> <para>
Apache web server, and other NCSA-compliant web servers,
to restrict access to certain files. In Bugzilla, they are used observe the convention of using files in directories
to keep secret files which would otherwise called <filename>.htaccess</filename> files. These
compromise your installation - e.g. the restrict parameters of the web server. In Bugzilla, they
<filename>localconfig</filename> are used to restrict access to certain files which would
file contains the password to your database. otherwise compromise your installation. For instance, the
curious.</para> <filename>localconfig</filename> file contains the
</glossdef> password to your database. If this information were
</glossentry> generally available, and remote access to your database
</glossdiv> turned on, you risk corruption of your database by
computer criminals or the curious.
<glossdiv id="gloss-a"> </para>
<title>A</title> </glossdef>
</glossentry>
<glossentry id="gloss-apache"> </glossdiv>
<glossterm>Apache</glossterm>
<glossdef>
<para>In this context, Apache is the web server most commonly used
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
<quote>a patchy</quote>
version of the original
<acronym>NCSA</acronym>
world-wide-web server.</para>
<variablelist>
<title>Useful Directives when configuring Bugzilla</title>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
<listitem>
<para>Tell Apache that it's OK to run CGI scripts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
<listitem>
<para>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 <filename>.htaccess</filename>
overrides.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
<listitem>
<para>Used to tell Apache what files are indexes. If you can
not add <filename>index.cgi</filename> to the list of valid files,
you'll need to set <computeroutput>$index_html</computeroutput> to
1 in <filename>localconfig</filename> so
<command>./checksetup.pl</command> will create an
<filename>index.html</filename> that redirects to
<filename>index.cgi</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
<listitem>
<para>Used when running Apache on windows so the shebang line
doesn't have to be changed in every Bugzilla script.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>For more information about how to configure Apache for Bugzilla,
see <xref linkend="http-apache"/>.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-b">
<title>B</title>
<glossentry>
<glossterm>Bug</glossterm>
<glossdef>
<para>A
<quote>bug</quote>
in Bugzilla refers to an issue entered into the database which has an
associated number, assignments, comments, etc. Some also refer to a
<quote>tickets</quote>
or
<quote>issues</quote>;
in the context of Bugzilla, they are synonymous.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Bug Number</glossterm>
<glossdef>
<para>Each Bugzilla bug is assigned a number that uniquely identifies
that bug. The bug associated with a bug number can be pulled up via a
query, or easily from the very front page by typing the number in the
"Find" box.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-bugzilla">
<glossterm>Bugzilla</glossterm>
<glossdef>
<para>Bugzilla is the world-leading free software bug tracking system.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-c">
<title>C</title>
<glossentry id="gloss-cgi">
<glossterm>Common Gateway Interface</glossterm>
<acronym>CGI</acronym>
<glossdef>
<para><acronym>CGI</acronym> 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 <acronym>CGI</acronym> application.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-component">
<glossterm>Component</glossterm>
<glossdef>
<para>A Component is a subsection of a Product. It should be a narrow
category, tailored to your organization. All Products must contain at
least one Component (and, as a matter of fact, creating a Product
with no Components will create an error in Bugzilla).</para>
</glossdef>
</glossentry>
<glossentry id="gloss-cpan">
<glossterm>Comprehensive Perl Archive Network</glossterm>
<acronym>CPAN</acronym>
<!-- TODO: Rewrite def for CPAN -->
<glossdef>
<para>
<acronym>CPAN</acronym>
stands for the
<quote>Comprehensive Perl Archive Network</quote>.
CPAN maintains a large number of extremely useful
<glossterm>Perl</glossterm>
modules - encapsulated chunks of code for performing a
particular task.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-contrib">
<glossterm><filename class="directory">contrib</filename></glossterm>
<glossdef>
<para>The <filename class="directory">contrib</filename> directory is
a location to put scripts that have been contributed to Bugzilla but
are not a part of the official distribution. These scripts are written
by third parties and may be in languages other than perl. For those
that are in perl, there may be additional modules or other requirements
than those of the official distribution.
<note>
<para>Scripts in the <filename class="directory">contrib</filename>
directory are not officially supported by the Bugzilla team and may
break in between versions.
</para>
</note>
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-d">
<title>D</title>
<glossentry id="gloss-daemon">
<glossterm>daemon</glossterm>
<glossdef>
<para>A daemon is a computer program which runs in the background. In
general, most daemons are started at boot time via System V init
scripts, or through RC scripts on BSD-based systems.
<glossterm>mysqld</glossterm>,
the MySQL server, and
<glossterm>apache</glossterm>,
a web server, are generally run as daemons.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-dos"> <glossdiv id="gloss_a">
<glossterm>DOS Attack</glossterm> <title>A</title>
<glossentry>
<glossdef> <glossterm>There are no entries for A</glossterm>
<para>A DOS, or Denial of Service attack, is when a user attempts to <glossdef>
deny access to a web server by repeatedly accessing a page or sending <para></para>
malformed requests to a webserver. A D-DOS, or </glossdef>
Distributed Denial of Service attack, is when these requests come </glossentry>
from multiple sources at the same time. Unfortunately, these are much </glossdiv>
more difficult to defend against.
</para>
</glossdef>
</glossentry>
</glossdiv> <glossdiv id="gloss_b">
<title>B</title>
<glossdiv id="gloss-g"> <glossentry>
<title>G</title> <glossterm>Bug</glossterm>
<glossdef>
<glossentry id="gloss-groups"> <para>
<glossterm>Groups</glossterm> A <quote>Bug</quote> in Bugzilla refers to an issue
entered into the database which has an associated number,
<glossdef> assignments, comments, etc. Some also refer to a
<para>The word <quote>tickets</quote> or <quote>issues</quote>; in the
<quote>Groups</quote> context of Bugzilla, they are synonymous.
</para>
has a very special meaning to Bugzilla. Bugzilla's main security </glossdef>
mechanism comes by placing users in groups, and assigning those </glossentry>
groups certain privileges to view bugs in particular
<glossterm>Products</glossterm>
in the
<glossterm>Bugzilla</glossterm>
database.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-j">
<title>J</title>
<glossentry id="gloss-javascript">
<glossterm>JavaScript</glossterm>
<glossdef>
<para>JavaScript is cool, we should talk about it.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-m">
<title>M</title>
<glossentry id="gloss-mta">
<glossterm>Message Transport Agent</glossterm>
<acronym>MTA</acronym>
<glossdef>
<para>A Message Transport Agent is used to control the flow of email on a system.
The <ulink url="http://search.cpan.org/dist/Email-Send/lib/Email/Send.pm">Email::Send</ulink>
Perl module, which Bugzilla uses to send email, can be configured to
use many different underlying implementations for actually sending the
mail using the <option>mail_delivery_method</option> parameter.
Implementations other than <literal>sendmail</literal> require that the
<option>sendmailnow</option> param be set to <literal>on</literal>.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-mysql">
<glossterm>MySQL</glossterm>
<glossdef>
<para>MySQL is currently the required
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL
can be downloaded from <ulink url="http://www.mysql.com"/>. While you
should familiarize yourself with all of the documentation, some high
points are:
</para>
<variablelist>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
<listitem>
<para>Methods for backing up your Bugzilla database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
<listitem>
<para>Information about how to configure MySQL using
<filename>my.cnf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
<listitem>
<para>Much more detailed information about the suggestions in
<xref linkend="security-mysql"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-p">
<title>P</title>
<glossentry id="gloss-ppm">
<glossterm>Perl Package Manager</glossterm>
<acronym>PPM</acronym>
<glossdef>
<para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/>
</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm id="gloss-product">Product</glossterm>
<glossdef>
<para>A Product is a broad category of types of bugs, normally
representing a single piece of software or entity. In general,
there are several Components to a Product. A Product may define a
group (used for security) for all bugs entered into
its Components.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Perl</glossterm>
<glossdef>
<para>First written by Larry Wall, Perl is a remarkable program
language. It has the benefits of the flexibility of an interpreted
scripting language (such as shell script), combined with the speed
and power of a compiled language, such as C.
<glossterm>Bugzilla</glossterm>
is maintained in Perl.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-q">
<title>Q</title>
<glossentry>
<glossterm>QA</glossterm>
<glossdef>
<para>
<quote>QA</quote>,
<quote>Q/A</quote>, and
<quote>Q.A.</quote>
are short for
<quote>Quality Assurance</quote>.
In most large software development organizations, there is a team
devoted to ensuring the product meets minimum standards before
shipping. This team will also generally want to track the progress of
bugs over their life cycle, thus the need for the
<quote>QA Contact</quote>
field in a bug.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-r">
<title>R</title>
<glossentry id="gloss-rdbms">
<glossterm>Relational DataBase Management System</glossterm>
<acronym>RDBMS</acronym>
<glossdef>
<para>A relational database management system is a database system
that stores information in tables that are related to each other.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-regexp">
<glossterm>Regular Expression</glossterm>
<acronym>regexp</acronym>
<glossdef>
<para>A regular expression is an expression used for pattern matching.
<ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink>
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-s">
<title>S</title>
<glossentry id="gloss-service">
<glossterm>Service</glossterm>
<glossdef> <glossentry>
<para>In Windows NT environment, a boot-time background application <glossterm>Bug Number</glossterm>
is referred to as a service. These are generally managed through the <glossdef>
control panel while logged in as an account with <para>
<quote>Administrator</quote> level capabilities. For more Each Bugzilla Bug is assigned a number that uniquely
information, consult your Windows manual or the MSKB. identifies that Bug. The Bug associated with a Bug Number
</para> can be pulled up via a query, or easily from the very
</glossdef> front page by typing the number in the "Find" box.
</glossentry> </para>
</glossdef>
<glossentry> </glossentry>
<glossterm>
<acronym>SGML</acronym> <glossentry>
</glossterm> <glossterm>Bug Life Cycle</glossterm>
<glossdef>
<glossdef> <para>A Bug has stages through which it must pass before
<para> becoming a <quote>closed bug</quote>, including
<acronym>SGML</acronym> acceptance, resolution, and verification. The <quote>Bug
Life Cycle</quote> is moderately flexible according to
stands for the needs of the organization using it, though.</para>
<quote>Standard Generalized Markup Language</quote>. </glossdef>
Created in the 1980's to provide an extensible means to maintain </glossentry>
documentation based upon content instead of presentation, </glossdiv>
<acronym>SGML</acronym>
<glossdiv id="gloss_i">
has withstood the test of time as a robust, powerful language. <title>I</title>
<glossterm> <glossentry id="gloss_infiniteloop">
<acronym>XML</acronym> <glossterm>Infinite Loop</glossterm>
</glossterm> <glossdef>
<para>A loop of information that never ends; see recursion.</para>
is the </glossdef>
<quote>baby brother</quote> </glossentry>
</glossdiv>
of SGML; any valid
<acronym>XML</acronym> <glossdiv id="gloss_p">
<title>P</title>
document it, by definition, a valid <glossentry>
<acronym>SGML</acronym> <glossterm id="gloss_product">Product</glossterm>
<glossdef>
document. The document you are reading is written and maintained in <para>A Product is a broad category of types of bugs. In
<acronym>SGML</acronym>, general, there are several Components to a Product. A
and is also valid Product also defines a default Group (used for Bug
<acronym>XML</acronym> Security) for all bugs entered into components beneath
it.</para>
if you modify the Document Type Definition.</para> <example>
</glossdef> <title>A Sample Product</title>
</glossentry> <para>A company sells a software product called
</glossdiv> <quote>X</quote>. They also maintain some older
software called <quote>Y</quote>, and have a secret
<glossdiv id="gloss-t"> project <quote>Z</quote>. An effective use of Products
<title>T</title> might be to create Products <quote>X</quote>,
<quote>Y</quote>, <quote>Z</quote>, each with Components
<glossentry id="gloss-target-milestone" xreflabel="Target Milestone"> of User Interface, Database, and Business Logic. They
<glossterm>Target Milestone</glossterm> might also change group permissions so that only those
people who are members of Group <quote>Z</quote> can see
<glossdef> components and bugs under Product
<para>Target Milestones are Product goals. They are configurable on a <quote>Z</quote>.</para>
per-Product basis. Most software development houses have a concept of </example>
</glossdef>
<quote>milestones</quote> </glossentry>
</glossdiv>
where the people funding a project expect certain functionality on
certain dates. Bugzilla facilitates meeting these milestones by <glossdiv id="gloss_q">
giving you the ability to declare by which milestone a bug will be <title>Q</title>
fixed, or an enhancement will be implemented.</para> <glossentry>
</glossdef> <glossterm>QA</glossterm>
</glossentry> <glossdef>
<para><quote>QA</quote>, <quote>Q/A</quote>, and
<glossentry id="gloss-tcl"> <quote>Q.A.</quote> are short for <quote>Quality
<glossterm>Tool Command Language</glossterm> Assurance</quote>. In most large software development
<acronym>TCL</acronym> organizations, there is a team devoted to ensuring the
<glossdef> product meets minimum standards before shipping. This
<para>TCL is an open source scripting language available for Windows, team will also generally want to track the progress of
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but bugs over their life cycle, thus the need for the
never released. The first release of Bugzilla was 2.0, which was when <quote>QA Contact</quote> field in a Bug.</para>
it was ported to perl. </glossdef>
</para> </glossentry>
</glossdef> </glossdiv>
</glossentry>
</glossdiv> <glossdiv id="gloss_r">
<title>R</title>
<glossdiv id="gloss-z"> <glossentry>
<title>Z</title> <glossterm id="gloss_recursion">Recursion</glossterm>
<glossdef>
<glossentry id="gloss-zarro"> <para>The property of a function looking back at itself for
<glossterm>Zarro Boogs Found</glossterm> something. <quote>GNU</quote>, for instance, stands for
<quote>GNU's Not UNIX</quote>, thus recursing upon itself
<glossdef> for definition. For further clarity, see Infinite
<para>This is just a goofy way of saying that there were no bugs Loop.</para>
found matching your query. When asked to explain this message, </glossdef>
Terry had the following to say: </glossentry>
</para> </glossdiv>
<blockquote> <glossdiv id="gloss_z">
<attribution>Terry Weissman</attribution> <title>Z</title>
<para>I've been asked to explain this ... way back when, when <glossentry>
Netscape released version 4.0 of its browser, we had a release <glossterm>Zarro Boogs Found</glossterm>
party. Naturally, there had been a big push to try and fix every <glossdef>
known bug before the release. Naturally, that hadn't actually <para>This is the cryptic response sent by Bugzilla when a
happened. (This is not unique to Netscape or to 4.0; the same thing query returned no results. It is just a goofy way of
has happened with every software project I've ever seen.) Anyway, saying "Zero Bugs Found".</para>
at the release party, T-shirts were handed out that said something </glossdef>
like "Netscape 4.0: Zarro Boogs". Just like the software, the </glossentry>
T-shirt had no known bugs. Uh-huh. </glossdiv>
</para>
</glossary>
<para>So, when you query for a list of bugs, and it gets no results,
you can think of this as a friendly reminder. Of *course* there are
bugs matching your query, they just aren't in the bugsystem yet...
</para>
</blockquote>
</glossdef>
</glossentry>
</glossdiv>
</glossary>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -544,7 +170,7 @@ sgml-local-ecat-files:nil ...@@ -544,7 +170,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
...@@ -13,9 +13,8 @@ sgml-local-ecat-files:nil ...@@ -13,9 +13,8 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<CHAPTER id="installation"> <chapter id="installation">
<TITLE>Installing Bugzilla</TITLE> <title>Installation</title>
<para>
These installation instructions are presented assuming you are
installing on a UNIX or completely POSIX-compliant system. If
you are installing on Microsoft Windows or another oddball
operating system, please consult the appropriate sections in
this installation guide for notes on how to be successful.
</para>
<section id="errata">
<title>ERRATA</title>
<para>Here are some miscellaneous notes about possible issues you
main run into when you begin your Bugzilla installation.
Reference platforms for Bugzilla installation are Redhat Linux
7.2, Linux-Mandrake 8.0, and Solaris 8.</para>
<SECTION id="README.unix"> <simplelist>
<TITLE>UNIX Installation</TITLE> <member>
<SECTION> If you are installing Bugzilla on S.u.S.e. Linux, or some
<TITLE>ERRATA</TITLE> other distributions with <quote>paranoid</quote> security
<NOTE> options, it is possible that the checksetup.pl script may fail
<PARA> with the error: <errorname>cannot chdir(/var/spool/mqueue):
If you are installing Bugzilla on S.u.S.e. Linux, or some other Permission denied</errorname> This is because your
distributions with "paranoid" security options, it is possible <filename>/var/spool/mqueue</filename> directory has a mode of
that the checksetup.pl script may fail with the error: <quote>drwx------</quote>. Type <command>chmod 755
<ERRORNAME>cannot chdir(/var/spool/mqueue): Permission denied</ERRORNAME> <filename>/var/spool/mqueue</filename></command> as root to
This is because your fix this problem.
/var/spool/mqueue directory has a mode of "drwx------". Type </member>
<COMMAND>chmod 755 /var/spool/mqueue</COMMAND> as root to fix this problem.
</PARA>
</NOTE>
<NOTE> <member>
<PARA> Bugzilla may be installed on Macintosh OS X (10), which is a
Release Notes for Bugzilla 2.12 are available at docs/rel_notes.txt unix-based (BSD) operating system. Everything required for
</PARA> Bugzilla on OS X will install cleanly, but the optional GD
</NOTE> perl module which is used for bug charting requires some
additional setup for installation. Please see the Mac OS X
installation section below for details
</member>
<NOTE> <member>
<PARA> Release Notes for Bugzilla &bz-ver; are available at
The preferred documentation for Bugzilla is available in docs/, with <filename>docs/rel_notes.txt</filename> in your Bugzilla
a variety of document types available. Please refer to these documents when source distribution.
installing, configuring, and maintaining your Bugzilla installation. </member>
</PARA>
</NOTE>
<WARNING> <member>
<PARA> The preferred documentation for Bugzilla is available in
Bugzilla is not a package where you can just plop it in a directory, docs/, with a variety of document types available. Please
twiddle a few things, and you're off. Installing Bugzilla assumes you refer to these documents when installing, configuring, and
know your variant of UNIX or Microsoft Windows well, are familiar with the maintaining your Bugzilla installation.
command line, and are comfortable compiling and installing a plethora </member>
of third-party utilities. To install Bugzilla on Win32 requires </simplelist>
fair Perl proficiency, and if you use a webserver other than Apache you
should be intimately familiar with the security mechanisms and CGI <warning>
environment thereof. <para>
</PARA> Bugzilla is not a package where you can just plop it in a directory,
</WARNING> twiddle a few things, and you're off. Installing Bugzilla assumes you
know your variant of UNIX or Microsoft Windows well, are familiar with the
command line, and are comfortable compiling and installing a plethora
of third-party utilities. To install Bugzilla on Win32 requires
fair Perl proficiency, and if you use a webserver other than Apache you
should be intimately familiar with the security mechanisms and CGI
environment thereof.
</para>
</warning>
<warning>
<para>
Bugzilla has not undergone a complete security review. Security holes
may exist in the code. Great care should be taken both in the installation
and usage of this software. Carefully consider the implications of
installing other network services with Bugzilla.
</para>
</warning>
</section>
<section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step">
<title>Step-by-step Install</title>
<section>
<title>Introduction</title>
<para>
Installation of bugzilla is pretty straightforward, particularly if your
machine already has MySQL and the MySQL-related perl packages installed.
If those aren't installed yet, then that's the first order of business. The
other necessary ingredient is a web server set up to run cgi scripts.
While using Apache for your webserver is not required, it is recommended.
</para>
<WARNING> <para>
<PARA> Bugzilla has been successfully installed under Solaris, Linux,
Bugzilla has not undergone a complete security review. Security holes and Win32. The peculiarities of installing on Win32 (Microsoft
may exist in the code. Great care should be taken both in the installation Windows) are not included in this section of the Guide; please
and usage of this software. Carefully consider the implications of check out the <xref linkend="win32"> for further advice
installing other network services with Bugzilla. on getting Bugzilla to work on Microsoft Windows.
</PARA> </para>
</WARNING>
</SECTION> <para>
The Bugzilla Guide is contained in the "docs/" folder in your
<SECTION> Bugzilla distribution. It is available in plain text
<TITLE>Step-by-step Install</TITLE> (docs/txt), HTML (docs/html), or SGML source (docs/sgml).
<SECTION> </para>
<TITLE>Introduction</TITLE> </section>
<PARA> <section>
Installation of bugzilla is pretty straightforward, particularly if your <title>Installing the Prerequisites</title>
machine already has MySQL and the MySQL-related perl packages installed. <note>
If those aren't installed yet, then that's the first order of business. The <para>If you want to skip these manual installation steps for
other necessary ingredient is a web server set up to run cgi scripts. the CPAN dependencies listed below, and are running the very
While using Apache for your webserver is not required, it is recommended. most recent version of Perl and MySQL (both the executables
</PARA> and development libraries) on your system, check out
Bundle::Bugzilla in <xref
<PARA> linkend="bundlebugzilla"></para>
Bugzilla has been successfully installed under Solaris, Linux, and </note>
Win32. The peculiarities of installing on Win32 (Win98+/NT/2K) are not <para>
included in this section of the Guide; please check out the "Win32 Installation Instructions" The software packages necessary for the proper running of bugzilla are:
for further advice on getting Bugzilla to work on Microsoft Windows. <orderedlist>
</PARA> <listitem>
<para>
<PARA> MySQL database server and the mysql client (3.22.5 or greater)
The Bugzilla Guide is contained in the "docs/" folder. It is available </para>
in plain text (docs/txt), HTML (docs/html), or SGML source (docs/sgml). </listitem>
</PARA> <listitem>
</SECTION> <para>
<SECTION> Perl (5.004 or greater, 5.6.1 is recommended if you wish
<TITLE>Installing the Prerequisites</TITLE> to use Bundle::Bugzilla)
</para>
<PARA> </listitem>
The software packages necessary for the proper running of bugzilla are: <listitem>
<ORDEREDLIST> <para>
<LISTITEM> DBI Perl module
<PARA> </para>
MySQL database server and the mysql client (3.22.5 or greater) </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Data::Dumper Perl module
<PARA> </para>
Perl (5.004 or greater) </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Bundle::Mysql Perl module collection
<PARA> </para>
DBI Perl module </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> TimeDate Perl module collection
<PARA> </para>
Data::Dumper Perl module </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> GD perl module (1.8.3) (optional, for bug charting)
<PARA> </para>
DBD::mySQL </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Chart::Base Perl module (0.99c) (optional, for bug charting)
<PARA> </para>
TimeDate Perl module collection </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> DB_File Perl module (optional, for bug charting)
<PARA> </para>
GD perl module (1.8.3) (optional, for bug charting) </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> The web server of your choice. Apache is recommended.
<PARA> </para>
Chart::Base Perl module (0.99c) (optional, for bug charting) </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
<PARA> </para>
DB_File Perl module (optional, for bug charting) </listitem>
</PARA> </orderedlist>
</LISTITEM>
<LISTITEM>
<PARA>
The web server of your choice. Apache is recommended.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
</PARA>
</LISTITEM>
</ORDEREDLIST>
<NOTE>
<PARA>
You must run Bugzilla on a filesystem that supports file locking via
flock(). This is necessary for Bugzilla to operate safely with multiple
instances.
</PARA>
</NOTE>
<WARNING>
<PARA>
It is a good idea, while installing Bugzilla, to ensure it is not
<EMPHASIS>accessible</EMPHASIS> by other machines on the Internet.
Your machine may be vulnerable to attacks
while you are installing. In other words, ensure there is some kind of firewall between you
and the rest of the Internet. Many installation steps require an active Internet connection
to complete, but you must take care to ensure that at no point is your machine vulnerable
to an attack.
</PARA>
</WARNING>
</PARA>
</SECTION>
<SECTION>
<TITLE>Installing MySQL Database</TITLE>
<PARA>
Visit MySQL homepage at http://www.mysql.org/ and grab the latest stable
release of the server. Both binaries and source are available and which
you get shouldn't matter. Be aware that many of the binary versions
of MySQL store their data files in /var which on many installations
(particularly common with linux installations) is part of a smaller
root partition. If you decide to build from sources you can easily set
the dataDir as an option to configure.
</PARA>
<PARA>
If you've installed from source or non-package (RPM, deb, etc.) binaries
you'll want to make sure to add mysqld to your init scripts so the server
daemon will come back up whenever your machine reboots.
You also may want to edit those init scripts, to make sure that
mysqld will accept large packets. By default, mysqld is set up to only
accept packets up to 64K long. This limits the size of attachments you
may put on bugs. If you add something like "-O max_allowed_packet=1M"
to the command that starts mysqld (or safe_mysqld), then you will be
able to have attachments up to about 1 megabyte.
</PARA>
<NOTE>
<PARA>
If you plan on running Bugzilla and MySQL on the same machine,
consider using the "--skip-networking" option in the init script.
This enhances security by preventing network access to MySQL.
</PARA>
</NOTE>
</SECTION>
<SECTION>
<TITLE>Perl (5.004 or greater)</TITLE>
<PARA>
Any machine that doesn't have perl on it is a sad machine indeed. Perl
for *nix systems can be gotten in source form from http://www.perl.com.
</PARA>
<PARA>
Perl is now a far cry from the the single compiler/interpreter binary it
once was. It now includes a great many required modules and quite a
few other support files. If you're not up to or not inclined to build
perl from source, you'll want to install it on your machine using some
sort of packaging system (be it RPM, deb, or what have you) to ensure
a sane install. In the subsequent sections you'll be installing quite
a few perl modules; this can be quite ornery if your perl installation
isn't up to snuff.
</PARA>
<TIP>
<PARA>
You can skip the following Perl module installation
steps by installing "Bundle::Bugzilla" from CPAN, which includes them.
All Perl module installation steps require you have an active Internet
connection.
</PARA>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>perl -MCPAN -e 'install "Bundle::Bugzilla"'</COMMAND>
</COMPUTEROUTPUT>
</PARA>
<PARA>
Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser,
which are not essential to a basic Bugzilla install. If installing
this bundle fails, you should install each module individually to
isolate the problem.
</PARA>
</TIP>
</SECTION>
<SECTION>
<TITLE>DBI Perl Module</TITLE>
<PARA>
The DBI module is a generic Perl module used by other database related
Perl modules. For our purposes it's required by the MySQL-related
modules. As long as your Perl installation was done correctly the
DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
MakeMaker system simplifies the C compilation greatly.
</PARA>
<PARA>
Like almost all Perl modules DBI can be found on the Comprehensive Perl
Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
real tendency to bog down, so please use mirrors. The current location
at the time of this writing (02/17/99) can be found in Appendix A.
</PARA>
<PARA>
Quality, general Perl module installation instructions can be found on
the CPAN website, but the easy thing to do is to just use the CPAN shell
which does all the hard work for you.
</PARA>
<PARA>
To use the CPAN shell to install DBI:
<INFORMALEXAMPLE>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>perl -MCPAN -e 'install "DBI"'</COMMAND>
</COMPUTEROUTPUT>
<NOTE>
<PARA>Replace "DBI" with the name of whichever module you wish
to install, such as Data::Dumper, TimeDate, GD, etc.</PARA>
</NOTE>
</PARA>
</INFORMALEXAMPLE>
To do it the hard way:
<INFORMALEXAMPLE>
<PARA>
Untar the module tarball -- it should create its own directory
</PARA>
<PARA>
CD to the directory just created, and enter the following commands:
<ORDEREDLIST>
<LISTITEM>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>perl Makefile.PL</COMMAND>
</COMPUTEROUTPUT>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>make</COMMAND>
</COMPUTEROUTPUT>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>make test</COMMAND>
</COMPUTEROUTPUT>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT>
<COMMAND>make install</COMMAND>
</COMPUTEROUTPUT>
</PARA>
</LISTITEM>
</ORDEREDLIST>
If everything went ok that should be all it takes. For the vast
majority of perl modules this is all that's required.
</PARA>
</INFORMALEXAMPLE>
</PARA>
</SECTION>
<SECTION>
<TITLE>Data::Dumper Perl Module</TITLE>
<PARA>
The Data::Dumper module provides data structure persistence for Perl
(similar to Java's serialization). It comes with later sub-releases of
Perl 5.004, but a re-installation just to be sure it's available won't
hurt anything.
</PARA>
<PARA>
Data::Dumper is used by the MySQL related Perl modules. It can be
found on CPAN (link in Appendix A) and can be installed by following
the same four step make sequence used for the DBI module.
</PARA>
</SECTION>
<SECTION> <warning>
<TITLE>MySQL related Perl Module Collection</TITLE> <para>
<PARA> It is a good idea, while installing Bugzilla, to ensure it
The Perl/MySQL interface requires a few mutually-dependent perl is not <emphasis>accessible</emphasis> by other machines
modules. These modules are grouped together into the the on the Internet. Your machine may be vulnerable to attacks
Msql-Mysql-modules package. This package can be found at CPAN. while you are installing. In other words, ensure there is
After the archive file has been downloaded it should some kind of firewall between you and the rest of the
be untarred. Internet. Many installation steps require an active
</PARA> Internet connection to complete, but you must take care to
<PARA> ensure that at no point is your machine vulnerable to an
The MySQL modules are all built using one make file which is generated attack.
by running: </para>
<PROMPT>bash#</PROMPT> </warning>
<COMMAND>perl Makefile.pl</COMMAND>
</PARA> </para>
<PARA> </section>
The MakeMaker process will ask you a few questions about the desired <section id="install-mysql">
compilation target and your MySQL installation. For many of the questions <title>Installing MySQL Database</title>
the provided default will be adequate. <para>
</PARA> Visit MySQL homepage at http://www.mysql.com/ and grab the
<PARA> latest stable release of the server. Both binaries and source
When asked if your desired target is the MySQL or mSQL packages are available and which you get shouldn't matter. Be aware
selected the MySQL related ones. Later you will be asked if you wish that many of the binary versions of MySQL store their data
to provide backwards compatibility with the older MySQL packages; you files in /var which on many installations (particularly common
must answer YES to this question. The default will be no, and if you with linux installations) is part of a smaller root partition.
select it things won't work later. If you decide to build from sources you can easily set the
</PARA> dataDir as an option to configure.
<PARA> </para>
<para>
If you've installed from source or non-package (RPM, deb,
etc.) binaries you'll want to make sure to add mysqld to your
init scripts so the server daemon will come back up whenever
your machine reboots. You also may want to edit those init
scripts, to make sure that mysqld will accept large packets.
By default, mysqld is set up to only accept packets up to 64K
long. This limits the size of attachments you may put on
bugs. If you add something like "-O max_allowed_packet=1M" to
the command that starts mysqld (or safe_mysqld), then you will
be able to have attachments up to about 1 megabyte.
</para>
<note>
<para>
If you plan on running Bugzilla and MySQL on the same
machine, consider using the "--skip-networking" option in
the init script. This enhances security by preventing
network access to MySQL.
</para>
</note>
</section>
<section id="install-perl">
<title>Perl (5.004 or greater)</title>
<para>
Any machine that doesn't have perl on it is a sad machine
indeed. Perl for *nix systems can be gotten in source form
from http://www.perl.com. Although Bugzilla runs with most
post-5.004 versions of Perl, it's a good idea to be up to the
very latest version if you can when running Bugzilla. As of
this writing, that is perl version &perl-ver;.
</para>
<para>
Perl is now a far cry from the the single compiler/interpreter
binary it once was. It includes a great many required modules
and quite a few other support files. If you're not up to or
not inclined to build perl from source, you'll want to install
it on your machine using some sort of packaging system (be it
RPM, deb, or what have you) to ensure a sane install. In the
subsequent sections you'll be installing quite a few perl
modules; this can be quite ornery if your perl installation
isn't up to snuff.
</para>
<warning>
<para>Many people complain that Perl modules will not install
for them. Most times, the error messages complain that they
are missing a file in <quote>@INC</quote>. Virtually every
time, this is due to permissions being set too restrictively
for you to compile Perl modules or not having the necessary
Perl development libraries installed on your system..
Consult your local UNIX systems administrator for help
solving these permissions issues; if you
<emphasis>are</emphasis> the local UNIX sysadmin, please
consult the newsgroup/mailing list for further assistance or
hire someone to help you out.
</para>
</warning>
<tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
<para>
You can skip the following Perl module installation steps by
installing "Bundle::Bugzilla" from CPAN, which includes
them. All Perl module installation steps require you have an
active Internet connection. If you wish to use
Bundle::Bugzilla, however, you must be using the latest
version of Perl (at this writing, version &perl-ver;)
</para>
<para>
<computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN
-e 'install "Bundle::Bugzilla"'</command>
</computeroutput>
</para>
<para>
Bundle::Bugzilla doesn't include GD, Chart::Base, or
MIME::Parser, which are not essential to a basic Bugzilla
install. If installing this bundle fails, you should
install each module individually to isolate the problem.
</para>
</tip>
</section>
<section>
<title>DBI Perl Module</title>
<para>
The DBI module is a generic Perl module used by other database related
Perl modules. For our purposes it's required by the MySQL-related
modules. As long as your Perl installation was done correctly the
DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
MakeMaker system simplifies the C compilation greatly.
</para>
<para>
Like almost all Perl modules DBI can be found on the Comprehensive Perl
Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
real tendency to bog down, so please use mirrors. The current location
at the time of this writing (02/17/99) can be found in Appendix A.
</para>
<para>
Quality, general Perl module installation instructions can be found on
the CPAN website, but the easy thing to do is to just use the CPAN shell
which does all the hard work for you.
</para>
<para>
To use the CPAN shell to install DBI:
<informalexample>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>perl -MCPAN -e 'install "DBI"'</command>
</computeroutput>
<note>
<para>Replace "DBI" with the name of whichever module you wish
to install, such as Data::Dumper, TimeDate, GD, etc.</para>
</note>
</para>
</informalexample>
To do it the hard way:
<informalexample>
<para>
Untar the module tarball -- it should create its own directory
</para>
<para>
CD to the directory just created, and enter the following commands:
<orderedlist>
<listitem>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>perl Makefile.PL</command>
</computeroutput>
</para>
</listitem>
<listitem>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>make</command>
</computeroutput>
</para>
</listitem>
<listitem>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>make test</command>
</computeroutput>
</para>
</listitem>
<listitem>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>make install</command>
</computeroutput>
</para>
</listitem>
</orderedlist>
If everything went ok that should be all it takes. For the vast
majority of perl modules this is all that's required.
</para>
</informalexample>
</para>
</section>
<section>
<title>Data::Dumper Perl Module</title>
<para>
The Data::Dumper module provides data structure persistence for Perl
(similar to Java's serialization). It comes with later sub-releases of
Perl 5.004, but a re-installation just to be sure it's available won't
hurt anything.
</para>
<para>
Data::Dumper is used by the MySQL-related Perl modules. It can be
found on CPAN (link in Appendix A) and can be installed by following
the same four step make sequence used for the DBI module.
</para>
</section>
<section>
<title>MySQL related Perl Module Collection</title>
<para>
The Perl/MySQL interface requires a few mutually-dependent perl
modules. These modules are grouped together into the the
Msql-Mysql-modules package. This package can be found at CPAN.
After the archive file has been downloaded it should
be untarred.
</para>
<para>
The MySQL modules are all built using one make file which is generated
by running:
<prompt>bash#</prompt>
<command>perl Makefile.pl</command>
</para>
<para>
The MakeMaker process will ask you a few questions about the desired
compilation target and your MySQL installation. For many of the questions
the provided default will be adequate.
</para>
<para>
When asked if your desired target is the MySQL or mSQL packages,
select the MySQL related ones. Later you will be asked if you wish
to provide backwards compatibility with the older MySQL packages; you
should answer YES to this question. The default is NO.
</para>
<para>
A host of 'localhost' should be fine and a testing user of 'test' and A host of 'localhost' should be fine and a testing user of 'test' and
a null password should find itself with sufficient access to run tests a null password should find itself with sufficient access to run tests
on the 'test' database which MySQL created upon installation. If 'make on the 'test' database which MySQL created upon installation. If 'make
test' and 'make install' go through without errors you should be ready test' and 'make install' go through without errors you should be ready
to go as far as database connectivity is concerned. to go as far as database connectivity is concerned.
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>TimeDate Perl Module Collection</TITLE> <title>TimeDate Perl Module Collection</title>
<PARA> <para>
Many of the more common date/time/calendar related Perl modules have Many of the more common date/time/calendar related Perl modules have
been grouped into a bundle similar to the MySQL modules bundle. This been grouped into a bundle similar to the MySQL modules bundle. This
bundle is stored on the CPAN under the name TimeDate. A (hopefully bundle is stored on the CPAN under the name TimeDate. A link
current) link can be found in Appendix A. The component module we're link may be found in Appendix B, Software Download Links.
The component module we're
most interested in is the Date::Format module, but installing all of them most interested in is the Date::Format module, but installing all of them
is probably a good idea anyway. The standard Perl module installation is probably a good idea anyway. The standard Perl module installation
instructions should work perfectly for this simple package. instructions should work perfectly for this simple package.
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>GD Perl Module (1.8.3)</TITLE> <title>GD Perl Module (1.8.3)</title>
<PARA> <para>
The GD library was written by Thomas Boutell a long while ago to The GD library was written by Thomas Boutell a long while ago to
programatically generate images in C. Since then it's become almost a programatically generate images in C. Since then it's become almost a
defacto standard for programatic image construction. The Perl bindings defacto standard for programatic image construction. The Perl bindings
to it found in the GD library are used on a million web pages to generate to it found in the GD library are used on a million web pages to generate
graphs on the fly. That's what bugzilla will be using it for so you'd graphs on the fly. That's what bugzilla will be using it for so you'd
better install it if you want any of the graphing to work. better install it if you want any of the graphing to work.
</PARA> </para>
<PARA> <para>
Actually bugzilla uses the Graph module which relies on GD itself, Actually bugzilla uses the Graph module which relies on GD itself,
but isn't that always the way with OOP. At any rate, you can find the but isn't that always the way with OOP. At any rate, you can find the
GD library on CPAN (link in Appendix "Required Software"). GD library on CPAN (link in Appendix B, Software Download Links).
</PARA> </para>
<NOTE> <note>
<PARA> <para>
The Perl GD library requires some other libraries that may or may not be The Perl GD library requires some other libraries that may or may not be
installed on your system, including "libpng" and "libgd". The full requirements installed on your system, including "libpng" and "libgd". The full requirements
are listed in the Perl GD library README. Just realize that if compiling GD fails, are listed in the Perl GD library README. Just realize that if compiling GD fails,
it's probably because you're missing a required library. it's probably because you're missing a required library.
</PARA> </para>
</NOTE> </note>
</SECTION> </section>
<SECTION> <section>
<TITLE>Chart::Base Perl Module (0.99c)</TITLE> <title>Chart::Base Perl Module (0.99c)</title>
<PARA> <para>
The Chart module provides bugzilla with on-the-fly charting The Chart module provides bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been abilities. It can be installed in the usual fashion after it has been
fetched from CPAN where it is found as the Chart-x.x... tarball in a fetched from CPAN where it is found as the Chart-x.x... tarball in a
directory to be listed in Appendix "Required Software". Note that as with the GD perl directory to be listed in Appendix B, "Software Download Links".
module, only the specific versions listed above (or newer) will work. Earlier Note that as with the GD perl
module, only the version listed above, or newer, will work.
Earlier
versions used GIF's, which are no longer supported by the latest versions used GIF's, which are no longer supported by the latest
versions of GD. versions of GD.
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>DB_File Perl Module</TITLE> <title>DB_File Perl Module</title>
<PARA> <para>
DB_File is a module which allows Perl programs to make use of the facilities provided by DB_File is a module which allows Perl programs to make use of the facilities provided by
Berkeley DB version 1.x. This module is required by collectstats.pl which is used for Berkeley DB version 1.x. This module is required by collectstats.pl which is used for
bug charting. If you plan to make use of bug charting, you must install this module. bug charting. If you plan to make use of bug charting, you must install this module.
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>HTTP Server</TITLE> <title>HTTP Server</title>
<PARA> <para>
You have a freedom of choice here - Apache, Netscape or any other You have a freedom of choice here - Apache, Netscape or any other
server on UNIX would do. You can easily run the web server on a different server on UNIX would do. You can easily run the web server on a different
machine than MySQL, but need to adjust the MySQL "bugs" user permissions machine than MySQL, but need to adjust the MySQL "bugs" user permissions
accordingly. accordingly.
</PARA> </para>
<PARA> <para>
You'll want to make sure that your web server will run any file You'll want to make sure that your web server will run any file
with the .cgi extension as a cgi and not just display it. If you're using with the .cgi extension as a cgi and not just display it. If you're using
apache that means uncommenting the following line in the srm.conf file: apache that means uncommenting the following line in the srm.conf file:
<COMPUTEROUTPUT>AddHandler cgi-script .cgi</COMPUTEROUTPUT> <computeroutput>AddHandler cgi-script .cgi</computeroutput>
</PARA> </para>
<PARA> <para>
With apache you'll also want to make sure that within the access.conf With apache you'll also want to make sure that within the access.conf
file the line: file the line:
<COMPUTEROUTPUT> <computeroutput>
Options ExecCGI Options ExecCGI
</COMPUTEROUTPUT> </computeroutput>
is in the stanza that covers the directories you intend to put the bugzilla is in the stanza that covers the directories you intend to put the bugzilla
.html and .cgi files into. .html and .cgi files into.
</PARA> </para>
<PARA> <para>
If you are using a newer version of Apache, both of the above lines will be If you are using a newer version of Apache, both of the above lines will be
(or will need to be) in the httpd.conf file, rather than srm.conf or (or will need to be) in the httpd.conf file, rather than srm.conf or
access.conf. access.conf.
</PARA> </para>
<WARNING> <warning>
<PARA> <para>
There are two critical directories and a file that should not be a served by There are two critical directories and a file that should not be a served by
the HTTP server. These are the 'data' and 'shadow' directories and the the HTTP server. These are the <quote>data</quote> and <quote>shadow</quote>
'localconfig' file. You should configure your HTTP server to not serve directories and the
<quote>localconfig</quote> file. You should configure your HTTP server to not serve
content from these files. Failure to do so will expose critical passwords content from these files. Failure to do so will expose critical passwords
and other data. Please see your HTTP server configuration manual on how and other data. Please see <xref linkend="htaccess"> for details.
to do this. If you use quips (at the top of the buglist pages) you will want </para>
the 'data/comments' file to still be served. This file contains those quips. </warning>
</PARA> </section>
</WARNING>
</SECTION>
<SECTION> <section>
<TITLE>Installing the Bugzilla Files</TITLE> <title>Installing the Bugzilla Files</title>
<PARA> <para>
You should untar the Bugzilla files into a directory that you're You should untar the Bugzilla files into a directory that you're
willing to make writable by the default web server user (probably willing to make writable by the default web server user (probably
'nobody'). You may decide to put the files off of the main web space <quote>nobody</quote>). You may decide to put the files off of the main web space
for your web server or perhaps off of /usr/local with a symbolic link for your web server or perhaps off of /usr/local with a symbolic link
in the web space that points to the bugzilla directory. At any rate, in the web space that points to the bugzilla directory. At any rate,
just dump all the files in the same place (optionally omitting the CVS just dump all the files in the same place (optionally omitting the CVS
directories if they were accidentally tarred up with the rest of Bugzilla) directories if they were accidentally tarred up with the rest of Bugzilla)
and make sure you can access the files in that directory through your and make sure you can access the files in that directory through your
web server. web server.
</PARA> </para>
<TIP> <tip>
<PARA> <para>
If you symlink the bugzilla directory into your Apache's If you symlink the bugzilla directory into your Apache's
HTML heirarchy, you may receive "Forbidden" errors unless you HTML heirarchy, you may receive "Forbidden" errors unless you
add the "FollowSymLinks" directive to the &lt;Directory&gt; entry add the "FollowSymLinks" directive to the &lt;Directory&gt; entry
for the HTML root. for the HTML root.
</PARA> </para>
</TIP> </tip>
<PARA> <para>
Once all the files are in a web accessible directory, make that Once all the files are in a web accessible directory, make that
directory writable by your webserver's user (which may require just directory writable by your webserver's user (which may require just
making it world writable). This is a temporary step until you run making it world writable). This is a temporary step until you run
the post-install "checksetup.pl" script, which locks down your the post-install <quote>checksetup.pl</quote> script, which locks down your
installation. installation.
</PARA> </para>
<PARA> <para>
Lastly, you'll need to set up a symbolic link to /usr/bonsaitools/bin/perl Lastly, you'll need to set up a symbolic link to /usr/bonsaitools/bin/perl
for the correct location of your perl executable (probably /usr/bin/perl). for the correct location of your perl executable (probably /usr/bin/perl).
Otherwise you must hack all the .cgi files to change where they look Otherwise you must hack all the .cgi files to change where they look
for perl. To make future upgrades easier, you should use the symlink for perl. To make future upgrades easier, you should use the symlink
approach. approach.
<EXAMPLE> <example>
<TITLE>Setting up bonsaitools symlink</TITLE> <title>Setting up bonsaitools symlink</title>
<PARA> <para>
Here's how you set up the Perl symlink on Linux to make Bugzilla work. Here's how you set up the Perl symlink on Linux to make Bugzilla work.
Your mileage may vary; if you are running on Solaris, you probably need to subsitute Your mileage may vary; if you are running on Solaris, you probably need to subsitute
"/usr/local/bin/perl" for "/usr/bin/perl" below; if on certain other UNIX systems, <quote>/usr/local/bin/perl</quote> for <quote>/usr/bin/perl</quote>
Perl may live in weird places like "/opt/perl". As root, run these commands: below; if on certain other UNIX systems,
<PROGRAMLISTING> Perl may live in weird places like <quote>/opt/perl</quote>. As root, run these commands:
<programlisting>
bash# mkdir /usr/bonsaitools bash# mkdir /usr/bonsaitools
bash# mkdir /usr/bonsaitools/bin bash# mkdir /usr/bonsaitools/bin
bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
</PROGRAMLISTING> </programlisting>
</PARA> </para>
</EXAMPLE> </example>
<TIP> <tip>
<PARA> <para>
If you don't have root access to set this symlink up, check out the If you don't have root access to set this symlink up,
"setperl.csh" utility, listed in the Patches section of this check out the
Guide. It will change the path to perl in all your Bugzilla files for <xref linkend="setperl">, listed in <xref linkend="patches">.
you. It will change the path to perl in all your Bugzilla files for you.
</PARA> </para>
</TIP> </tip>
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>Setting Up the MySQL Database</TITLE> <title>Setting Up the MySQL Database</title>
<PARA> <para>
After you've gotten all the software installed and working you're ready After you've gotten all the software installed and working you're ready
to start preparing the database for its life as a the back end to a high to start preparing the database for its life as a the back end to a high
quality bug tracker. quality bug tracker.
</PARA> </para>
<PARA> <para>
First, you'll want to fix MySQL permissions to allow access from First, you'll want to fix MySQL permissions to allow access from
Bugzilla. For the purpose of this Installation section, the Bugzilla username Bugzilla. For the purpose of this Installation section, the Bugzilla username
will be "bugs", and will have minimal permissions. Bugzilla has will be "bugs", and will have minimal permissions.
not undergone a thorough security audit. It may be possible for
a system cracker to somehow trick Bugzilla into executing a command <warning>
such as "; DROP DATABASE mysql". <para>
</PARA> Bugzilla has not undergone a thorough security audit. It
<PARA> may be possible for a system cracker to somehow trick
That would be bad. Bugzilla into executing a command such as <command>DROP
</PARA> DATABASE mysql</command>.
<PARA> </para>
<para>That would be bad.</para>
</warning>
</para>
<para>
Give the MySQL root user a password. MySQL passwords are Give the MySQL root user a password. MySQL passwords are
limited to 16 characters. limited to 16 characters.
<SIMPLELIST> <simplelist>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>bash#</PROMPT> <prompt>bash#</prompt>
<COMMAND>mysql -u root mysql</COMMAND> <command>mysql -u root mysql</command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>mysql></PROMPT> <prompt>mysql></prompt>
<COMMAND> <command>
UPDATE user SET Password=PASSWORD ('new_password') UPDATE user SET Password=PASSWORD ('new_password')
WHERE user='root'; WHERE user='root';
</COMMAND> </command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>mysql></PROMPT> <prompt>mysql></prompt>
<COMMAND>FLUSH PRIVILEGES;</COMMAND> <command>FLUSH PRIVILEGES;</command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
</SIMPLELIST> </simplelist>
From this point on, if you need to access MySQL as the From this point on, if you need to access MySQL as the
MySQL root user, you will need to use "mysql -u root -p" and MySQL root user, you will need to use "mysql -u root -p" and
enter your new_password. Remember that MySQL user names have enter your new_password. Remember that MySQL user names have
nothing to do with Unix user names (login names). nothing to do with Unix user names (login names).
</PARA> </para>
<PARA> <para>
Next, we create the "bugs" user, and grant sufficient Next, we create the "bugs" user, and grant sufficient
permissions for checksetup.pl, which we'll use later, to work permissions for checksetup.pl, which we'll use later, to work
its magic. This also restricts the "bugs" user to operations its magic. This also restricts the "bugs" user to operations
...@@ -580,755 +635,1091 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl ...@@ -580,755 +635,1091 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
to connect from "localhost". Modify it to reflect your setup to connect from "localhost". Modify it to reflect your setup
if you will be connecting from another machine or as a different if you will be connecting from another machine or as a different
user. user.
</PARA> </para>
<PARA> <para>
Remember to set bugs_password to some unique password. Remember to set bugs_password to some unique password.
<SIMPLELIST> <simplelist>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>mysql></PROMPT> <prompt>mysql></prompt>
<COMMAND>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
ALTER,CREATE,DROP,REFERENCES ALTER,CREATE,DROP,REFERENCES
ON bugs.* TO bugs@localhost ON bugs.* TO bugs@localhost
IDENTIFIED BY 'bugs_password';</COMMAND> IDENTIFIED BY 'bugs_password';</command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT> <prompt>
mysql> mysql>
</PROMPT> </prompt>
<COMMAND> <command>
FLUSH PRIVILEGES; FLUSH PRIVILEGES;
</COMMAND> </command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
</SIMPLELIST> </simplelist>
</PARA> </para>
<PARA> <para>
Next, run the magic checksetup.pl script. (Many thanks to Holger Next, run the magic checksetup.pl script. (Many thanks to Holger
Schurig &lt;holgerschurig@nikocity.de&gt; for writing this script!) Schurig &lt;holgerschurig@nikocity.de&gt; for writing this script!)
It will make sure Bugzilla files and directories have reasonable It will make sure Bugzilla files and directories have reasonable
permissions, set up the "data" directory, and create all the MySQL permissions, set up the "data" directory, and create all the MySQL
tables. tables.
<SIMPLELIST> <simplelist>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>bash#</PROMPT> <prompt>bash#</prompt>
<COMMAND>./checksetup.pl</COMMAND> <command>./checksetup.pl</command>
</COMPUTEROUTPUT> </computeroutput>
</MEMBER> </member>
</SIMPLELIST> </simplelist>
The first time you run it, it will create a file called "localconfig". The first time you run it, it will create a file called "localconfig".
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>Tweaking "localconfig"</TITLE> <title>Tweaking "localconfig"</title>
<PARA> <para>
This file contains a variety of settings you may need to tweak including This file contains a variety of settings you may need to tweak including
how Bugzilla should connect to the MySQL database. how Bugzilla should connect to the MySQL database.
</PARA> </para>
<PARA> <para>
The connection settings include: The connection settings include:
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
server's host: just use "localhost" if the MySQL server is server's host: just use "localhost" if the MySQL server is
local local
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
database name: "bugs" if you're following these directions database name: "bugs" if you're following these directions
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
MySQL username: "bugs" if you're following these directions MySQL username: "bugs" if you're following these directions
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Password for the "bugs" MySQL account above Password for the "bugs" MySQL account above
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
</PARA> </para>
<PARA> <para>
You may also install .htaccess files that the Apache webserver will use
to restrict access to Bugzilla data files. See <xref linkend="htaccess">.
</para>
<para>
Once you are happy with the settings, re-run checksetup.pl. On this Once you are happy with the settings, re-run checksetup.pl. On this
second run, it will create the database and an administrator account second run, it will create the database and an administrator account
for which you will be prompted to provide information. for which you will be prompted to provide information.
</PARA> </para>
<PARA> <para>
When logged into an administrator account once Bugzilla is running, When logged into an administrator account once Bugzilla is running,
if you go to the query page (off of the bugzilla main menu), you'll if you go to the query page (off of the bugzilla main menu), you'll
find an 'edit parameters' option that is filled with editable treats. find an 'edit parameters' option that is filled with editable treats.
</PARA> </para>
<PARA> <para>
Should everything work, you should have a nearly empty copy of the bug Should everything work, you should have a nearly empty copy of the bug
tracking setup. tracking setup.
</PARA> </para>
<PARA> <para>
The second time around, checksetup.pl will stall if it is on a The second time around, checksetup.pl will stall if it is on a
filesystem that does not fully support file locking via flock(), such as filesystem that does not fully support file locking via flock(), such as
NFS mounts. This support is required for Bugzilla to operate safely with NFS mounts. This support is required for Bugzilla to operate safely with
multiple instances. If flock() is not fully supported, it will stall at: multiple instances. If flock() is not fully supported, it will stall at:
<ERRORCODE>Now regenerating the shadow database for all bugs.</ERRORCODE> <errorcode>Now regenerating the shadow database for all bugs.</errorcode>
<NOTE> <note>
<PARA> <para>
The second time you run checksetup.pl, you should become the The second time you run checksetup.pl, you should become the
user your web server runs as, and that you ensure you have set the user your web server runs as, and that you ensure that you set the
"webservergroup" parameter in localconfig to match the web server's group "webservergroup" parameter in localconfig to match the web
name, if any. I believe, for the next release of Bugzilla, this will server's group
be fixed so that Bugzilla supports a "webserveruser" parameter in localconfig name, if any. I believe, for the next release of Bugzilla,
this will
be fixed so that Bugzilla supports a "webserveruser" parameter
in localconfig
as well. as well.
<EXAMPLE> <example>
<TITLE>Running checksetup.pl as the web user</TITLE> <title>Running checksetup.pl as the web user</title>
<PARA> <para>
Assuming your web server runs as user "apache", and Bugzilla is installed in Assuming your web server runs as user "apache",
"/usr/local/bugzilla", here's one way to run checksetup.pl as the web server user. and Bugzilla is installed in
As root, for the <EMPHASIS>second run</EMPHASIS> of checksetup.pl, do this: "/usr/local/bugzilla", here's one way to run checksetup.pl
<PROGRAMLISTING> as the web server user.
As root, for the <emphasis>second run</emphasis>
of checksetup.pl, do this:
<programlisting>
bash# chown -R apache:apache /usr/local/bugzilla bash# chown -R apache:apache /usr/local/bugzilla
bash# su - apache bash# su - apache
bash# cd /usr/local/bugzilla bash# cd /usr/local/bugzilla
bash# ./checksetup.pl bash# ./checksetup.pl
</PROGRAMLISTING> </programlisting>
</PARA> </para>
</EXAMPLE> </example>
</PARA> </para>
</NOTE> </note>
</PARA> </para>
<NOTE> <note>
<PARA> <para>
The checksetup.pl script is designed so that you can run it at any time The checksetup.pl script is designed so that you can run
without causing harm. You should run it after any upgrade to Bugzilla. it at any time without causing harm. You should run it
</PARA> after any upgrade to Bugzilla.
</NOTE> </para>
</SECTION> </note>
</section>
<SECTION>
<TITLE>Setting Up Maintainers Manually (Optional)</TITLE>
<PARA>
If you want to add someone else to every group by hand, you can do it
by typing the appropriate MySQL commands. Run '<COMPUTEROUTPUT>
mysql -u root -p bugs</COMPUTEROUTPUT>'
(you may need different parameters, depending on your security settings
according to section 3, above). Then:
<SIMPLELIST>
<MEMBER>
<COMPUTEROUTPUT>
<PROMPT>mysql></PROMPT>
<COMMAND>update profiles set groupset=0x7fffffffffffffff
where login_name = 'XXX';</COMMAND>
</COMPUTEROUTPUT>
</MEMBER>
</SIMPLELIST>
replacing XXX with the Bugzilla email address.
</PARA>
</SECTION>
<SECTION> <section>
<TITLE>The Whining Cron (Optional)</TITLE> <title>Setting Up Maintainers Manually (Optional)</title>
<PARA> <para>
By now you've got a fully functional bugzilla, but what good are bugs If you want to add someone else to every group by hand, you
if they're not annoying? To help make those bugs more annoying you can can do it by typing the appropriate MySQL commands. Run
set up bugzilla's automatic whining system. This can be done by adding '<computeroutput> mysql -u root -p bugs</computeroutput>' You
the following command as a daily crontab entry (for help on that see that may need different parameters, depending on your security
crontab man page): settings. Then:
<SIMPLELIST> <simplelist>
<MEMBER> <member>
<COMPUTEROUTPUT> <computeroutput> <prompt>mysql></prompt> <command>update
<COMMAND>cd &lt;your-bugzilla-directory&gt; ; ./whineatnews.pl</COMMAND> profiles set groupset=0x7fffffffffffffff where
</COMPUTEROUTPUT> login_name = 'XXX';</command> </computeroutput>
</MEMBER> </member>
</SIMPLELIST> </simplelist> replacing XXX with the Bugzilla email address.
</PARA> </para>
</SECTION> </section>
<SECTION> <section>
<TITLE>Bug Graphs (Optional)</TITLE> <title>The Whining Cron (Optional)</title>
<PARA> <para>
As long as you installed the GD and Graph::Base Perl modules you might By now you have a fully functional bugzilla, but what good
as well turn on the nifty bugzilla bug reporting graphs. are bugs if they're not annoying? To help make those bugs
</PARA> more annoying you can set up bugzilla's automatic whining
<PARA> system. This can be done by adding the following command as a
Add a cron entry like this to run collectstats daily at 5 after midnight: daily crontab entry (for help on that see that crontab man
<SIMPLELIST> page):
<MEMBER> <simplelist>
<COMPUTEROUTPUT> <member>
<PROMPT>bash#</PROMPT> <computeroutput> <command>cd
<COMMAND>crontab -e</COMMAND> &lt;your-bugzilla-directory&gt; ;
</COMPUTEROUTPUT> ./whineatnews.pl</command> </computeroutput>
</MEMBER> </member>
<MEMBER> </simplelist>
<COMPUTEROUTPUT> </para>
5 0 * * * cd &lt;your-bugzilla-directory&gt; ; ./collectstats.pl <tip>
</COMPUTEROUTPUT> <para>
</MEMBER> Depending on your system, crontab may have several manpages.
</SIMPLELIST> The following command should lead you to the most useful
</PARA> page for this purpose:
<PARA> <programlisting>
After two days have passed you'll be able to view bug graphs from the man 5 crontab
Bug Reports page. </programlisting>
</PARA> </para>
</SECTION> </tip>
</section>
<section>
<title>Bug Graphs (Optional)</title>
<para>
As long as you installed the GD and Graph::Base Perl modules
you might as well turn on the nifty bugzilla bug reporting
graphs.
</para>
<para>
Add a cron entry like this to run collectstats daily at 5
after midnight:
<simplelist>
<member>
<computeroutput> <prompt>bash#</prompt> <command>crontab
-e</command> </computeroutput>
</member>
<member>
<computeroutput> 5 0 * * * cd
&lt;your-bugzilla-directory&gt; ; ./collectstats.pl
</computeroutput>
</member>
</simplelist>
</para>
<para>
After two days have passed you'll be able to view bug graphs
from the Bug Reports page.
</para>
</section>
<section>
<title>Securing MySQL</title>
<para>
If you followed the installation instructions for setting up
your "bugs" and "root" user in MySQL, much of this should not
apply to you. If you are upgrading an existing installation
of Bugzilla, you should pay close attention to this section.
</para>
<para>
Most MySQL installs have "interesting" default security parameters:
<simplelist>
<member>mysqld defaults to running as root</member>
<member>it defaults to allowing external network connections</member>
<member>it has a known port number, and is easy to detect</member>
<member>it defaults to no passwords whatsoever</member>
<member>it defaults to allowing "File_Priv"</member>
</simplelist>
</para>
<para>
This means anyone from anywhere on the internet can not only
drop the database with one SQL command, and they can write as
root to the system.
</para>
<para>
To see your permissions do:
<simplelist>
<member>
<computeroutput>
<prompt>bash#</prompt>
<command>mysql -u root -p</command>
</computeroutput>
</member>
<member>
<computeroutput>
<prompt>mysql></prompt>
<command>use mysql;</command>
</computeroutput>
</member>
<member>
<computeroutput>
<prompt>mysql></prompt>
<command>show tables;</command>
</computeroutput>
</member>
<member>
<computeroutput>
<prompt>mysql></prompt>
<command>select * from user;</command>
</computeroutput>
</member>
<member>
<computeroutput>
<prompt>mysql></prompt>
<command>select * from db;</command>
</computeroutput>
</member>
</simplelist>
</para>
<para>
To fix the gaping holes:
<simplelist>
<member>DELETE FROM user WHERE User='';</member>
<member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member>
<member> FLUSH PRIVILEGES;</member>
</simplelist>
</para>
<para>
If you're not running "mit-pthreads" you can use:
<simplelist>
<member>GRANT USAGE ON *.* TO bugs@localhost;</member>
<member>GRANT ALL ON bugs.* TO bugs@localhost;</member>
<member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member>
<member>FLUSH PRIVILEGES;</member>
</simplelist>
</para>
<para>
With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
line to specify a specific host name instead of "localhost", and accept
external connections:
<simplelist>
<member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member>
<member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member>
<member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member>
<member>FLUSH PRIVILEGES;</member>
</simplelist>
</para>
<para>
Use .htaccess files with the Apache webserver to secure your
bugzilla install. See <xref linkend="htaccess">
</para>
<para>
Consider also:
<orderedlist>
<listitem>
<para>
Turning off external networking with "--skip-networking",
unless you have "mit-pthreads", in which case you can't.
Without networking, MySQL connects with a Unix domain socket.
</para>
</listitem>
<listitem>
<para>
using the --user= option to mysqld to run it as an unprivileged
user.
</para>
</listitem>
<listitem>
<para>
starting MySQL in a chroot jail
</para>
</listitem>
<listitem>
<para>
running the httpd in a "chrooted" jail
</para>
</listitem>
<listitem>
<para>
making sure the MySQL passwords are different from the OS
passwords (MySQL "root" has nothing to do with system "root").
</para>
</listitem>
<listitem>
<para>
running MySQL on a separate untrusted machine
</para>
</listitem>
<listitem>
<para>
making backups ;-)
</para>
</listitem>
</orderedlist>
</para>
</section>
</section>
<section id="osx">
<title>Mac OS X Installation Notes</title>
<para>
There are a lot of common libraries and utilities out there
that Apple did not include with Mac OS X, but which run
perfectly well on it. The GD library, which Bugzilla needs to
do bug graphs, is one of these.
</para>
<para>
The easiest way to get a lot of these is with a program called
Fink, which is similar in nature to the CPAN installer, but
installs common GNU utilities. Fink is available from
&lt;http://sourceforge.net/projects/fink/>.
</para>
<para>
Follow the instructions for setting up Fink. Once it's
installed, you'll want to run the following as root:
<command>fink install gd</command>
</para>
<para>
It will prompt you for a number of dependencies, type 'y' and
hit enter to install all of the dependencies. Then watch it
work.
</para>
<para>
To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at
/sw where it installs most of the software that it installs.
This means your libraries and headers for libgd will be at
/sw/lib and /sw/include instead of /usr/lib and
/usr/local/include. Because of these changed locations for
the libraries, the Perl GD module will not install directly
via CPAN (it looks for the specific paths instead of getting
them from your environment). But there's a way around that
:-)
</para>
<para>
Instead of typing <quote>install GD</quote> at the
<prompt>cpan&gt;</prompt> prompt, type <command>look
GD</command>. This should go through the motions of
downloading the latest version of the GD module, then it will
open a shell and drop you into the build directory. Apply the
following patch to the Makefile.PL file (save the patch into a
file and use the command <command>patch &lt;
patchfile</command>:
</para>
<para>
<programlisting>
<![CDATA[
--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000
+++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001
@@ -3,8 +3,8 @@
warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
# =====> PATHS: CHECK AND ADJUST <=====
-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
my @LIBS = qw(-lgd -lpng -lz);
# FEATURE FLAGS
@@ -23,7 +23,7 @@
push @LIBS,'-lttf' if $TTF;
push @LIBS,'-ljpeg' if $JPEG;
-push @LIBS, '-lm' unless $^O eq 'MSWin32';
+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
# FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
<SECTION> ]]>
<TITLE>Securing MySQL</TITLE> </programlisting>
<PARA> </para>
If you followed the README for setting up your "bugs" and "root" user in <para>
MySQL, much of this should not apply to you. If you are upgrading Then, run these commands to finish the installation of the perl module:
an existing installation of Bugzilla, you should pay close attention <simplelist>
to this section. <member><command>perl Makefile.PL</command></member>
</PARA> <member><command>make</command></member>
<PARA> <member><command>make test</command></member>
Most MySQL installs have "interesting" default security parameters: <member><command>make install</command></member>
<SIMPLELIST> <member>And don't forget to run <command>exit</command> to get back to cpan.</member>
<MEMBER>mysqld defaults to running as root</MEMBER> </simplelist>
<MEMBER>it defaults to allowing external network connections</MEMBER> </para>
<MEMBER>it has a known port number, and is easy to detect</MEMBER> <para>
<MEMBER>it defaults to no passwords whatsoever</MEMBER> Happy Hacking!
<MEMBER>it defaults to allowing "File_Priv"</MEMBER> </para>
</SIMPLELIST> </section>
</PARA>
<PARA> <section id="bsdinstall" xreflabel="BSD Installation Notes">
This means anyone from anywhere on the internet can not only drop the <title>BSD Installation Notes</title>
database with one SQL command, and they can write as root to the system. <para>
</PARA> For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
<PARA> consult <xref linkend="osx">.
To see your permissions do: </para>
<SIMPLELIST> </section>
<MEMBER>
<COMPUTEROUTPUT>
<PROMPT>bash#</PROMPT> <section id="geninstall" xreflabel="Installation General Notes">
<COMMAND>mysql -u root -p</COMMAND> <title>Installation General Notes</title>
</COMPUTEROUTPUT> <section>
</MEMBER> <title>Modifying Your Running System</title>
<MEMBER> <para>
<COMPUTEROUTPUT> Bugzilla optimizes database lookups by storing all relatively static
<PROMPT>mysql></PROMPT> information in the versioncache file, located in the data/ subdirectory
<COMMAND>use mysql;</COMMAND> under your installation directory.
</COMPUTEROUTPUT> </para>
</MEMBER> <para>
<MEMBER> If you make a change to the structural data in your database
<COMPUTEROUTPUT> (the versions table for example), or to the
<PROMPT>mysql></PROMPT> <quote>constants</quote> encoded in defparams.pl, you will
<COMMAND>show tables;</COMMAND> need to remove the cached content from the data directory
</COMPUTEROUTPUT> (by doing a <quote>rm data/versioncache</quote>), or your
</MEMBER> changes won't show up.
<MEMBER> </para>
<COMPUTEROUTPUT> <para>
<PROMPT>mysql></PROMPT> That file gets automatically regenerated whenever it's more than an
<COMMAND>select * from user;</COMMAND> hour old, so Bugzilla will eventually notice your changes by itself, but
</COMPUTEROUTPUT> generally you want it to notice right away, so that you can test things.
</MEMBER> </para>
<MEMBER> </section>
<COMPUTEROUTPUT> <section>
<PROMPT>mysql></PROMPT> <title>Upgrading From Previous Versions</title>
<COMMAND>select * from db;</COMMAND> <para>
</COMPUTEROUTPUT> The developers of Bugzilla are constantly adding new tables, columns and
</MEMBER> fields. You'll get SQL errors if you just update the code. The strategy
</SIMPLELIST> to update is to simply always run the checksetup.pl script whenever
</PARA> you upgrade your installation of Bugzilla. If you want to see what has
<PARA> changed, you can read the comments in that file, starting from the end.
To fix the gaping holes: </para>
<SIMPLELIST> <para>
<MEMBER>DELETE FROM user WHERE User='';</MEMBER> If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
<MEMBER>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</MEMBER> the latest version, please consult the file, "UPGRADING-pre-2.8" in the
<MEMBER> FLUSH PRIVILEGES;</MEMBER> Bugzilla root directory after untarring the archive.
</SIMPLELIST> </para>
</PARA> </section>
<PARA>
If you're not running "mit-pthreads" you can use:
<SIMPLELIST>
<MEMBER>GRANT USAGE ON *.* TO bugs@localhost;</MEMBER>
<MEMBER>GRANT ALL ON bugs.* TO bugs@localhost;</MEMBER>
<MEMBER>REVOKE DROP ON bugs.* FROM bugs@localhost;</MEMBER>
<MEMBER>FLUSH PRIVILEGES;</MEMBER>
</SIMPLELIST>
</PARA>
<PARA>
With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
line to specify a specific host name instead of "localhost", and accept
external connections:
<SIMPLELIST>
<MEMBER>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</MEMBER>
<MEMBER>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</MEMBER>
<MEMBER>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</MEMBER>
<MEMBER>FLUSH PRIVILEGES;</MEMBER>
</SIMPLELIST>
</PARA>
<PARA>
Consider also:
<ORDEREDLIST>
<LISTITEM>
<PARA>
Turning off external networking with "--skip-networking",
unless you have "mit-pthreads", in which case you can't.
Without networking, MySQL connects with a Unix domain socket.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
using the --user= option to mysqld to run it as an unprivileged
user.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
starting MySQL in a chroot jail
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
running the httpd in a "chrooted" jail
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
making sure the MySQL passwords are different from the OS
passwords (MySQL "root" has nothing to do with system "root").
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
running MySQL on a separate untrusted machine
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>
making backups ;-)
</PARA>
</LISTITEM>
</ORDEREDLIST>
</PARA>
</SECTION>
<SECTION>
<TITLE>Installation General Notes</TITLE>
<SECTION>
<TITLE>Modifying Your Running System</TITLE>
<PARA>
Bugzilla optimizes database lookups by storing all relatively static
information in the versioncache file, located in the data/ subdirectory
under your installation directory (we said before it needs to be writable,
right?!)
</PARA>
<PARA>
If you make a change to the structural data in your database (the
versions table for example), or to the "constants" encoded in
defparams.pl, you will need to remove the cached content from the data
directory (by doing a "rm data/versioncache"), or your changes won't show
up!
</PARA>
<PARA>
That file gets automatically regenerated whenever it's more than an
hour old, so Bugzilla will eventually notice your changes by itself, but
generally you want it to notice right away, so that you can test things.
</PARA>
</SECTION>
<SECTION>
<TITLE>Upgrading From Previous Versions</TITLE>
<PARA>
The developers of Bugzilla are constantly adding new tables, columns and
fields. You'll get SQL errors if you just update the code. The strategy
to update is to simply always run the checksetup.pl script whenever
you upgrade your installation of Bugzilla. If you want to see what has
changed, you can read the comments in that file, starting from the end.
</PARA>
</SECTION>
<SECTION>
<TITLE>UNIX Installation Instructions History</TITLE>
<PARA>
This document was originally adapted from the Bonsai installation
instructions by Terry Weissman &lt;terry@mozilla.org&gt;.
</PARA>
<PARA>
The February 25, 1999 re-write of this page was done by Ry4an Brase
&lt;ry4an@ry4an.org&gt;, with some edits by Terry Weissman, Bryce Nesbitt,
Martin Pool, & Dan Mosedale (But don't send bug reports to them!
Report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi ,
project Webtools, component Bugzilla).
</PARA>
<PARA>
This document was heavily modified again Wednesday, March 07 2001 to
reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The
securing MySQL section should be changed to become standard procedure
for Bugzilla installations.
</PARA>
<PARA>
Finally, the README in its entirety was marked up in SGML and included into
the Guide on April 24, 2001.
</PARA>
<PARA>
Comments from people using this Guide for the first time are particularly welcome.
</PARA>
</SECTION>
</SECTION>
</SECTION>
</SECTION>
<SECTION id="README.windows"> <section id="htaccess" xreflabel=".htaccess files and security">
<TITLE>Win32 (Win98+/NT/2K) Installation</TITLE> <title><filename>.htaccess</filename> files and security</title>
<PARA> <para>
These directions have <EMPHASIS>not</EMPHASIS> been extensively tested. To enhance the security of your Bugzilla installation,
We need testers! Please try these out and post any changes to the Bugzilla will generate
newsgroup. <glossterm><filename>.htaccess</filename></glossterm> files
</PARA> which the Apache webserver can use to restrict access to
<SECTION id="ntverified"> the bugzilla data files. The checksetup script will
<TITLE>Win32 Installation: Step-by-step</TITLE> generate the <filename>.htaccess</filename> files.
<NOTE>
<PARA> <note>
You should be familiar with, and cross-reference, the UNIX README <para>
while performing your Win32 installation. Unfortunately, Win32 If you are using an alternate provider of
directions are not yet as detailed as those for UNIX. <productname>webdot</productname> services for graphing
</PARA> (as described when viewing
<PARA> <filename>editparams.cgi</filename> in your web
The <EMPHASIS>most critical</EMPHASIS> difference for Win32 users is browser), you will need to change the ip address in
the lack of support for a crypt() function in MySQL for Windows. It does not <filename>data/webdot/.htaccess</filename> to the ip
have it! All ENCRYPT statements must be modified. address of the webdot server that you are using.
</PARA> </para>
</NOTE> </note>
</para>
<para>
If you are using Internet Information Server or other web
server which does not observe <filename>.htaccess</filename>
conventions, you can disable their creation by editing
<filename>localconfig</filename> and setting the
<varname>$create_htaccess</varname> variable to
<parameter>0</parameter>.
</para>
</section>
<section>
<title>UNIX Installation Instructions History</title>
<para>
This document was originally adapted from the Bonsai installation
instructions by Terry Weissman &lt;terry@mozilla.org&gt;.
</para>
<para>
The February 25, 1999 re-write of this page was done by Ry4an Brase
&lt;ry4an@ry4an.org&gt;, with some edits by Terry Weissman, Bryce Nesbitt,
Martin Pool, & Dan Mosedale (But don't send bug reports to them;
report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi ,
project Webtools, component Bugzilla).
</para>
<para>
This document was heavily modified again Wednesday, March 07 2001 to
reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The
securing MySQL section should be changed to become standard procedure
for Bugzilla installations.
</para>
<para>
Finally, the README in its entirety was marked up in SGML and included into
the Guide on April 24, 2001 by Matt Barnson. Since that time, it's undergone
extensive modification as Bugzilla grew.
</para>
<para>
Comments from people using this Guide for the first time are particularly welcome.
</para>
</section>
</section>
<section id="win32" xreflabel="Win32 Installation Notes">
<title>Win32 Installation Notes</title>
<para>This section covers installation on Microsoft Windows 95,
98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms,
but please remember that the Bugzilla team and the author of the
Guide neither endorse nor support installation on Microsoft
Windows. Bugzilla installs and runs <emphasis>best</emphasis>
and <emphasis>easiest</emphasis> on UNIX-like operating systems,
and that is the way it will stay for the foreseeable future. The
Bugzilla team is considering supporting Win32 for the 2.16
release and later.</para>
<para>The easiest way to install Bugzilla on Intel-archiecture
machines is to install some variant of GNU/Linux, then follow
the UNIX installation instructions in this Guide. If you have
any influence in the platform choice for running this system,
please choose GNU/Linux instead of Microsoft Windows.</para>
<PROCEDURE> <section id="wininstall" xreflabel="Win32 Installation: Step-by-step">
<STEP> <title>Win32 Installation: Step-by-step</title>
<PARA> <note>
Install <ULINK URL="http://www.apache.org/">Apache Web Server</ULINK> <para>
You should be familiar with, and cross-reference, the rest
of the
<xref linkend="installation"> section while performing your
Win32 installation.
</para>
<para> Making Bugzilla work on Microsoft Windows is no
picnic. Support for Win32 has improved dramatically in the
last few releases, but, if you choose to proceed, you should
be a <emphasis>very</emphasis> skilled Windows Systems
Administrator with both strong troubleshooting abilities and
a high tolerance for pain. Bugzilla on NT requires hacking
source code and implementing some advanced utilities. What
follows is the recommended installation procedure for Win32;
additional suggestions are provided in <xref linkend="faq">.
</para>
</note>
<procedure>
<step>
<para>
Install <ulink url="http://www.apache.org/">Apache Web Server</ulink>
for Windows. for Windows.
</PARA> </para>
<NOTE> <note>
<PARA> <para>
You may also use Internet Information Server or Personal Web You may also use Internet Information Server or Personal Web
Server for this purpose. However, setup is slightly more Server for this purpose. However, setup is slightly more
difficult. If ActivePerl doesn't seem to handle your file difficult. If ActivePerl doesn't seem to handle your file
associations correctly (for .cgi and .pl files), please associations correctly (for .cgi and .pl files), please
consult the FAQ, in the "Win32" section. consult <xref linkend="faq">.
</PARA> </para>
<PARA> <para>
If you are going to use IIS, if on Windows NT you must be updated If you are going to use IIS, if on Windows NT you must
to at least Service Pack 4. be updated to at least Service Pack 4. Windows 2000
</PARA> ships with a sufficient version of IIS.
</NOTE> </para>
</STEP> </note>
<STEP> </step>
<PARA> <step>
Install <ULINK URL="http://www.activestate.com/">ActivePerl</ULINK> <para>
</PARA> Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary.
<PARA> </para>
<para>
Please also check the following links to fully understand the status Please also check the following links to fully understand the status
of ActivePerl on Win32: of ActivePerl on Win32:
<ULINK URL="http://language.perl.com/newdocs/pod/perlport.html"> <ulink url="http://language.perl.com/newdocs/pod/perlport.html">
Perl Porting</ULINK>, and Perl Porting</ulink>, and
<ULINK URL="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html">
Hixie Click Here</ULINK> Perl on Win32 FAQ</ulink>
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Use ppm from your perl\bin directory to install the following packs: DBI, Use ppm from your perl\bin directory to install the following packs: DBI,
DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need
to extract them from .zip format using Winzip or other unzip program first. to extract them from .zip format using Winzip or other unzip program first.
These additional ppm modules can be downloaded from ActiveState. These additional ppm modules can be downloaded from ActiveState.
</PARA> </para>
<PARA> <note>
<para>
You can find a list of modules at
<ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only">
http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink>
</para>
</note>
<para>
The syntax for ppm is: The syntax for ppm is:
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>C:> </PROMPT><COMMAND>ppm install &lt;module&gt;.ppd</COMMAND> <prompt>C:> </prompt><command>ppm &lt;modulename&gt;</command>
</COMPUTEROUTPUT> </computeroutput>
</PARA> </para>
<PARA>
<example>
<title>Installing ActivePerl ppd Modules on Microsoft Windows</title>
<para><prompt>C:></prompt><command>ppm
<option>DBD-Mysql</option></command></para>
<para>Watch your capitalization!</para>
</example>
<para>
You can find ActiveState ppm modules at You can find ActiveState ppm modules at
<ULINK URL="http://www.activestate.com/PPMPackages/5.6plus/"> <ulink url="http://www.activestate.com/PPMPackages/5.6plus/">
http://www.activestate.com/PPMPackages/5.6plus</ULINK> http://www.activestate.com/PPMPackages/5.6plus</ulink>
</PARA> </para>
</STEP> </step>
<STEP>
<PARA> <step>
Download and install the Windows GNU tools from <para>
<ULINK URL="http://www.cygwin.com/">www.cygwin.com</ULINK>.
Make sure the GNU utilities are in your $PATH.
</PARA>
</STEP>
<STEP>
<PARA>
Install MySQL for NT. Install MySQL for NT.
<NOTE> <note>
<PARA> <para>
Your configuration file for MySQL <EMPHASIS>must</EMPHASIS> be named C:\MY.CNF. You can download MySQL for Windows NT from <ulink
</PARA> url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
</NOTE> </para>
</PARA> </note>
</STEP> </para>
<STEP> </step>
<PARA> <step>
<para>
Setup MySQL Setup MySQL
</PARA> </para>
<SUBSTEPS> <substeps>
<STEP> <step>
<PARA> <para>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>C:> </PROMPT> <prompt>C:> </prompt>
<COMMAND>C:\mysql\bin\mysql -u root mysql</COMMAND> <command>C:\mysql\bin\mysql -u root mysql</command>
</COMPUTEROUTPUT> </computeroutput>
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>mysql></PROMPT> <prompt>mysql></prompt>
<COMMAND>DELETE FROM user WHERE Host='localhost' AND User='';</COMMAND> <command>DELETE FROM user WHERE Host='localhost' AND User='';</command>
</COMPUTEROUTPUT> </computeroutput>
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
<COMPUTEROUTPUT> <computeroutput>
<PROMPT>mysql></PROMPT> <prompt>mysql></prompt>
<COMMAND>UPDATE user SET Password=PASSWORD ('new_password') <command>UPDATE user SET Password=PASSWORD ('new_password')
WHERE user='root';</COMMAND> WHERE user='root';</command>
</COMPUTEROUTPUT> </computeroutput>
</PARA> </para>
</STEP> <para><quote>new_password</quote>, above, indicates
<STEP> whatever password you wish to use for your
<PARA> <quote>root</quote> user.</para>
<COMPUTEROUTPUT> </step>
<PROMPT>mysql></PROMPT> <step id="ntbugs-password">
<COMMAND>GRANT SELECT, INSERT, UPDATE, DELETE, <para>
<computeroutput>
<prompt>mysql></prompt>
<command>GRANT SELECT, INSERT, UPDATE, DELETE,
INDEX, ALTER, CREATE, DROP, REFERENCES INDEX, ALTER, CREATE, DROP, REFERENCES
ON bugs.* to bugs@localhost ON bugs.* to bugs@localhost
IDENTIFIED BY 'bugs_password';</COMMAND> IDENTIFIED BY 'bugs_password';</command>
</COMPUTEROUTPUT> </computeroutput>
</PARA> </para>
</STEP> <para><quote>bugs_password</quote>, above, indicates
<STEP> whatever password you wish to use for your
<PARA> <quote>bugs</quote> user.</para>
<COMPUTEROUTPUT> </step>
<PROMPT>mysql></PROMPT> <step>
<COMMAND>FLUSH PRIVILEGES;</COMMAND> <para>
</COMPUTEROUTPUT> <computeroutput>
</PARA> <prompt>mysql></prompt>
</STEP> <command>FLUSH PRIVILEGES;</command>
<STEP> </computeroutput>
<PARA> </para>
<COMPUTEROUTPUT> </step>
<PROMPT>mysql></PROMPT> <step>
<COMMAND>create database bugs;</COMMAND> <para>
</COMPUTEROUTPUT> <computeroutput>
</PARA> <prompt>mysql></prompt>
</STEP> <command>create database bugs;</command>
<STEP> </computeroutput>
<PARA> </para>
<COMPUTEROUTPUT> </step>
<PROMPT>mysql></PROMPT> <step>
<COMMAND>exit</COMMAND> <para>
</COMPUTEROUTPUT> <computeroutput>
</PARA> <prompt>mysql></prompt>
</STEP> <command>exit;</command>
<STEP> </computeroutput>
<PARA> </para>
<COMPUTEROUTPUT> </step>
<PROMPT>C:></PROMPT> <step>
<COMMAND>C:\mysql\bin\mysqladmin -u root -p reload</COMMAND> <para>
</COMPUTEROUTPUT> <computeroutput>
</PARA> <prompt>C:></prompt>
</STEP> <command>C:\mysql\bin\mysqladmin -u root -p reload</command>
</SUBSTEPS> </computeroutput>
</STEP> </para>
</step>
</substeps>
</step>
<STEP> <step>
<PARA> <para>
Configure Bugzilla. For Win32, this involves editing "defparams.pl" Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change
and "localconfig" to taste. Running "checksetup.pl" should create this line:
localconfig for you. Note that getgrnam() doesn't work, and should be </para>
deleted. Change this line: <para>
"my $webservergid = getgrnam($my_webservergroup); " "my $webservergid = getgrnam($my_webservergroup); "
</para>
<para>
to to
</para>
<para>
"my $webservergid = $my_webservergroup; " "my $webservergid = $my_webservergroup; "
</PARA> </para>
</STEP> </step>
<step>
<para>
Run <filename>checksetup.pl</filename> from the Bugzilla directory.
</para>
</step>
<step>
<para>Edit <filename>localconfig</filename> to suit your
requirements. Set <varname>$db_pass</varname> to your
<quote>bugs_password</quote> from <xref
linkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para>
<note>
<para>Not sure on the <quote>8</quote> for
<varname>$webservergroup</varname> above. If it's
wrong, please send corrections.</para>
</note>
</step>
<step>
<para>
Edit <filename>defparams.pl</filename> to suit your
requirements. Particularly, set
<varname>DefParam("maintainer")</varname> and
<varname>DefParam("urlbase") to match your
install.</varname>
</para>
<note>
<para>This is yet another step I'm not sure of, since the
maintainer of this documentation does not maintain
Bugzilla on NT. If you can confirm or deny that this
step is required, please let me know.</para>
</note>
</step>
<STEP> <step>
<NOTE> <note>
<PARA> <para>
There are several alternatives to Sendmail that will work on Win32. There are several alternatives to Sendmail that will work on Win32.
The one mentioned here is a <EMPHASIS>suggestion</EMPHASIS>, not The one mentioned here is a <emphasis>suggestion</emphasis>, not
a requirement. Some other mail packages that can work include a requirement. Some other mail packages that can work include
<ULINK URL="http://www.blat.net/">BLAT</ULINK>, <ulink url="http://www.blat.net/">BLAT</ulink>,
<ULINK URL="http://www.geocel.com/windmail/">Windmail</ULINK>, <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>,
<ULINK URL="http://www.dynamicstate.com/">Mercury Sendmail</ULINK>, <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>,
and the CPAN Net::SMTP Perl module (available in .ppm). and the CPAN Net::SMTP Perl module (available in .ppm).
Every option requires some hacking of the Perl scripts for Bugzilla Every option requires some hacking of the Perl scripts for Bugzilla
to make it work. The option here simply requires the least. to make it work. The option here simply requires the least.
</PARA> </para>
</NOTE> </note>
<PARA>
Download NTsendmail, available from<ULINK URL="http://www.ntsendmail.com/"> <procedure>
www.ntsendmail.com</ULINK>. In order for it to work, you must set up some <step>
new environment variables (detailed on the ntsendmail home page). Figuring <para>
out where to put those variables is left as an exercise for the reader. Download NTsendmail, available from<ulink
You must have a "real" mail server which allows you to relay off it url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
in your $ENV{"NTsendmail"} (which you should probably place in globals.pl) </para>
</PARA> </step>
<PARA>
Once downloaded and installed, modify all open(SENDMAIL) calls to open <step>
"| c:\ntsendmail\ntsendmail -t" instead of "|/usr/lib/sendmail -t". <para>Put ntsendmail.pm into your .\perl\lib directory.</para>
</PARA> </step>
<NOTE>
<PARA> <step>
We need someone to test this and make sure this works as advertised. <para>Add to globals.pl:</para>
</PARA> <programlisting>
</NOTE> # these settings configure the NTsendmail process
</STEP> use NTsendmail;
<STEP> $ENV{"NTsendmail"}="your.smtpserver.box";
<PARA> $ENV{"NTsendmail_debug"}=1;
Modify globals.pl and CGI.pl to remove the word "encrypt". $ENV{"NTsendmail_max_tries"}=5;
</PARA> </programlisting>
<NOTE> <note>
<PARA> <para>
I'm not sure this is all that is involved to remove crypt. Any Some mention to also edit
NT Bugzilla hackers want to pipe up? <varname>$db_pass</varname> in
</PARA> <filename>globals.pl</filename> to be your
</NOTE> <quote>bugs_password</quote>. Although this may get
</STEP> you around some problem authenticating to your
<STEP> database, since globals.pl is not normally
<PARA> restricted by <filename>.htaccess</filename>, your
Change all references to "processmail" to "processmail.pl" in database password is exposed to whoever uses your
all files, and rename "processmail" to "processmail.pl" web server.
</PARA> </para>
<NOTE> </note>
<PARA> </step>
I really think this may be a change we want to make for
<step>
<para>
Find and comment out all occurences of
<quote><command>open(SENDMAIL</command></quote> in
your Bugzilla directory. Then replace them with:
<programlisting>
# new sendmail functionality
my $mail=new NTsendmail;
my $from="bugzilla\@your.machine.name.tld";
my $to=$login;
my $subject=$urlbase;
$mail->send($from,$to,$subject,$msg);
</programlisting>
</para>
<note>
<para>The code above needs testing as well to make sure it is correct.</para>
</note>
</step>
</procedure>
</step>
<step>
<para>
Change all references in all files from
<filename>processmail</filename> to
<filename>processmail.pl</filename>, and
rename <filename>processmail</filename> to
<filename>processmail.pl</filename>.
</para>
<note>
<para>
Many think this may be a change we want to make for
main-tree Bugzilla. It's painless for the UNIX folks, main-tree Bugzilla. It's painless for the UNIX folks,
and will make the Win32 people happier. and will make the Win32 people happier.
</PARA> </para>
</NOTE> </note>
</STEP> <note>
<STEP> <para>
<PARA> Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.
Modify the path to perl on the first line (#!) of all files <programlisting>
to point to your Perl installation, and <![CDATA[
add "perl" to the beginning of all Perl system calls that
use a perl script as an argument. This may take you a while. my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server
There is a "setperl.pl" utility to speed part of this procedure, $smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
available in the "Patches and Utilities" section of The Bugzilla Guide. $smtp->to($tolist); # recipient's address
</PARA> $smtp->data(); # Start the mail
</STEP> $smtp->datasend($msg);
<STEP> $smtp->dataend(); # Finish sending the mail
<PARA> $smtp->quit; # Close the SMTP connection
In processmail.pl, add "binmode(HANDLE)" before all read() calls. $logstr = "$logstr; mail sent to $tolist $cclist";
This may not be necessary, but in some cases the read() under }
Win32 doesn't count the EOL's without using a binary read().
</PARA> ]]>
</STEP> </programlisting>
</PROCEDURE> here is a test mail program for Net::SMTP:
<programlisting>
<![CDATA[
</SECTION> 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;
<SECTION id="addlwintips"> ]]>
<TITLE>Additional Windows Tips</TITLE> </programlisting>
<TIP> </para>
<PARA> </note>
</step>
<step>
<note>
<para>
This step is completely optional if you are using IIS or
another web server which only decides on an interpreter
based upon the file extension (.pl), rather than the
<quote>shebang</quote> line (#/usr/bonsaitools/bin/perl)
</para>
</note>
<para>
Modify the path to perl on the first line (#!) of all
files to point to your Perl installation, and add
<quote>perl</quote> to the beginning of all Perl system
calls that use a perl script as an argument. This may
take you a while. There is a <quote>setperl.csh</quote>
utility to speed part of this procedure, available in the
<xref linkend="patches"> section of The Bugzilla Guide.
However, it requires the Cygwin GNU-compatible environment
for Win32 be set up in order to work. See <ulink
url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin.
</para>
</step>
<step>
<para>
Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail:
<programlisting>
system ("./processmail.pl",@ARGLIST);
</programlisting>
to
<programlisting>
system ("perl processmail.pl",@ARGLIST);
</programlisting>
</para>
</step>
</procedure>
<tip>
<para>
If you are using IIS 5.0 or higher, you must add cgi
relationships to Properties -> Home directory (tab) ->
Application Settings (section) -> Configuration (button),
such as: <programlisting>
.cgi to: &lt;perl install directory&gt;\perl.exe %s %s
.pl to: &lt;perl install directory&gt;\perl.exe %s %s
GET,HEAD,POST
</programlisting>
Change the path to Perl to match your
install, of course.
</para>
</tip>
</section>
<section id="addlwintips">
<title>Additional Windows Tips</title>
<tip>
<para>
From Andrew Pearson: From Andrew Pearson:
<BLOCKQUOTE> <blockquote>
<PARA> <para>
"You can make Bugzilla work with Personal Web Server for "You can make Bugzilla work with Personal Web Server for
Windows 98 and higher, as well as for IIS 4.0. Microsoft has Windows 98 and higher, as well as for IIS 4.0. Microsoft has
information available at information available at
<ULINK URL=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> <ulink url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP">
http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ULINK> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink>
</PARA> </para>
<PARA> <para>
Basically you need to add two String Keys in the Basically you need to add two String Keys in the
registry at the following location: registry at the following location:
</PARA> </para>
<PARA> <para>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
</PARA> </para>
<PARA> <para>
The keys should be called ".pl" and ".cgi", and both The keys should be called ".pl" and ".cgi", and both
should have a value something like: should have a value something like:
<COMMAND>c:/perl/bin/perl.exe "%s" "%s"</COMMAND> <command>c:/perl/bin/perl.exe "%s" "%s"</command>
</PARA> </para>
<PARA> <para>
The KB article only talks about .pl, but it goes into The KB article only talks about .pl, but it goes into
more detail and provides a perl test script. more detail and provides a perl test script.
</PARA> </para>
</BLOCKQUOTE> </blockquote>
</PARA> </para>
</TIP> </tip>
<TIP> <tip>
<PARA>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</PARA> <para>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</para>
<BLOCKQUOTE> <blockquote>
<PARA> <para>
Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I
deleted the current dir and copied the files in). deleted the current dir and copied the files in).
</PARA> </para>
<PARA> <para>
In checksetup.pl, I did the following... In checksetup.pl, I did the following...
</PARA> </para>
<PROCEDURE> <procedure>
<STEP> <step>
<PROGRAMLISTING> <programlisting>
my $webservergid = getgrnam($my_webservergroup); my $webservergid = getgrnam($my_webservergroup);
</PROGRAMLISTING> </programlisting>
<PARA>to</PARA> <para>to</para>
<PROGRAMLISTING> <programlisting>
my $webservergid = 'Administrators' my $webservergid = 'Administrators'
</PROGRAMLISTING> </programlisting>
</STEP> </step>
<STEP> <step>
<PARA> <para>
I then ran checksetup.pl I then ran checksetup.pl
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
I removed all the encrypt() I removed all the encrypt()
<EXAMPLE> <example>
<TITLE>Removing encrypt() for Windows NT installations</TITLE> <title>Removing encrypt() for Windows NT installations</title>
<PARA> <para>
Replace this: Replace this:
<PROGRAMLISTING> <programlisting>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " .
SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); SqlQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn(); my $enteredcryptpwd = FetchOneColumn();
</PROGRAMLISTING> </programlisting>
with this: with this:
<PROGRAMLISTING> <programlisting>
my $enteredcryptpwd = $enteredpwd my $enteredcryptpwd = $enteredpwd
</PROGRAMLISTING> </programlisting>
in cgi.pl. in cgi.pl.
</PARA> </para>
</EXAMPLE> </example>
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
I renamed processmail to processmail.pl I renamed processmail to processmail.pl
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
I altered the sendmail statements to windmail: I altered the sendmail statements to windmail:
<PROGRAMLISTING> <programlisting>
open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
</PROGRAMLISTING> </programlisting>
</PARA> </para>
<PARA> <para>
The quotes around the dir is for the spaces. mail.log is for the output The quotes around the dir is for the spaces. mail.log is for the output
</PARA> </para>
</STEP> </step>
</PROCEDURE> </procedure>
</BLOCKQUOTE> </blockquote>
</TIP> </tip>
<TIP> <tip>
<PARA> <para>
This was some late breaking information from Jan Evert. Sorry for the lack of formatting. This was some late breaking information from Jan Evert. Sorry for the lack of formatting.
</PARA> </para>
<LITERALLAYOUT> <literallayout>
I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you
at this moment of the commments I have to section 2.2.1 of the bugzilla at this moment of the commments I have to section 2.2.1 of the bugzilla
guide (at http://www.trilobyte.net/barnsons/html/). guide (at http://www.trilobyte.net/barnsons/html/).
...@@ -1340,7 +1731,7 @@ necessary to add the ExecCGI option to the bugzilla directory. Also the ...@@ -1340,7 +1731,7 @@ necessary to add the ExecCGI option to the bugzilla directory. Also the
'AddHandler' line for .cgi is by default commented out. 'AddHandler' line for .cgi is by default commented out.
Step 3: although just a detail, 'ppm install &lt;module%gt;' will also work Step 3: although just a detail, 'ppm install &lt;module%gt;' will also work
(wihtout .ppd). And, it can also download these automatically from (without .ppd). And, it can also download these automatically from
ActiveState. ActiveState.
Step 4: although I have cygwin installed, it seems that it is not necessary. Step 4: although I have cygwin installed, it seems that it is not necessary.
...@@ -1372,30 +1763,30 @@ that apache can serve them. ...@@ -1372,30 +1763,30 @@ that apache can serve them.
Just noticed the updated guide... Brian's comment is new. His first comment Just noticed the updated guide... Brian's comment is new. His first comment
will work, but opens up a huge security hole. will work, but opens up a huge security hole.
</LITERALLAYOUT> </literallayout>
</TIP> </tip>
</SECTION> </section>
</SECTION> </section>
</CHAPTER> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:upper
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB --> <!-- Keep these tools listings in alphabetical order please. -MPB -->
...@@ -12,14 +12,13 @@ ...@@ -12,14 +12,13 @@
<section id="cvs"> <section id="cvs">
<title>CVS</title> <title>CVS</title>
<para>We need CVS integration information</para> <para>CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.</para>
</section> </section>
<section id="scm"> <section id="scm">
<title>Perforce SCM</title> <title>Perforce SCM</title>
<para> <para>
Richard Brooksby created a Perforce integration tool for Bugzilla and TeamTrack. You can find the project page for Bugzilla and Teamtrack Perforce integration at:
You can find the main project page at
<ulink url="http://www.ravenbrook.com/project/p4dti/"> <ulink url="http://www.ravenbrook.com/project/p4dti/">
http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" is now an officially http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" is now an officially
supported product from Perforce, and you can find the "Perforce Public Depot" supported product from Perforce, and you can find the "Perforce Public Depot"
...@@ -54,22 +53,25 @@ ...@@ -54,22 +53,25 @@
</chapter> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="patches"> <appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Useful Patches and Utilities for Bugzilla</title> <title>Useful Patches and Utilities for Bugzilla</title>
<section id="setperl"> <section id="setperl" xreflabel="The setperl.csh Utility">
<title>The setperl.csh Utility</title> <title>The setperl.csh Utility</title>
<para> <para> You can use the "setperl.csh" utility to quickly and
You can use the "setperl.csh" utility to quickly and easily easily change the path to perl on all your Bugzilla files. This
change the path to perl on all your Bugzilla files. is a C-shell script; if you do not have "csh" or "tcsh" in the
This is a C-shell script; if you do not have "csh" or "tcsh" in the search search path on your system, it will not work!
path on your system, it will not work!
</para> </para>
<procedure> <procedure>
<step> <step>
...@@ -28,18 +27,15 @@ ...@@ -28,18 +27,15 @@
</step> </step>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt> <command>wget -O
<prompt>bash#</prompt> setperl.csh
<command>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> </computeroutput>
</computeroutput>
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt> <command>chmod
<prompt>bash#</prompt> u+x setperl.csh</command> </computeroutput>
<command>chmod u+x setperl.csh</command>
</computeroutput>
</para> </para>
</step> </step>
</substeps> </substeps>
...@@ -59,10 +55,8 @@ ...@@ -59,10 +55,8 @@
</step> </step>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt> <command>chmod
<prompt>bash#</prompt> u+x duplicates.cgi</command> </computeroutput>
<command>chmod u+x duplicates.cgi</command>
</computeroutput>
</para> </para>
</step> </step>
<step> <step>
...@@ -80,16 +74,14 @@ ...@@ -80,16 +74,14 @@
Run the script: Run the script:
</para> </para>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt>
<prompt>bash#</prompt>
<command>./setperl.csh /your/path/to/perl</command> <command>./setperl.csh /your/path/to/perl</command>
</computeroutput> </computeroutput>
<example> <example>
<title>Using Setperl to set your perl path</title> <title>Using Setperl to set your perl path</title>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt>
<prompt>bash#</prompt> <command>./setperl.csh /usr/bin/perl</command>
<command>./setperl.csh /usr/bin/perl</command>
</computeroutput> </computeroutput>
</para> </para>
</example> </example>
...@@ -101,22 +93,23 @@ ...@@ -101,22 +93,23 @@
<section id="cmdline"> <section id="cmdline">
<title>Command-line Bugzilla Queries</title> <title>Command-line Bugzilla Queries</title>
<para> <para>
Users can query Bugzilla from the command line using Users can query Bugzilla from the command line using this suite
this suite of utilities. of utilities.
</para> </para>
<para> <para>
The query.conf file contains the mapping from options to field The query.conf file contains the mapping from options to field
names and comparison types. Quoted option names are "grepped" for, so names and comparison types. Quoted option names are "grepped"
it should be easy to edit this file. Comments (#) have no effect; you for, so it should be easy to edit this file. Comments (#) have
must make sure these lines do not contain any quoted "option" no effect; you must make sure these lines do not contain any
quoted "option"
</para> </para>
<para> <para>
buglist is a shell script which submits a Bugzilla query and writes the buglist is a shell script which submits a Bugzilla query and
resulting HTML page to stdout. It supports both short options, writes the resulting HTML page to stdout. It supports both
(such as "-Afoo" or "-Rbar") and long options (such as short options, (such as "-Afoo" or "-Rbar") and long options
"--assignedto=foo" or "--reporter=bar"). If the first character (such as "--assignedto=foo" or "--reporter=bar"). If the first
of an option is not "-", it is treated as if it were prefixed character of an option is not "-", it is treated as if it were
with "--default=". prefixed with "--default=".
</para> </para>
<para> <para>
The columlist is taken from the COLUMNLIST environment variable. The columlist is taken from the COLUMNLIST environment variable.
...@@ -128,10 +121,10 @@ ...@@ -128,10 +121,10 @@
<para> <para>
bugs is a simple shell script which calls buglist and extracts bugs is a simple shell script which calls buglist and extracts
the bug numbers from the output. Adding the prefix the bug numbers from the output. Adding the prefix
"http://bugzilla.mozilla.org/buglist.cgi?bug_id=" "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug
turns the bug list into a working link if any bugs are found. list into a working link if any bugs are found. Counting bugs is
Counting bugs is easy. Pipe the results through easy. Pipe the results through <command>sed -e 's/,/ /g' | wc |
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> awk '{printf $2 "\n"}'</command>
</para> </para>
<para> <para>
Akkana says she has good results piping buglist output through Akkana says she has good results piping buglist output through
...@@ -145,26 +138,23 @@ ...@@ -145,26 +138,23 @@
<substeps> <substeps>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash$</prompt> <command>wget -O
<prompt>bash$</prompt> query.conf
<command>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> </computeroutput>
</computeroutput>
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash$</prompt> <command>wget -O
<prompt>bash$</prompt> buglist
<command>wget -O buglist 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> </computeroutput>
</computeroutput>
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<computeroutput> <computeroutput> <prompt>bash#</prompt> <command>wget -O
<prompt>bash#</prompt> bugs
<command>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> </computeroutput>
</computeroutput>
</para> </para>
</step> </step>
</substeps> </substeps>
...@@ -185,53 +175,64 @@ ...@@ -185,53 +175,64 @@
<title>The Quicksearch Utility</title> <title>The Quicksearch Utility</title>
<para> <para>
Quicksearch is a new, experimental feature of the 2.12 release. Quicksearch is a new, experimental feature of the 2.12 release.
It consist of two Javascript files, "quicksearch.js" and "localconfig.js", It consist of two Javascript files, "quicksearch.js" and
and two documentation files, "quicksearch.html" and "quicksearchhack.html" "localconfig.js", and two documentation files,
"quicksearch.html" and "quicksearchhack.html"
</para> </para>
<para> <para>
The index.html page has been updated to include the QuickSearch text box. The index.html page has been updated to include the QuickSearch
text box.
</para> </para>
<para> <para>
To take full advantage of the query power, the Bugzilla maintainer must To take full advantage of the query power, the Bugzilla
edit "localconfig.js" according to the value sets used in the local installation. maintainer must edit "localconfig.js" according to the value
sets used in the local installation.
</para> </para>
<para> <para>
Currently, keywords must be hard-coded in localconfig.js. If they are not, Currently, keywords must be hard-coded in localconfig.js. If
keywords are not automatically recognized. This means, if localconfig.js they are not, keywords are not automatically recognized. This
is left unconfigured, that searching for a bug with the "foo" keyword means, if localconfig.js is left unconfigured, that searching
will only find bugs with "foo" in the summary, status whiteboard, product or for a bug with the "foo" keyword will only find bugs with "foo"
component name, but not those with the keyword "foo". in the summary, status whiteboard, product or component name,
but not those with the keyword "foo".
</para> </para>
<para> <para>
Workarounds for Bugzilla users: Workarounds for Bugzilla users:
<simplelist> <simplelist>
<member>search for '!foo' (this will find only bugs with the keyword "foo"</member> <member>search for '!foo' (this will find only bugs with the
<member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> keyword "foo"</member>
<member>search 'foo,!foo' (equivalent to 'foo OR
keyword:foo')</member>
</simplelist> </simplelist>
</para> </para>
<para> <para>
When this tool is ported from client-side JavaScript to server-side Perl, When this tool is ported from client-side JavaScript to
the requirement for hard-coding keywords can be fixed. server-side Perl, the requirement for hard-coding keywords can
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> be fixed. <ulink
has details. url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> has details.
</para> </para>
</section> </section>
</appendix> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="downloadlinks"> <appendix id="downloadlinks">
<title>Software Download Links</title> <title>Software Download Links</title>
<para>
<para>All of these sites are current as of April, 2001. Hopefully they'll All of these sites are current as of April, 2001. Hopefully
stay current for a while.</para> they'll stay current for a while.
<para>Apache Web Server:
<ulink url="http://www.apache.org/"/>
Optional web server for Bugzilla, but recommended because of broad user
base and support.</para>
<para>Bugzilla:
<ulink url="http://www.bugzilla.org/"/>
</para> </para>
<para>
<para>MySQL: Apache Web Server: <ulink url="http://www.apache.org/">http://www.apache.org</ulink>
<ulink url="http://www.mysql.com/"/> Optional web server for Bugzilla, but recommended because of broad user base and support.
</para> </para>
<para>
<para>Perl: Bugzilla: <ulink url="http://www.mozilla.org/projects/bugzilla/">
<ulink url="http://www.perl.org/"/> http://www.mozilla.org/projects/bugzilla/</ulink>
</para> </para>
<para>
<para>CPAN: MySQL: <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink>
<ulink url="http://www.cpan.org/"/>
</para> </para>
<para>
<para>DBI Perl module: Perl: <ulink url="http://www.perl.org">http://www.perl.org/</ulink>
<ulink url="http://www.cpan.org/modules/by-module/DBI/"/>
</para> </para>
<para>
<para>MySQL related Perl modules: CPAN: <ulink url="http://www.cpan.org/">http://www.cpan.org/</ulink>
<ulink url="http://www.cpan.org/modules/by-module/Mysql/"/>
</para> </para>
<para>
<para>TimeDate Perl module collection: DBI Perl module:
<ulink url="http://www.cpan.org/modules/by-module/Date/"/> <ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/DBI/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/DBI/</ulink>
</para> </para>
<para>
<para>GD Perl module: Data::Dumper module:
<ulink url="http://www.cpan.org/modules/by-module/GD/"/> <ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Data/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Data/</ulink>
Alternately, you should be able to find the latest version of GD at
<ulink url="http://www.boutell.com/gd/"/>
</para> </para>
<para>
<para>Chart::Base module: MySQL related Perl modules:
<ulink url="http://www.cpan.org/modules/by-module/Chart/"/> <ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Mysql/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Mysql/</ulink>
</para> </para>
<para>
<para>(But remember, Bundle::Bugzilla will install all the modules for you.) TimeDate Perl module collection:
<ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Date/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Date/</ulink>
</para>
<para>
GD Perl module:
<ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/GD/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/GD/</ulink>
Alternately, you should be able to find the latest version of
GD at <ulink url="http://www.boutell.com/gd/">http://www.boutell.com/gd/</ulink>
</para> </para>
<para>
Chart::Base module:
<ulink url="ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Chart/">
ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Chart/</ulink>
</para>
<para>
LinuxDoc Software:
<ulink url="http://www.linuxdoc.org/">http://www.linuxdoc.org/</ulink>
(for documentation maintenance)
</para>
</appendix> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -69,9 +79,8 @@ sgml-local-ecat-files:nil ...@@ -69,9 +79,8 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<!-- TOC <!-- TOC
Chapter: Using Bugzilla Chapter: Using Bugzilla
...@@ -38,19 +38,19 @@ Chapter: Using Bugzilla ...@@ -38,19 +38,19 @@ Chapter: Using Bugzilla
<section id="whatis"> <section id="whatis">
<title>What is Bugzilla?</title> <title>What is Bugzilla?</title>
<para> <para>
Bugzilla is one example of a class of programs called "Defect Tracking Systems", Bugzilla is one example of a class of programs called "Defect
or, more commonly, "Bug-Tracking Systems". Defect Tracking Systems allow individual or Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
groups of developers to keep track of outstanding bugs in their product effectively. Tracking Systems allow individual or groups of developers to keep
Bugzilla was originally written by Terry Weissman in a programming language called track of outstanding bugs in their product effectively. Bugzilla was
"TCL", to replace a crappy originally written by Terry Weissman in a programming language called
bug-tracking database used internally for Netscape Communications. Terry later ported "TCL", to replace a crappy bug-tracking database used internally for
Bugzilla to Netscape Communications. Terry later ported Bugzilla to Perl from
Perl from TCL, and in Perl it remains to this day. TCL, and in Perl it remains to this day. Most commercial
Most commercial defect-tracking software vendors at the defect-tracking software vendors at the time charged enormous
time charged enormous licensing fees, and Bugzilla quickly became a favorite of the licensing fees, and Bugzilla quickly became a favorite of the
open-source crowd (with its genesis in the open-source browser project, Mozilla). It open-source crowd (with its genesis in the open-source browser
is now the de-facto standard defect-tracking system against which all others are project, Mozilla). It is now the de-facto standard defect-tracking
measured. system against which all others are measured.
</para> </para>
<para> <para>
Bugzilla has matured immensely, and now boasts many advanced features. These include: Bugzilla has matured immensely, and now boasts many advanced features. These include:
...@@ -87,13 +87,13 @@ Chapter: Using Bugzilla ...@@ -87,13 +87,13 @@ Chapter: Using Bugzilla
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
email, XML, and HTTP APIs email, XML, console, and HTTP APIs
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
available integration with automated software configuration management systems, including available integration with automated software configuration management systems, including
Perforce and CVS. Perforce and CVS
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
...@@ -137,7 +137,7 @@ Chapter: Using Bugzilla ...@@ -137,7 +137,7 @@ Chapter: Using Bugzilla
with bug-tracking software, and instead simply relied on shared lists and 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 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 tends to cause those bugs judged least significant by developers to be
dropped or ignored dropped or ignored.
</para> </para>
<para> <para>
These days, many companies are finding that integrated defect-tracking These days, many companies are finding that integrated defect-tracking
...@@ -223,12 +223,12 @@ Chapter: Using Bugzilla ...@@ -223,12 +223,12 @@ Chapter: Using Bugzilla
<section id="myaccount"> <section id="myaccount">
<title>Create a Bugzilla Account</title> <title>Create a Bugzilla Account</title>
<para> <para>
First thing's first! If you want to use Bugzilla, first you need to create First things first! If you want to use Bugzilla, first you need to create
an account. Consult with the administrator responsible for your installation an account. Consult with the administrator responsible for your installation
of Bugzilla for the URL you should use to access it. of Bugzilla for the URL you should use to access it.
If you're test-driving the end-user Bugzilla experience, use this URL: If you're test-driving the end-user Bugzilla experience, use this URL:
<ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
</para> </para>
<orderedlist> <orderedlist>
<listitem> <listitem>
...@@ -560,15 +560,15 @@ Chapter: Using Bugzilla ...@@ -560,15 +560,15 @@ Chapter: Using Bugzilla
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
Go back to <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> Go back to <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
in your browser. in your browser.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Select the Select the
<ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/enter_bug.cgi"> <ulink url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi">
Enter a new bug report</ulink> link. Enter a new bug report</ulink> link.
</para> </para>
</listitem> </listitem>
...@@ -716,7 +716,7 @@ Chapter: Using Bugzilla ...@@ -716,7 +716,7 @@ Chapter: Using Bugzilla
Let's plunge into what you can do! The first step is to click Let's plunge into what you can do! The first step is to click
the "Edit prefs" link at the footer of each page once you the "Edit prefs" link at the footer of each page once you
have logged in to have logged in to
<ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/query.cgi?GoAheadAndLogIn=1"> <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1">
Landfill</ulink>. Landfill</ulink>.
</para> </para>
<section id="accountsettings"> <section id="accountsettings">
...@@ -861,17 +861,20 @@ Chapter: Using Bugzilla ...@@ -861,17 +861,20 @@ Chapter: Using Bugzilla
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:Bugzilla-Guide\.sgml
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment