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