diff options
| author | gerv%gerv.net <> | 2004-01-25 03:30:57 +0100 |
|---|---|---|
| committer | gerv%gerv.net <> | 2004-01-25 03:30:57 +0100 |
| commit | 6c709dd097e65025038a0dc9c17fad6a88e99b6b (patch) | |
| tree | c0c33411898e67410829ea142458440fe912b388 /docs/html/Bugzilla-Guide.html | |
| parent | c7f3e4a3a055bbbec29a8731f388f9fa4648c768 (diff) | |
| download | bugzilla-6c709dd097e65025038a0dc9c17fad6a88e99b6b.tar.gz bugzilla-6c709dd097e65025038a0dc9c17fad6a88e99b6b.tar.xz | |
Massive rearrangement of the installation section. Hopefully it makes sense now.
Diffstat (limited to 'docs/html/Bugzilla-Guide.html')
| -rw-r--r-- | docs/html/Bugzilla-Guide.html | 7033 |
1 files changed, 3428 insertions, 3605 deletions
diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index b066c51d1..a593c3b31 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -1,7 +1,7 @@ <HTML ><HEAD ><TITLE ->The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release</TITLE ><META NAME="GENERATOR" @@ -44,14 +44,14 @@ CLASS="title" ><A NAME="AEN2" ></A ->The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release</H1 ><H3 CLASS="corpauthor" >The Bugzilla Team</H3 ><P CLASS="pubdate" ->2004-01-15<BR></P +>2004-01-24<BR></P ><DIV ><DIV CLASS="abstract" @@ -124,211 +124,187 @@ HREF="#conventions" ></DD ><DT >2. <A -HREF="#introduction" ->Introduction</A +HREF="#installing-bugzilla" +>Installing Bugzilla</A ></DT ><DD ><DL ><DT >2.1. <A -HREF="#what-is-bugzilla" ->What is Bugzilla?</A +HREF="#installation" +>Installation</A ></DT ><DT >2.2. <A -HREF="#why-tracking" ->Why use a bug-tracking system?</A +HREF="#configuration" +>Configuration</A ></DT ><DT >2.3. <A -HREF="#why-bugzilla" ->Why use Bugzilla?</A +HREF="#extraconfig" +>Optional Additional Configuration</A +></DT +><DT +>2.4. <A +HREF="#os-specific" +>OS-Specific Installation Notes</A +></DT +><DT +>2.5. <A +HREF="#troubleshooting" +>Troubleshooting</A ></DT ></DL ></DD ><DT >3. <A -HREF="#using" ->Using Bugzilla</A +HREF="#administration" +>Administering Bugzilla</A ></DT ><DD ><DL ><DT >3.1. <A -HREF="#using-intro" ->Introduction</A +HREF="#parameters" +>Bugzilla Configuration</A ></DT ><DT >3.2. <A -HREF="#myaccount" ->Create a Bugzilla Account</A +HREF="#useradmin" +>User Administration</A ></DT ><DT >3.3. <A -HREF="#bug_page" ->Anatomy of a Bug</A +HREF="#products" +>Products</A ></DT ><DT >3.4. <A -HREF="#query" ->Searching for Bugs</A +HREF="#components" +>Components</A ></DT ><DT >3.5. <A -HREF="#list" ->Bug Lists</A +HREF="#versions" +>Versions</A ></DT ><DT >3.6. <A -HREF="#bugreports" ->Filing Bugs</A +HREF="#milestones" +>Milestones</A ></DT ><DT >3.7. <A -HREF="#patchviewer" ->Patch Viewer</A +HREF="#voting" +>Voting</A ></DT ><DT >3.8. <A -HREF="#hintsandtips" ->Hints and Tips</A +HREF="#groups" +>Groups and Group Security</A ></DT ><DT >3.9. <A -HREF="#userpreferences" ->User Preferences</A -></DT -><DT ->3.10. <A -HREF="#reporting" ->Reports</A +HREF="#upgrading" +>Upgrading to New Releases</A ></DT ></DL ></DD ><DT >4. <A -HREF="#installation" ->Installation</A +HREF="#customization" +>Customising Bugzilla</A ></DT ><DD ><DL ><DT >4.1. <A -HREF="#stepbystep" ->Step-by-step Install</A +HREF="#cust-templates" +>Template Customization</A ></DT ><DT >4.2. <A -HREF="#http" ->HTTP Server Configuration</A +HREF="#cust-hooks" +>Template Hooks</A ></DT ><DT >4.3. <A -HREF="#extraconfig" ->Optional Additional Configuration</A +HREF="#cust-change-permissions" +>Customizing Who Can Change What</A ></DT ><DT >4.4. <A -HREF="#os-specific" ->OS Specific Installation Notes</A +HREF="#dbmodify" +>Modifying Your Running System</A ></DT ><DT >4.5. <A -HREF="#security" ->Bugzilla Security</A +HREF="#dbdoc" +>MySQL Bugzilla Database Introduction</A ></DT ><DT >4.6. <A -HREF="#troubleshooting" ->Troubleshooting</A +HREF="#integration" +>Integrating Bugzilla with Third-Party Tools</A ></DT ></DL ></DD ><DT >5. <A -HREF="#administration" ->Administering Bugzilla</A +HREF="#using" +>Using Bugzilla</A ></DT ><DD ><DL ><DT >5.1. <A -HREF="#parameters" ->Bugzilla Configuration</A +HREF="#using-intro" +>Introduction</A ></DT ><DT >5.2. <A -HREF="#useradmin" ->User Administration</A +HREF="#myaccount" +>Create a Bugzilla Account</A ></DT ><DT >5.3. <A -HREF="#products" ->Products</A +HREF="#bug_page" +>Anatomy of a Bug</A ></DT ><DT >5.4. <A -HREF="#components" ->Components</A +HREF="#query" +>Searching for Bugs</A ></DT ><DT >5.5. <A -HREF="#versions" ->Versions</A +HREF="#list" +>Bug Lists</A ></DT ><DT >5.6. <A -HREF="#milestones" ->Milestones</A +HREF="#bugreports" +>Filing Bugs</A ></DT ><DT >5.7. <A -HREF="#voting" ->Voting</A +HREF="#patchviewer" +>Patch Viewer</A ></DT ><DT >5.8. <A -HREF="#groups" ->Groups and Group Security</A +HREF="#hintsandtips" +>Hints and Tips</A ></DT ><DT >5.9. <A -HREF="#upgrading" ->Upgrading to New Releases</A -></DT -></DL -></DD -><DT ->6. <A -HREF="#customization" ->Customising Bugzilla</A -></DT -><DD -><DL -><DT ->6.1. <A -HREF="#cust-templates" ->Template Customization</A -></DT -><DT ->6.2. <A -HREF="#cust-change-permissions" ->Customizing Who Can Change What</A -></DT -><DT ->6.3. <A -HREF="#dbmodify" ->Modifying Your Running System</A -></DT -><DT ->6.4. <A -HREF="#dbdoc" ->MySQL Bugzilla Database Introduction</A +HREF="#userpreferences" +>User Preferences</A ></DT ><DT ->6.5. <A -HREF="#integration" ->Integrating Bugzilla with Third-Party Tools</A +>5.10. <A +HREF="#reporting" +>Reports</A ></DT ></DL ></DD @@ -353,6 +329,25 @@ HREF="#cmdline" ></DD ><DT >C. <A +HREF="#install-perlmodules-manual" +>Manual Installation of Perl Modules</A +></DT +><DD +><DL +><DT +>C.1. <A +HREF="#modules-manual-instructions" +>Instructions</A +></DT +><DT +>C.2. <A +HREF="#modules-manual-download" +>Download Locations</A +></DT +></DL +></DD +><DT +>D. <A HREF="#gfdl" >GNU Free Documentation License</A ></DT @@ -361,57 +356,57 @@ HREF="#gfdl" ><DT >0. <A HREF="#gfdl-0" ->PREAMBLE</A +>Preamble</A ></DT ><DT >1. <A HREF="#gfdl-1" ->APPLICABILITY AND DEFINITIONS</A +>Applicability and Definition</A ></DT ><DT >2. <A HREF="#gfdl-2" ->VERBATIM COPYING</A +>Verbatim Copying</A ></DT ><DT >3. <A HREF="#gfdl-3" ->COPYING IN QUANTITY</A +>Copying in Quantity</A ></DT ><DT >4. <A HREF="#gfdl-4" ->MODIFICATIONS</A +>Modifications</A ></DT ><DT >5. <A HREF="#gfdl-5" ->COMBINING DOCUMENTS</A +>Combining Documents</A ></DT ><DT >6. <A HREF="#gfdl-6" ->COLLECTIONS OF DOCUMENTS</A +>Collections of Documents</A ></DT ><DT >7. <A HREF="#gfdl-7" ->AGGREGATION WITH INDEPENDENT WORKS</A +>Aggregation with Independent Works</A ></DT ><DT >8. <A HREF="#gfdl-8" ->TRANSLATION</A +>Translation</A ></DT ><DT >9. <A HREF="#gfdl-9" ->TERMINATION</A +>Termination</A ></DT ><DT >10. <A HREF="#gfdl-10" ->FUTURE REVISIONS OF THIS LICENSE</A +>Future Revisions of this License</A ></DT ><DT ><A @@ -433,50 +428,20 @@ CLASS="LOT" CLASS="LOT" ><DT ><B ->List of Figures</B -></DT -><DT ->4-1. <A -HREF="#install-mysql-packets" ->Set Max Packet Size in MySQL</A -></DT -><DT ->4-2. <A -HREF="#trouble-filetemp-errors" ->Other File::Temp error messages</A -></DT -><DT ->4-3. <A -HREF="#trouble-filetemp-patch" ->Patch for File::Temp in Perl 5.6.0</A -></DT -></DL -></DIV -><DIV -CLASS="LOT" -><DL -CLASS="LOT" -><DT -><B >List of Examples</B ></DT ><DT ->4-1. <A -HREF="#install-perlmodules-cpan" ->Installing perl modules with CPAN</A -></DT -><DT ->5-1. <A +>3-1. <A HREF="#upgrade-cvs" >Upgrading using CVS</A ></DT ><DT ->5-2. <A +>3-2. <A HREF="#upgrade-tarball" >Upgrading using the tarball</A ></DT ><DT ->5-3. <A +>3-3. <A HREF="#upgrade-patches" >Upgrading using patches</A ></DT @@ -497,23 +462,14 @@ CLASS="section" NAME="copyright" ></A >1.1. Copyright Information</H1 +><P +>This document is copyright (c) 2000-2004 by the various + Bugzilla contributors who wrote it.</P ><A -NAME="AEN25" +NAME="AEN26" ></A -><TABLE -BORDER="0" -WIDTH="100%" -CELLSPACING="0" -CELLPADDING="0" +><BLOCKQUOTE CLASS="BLOCKQUOTE" -><TR -><TD -WIDTH="10%" -VALIGN="TOP" -> </TD -><TD -WIDTH="80%" -VALIGN="TOP" ><P > Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation @@ -522,29 +478,10 @@ VALIGN="TOP" Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in <A HREF="#gfdl" ->Appendix C</A +>Appendix D</A >. </P -></TD -><TD -WIDTH="10%" -VALIGN="TOP" -> </TD -></TR -><TR -><TD -COLSPAN="2" -ALIGN="RIGHT" -VALIGN="TOP" ->--<SPAN -CLASS="attribution" ->Copyright (c) 2000-2004 The Bugzilla Team</SPAN -></TD -><TD -WIDTH="10%" -> </TD -></TR -></TABLE +></BLOCKQUOTE ><P > If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, @@ -578,10 +515,10 @@ NAME="disclaimer" </P ><P > Although the Bugzilla development team has taken great care to - ensure that all exploitable bugs or options have been - fixed, security holes surely exist. Great care should be taken both in + ensure that all exploitable bugs have been fixed, security holes surely + exist in any piece of code. Great care should be taken both in the installation and usage of this software. The Bugzilla development - team members assume no liability for your use of this software. You have + team members assume no liability for your use of Bugzilla. You have the source code, and are responsible for auditing it yourself to ensure your security needs are met. </P @@ -595,7 +532,7 @@ NAME="newversions" ></A >1.3. New Versions</H1 ><P -> This is the 2.17.5 version of The Bugzilla Guide. It is so named +> This is the 2.17.7 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. This version of the guide, like its associated Bugzilla version, is a @@ -607,8 +544,8 @@ NAME="newversions" HREF="http://www.bugzilla.org" TARGET="_top" >http://www.bugzilla.org</A ->, or checked out via CVS. - (Please follow the <A +>, or checked out via CVS by + following the <A HREF="http://www.mozilla.org/cvs.html" TARGET="_top" >Mozilla @@ -618,12 +555,68 @@ TARGET="_top" CLASS="filename" >mozilla/webtools/bugzilla/docs/</TT > - subtree.) However, you should read the version + subtree. However, you should read the version which came with the Bugzilla release you are using. </P ><P -> The Bugzilla Guide is currently only available in English. - If you would like to volunteer to translate it, please contact +> The Bugzilla Guide, or a section of it, is also available in + the following languages: + <A +HREF="http://bugzilla-de.sourceforge.net/docs/html/" +TARGET="_top" +>German</A +>. + </P +><P +> + In addition, there are Bugzilla template localisation projects in + the following languages. They may have translated documentation + available: + <A +HREF="http://sourceforge.net/projects/bugzilla-be/" +TARGET="_top" +>Belarusian</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-br/" +TARGET="_top" +>Brazilian Portuguese</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-cn/" +TARGET="_top" +>Chinese</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-fr/" +TARGET="_top" +>French</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-de/" +TARGET="_top" +>German</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-kr/" +TARGET="_top" +>Korean</A +>, + <A +HREF="http://sourceforge.net/projects/bugzilla-ru/" +TARGET="_top" +>Russian</A +> and + <A +HREF="http://sourceforge.net/projects/bugzilla-es/" +TARGET="_top" +>Spanish</A +>. + </P +><P +> + If you would like to volunteer to translate the Guide into additional + languages, please contact <A HREF="mailto:justdave@syndicomm.com" TARGET="_top" @@ -649,7 +642,7 @@ NAME="credits" > Matthew P. Barnson, Kevin Brannen, Dawn Endico, Ben FrantzDale, Eric Hanson, Tara Hernandez, Dave Lawrence, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Jacob Steenhagen, Ron Teitelbaum, Terry Weissman, Martin Wulffeld. </P ><P -> Last but not least, all the members of the +> Also, thanks are due to the members of the <A HREF="news://news.mozilla.org/netscape.public.mozilla.webtools" TARGET="_top" @@ -672,7 +665,7 @@ NAME="conventions" ><DIV CLASS="informaltable" ><A -NAME="AEN72" +NAME="AEN83" ></A ><P ></P @@ -998,1092 +991,17 @@ TARGET="_top" CLASS="chapter" ><HR><H1 ><A -NAME="introduction" -></A ->Chapter 2. Introduction</H1 -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="what-is-bugzilla" -></A ->2.1. What is Bugzilla?</H1 -><P -> Bugzilla is a bug- or issue-tracking system. Bug-tracking - systems allow individual or groups of developers effectively to keep track - of outstanding problems with their products. - </P -><P -><EM ->Do we need more here?</EM -></P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="why-tracking" -></A ->2.2. Why use a bug-tracking system?</H1 -><P ->Those who do not use a bug-tracking system tend to rely on - shared lists, email, spreadsheets and/or Post-It notes to monitor the - status of defects. This procedure - is usually error-prone and tends to cause those bugs judged least - significant by developers to be dropped or ignored.</P -><P ->Integrated defect-tracking systems make sure that nothing gets - swept under the carpet; they provide a method of creating, storing, - arranging and processing defect reports and enhancement requests.</P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="why-bugzilla" -></A ->2.3. Why use Bugzilla?</H1 -><P ->Bugzilla is the leading open-source/free software bug tracking - system. It boasts many advanced features, including: - <P -></P -><UL -><LI -><P ->Powerful searching</P -></LI -><LI -><P ->User-configurable email notifications of bug changes</P -></LI -><LI -><P ->Full change history</P -></LI -><LI -><P ->Inter-bug dependency tracking and graphing</P -></LI -><LI -><P ->Excellent attachment management</P -></LI -><LI -><P ->Integrated, product-based, granular security schema</P -></LI -><LI -><P ->Fully security-audited, and runs under Perl's taint mode</P -></LI -><LI -><P ->A robust, stable RDBMS back-end</P -></LI -><LI -><P ->Completely customisable and/or localisable web user - interface</P -></LI -><LI -><P ->Additional XML, email and console interfaces</P -></LI -><LI -><P ->Extensive configurability</P -></LI -><LI -><P ->Smooth upgrade pathway between versions</P -></LI -></UL -> - </P -><P ->Bugzilla is very adaptable to various situations. Known uses - currently include IT support queues, Systems Administration deployment - management, chip design and development problem tracking (both - pre-and-post fabrication), and software and hardware bug tracking for - luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems. - Combined with systems such as - <A -HREF="http://www.cvshome.org" -TARGET="_top" ->CVS</A ->, - <A -HREF="http://www.mozilla.org/bonsai.html" -TARGET="_top" ->Bonsai</A ->, or - <A -HREF="http://www.perforce.com" -TARGET="_top" ->Perforce SCM</A ->, Bugzilla - provides a powerful, easy-to-use configuration management solution.</P -></DIV -></DIV -><DIV -CLASS="chapter" -><HR><H1 -><A -NAME="using" +NAME="installing-bugzilla" ></A ->Chapter 3. Using Bugzilla</H1 +>Chapter 2. Installing Bugzilla</H1 ><DIV CLASS="section" ><H1 CLASS="section" ><A -NAME="using-intro" -></A ->3.1. Introduction</H1 -><P ->This section contains information for end-users of Bugzilla. - There is a Bugzilla test installation, called - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/" -TARGET="_top" ->Landfill</A ->, - which you are welcome to play with (if it's up.) - However, it does not necessarily - have all Bugzilla features enabled, and runs an up-to-the-minute version, - so some things may not quite work as this document describes.</P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="myaccount" -></A ->3.2. Create a Bugzilla Account</H1 -><P ->If you want to use Bugzilla, first you need to create an account. - Consult with the administrator responsible for your installation of - Bugzilla for the URL you should use to access it. If you're - test-driving Bugzilla, use this URL: - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/" -TARGET="_top" ->http://landfill.bugzilla.org/bugzilla-tip/</A ->. - </P -><P -></P -><OL -TYPE="1" -><LI -><P ->Click the - <SPAN -CLASS="QUOTE" ->"Open a new Bugzilla account"</SPAN -> - - link, enter your email address and, optionally, your name in the - spaces provided, then click - <SPAN -CLASS="QUOTE" ->"Create Account"</SPAN -> - - .</P -></LI -><LI -><P ->Within moments, you should receive an email to the address - you provided, which contains your login name (generally the - same as the email address), and a password. - This password is randomly generated, but can be - changed to something more memorable.</P -></LI -><LI -><P ->Click the - <SPAN -CLASS="QUOTE" ->"Log In"</SPAN -> - link in the footer at the bottom of the page in your browser, - enter your email address and password into the spaces provided, and - click - <SPAN -CLASS="QUOTE" ->"Login"</SPAN ->. - </P -></LI -></OL -><P ->You are now logged in. Bugzilla uses cookies to remember you are - logged in so, unless you have cookies disabled or your IP address changes, - you should not have to log in again.</P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="bug_page" -></A ->3.3. Anatomy of a Bug</H1 -><P ->The core of Bugzilla is the screen which displays a particular - bug. It's a good place to explain some Bugzilla concepts. - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1" -TARGET="_top" -> Bug 1 on Landfill</A -> - - is a good example. Note that the labels for most fields are hyperlinks; - clicking them will take you to context-sensitive help on that - particular field. Fields marked * may not be present on every - installation of Bugzilla.</P -><P -></P -><OL -TYPE="1" -><LI -><P -> <EM ->Product and Component</EM ->: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: - <P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD -> <EM ->Administration:</EM -> - Administration of a Bugzilla installation.</TD -></TR -><TR -><TD -> <EM ->Bugzilla-General:</EM -> - Anything that doesn't fit in the other components, or spans - multiple components.</TD -></TR -><TR -><TD -> <EM ->Creating/Changing Bugs:</EM -> - Creating, changing, and viewing bugs.</TD -></TR -><TR -><TD -> <EM ->Documentation:</EM -> - The Bugzilla documentation, including The Bugzilla Guide.</TD -></TR -><TR -><TD -> <EM ->Email:</EM -> - Anything to do with email sent by Bugzilla.</TD -></TR -><TR -><TD -> <EM ->Installation:</EM -> - The installation process of Bugzilla.</TD -></TR -><TR -><TD -> <EM ->Query/Buglist:</EM -> - Anything to do with searching for bugs and viewing the - buglists.</TD -></TR -><TR -><TD -> <EM ->Reporting/Charting:</EM -> - Getting reports from Bugzilla.</TD -></TR -><TR -><TD -> <EM ->User Accounts:</EM -> - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc.</TD -></TR -><TR -><TD -> <EM ->User Interface:</EM -> - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc.</TD -></TR -></TBODY -></TABLE -><P -></P -> - </P -></LI -><LI -><P -> <EM ->Status and Resolution:</EM -> - - These define exactly what state the bug is in - from not even - being confirmed as a bug, through to being fixed and the fix - confirmed by Quality Assurance. The different possible values for - Status and Resolution on your installation should be documented in the - context-sensitive help for those items.</P -></LI -><LI -><P -> <EM ->Assigned To:</EM -> - The person responsible for fixing the bug.</P -></LI -><LI -><P -> <EM ->*URL:</EM -> - A URL associated with the bug, if any.</P -></LI -><LI -><P -> <EM ->Summary:</EM -> - A one-sentence summary of the problem.</P -></LI -><LI -><P -> <EM ->*Status Whiteboard:</EM -> - (a.k.a. Whiteboard) A free-form text area for adding short notes - and tags to a bug.</P -></LI -><LI -><P -> <EM ->*Keywords:</EM -> - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression.</P -></LI -><LI -><P -> <EM ->Platform and OS:</EM -> - These indicate the computing environment where the bug was - found.</P -></LI -><LI -><P -> <EM ->Version:</EM -> - The "Version" field is usually used for versions of a product which - have been released, and is set to indicate which versions of a - Component have the particular problem the bug report is - about.</P -></LI -><LI -><P -> <EM ->Priority:</EM -> - The bug assignee uses this field to prioritise his or her bugs. - It's a good idea not to change this on other people's bugs.</P -></LI -><LI -><P -> <EM ->Severity:</EM -> - This indicates how severe the problem is - from blocker - ("application unusable") to trivial ("minor cosmetic issue"). You - can also use this field to indicate whether a bug is an enhancement - request.</P -></LI -><LI -><P -> <EM ->*Target:</EM -> - (a.k.a. Target Milestone) A future version by which the bug is to - be fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not - restricted to numbers, thought - you can use any text strings, such - as dates.</P -></LI -><LI -><P -> <EM ->Reporter:</EM -> - The person who filed the bug.</P -></LI -><LI -><P -> <EM ->CC list:</EM -> - A list of people who get mail when the bug changes.</P -></LI -><LI -><P -> <EM ->Attachments:</EM -> - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section.</P -></LI -><LI -><P -> <EM ->*Dependencies:</EM -> - If this bug cannot be fixed unless other bugs are fixed (depends - on), or this bug stops other bugs being fixed (blocks), their - numbers are recorded here.</P -></LI -><LI -><P -> <EM ->*Votes:</EM -> - Whether this bug has any votes.</P -></LI -><LI -><P -> <EM ->Additional Comments:</EM -> - You can add your two cents to the bug discussion here, if you have - something worthwhile to say.</P -></LI -></OL -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="query" -></A ->3.4. Searching for Bugs</H1 -><P ->The Bugzilla Search page is is the interface where you can find - any bug report, comment, or patch currently in the Bugzilla system. You - can play with it here: - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/query.cgi" -TARGET="_top" ->http://landfill.bugzilla.org/bugzilla-tip/query.cgi</A ->.</P -><P ->The Search page has controls for selecting different possible - values for all of the fields in a bug, as described above. For some - fields, multiple values can be selected. In those cases, Bugzilla - returns bugs where the content of the field matches any one of the selected - values. If none is selected, then the field can take any value.</P -><P ->Once you've run a search, you can save it as a Saved Search, which - appears in the page footer.</P -><P ->Highly advanced querying is done using Boolean Charts. See the - Boolean Charts help link on the Search page for more information.</P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="list" -></A ->3.5. Bug Lists</H1 -><P ->If you run a search, a list of matching bugs will be returned. - </P -><P ->The format of the list is configurable. For example, it can be - sorted by clicking the column headings. Other useful features can be - accessed using the links at the bottom of the list: - <P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD -> <EM ->Long Format:</EM -> - - this gives you a large page with a non-editable summary of the fields - of each bug.</TD -></TR -><TR -><TD -> <EM ->CSV:</EM -> - - get the buglist as comma-separated values, for import into e.g. - a spreadsheet.</TD -></TR -><TR -><TD -> <EM ->Change Columns:</EM -> - - change the bug attributes which appear in the list.</TD -></TR -><TR -><TD -> <EM ->Change several bugs at once:</EM -> - - If your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner.</TD -></TR -><TR -><TD -> <EM ->Send mail to bug owners:</EM -> - - Sends mail to the owners of all bugs on the list.</TD -></TR -><TR -><TD -> <EM ->Edit Search:</EM -> - - If you didn't get exactly the results you were looking for, you can - return to the Query page through this link and make small revisions - to the query you just made so you get more accurate results.</TD -></TR -><TR -><TD -> <EM ->Remember Search As:</EM -> - - You can give a search a name and remember it; a link will appear - in your page footer giving you quick access to run it again later. - </TD -></TR -></TBODY -></TABLE -><P -></P -> - </P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="bugreports" -></A ->3.6. Filing Bugs</H1 -><P ->Years of bug writing experience has been distilled for your - reading pleasure into the - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html" -TARGET="_top" -> Bug Writing Guidelines</A ->. - While some of the advice is Mozilla-specific, the basic principles of - reporting Reproducible, Specific bugs, isolating the Product you are - using, the Version of the Product, the Component which failed, the - Hardware Platform, and Operating System you were using at the time of - the failure go a long way toward ensuring accurate, responsible fixes - for the bug that bit you.</P -><P ->The procedure for filing a test bug is as follows:</P -><P -></P -><OL -TYPE="1" -><LI -><P ->Go to - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/" -TARGET="_top" -> Landfill</A -> - in your browser and click - <A -HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi" -TARGET="_top" -> Enter a new bug report</A ->. - </P -></LI -><LI -><P ->Select a product - any one will do.</P -></LI -><LI -><P ->Fill in the fields. Bugzilla should have made reasonable - guesses, based upon your browser, for the "Platform" and "OS" - drop-down boxes. If they are wrong, change them.</P -></LI -><LI -><P ->Select "Commit" and send in your bug report.</P -></LI -></OL -><P ->Try to make sure that everything said in the summary is also - said in the first comment. Summaries are often updated and this will - ensure your original information is easily accessible. - </P -><P -> You do not need to put "any" or similar strings in the URL field. - If there is no specific URL associated with the bug, leave this - field blank. - </P -><P ->If you feel a bug you filed was incorrectly marked as a - DUPLICATE of another, please question it in your bug, not - the bug it was duped to. Feel free to CC the person who duped it - if they are not already CCed. - </P -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="patchviewer" -></A ->3.7. Patch Viewer</H1 -><P ->Viewing and reviewing patches in Bugzilla is often difficult due to - lack of context, improper format and the inherent readability issues that - raw patches present. Patch Viewer is an enhancement to Bugzilla designed - to fix that by offering increased context, linking to sections, and - integrating with Bonsai, LXR and CVS.</P -><P ->Patch viewer allows you to:</P -><P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD ->View patches in color, with side-by-side view rather than trying - to interpret the contents of the patch.</TD -></TR -><TR -><TD ->See the difference between two patches.</TD -></TR -><TR -><TD ->Get more context in a patch.</TD -></TR -><TR -><TD ->Collapse and expand sections of a patch for easy - reading.</TD -></TR -><TR -><TD ->Link to a particular section of a patch for discussion or - review</TD -></TR -><TR -><TD ->Go to Bonsai or LXR to see more context, blame, and - cross-references for the part of the patch you are looking at</TD -></TR -><TR -><TD ->Create a rawtext unified format diff out of any patch, no - matter what format it came from</TD -></TR -></TBODY -></TABLE -><P -></P -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_view" -></A ->3.7.1. Viewing Patches in Patch Viewer</H2 -><P ->The main way to view a patch in patch viewer is to click on the - "Diff" link next to a patch in the Attachments list on a bug. You may - also do this within the edit window by clicking the "View Attachment As - Diff" button in the Edit Attachment screen.</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_diff" -></A ->3.7.2. Seeing the Difference Between Two Patches</H2 -><P ->To see the difference between two patches, you must first view the - newer patch in Patch Viewer. Then select the older patch from the - dropdown at the top of the page ("Differences between [dropdown] and - this patch") and click the "Diff" button. This will show you what - is new or changed in the newer patch.</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_context" -></A ->3.7.3. Getting More Context in a Patch</H2 -><P ->To get more context in a patch, you put a number in the textbox at - the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. - This will give you that many lines of context before and after each - change. Alternatively, you can click on the "File" link there and it - will show each change in the full context of the file. This feature only - works against files that were diffed using "cvs diff".</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_collapse" -></A ->3.7.4. Collapsing and Expanding Sections of a Patch</H2 -><P ->To view only a certain set of files in a patch (for example, if a - patch is absolutely huge and you want to only review part of it at a - time), you can click the "(+)" and "(-)" links next to each file (to - expand it or collapse it). If you want to collapse all files or expand - all files, you can click the "Collapse All" and "Expand All" links at the - top of the page.</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_link" -></A ->3.7.5. Linking to a Section of a Patch</H2 -><P ->To link to a section of a patch (for example, if you want to be - able to give someone a URL to show them which part you are talking - about) you simply click the "Link Here" link on the section header. The - resulting URL can be copied and used in discussion. (Copy Link - Location in Mozilla works as well.)</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_bonsai_lxr" -></A ->3.7.6. Going to Bonsai and LXR</H2 -><P ->To go to Bonsai to get blame for the lines you are interested in, - you can click the "Lines XX-YY" link on the section header you are - interested in. This works even if the patch is against an old - version of the file, since Bonsai stores all versions of the file.</P -><P ->To go to LXR, you click on the filename on the file header - (unfortunately, since LXR only does the most recent version, line - numbers are likely to rot).</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="patchviewer_unified_diff" -></A ->3.7.7. Creating a Unified Diff</H2 -><P ->If the patch is not in a format that you like, you can turn it - into a unified diff format by clicking the "Raw Unified" link at the top - of the page.</P -></DIV -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="hintsandtips" -></A ->3.8. Hints and Tips</H1 -><P ->This section distills some Bugzilla tips and best practices - that have been developed.</P -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="AEN363" -></A ->3.8.1. Autolinkification</H2 -><P ->Bugzilla comments are plain text - so typing <U> will - produce less-than, U, greater-than rather than underlined text. - However, Bugzilla will automatically make hyperlinks out of certain - sorts of text in comments. For example, the text - "http://www.bugzilla.org" will be turned into a link: - <A -HREF="http://www.bugzilla.org" -TARGET="_top" ->http://www.bugzilla.org</A ->. - Other strings which get linkified in the obvious manner are: - <P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD ->bug 12345</TD -></TR -><TR -><TD ->comment 7</TD -></TR -><TR -><TD ->bug 23456, comment 53</TD -></TR -><TR -><TD ->attachment 4321</TD -></TR -><TR -><TD ->mailto:george@example.com</TD -></TR -><TR -><TD ->george@example.com</TD -></TR -><TR -><TD ->ftp://ftp.mozilla.org</TD -></TR -><TR -><TD ->Most other sorts of URL</TD -></TR -></TBODY -></TABLE -><P -></P -> - </P -><P ->A corollary here is that if you type a bug number in a comment, - you should put the word "bug" before it, so it gets autolinkified - for the convenience of others. - </P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="quicksearch" -></A ->3.8.2. Quicksearch</H2 -><P ->Quicksearch is a single-text-box query tool which uses - metacharacters to indicate what is to be searched. For example, typing - "<TT -CLASS="filename" ->foo|bar</TT ->" - into Quicksearch would search for "foo" or "bar" in the - summary and status whiteboard of a bug; adding - "<TT -CLASS="filename" ->:BazProduct</TT ->" would - search only in that product. - </P -><P ->You'll find the Quicksearch box on Bugzilla's - front page, along with a - <A -HREF="../../quicksearch.html" -TARGET="_top" ->Help</A -> - link which details how to use it.</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="commenting" -></A ->3.8.3. Comments</H2 -><P ->If you are changing the fields on a bug, only comment if - either you have something pertinent to say, or Bugzilla requires it. - Otherwise, you may spam people unnecessarily with bug mail. - To take an example: a user can set up their account to filter out messages - where someone just adds themselves to the CC field of a bug - (which happens a lot.) If you come along, add yourself to the CC field, - and add a comment saying "Adding self to CC", then that person - gets a pointless piece of mail they would otherwise have avoided. - </P -><P -> Don't use sigs in comments. Signing your name ("Bill") is acceptable, - if you do it out of habit, but full mail/news-style - four line ASCII art creations are not. - </P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="attachments" -></A ->3.8.4. Attachments</H2 -><P -> Use attachments, rather than comments, for large chunks of ASCII data, - such as trace, debugging output files, or log files. That way, it doesn't - bloat the bug for everyone who wants to read it, and cause people to - receive fat, useless mails. - </P -><P ->Trim screenshots. There's no need to show the whole screen if - you are pointing out a single-pixel problem. - </P -><P ->Don't attach simple test cases (e.g. one HTML file, one - CSS file and an image) as a ZIP file. Instead, upload them in - reverse order and edit the referring file so that they point to the - attached files. This way, the test case works immediately - out of the bug. - </P -></DIV -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="userpreferences" -></A ->3.9. User Preferences</H1 -><P ->Once you have logged in, you can customise various aspects of - Bugzilla via the "Edit prefs" link in the page footer. - The preferences are split into three tabs:</P -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="accountsettings" -></A ->3.9.1. Account Settings</H2 -><P ->On this tab, you can change your basic account information, - including your password, email address and real name. For security - reasons, in order to change anything on this page you must type your - <EM ->current</EM -> - password into the - <SPAN -CLASS="QUOTE" ->"Password"</SPAN -> - field at the top of the page. - If you attempt to change your email address, a confirmation - email is sent to both the old and new addresses, with a link to use to - confirm the change. This helps to prevent account hijacking.</P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="emailsettings" +NAME="installation" ></A ->3.9.2. Email Settings</H2 -><P ->On this tab you can reduce or increase the amount of email sent - you from Bugzilla, opting in our out depending on your relationship to - the bug and the change that was made to it. - </P -><P -> You can also do further filtering on the client side by - using the X-Bugzilla-Reason mail header which Bugzilla - adds to all bugmail. This tells you what relationship you have to the - bug in question, - and can be any of Owner, Reporter, QAcontact, CClist, Voter and - WatchingComponent.</P -><P ->By entering user email names, delineated by commas, into the - "Users to watch" text entry box you can receive a copy of all the - bugmail of other users (security settings permitting.) This powerful - functionality enables seamless transitions as developers change - projects or users go on holiday.</P +>2.1. Installation</H1 ><DIV CLASS="note" ><P @@ -2105,107 +1023,45 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->The ability to watch other users may not be available in all - Bugzilla installations. If you can't see it, ask your - administrator.</P +>If you just want to <EM +>use</EM +> Bugzilla, + you do not need to install it. None of this chapter is relevant to + you. Ask your Bugzilla administrator + for the URL to access it over the web. + </P ></TD ></TR ></TABLE ></DIV -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="permissionsettings" -></A ->3.9.3. Permissions</H2 ><P ->This is a purely informative page which outlines your current - permissions on this installation of Bugzilla - what product groups you - are in, and whether you can edit bugs or perform various administration - functions.</P -></DIV -></DIV -><DIV -CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="reporting" -></A ->3.10. Reports</H1 -><P -><EM ->To be written</EM -></P -></DIV -></DIV -><DIV -CLASS="chapter" -><HR><H1 -><A -NAME="installation" -></A ->Chapter 4. Installation</H1 -><DIV -CLASS="section" -><H1 -CLASS="section" -><A -NAME="stepbystep" -></A ->4.1. Step-by-step Install</H1 -><P ->Bugzilla has been successfully installed under many different - operating systems including almost all Unix clones and - <SPAN -CLASS="productname" ->Microsoft Windows</SPAN ->. Many - operating systems have utilities that make installation easier or quirks - that make it harder. We have tried to collect that information in - <A +>The Bugzilla server software is usually installed on Linux or + Solaris. + If you are installing on another OS, check <A HREF="#os-specific" ->Section 4.4</A ->, so unless you are on Linux, - be sure to check out that section before - you start your installation. - </P -><DIV -CLASS="note" +>Section 2.4</A +> + before you start your installation to see if there are any special + instructions. + </P ><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" +> As an alternative to following these instructions, you may wish to + try Arne Schirmacher's unofficial and unsupported + <A +HREF="http://www.softwaretesting.de/article/view/33/1/8/" +TARGET="_top" +>Bugzilla + Installer</A +>, which installs Bugzilla and all its prerequisites + on Linux or Solaris systems. + </P ><P ->Windows is one of those operating systems that has many quirks - and is not yet officially supported by the Bugzilla team. If you wish - to install Bugzilla on Windows, be sure to see - <A -HREF="#os-win32" ->Section 4.4.1</A ->. - </P -></TD -></TR -></TABLE -></DIV +>This guide assumes that you have administrative access to the + Bugzilla machine. It not possible to + install and run Bugzilla itself without administrative access except + in the very unlikely event that every single prerequisite is + already installed. + </P ><DIV CLASS="warning" ><P @@ -2227,33 +1083,21 @@ ALT="Warning"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->While installing Bugzilla, it is a good idea to ensure that there - is some kind of configurable firewall between you and the rest of the - Internet - as your machine may be insecure for periods during the install. Many - installation steps require an active Internet connection to complete, - but you must take care to ensure that at no point is your machine - vulnerable to an attack.</P +>The installation process may make your machine insecure for + short periods of time. Make sure there is a firewall between you + and the Internet. + </P ></TD ></TR ></TABLE ></DIV ><P ->This guide assumes that you already have your operating system - installed, network configured, and have administrative access to the - machine onto which you are installing Bugzilla. It is possible to - install and run Bugzilla itself without administrative access, but you - have to - either make sure all the required software is installed or get somebody - with administrative access to install it for you. - </P -><P -> You are strongly recommended to make a backup of your system - before installing Bugzilla (and at regular intervals thereafter :-). - </P +> You are strongly recommended to make a backup of your system + before installing Bugzilla (and at regular intervals thereafter :-). + </P ><P ->Here's a basic step-by-step list: - </P +>In outline, the installation proceeds as follows: + </P ><DIV CLASS="procedure" ><OL @@ -2264,8 +1108,8 @@ TYPE="1" HREF="#install-perl" >Install Perl</A > - (5.6.0 or above) - </P + (5.6.0 or above) + </P ></LI ><LI ><P @@ -2273,8 +1117,8 @@ HREF="#install-perl" HREF="#install-mysql" >Install MySQL</A > - (3.23.41 or above) - </P + (3.23.41 or above) + </P ></LI ><LI ><P @@ -2282,31 +1126,28 @@ HREF="#install-mysql" HREF="#install-webserver" >Install a Webserver</A > - </P + </P ></LI ><LI ><P ><A HREF="#install-bzfiles" ->Put Bugzilla in the Webspace</A +>Install Bugzilla</A > - </P + </P ></LI ><LI ><P ><A HREF="#install-perlmodules" ->Install Perl Modules</A +>Install Perl modules</A > - </P + </P ></LI ><LI ><P -><A -HREF="#install-setupdatabase" ->Setup the MySQL Database</A -> - </P +>Configure all of the above. + </P ></LI ></OL ></DIV @@ -2317,21 +1158,23 @@ CLASS="section" ><A NAME="install-perl" ></A ->4.1.1. Perl</H2 +>2.1.1. Perl</H2 +><P +>Installed Version Test: <TT +CLASS="filename" +>perl -v</TT +></P ><P >Any machine that doesn't have Perl on it is a sad machine indeed. - If your OS doesn't come with it, Perl can be got in source form - from <A + If you don't have it and your OS doesn't provide official packages, + visit <A HREF="http://www.perl.com" TARGET="_top" >http://www.perl.com</A >. - There are also binary versions available for many platforms, most of which - are linked to from perl.com. - Although Bugzilla runs with perl 5.6.0, - it's a good idea to be up to the very latest version - if you can when running Bugzilla. As of this writing, that is Perl - version 5.8.2.</P + Although Bugzilla runs with Perl 5.6.0, + it's a good idea to be using the latest stable version. + As of this writing, that is Perl 5.8.2.</P ></DIV ><DIV CLASS="section" @@ -2340,16 +1183,20 @@ CLASS="section" ><A NAME="install-mysql" ></A ->4.1.2. MySQL</H2 +>2.1.2. MySQL</H2 ><P ->If your OS doesn't come with it or provide official packages, - visit the MySQL homepage at - <A +>Installed Version Test: <TT +CLASS="filename" +>mysql -V</TT +></P +><P +> If you don't have it and your OS doesn't provide official packages, + visit <A HREF="http://www.mysql.com" TARGET="_top" >http://www.mysql.com</A -> - to grab and install the latest stable release of the server. +>. You need MySQL version + 3.23.41 or higher. </P ><DIV CLASS="note" @@ -2379,234 +1226,21 @@ CLASS="filename" >/var</TT >. On some Unix systems, this is part of a smaller root partition, - and may not have room for your bug database. You can set the data - directory as an option to <TT + and may not have room for your bug database. To change the data + directory, you have to build MySQL from source yourself, and + set it as an option to <TT CLASS="filename" >configure</TT -> - if you build MySQL from source yourself.</P +>.</P ></TD ></TR ></TABLE ></DIV ><P >If you install from something other than a packaging/installation - system (such as .rpm, .dep, .exe, or .msi) you will need to configure - your system so the MySQL server daemon will come back up whenever - your machine reboots. + system (such as .rpm, .dep, .exe, or .msi) make sure the MySQL server + is started when the machine boots. </P -><P ->If you wish to have attachments larger than 64K, you will have to - configure MySQL to accept large packets. This is done by adding the text - in <A -HREF="#install-mysql-packets" ->Figure 4-1</A -> to your - <TT -CLASS="filename" ->my.conf</TT -> file. There is also a parameter in Bugzilla - for setting the maximum allowable attachment size. - - You should set this value to be slightly larger than that parameter. - </P -><DIV -CLASS="figure" -><A -NAME="install-mysql-packets" -></A -><P -><B ->Figure 4-1. Set Max Packet Size in MySQL</B -></P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="programlisting" -> [mysqld] -# Allow packets up to 1M -set-variable = max_allowed_packet=1M - </PRE -></FONT -></TD -></TR -></TABLE -></DIV -><P ->If you are running Bugzilla and MySQL on the same machine, you may - also wish to utilize the <TT -CLASS="option" ->--skip-networking</TT -> option as - mentioned in <A -HREF="#security-mysql" ->Section 4.5.2</A -> for the added security. - </P -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-setupdatabase" -></A ->4.1.2.1. Adding a user to MySQL</H3 -><P ->This first thing you'll want to do is make sure you've given the - <SPAN -CLASS="QUOTE" ->"root"</SPAN -> user a password as suggested in - <A -HREF="#security-mysql" ->Section 4.5.2</A ->. Then, you need to add a user for - Bugzilla to use. For clarity, these instructions will - assume that your MySQL user for Bugzilla will be <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN ->, - the database will be called <SPAN -CLASS="QUOTE" ->"bugs_db"</SPAN -> and the password for - the <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN -> user is <SPAN -CLASS="QUOTE" ->"bugs_password"</SPAN ->. You - should, of course, substitute the values you intend to use for your site. - </P -><DIV -CLASS="note" -><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->Most people use <SPAN -CLASS="QUOTE" ->"bugs"</SPAN -> for both the user and - database name. Don't use it for the password, though... - </P -></TD -></TR -></TABLE -></DIV -><P ->We use an SQL <B -CLASS="command" ->GRANT</B -> command to create a - <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN -> - user. This also restricts the - <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN -> - user to operations within a database called - <SPAN -CLASS="QUOTE" ->"bugs_db"</SPAN ->, and only allows the account to connect from - <SPAN -CLASS="QUOTE" ->"localhost"</SPAN ->. - Modify it to reflect your setup if you will be connecting from - another machine or as a different user.</P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="screen" -> <TT -CLASS="prompt" ->mysql></TT -> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, - DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost - IDENTIFIED BY 'bugs_password'; - <TT -CLASS="prompt" ->mysql></TT -> FLUSH PRIVILEGES; - </PRE -></FONT -></TD -></TR -></TABLE -><DIV -CLASS="note" -><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->If you are using MySQL 4, the bugs user also needs to be granted - the <TT -CLASS="computeroutput" ->LOCK TABLES</TT -> and - <TT -CLASS="computeroutput" ->CREATE TEMPORARY TABLES</TT -> permissions, - so add them to the list in the - <TT -CLASS="computeroutput" ->GRANT</TT -> command. - </P -></TD -></TR -></TABLE -></DIV -></DIV ></DIV ><DIV CLASS="section" @@ -2615,7 +1249,10 @@ CLASS="section" ><A NAME="install-webserver" ></A ->4.1.3. HTTP Server</H2 +>2.1.3. Web Server</H2 +><P +>Installed Version Test: view the default welcome page at + http://<your-machine>/</P ><P >You have freedom of choice here, pretty much any web server that is capable of running <A @@ -2625,46 +1262,25 @@ CLASS="glossterm" >CGI</I ></A > - scripts will work. <A -HREF="#http" ->Section 4.2</A -> has more information about - configuring web servers to work with Bugzilla. - </P -><DIV -CLASS="note" -><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->We strongly recommend Apache as the web server to use. The - Bugzilla Guide installation instructions, in general, assume you are - using Apache. If you have got Bugzilla working using another webserver, + scripts will work. + However, we strongly recommend using the Apache web server + (either 1.3.x or 2.x), and + the installation instructions usually assume you are + using it. If you have got Bugzilla working using another webserver, please share your experiences with us by filing a bug in <A HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation" TARGET="_top" >Bugzilla Documentation</A >. - </P -></TD -></TR -></TABLE -></DIV + </P +><P +> If you don't have Apache and your OS doesn't provide official packages, + visit <A +HREF="http://httpd.apache.org/" +TARGET="_top" +>http://httpd.apache.org/</A +>. + </P ></DIV ><DIV CLASS="section" @@ -2673,67 +1289,22 @@ CLASS="section" ><A NAME="install-bzfiles" ></A ->4.1.4. Bugzilla</H2 +>2.1.4. Bugzilla</H2 ><P ->You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - <SPAN +> Download a Bugzilla tarball (or check it out from CVS) and place + it in a suitable directory, writable by the default web server user + (probably <SPAN CLASS="QUOTE" >"nobody"</SPAN >). - You may decide to put the files in the main web space for your - web server or perhaps in - <TT -CLASS="filename" ->/usr/local</TT -> - with a symbolic link in the web space that points to the Bugzilla - directory.</P -><DIV -CLASS="tip" -><P -></P -><TABLE -CLASS="tip" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/tip.gif" -HSPACE="5" -ALT="Tip"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->If you symlink the bugzilla directory into your Apache's - <TT -CLASS="filename" ->html</TT -> - hierarchy, you may receive - <SPAN -CLASS="errorname" ->Forbidden</SPAN -> - errors unless you add the + Good locations are either directly in the main web space for your + web server or perhaps in <TT CLASS="filename" ->FollowSymLinks</TT +>/usr/local</TT > - directive to the <TT -CLASS="filename" -><Directory></TT -> entry for - the HTML root directory in httpd.conf.</P -></TD -></TR -></TABLE -></DIV + with a symbolic link from the web space. + </P ><DIV CLASS="caution" ><P @@ -2759,12 +1330,12 @@ VALIGN="TOP" in a <TT CLASS="filename" >cgi-bin</TT -> directory (this +> directory. This includes any directory which is configured using the <TT CLASS="option" >ScriptAlias</TT -> directive of Apache). +> directive of Apache. </P ></TD ></TR @@ -2773,7 +1344,7 @@ CLASS="option" ><P >Once all the files are in a web accessible directory, make that directory writable by your webserver's user. This is a temporary step - until you run the post-install + until you run the <TT CLASS="filename" >checksetup.pl</TT @@ -2785,30 +1356,33 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN522" +NAME="install-perlmodules" ></A ->4.1.5. <TT +>2.1.5. Perl Modules</H2 +><P +>Bugzilla's installation process is based + on a script called <TT CLASS="filename" >checksetup.pl</TT -></H2 -><P ->Next, run the magic checksetup.pl script. - This is designed to check whether you have all of the right - Perl modules in the correct - versions, and that Bugzilla is generally set up correctly. +>. + The first thing it checks is whether you have appropriate + versions of all the required + Perl modules. The aim of this section is to pass this check. + When it passes, + <EM +>do not run it again</EM +>, + but proceed to <A +HREF="#configuration" +>Section 2.2</A +>. </P ><P -> Eventually, - it will make sure Bugzilla files and directories have reasonable - permissions, set up the - <TT +> At this point, you need to <TT CLASS="filename" ->data</TT -> - directory, and create all the MySQL tables. But the first time you - run it, it's highly likely to tell you that you are missing a few - Perl modules. Make a note of which ones they are, and then proceed to - the next section to install them. +>su</TT +> to root. You should + remain as root until the end of the install. Then run: </P ><TABLE BORDER="0" @@ -2820,174 +1394,44 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="screen" -> <TT +><TT CLASS="prompt" >bash#</TT -> ./checksetup.pl - </PRE +> ./checksetup.pl</PRE ></FONT ></TD ></TR ></TABLE ><P -> The first time you run it with all the correct modules installed, - it will create a file called - <TT -CLASS="filename" ->localconfig</TT ->.</P -><P ->This file contains a variety of settings you may need to tweak - including how Bugzilla should connect to the MySQL database.</P -><P ->The connection settings include: - <P -></P -><OL -TYPE="1" -><LI -><P ->server's host: just use - <SPAN -CLASS="QUOTE" ->"localhost"</SPAN -> - if the MySQL server is local</P -></LI -><LI -><P ->database name: - <SPAN -CLASS="QUOTE" ->"bugs_db"</SPAN -> - if you're following these directions</P -></LI -><LI -><P ->MySQL username: - <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN -> - if you're following these directions</P -></LI -><LI -><P ->Password for the - <SPAN -CLASS="QUOTE" ->"bugs_user"</SPAN -> - MySQL account; (<SPAN -CLASS="QUOTE" ->"bugs_password"</SPAN -> above)</P -></LI -></OL -> - </P -><P ->Edit the file to change these. Once you are happy with the - settings, <TT -CLASS="filename" ->su</TT -> to the user - your web server runs as, and re-run - <TT +> <TT CLASS="filename" >checksetup.pl</TT ->. (Note: on some security-conscious - systems, you may need to change the login shell for the webserver - account before you can do this.) - On this second run, it will create the database and an administrator - account for which you will be prompted to provide information.</P -><DIV -CLASS="note" -><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->The checksetup.pl script is designed so that you can run it at - any time without causing harm. You should run it after any upgrade to - Bugzilla.</P -></TD -></TR -></TABLE -></DIV -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="install-perlmodules" -></A ->4.1.6. Perl Modules</H2 -><P ->Don't be intimidated by this long list of modules. See - <A -HREF="#install-modules-bundle-bugzilla" ->Section 4.1.6.1</A -> for a way of - installing all the ones you need with a single command. +> will print out a list of the + required and optional Perl modules, together with the versions + (if any) installed on your machine. + The list of required modules is reasonably long; however, you + may already have several of them installed. </P ><P ->Perl modules can be found using - <A -HREF="#gloss-cpan" -><I -CLASS="glossterm" ->CPAN</I -></A -> on Unix based systems or - <A -HREF="#gloss-ppm" -><I -CLASS="glossterm" ->PPM</I -></A -> on Win32. +> There is a meta-module called Bundle::Bugzilla, + which installs all the other + modules with a single command. You should use this if you are running + Perl 5.6.1 or above. </P ><P ->Good instuctions can be found for using each of these services on - their respective websites. The basics can be found in - <A -HREF="#install-perlmodules-cpan" ->Example 4-1</A -> for CPAN and - <A +> The preferred way of installing Perl modules is via CPAN on Unix, + or PPM on Windows (see <A HREF="#win32-perlmodules" ->Section 4.4.1.2</A -> for PPM. +>Section 2.4.1.2</A +>). These + instructions assume you are using CPAN; if for some reason you need + to install the Perl modules manually, see + <A +HREF="#install-perlmodules-manual" +>Appendix C</A +>. </P -><DIV -CLASS="example" -><A -NAME="install-perlmodules-cpan" -></A -><P -><B ->Example 4-1. Installing perl modules with CPAN</B -></P -><P ->The easy way: - <TABLE +><TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -2997,131 +1441,23 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="screen" -> <TT +><TT CLASS="prompt" >bash#</TT -> perl -MCPAN -e 'install "<modulename>"' - </PRE +> perl -MCPAN -e 'install "<modulename>"'</PRE ></FONT ></TD ></TR ></TABLE -> - </P ><P ->Or the hard way: - <TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="screen" -> <TT -CLASS="prompt" ->bash#</TT -> tar xzvf <module>.tar.gz <A -NAME="cpan-moduletar" -><IMG -SRC="../images/callouts/1.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(1)"></A -> -<TT -CLASS="prompt" ->bash#</TT -> cd <module> <A -NAME="cpan-moduledir" -><IMG -SRC="../images/callouts/2.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(2)"></A -> -<TT -CLASS="prompt" ->bash#</TT -> perl Makefile.PL -<TT -CLASS="prompt" ->bash#</TT -> make -<TT -CLASS="prompt" ->bash#</TT -> make test -<TT -CLASS="prompt" ->bash#</TT -> make install - </PRE -></FONT -></TD -></TR -></TABLE -> - <DIV -CLASS="calloutlist" -><DL -COMPACT="COMPACT" -><DT -><A -HREF="#cpan-moduletar" -><IMG -SRC="../images/callouts/1.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(1)"></A -></DT -><DD ->This assumes that you've already downloaded the - <TT +> If you using Bundle::Bugzilla, invoke the magic CPAN command on it. + Otherwise, you need to work down the + list of modules that <TT CLASS="filename" -><module>.tar.gz</TT -> to the current working - directory. - </DD -><DT -><A -HREF="#cpan-moduledir" -><IMG -SRC="../images/callouts/2.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(2)"></A -></DT -><DD ->The process of untarring the module as defined in - <A -HREF="#cpan-moduletar" -><A -HREF="#cpan-moduletar" -><IMG -SRC="../images/callouts/1.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(1)"></A -></A -> will create the - <TT -CLASS="filename" -><module></TT -> directory. - </DD -></DL -></DIV -> - </P -></DIV +>checksetup.pl</TT +> says are + required, in the order given, invoking the command on each. + </P ><DIV CLASS="tip" ><P @@ -3165,45 +1501,38 @@ CLASS="QUOTE" ></TABLE ></DIV ><P ->Perl Modules (minimum version): +> Here is a complete list of modules and their minimum versions. + Some modules have special installation notes, which follow. + </P +><P +>Required Perl modules: <P ></P ><OL TYPE="1" ><LI ><P -> <A -HREF="#install-modules-bundle-bugzilla" ->Bundle::Bugzilla</A -> - (Will allow you to skip the rest) +> AppConfig (1.52) </P ></LI ><LI ><P -> <A -HREF="#install-modules-cgi" ->CGI</A -> - (2.88) +> CGI (2.93) </P ></LI ><LI ><P -> <A -HREF="#install-modules-date-format" ->Date::Format</A -> - (2.21) +> Data::Dumper (any) </P ></LI ><LI ><P -> <A -HREF="#install-modules-dbi" ->DBI</A -> - (1.32) +> Date::Format (2.21) + </P +></LI +><LI +><P +> DBI (1.32) </P ></LI ><LI @@ -3217,44 +1546,32 @@ HREF="#install-modules-dbd-mysql" ></LI ><LI ><P -> <A -HREF="#install-file-spec" ->File::Spec</A -> - (0.82) +> File::Spec (0.82) </P ></LI ><LI ><P -> <A -HREF="#install-modules-file-temp" ->File::Temp</A -> - (any) +> File::Temp (any) </P ></LI ><LI ><P > <A HREF="#install-modules-template" ->Template Toolkit</A +>Template</A > (2.08) </P ></LI ><LI ><P -> <A -HREF="#install-modules-text-wrap" ->Text::Wrap</A -> - (2001.0131) +> Text::Wrap (2001.0131) </P ></LI ></OL > - and, optionally: + Optional Perl modules: <P ></P ><OL @@ -3280,15 +1597,6 @@ HREF="#install-modules-chart-base" ><LI ><P > <A -HREF="#install-modules-xml-parser" ->XML::Parser</A -> - (any) for the XML interface - </P -></LI -><LI -><P -> <A HREF="#install-modules-gd-graph" >GD::Graph</A > @@ -3307,10 +1615,10 @@ HREF="#install-modules-gd-text-align" ><LI ><P > <A -HREF="#install-modules-mime-parser" ->MIME::Parser</A +HREF="#install-modules-xml-parser" +>XML::Parser</A > - (any) for the email interface + (any) for the XML interface </P ></LI ><LI @@ -3322,190 +1630,18 @@ HREF="#install-modules-patchreader" (0.9.1) for pretty HTML view of patches </P ></LI -></OL -> - </P -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-bundle-bugzilla" -></A ->4.1.6.1. Bundle::Bugzilla</H3 -><P ->If you are running at least perl 5.6.1, you can save yourself a lot - of time by using Bundle::Bugzilla. This bundle contains every module - required to get Bugzilla running. It does not include GD and friends, but - these are not required for a base install and can always be added later - if the need arises. - </P +><LI ><P ->Assuming your perl was installed with CPAN (most unix installations - are), using Bundle::Bugzilla is really easy. Simply follow along with the - commands below. - </P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="screen" -> <TT -CLASS="prompt" ->bash#</TT -> <B -CLASS="command" ->perl -MCPAN -eshell</B -> <A -NAME="bundle-cpanconfig" -><IMG -SRC="../images/callouts/1.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(1)"></A -> -cpan shell -- CPAN exploration and modules installation (v1.63) -ReadLine support enabled - -<TT -CLASS="prompt" ->cpan></TT +> <A +HREF="#install-modules-mime-parser" +>MIME::Parser</A > - - </PRE -></FONT -></TD -></TR -></TABLE -><DIV -CLASS="calloutlist" -><DL -COMPACT="COMPACT" -><DT -><A -HREF="#bundle-cpanconfig" -><IMG -SRC="../images/callouts/1.gif" -HSPACE="0" -VSPACE="0" -BORDER="0" -ALT="(1)"></A -></DT -><DD ->At this point, unless you've used CPAN on this machine before, - you'll have to go through a series of configuration steps. - </DD -></DL -></DIV -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-cgi" -></A ->4.1.6.2. CGI (2.88)</H3 -><P ->The CGI module parses form elements and cookies and does many - other usefule things. It come as a part of recent perl distributions, but - Bugzilla needs a fairly new version. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/CGI.pm/" -TARGET="_top" ->http://search.cpan.org/dist/CGI.pm/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip</A -><br> - Documentation: <A -HREF="http://www.perldoc.com/perl5.8.0/lib/CGI.html" -TARGET="_top" ->http://www.perldoc.com/perl5.8.0/lib/CGI.html</A -><br> - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-date-format" -></A ->4.1.6.3. TimeDate modules (2.21)</H3 -><P ->Many of the more common date/time/calendar related Perl modules - have been grouped into a bundle similar to the MySQL modules bundle. - This bundle is stored on the CPAN under the name TimeDate. - The component module we're most interested in is the Date::Format - module, but installing all of them is probably a good idea anyway. + (any) for the optional email interface + </P +></LI +></OL +> </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/TimeDate/" -TARGET="_top" ->http://search.cpan.org/dist/TimeDate/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip</A -><br> - Documentation: <A -HREF="http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm" -TARGET="_top" ->http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm</A -><br> - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-dbi" -></A ->4.1.6.4. DBI (1.32)</H3 -><P ->The DBI module is a generic Perl module used the - MySQL-related modules. As long as your Perl installation was done - correctly the DBI module should be a breeze. It's a mixed Perl/C - module, but Perl's MakeMaker system simplifies the C compilation - greatly.</P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/DBI/" -TARGET="_top" ->http://search.cpan.org/dist/DBI/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip</A -><br> - Documentation: <A -HREF="http://dbi.perl.org/doc/" -TARGET="_top" ->http://dbi.perl.org/doc/</A -><br> - </P -></DIV ><DIV CLASS="section" ><HR><H3 @@ -3513,107 +1649,20 @@ CLASS="section" ><A NAME="install-modules-dbd-mysql" ></A ->4.1.6.5. MySQL-related modules</H3 -><P ->The Perl/MySQL interface requires a few mutually-dependent Perl - modules. These modules are grouped together into the the - Msql-Mysql-modules package.</P -><P ->The MakeMaker process will ask you a few questions about the - desired compilation target and your MySQL installation. For most of the - questions the provided default will be adequate, but when asked if your - desired target is the MySQL or mSQL packages, you should - select the MySQL related ones. Later you will be asked if you wish to - provide backwards compatibility with the older MySQL packages; you - should answer YES to this question. The default is NO.</P -><P ->A host of 'localhost' should be fine and a testing user of 'test' - with a null password should find itself with sufficient access to run - tests on the 'test' database which MySQL created upon installation. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/DBD-mysql/" -TARGET="_top" ->http://search.cpan.org/dist/DBD-mysql/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip</A -><br> - Documentation: <A -HREF="http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pod" -TARGET="_top" ->http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pod</A -><br> - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-file-spec" -></A ->4.1.6.6. File::Spec (0.82)</H3 +>2.1.5.1. DBD::mysql</H3 ><P ->File::Spec is a perl module that allows file operations, such as - generating full path names, to work cross platform. - </P +>The installation process will ask you a few questions about the + desired compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if your + desired target is the MySQL or mSQL packages, you should + select the MySQL-related ones. Later you will be asked if you wish to + provide backwards compatibility with the older MySQL packages; you + should answer YES to this question. The default is NO.</P ><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/File-Spec/" -TARGET="_top" ->http://search.cpan.org/dist/File-Spec/</A -><br> - PPM Download Page: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip</A -><br> - Documentation: <A -HREF="http://www.perldoc.com/perl5.8.0/lib/File/Spec.html" -TARGET="_top" ->http://www.perldoc.com/perl5.8.0/lib/File/Spec.html</A -><br> - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-file-temp" -></A ->4.1.6.7. File::Temp (any)</H3 -><P ->File::Temp is used to generate a temporary filename that is - guaranteed to be unique. It comes as a standard part of perl - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/File-Spec/" -TARGET="_top" ->http://search.cpan.org/dist/File-Spec/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip</A -><br> - Documentation: <A -HREF="http://www.perldoc.com/perl5.8.0/lib/File/Temp.html" -TARGET="_top" ->http://www.perldoc.com/perl5.8.0/lib/File/Temp.html</A -><br> - </P +>A host of 'localhost' should be fine. A testing user of 'test', + with a null password, should have sufficient access to run + tests on the 'test' database which MySQL creates upon installation. + </P ></DIV ><DIV CLASS="section" @@ -3622,58 +1671,13 @@ CLASS="section" ><A NAME="install-modules-template" ></A ->4.1.6.8. Template Toolkit (2.08)</H3 +>2.1.5.2. Template Toolkit (2.08)</H3 ><P >When you install Template Toolkit, you'll get asked various - questions about features to enable. The defaults are fine, except - that it is recommended you use the high speed XS Stash of the Template - Toolkit, in order to achieve best performance. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/Template-Toolkit/" -TARGET="_top" ->http://search.cpan.org/dist/Template-Toolkit/</A -><br> - PPM Download Link: <A -HREF="http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz" -TARGET="_top" ->http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz</A -><br> - Documentation: <A -HREF="http://www.template-toolkit.org/docs.html" -TARGET="_top" ->http://www.template-toolkit.org/docs.html</A -><br> - </P -></DIV -><DIV -CLASS="section" -><HR><H3 -CLASS="section" -><A -NAME="install-modules-text-wrap" -></A ->4.1.6.9. Text::Wrap (2001.0131)</H3 -><P ->Text::Wrap is designed to proved intelligent text wrapping. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/Text-Tabs+Wrap/" -TARGET="_top" ->http://search.cpan.org/dist/Text-Tabs+Wrap/</A -><br> - Documentation: <A -HREF="http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html" -TARGET="_top" ->http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html</A -><br> - </P + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. + </P ></DIV ><DIV CLASS="section" @@ -3682,10 +1686,10 @@ CLASS="section" ><A NAME="install-modules-gd" ></A ->4.1.6.10. GD (1.20) [optional]</H3 +>2.1.5.3. GD (1.20)</H3 ><P ->You need the GD library if you want any of the graphing to work. - </P +>The GD module is only required if you want graphical reports. + </P ><DIV CLASS="note" ><P @@ -3707,20 +1711,20 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->The Perl GD library requires some other libraries that may or - may not be installed on your system, including - <TT +>The Perl GD module requires some other libraries that may or + may not be installed on your system, including + <TT CLASS="classname" >libpng</TT > - and - <TT + and + <TT CLASS="classname" >libgd</TT >. - The full requirements are listed in the Perl GD library README. - If compiling GD fails, it's probably because you're - missing a required library.</P + The full requirements are listed in the Perl GD module README. + If compiling GD fails, it's probably because you're + missing a required library.</P ></TD ></TR ></TABLE @@ -3746,40 +1750,21 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->The version of the GD perl module you need is very closely tied - to the <TT +>The version of the GD module you need is very closely tied + to the <TT CLASS="classname" >libgd</TT > version installed on your system. - If you have a version 1.x of <TT + If you have a version 1.x of <TT CLASS="classname" >libgd</TT > the 2.x - versions of the GD perl module won't work for you. - </P + versions of the GD module won't work for you. + </P ></TD ></TR ></TABLE ></DIV -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/GD/" -TARGET="_top" ->http://search.cpan.org/dist/GD/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip</A -><br> - Documentation: <A -HREF="http://stein.cshl.org/WWW/software/GD/" -TARGET="_top" ->http://stein.cshl.org/WWW/software/GD/</A -><br> - </P ></DIV ><DIV CLASS="section" @@ -3788,126 +1773,61 @@ CLASS="section" ><A NAME="install-modules-chart-base" ></A ->4.1.6.11. Chart::Base (0.99c) [optional]</H3 -><P ->The Chart module provides Bugzilla with on-the-fly charting - abilities. It can be installed in the usual fashion after it has been - fetched from CPAN. - Note that earlier versions that 0.99c used GIFs, which are no longer - supported by the latest versions of GD.</P +>2.1.5.4. Chart::Base (0.99c)</H3 ><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/Chart/" -TARGET="_top" ->http://search.cpan.org/dist/Chart/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Chart.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Chart.zip</A -><br> - </P +>The Chart::Base module is only required if you want graphical + reports. + Note that earlier versions that 0.99c used GIFs, which are no longer + supported by the latest versions of GD.</P ></DIV ><DIV CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="install-modules-xml-parser" +NAME="install-modules-gd-graph" ></A ->4.1.6.12. XML::Parser (any) [optional]</H3 +>2.1.5.5. GD::Graph (any)</H3 ><P ->XML::Parser is used by the <TT -CLASS="filename" ->importxml.pl</TT -> - script. You only need it if you are going to be importing bugs (such as - for bug moving). XML::Parser requires that the - <TT -CLASS="classname" ->expat</TT -> library is already installed on your machine. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/XML-Parser/" -TARGET="_top" ->http://search.cpan.org/dist/XML-Parser/</A -><br> - Documentation: <A -HREF="http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html" -TARGET="_top" ->http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html</A -><br> - </P +>The GD::Graph module is only required if you want graphical + reports. + </P ></DIV ><DIV CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="install-modules-gd-graph" +NAME="install-modules-gd-text-align" ></A ->4.1.6.13. GD::Graph (any) [optional]</H3 +>2.1.5.6. GD::Text::Align (any)</H3 ><P ->In addition to GD listed above, the reporting interface of Bugzilla - needs to have the GD::Graph module installed. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/GDGraph/" -TARGET="_top" ->http://search.cpan.org/dist/GDGraph/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip</A -><br> - Documentation: <A -HREF="http://search.cpan.org/dist/GDGraph/Graph.pm" -TARGET="_top" ->http://search.cpan.org/dist/GDGraph/Graph.pm</A -><br> - </P +>The GD::Text::Align module is only required if you want graphical + reports. + </P ></DIV ><DIV CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="install-modules-gd-text-align" +NAME="install-modules-xml-parser" ></A ->4.1.6.14. GD::Text::Align (any) [optional]</H3 +>2.1.5.7. XML::Parser (any)</H3 ><P ->GD::Text::Align, as the name implies, is used to draw aligned - strings of text. It is needed by the reporting interface. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/GDTextUtil/" -TARGET="_top" ->http://search.cpan.org/dist/GDTextUtil/</A -><br> - PPM Download Page: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip</A -><br> - Documentation: <A -HREF="http://search.cpan.org/dist/GDTextUtil/Text/Align.pm" -TARGET="_top" ->http://search.cpan.org/dist/GDTextUtil/Text/Align.pm</A -><br> - </P +>The XML::Parser module is only required if you want to import + XML bugs using the <TT +CLASS="filename" +>importxml.pl</TT +> + script. This is required to use Bugzilla's "move bugs" feature; + you may also want to use it for migrating from another bug database. + XML::Parser requires that the + <TT +CLASS="classname" +>expat</TT +> library is already installed on your machine. + </P ></DIV ><DIV CLASS="section" @@ -3916,33 +1836,15 @@ CLASS="section" ><A NAME="install-modules-mime-parser" ></A ->4.1.6.15. MIME::Parser (any) [optional]</H3 +>2.1.5.8. MIME::Parser (any)</H3 ><P ->MIME::Parser is only needed if you want to use the e-mail interface - located in the <TT +>The MIME::Parser module is only required if you want to use the + email interface + located in the <TT CLASS="filename" >contrib</TT > directory. - </P -><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/dist/MIME-tools/" -TARGET="_top" ->http://search.cpan.org/dist/MIME-tools/</A -><br> - PPM Download Link: <A -HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip" -TARGET="_top" ->http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip</A -><br> - Documentation: <A -HREF="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm" -TARGET="_top" ->http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm</A -><br> - </P + </P ></DIV ><DIV CLASS="section" @@ -3951,125 +1853,213 @@ CLASS="section" ><A NAME="install-modules-patchreader" ></A ->4.1.6.16. PatchReader (0.9.1) [optional]</H3 -><P ->PatchReader is only needed if you want to use Patch Viewer, a - Bugzilla feature to format patches in a pretty HTML fashion. There are a - number of optional parameters you can configure Patch Viewer with as well, - including cvsroot, cvsroot_get, lxr_root, bonsai_url, lxr_url, and - lxr_root. Patch Viewer also optionally will use cvs, diff and interdiff - utilities if they exist on the system (interdiff can be found in the - patchutils package at <A -HREF="http://cyberelk.net/tim/patchutils/" -TARGET="_top" ->http://cyberelk.net/tim/patchutils/</A ->. - These programs' locations can be configured in localconfig. - </P +>2.1.5.9. PatchReader (0.9.1)</H3 ><P -CLASS="literallayout" -><br> - CPAN Download Page: <A -HREF="http://search.cpan.org/author/JKEISER/PatchReader/" -TARGET="_top" ->http://search.cpan.org/author/JKEISER/PatchReader/</A -><br> - Documentation: <A -HREF="http://www.johnkeiser.com/mozilla/Patch_Viewer.html" -TARGET="_top" ->http://www.johnkeiser.com/mozilla/Patch_Viewer.html</A -><br> - </P +>The PatchReader module is only required if you want to use + Patch Viewer, a + Bugzilla feature to show code patches in your web browser in a more + readable form. + </P +></DIV ></DIV ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H1 CLASS="section" ><A -NAME="AEN768" +NAME="configuration" ></A ->4.1.7. Configuring Bugzilla</H2 +>2.2. Configuration</H1 +><DIV +CLASS="warning" ><P -> Once checksetup.pl has run successfully, Bugzilla should start up. - Proceed to the correct URL and log in with the administrator account - you defined in the last checksetup.pl run. - </P +></P +><TABLE +CLASS="warning" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/warning.gif" +HSPACE="5" +ALT="Warning"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" ><P -> You should run through the parameters on the Edit Parameters page - (link in the footer) and set them all to appropriate values. - They key parameters are documented in <A -HREF="#parameters" ->Section 5.1</A ->. - </P -></DIV +>Poorly-configured MySQL and Bugzilla installations have + given attackers full access to systems in the past. Please take the + security parts of these guidelines seriously, even for Bugzilla + machines hidden away behind your firewall.</P +></TD +></TR +></TABLE ></DIV ><DIV CLASS="section" -><HR><H1 +><HR><H2 CLASS="section" ><A -NAME="http" +NAME="localconfig" ></A ->4.2. HTTP Server Configuration</H1 +>2.2.1. localconfig</H2 ><P ->The Bugzilla Team recommends Apache when using Bugzilla, however, any web server - that can be configured to run <A -HREF="#gloss-cgi" -><I -CLASS="glossterm" ->CGI</I -></A -> scripts - should be able to handle Bugzilla. No matter what web server you choose, but - especially if you choose something other than Apache, you should be sure to read - <A -HREF="#security-access" ->Section 4.5.4</A ->. - </P +> Once you run <TT +CLASS="filename" +>checksetup.pl</TT +> with all the correct + modules installed, it displays a message about, and write out a + file called, + <TT +CLASS="filename" +>localconfig</TT +>. This file contains the default + settings for a number of Bugzilla parameters. + </P ><P ->The plan for this section is to eventually document the specifics of how to lock - down permissions on individual web servers. - </P +>Load this file in your editor. The only value you + <EM +>need</EM +> to change is $db_pass, the password for + the user you will create for your database. + Pick a strong password (for simplicity, it should not contain + single quote characters) and put it here. + </P +><P +> The other options in the <TT +CLASS="filename" +>localconfig</TT +> file + are documented by their accompanying comments. If you have a slightly + non-standard MySQL setup, you may wish to change one or more of + the other "$db_*" parameters. + </P +><P +> You may also wish to change the names of + the priorities, severities, operating systems and platforms for your + installation. However, you can always change these after installation + has finished; if you then re-run + <TT +CLASS="filename" +>checksetup.pl</TT +>, the changes will get picked up. + </P +></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="http-apache" +NAME="mysql" ></A ->4.2.1. Apache <SPAN -CLASS="productname" ->httpd</SPAN -></H2 +>2.2.2. MySQL</H2 +><DIV +CLASS="section" +><H3 +CLASS="section" +><A +NAME="security-mysql" +></A +>2.2.2.1. Security</H3 ><P ->You will have to make sure that Apache is properly - configured to run the Bugzilla CGI scripts. You also need to make sure - that the <TT +>MySQL ships as insecure by default. + It allows anybody to on the local machine full administrative + capabilities without requiring a password; the special + MySQL root account (note: this is <EM +>not</EM +> the same as + the system root) also has no password. + Also, many installations default to running + <SPAN +CLASS="application" +>mysqld</SPAN +> as the system root. + </P +><P +></P +><OL +TYPE="1" +><LI +><P +>To disable the anonymous user account + and set a password for the root user, execute the following. The + root user password should be different to the bugs user password + you set in + <TT CLASS="filename" ->.htaccess</TT -> files created by - <B -CLASS="command" ->./checksetup.pl</B -> are allowed to override Apache's normal access - permissions or else important password information may be exposed to the - Internet. - </P +>localconfig</TT +> in the previous section, + and also different to + the password for the system root account on your machine. + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="screen" +> <TT +CLASS="prompt" +>bash$</TT +> mysql mysql + <TT +CLASS="prompt" +>mysql></TT +> DELETE FROM user WHERE user = ''; + <TT +CLASS="prompt" +>mysql></TT +> UPDATE user SET password = password('<TT +CLASS="replaceable" +><I +>new_password</I +></TT +>') WHERE user = 'root'; + <TT +CLASS="prompt" +>mysql></TT +> FLUSH PRIVILEGES;</PRE +></FONT +></TD +></TR +></TABLE ><P ->You need to configure Apache to run .cgi files outside the - <TT +>From this point forward, to run the + <TT CLASS="filename" ->cgi-bin</TT -> directory. - Open your - <TT +>mysql</TT +> command-line client, + you will need to type + <B +CLASS="command" +>mysql -u root -p</B +> and enter + <TT +CLASS="replaceable" +><I +>new_password</I +></TT +> when prompted. + </P +></LI +><LI +><P +>If you run MySQL on the same machine as your web server, you + should disable remote access to MySQL by adding + the following to your <TT CLASS="filename" ->httpd.conf</TT -> file and make sure the - following line exists and is uncommented:</P +>/etc/my.conf</TT +>: + </P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -4080,24 +2070,54 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> AddHandler cgi-script .cgi - </PRE +> [myslqd] + # Prevent network access to MySQL. + skip-networking</PRE ></FONT ></TD ></TR ></TABLE +></LI +><LI +><P +>Consult the documentation that came with your system for + information on making <SPAN +CLASS="application" +>mysqld</SPAN +> run as an + unprivileged user. + </P +></LI +><LI +><P +>For added security, you could also run MySQL, or even all + of Bugzilla + in a chroot jail; however, instructions for doing that are beyond + the scope of this document. + </P +></LI +></OL +></DIV +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A +NAME="install-setupdatabase" +></A +>2.2.2.2. Allow large attachments</H3 ><P ->To allow <TT +>You need to configure MySQL to accept large packets, if you + want to have attachments larger than 64K. Add the text + below to your + <TT CLASS="filename" ->.htaccess</TT -> files to override - permissions and .cgi files to run in the Bugzilla directory, make sure - the following two lines are in a <TT -CLASS="computeroutput" ->Directory</TT -> - directive that applies to the Bugzilla directory on your system - (either the Bugzilla directory or one of its parents). +>/etc/my.conf</TT +>. + There is also a parameter in Bugzilla + for setting the maximum allowable attachment size, (default 1MB). + Bugzilla will only accept attachments up to the lower of these two + sizes. </P ><TABLE BORDER="0" @@ -4108,29 +2128,108 @@ WIDTH="100%" ><FONT COLOR="#000000" ><PRE -CLASS="programlisting" -> Options +ExecCGI -AllowOverride Limit - </PRE +CLASS="screen" +> [mysqld] + # Allow packets up to 1M + set-variable = max_allowed_packet=1M</PRE ></FONT ></TD ></TR ></TABLE +></DIV +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A +NAME="install-setupdatabase-adduser" +></A +>2.2.2.3. Add a user to MySQL</H3 ><P ->You should modify the <DirectoryIndex> parameter for - the Apache virtual host running your Bugzilla installation to - allow <TT -CLASS="filename" ->index.cgi</TT -> as the index page for a - directory, as well as the usual <TT +>You need to add a new MySQL user for + Bugzilla to use. (It's not safe to have Bugzilla use the MySQL root + account.) The following instructions assume the defaults in + <TT CLASS="filename" ->index.html</TT ->, +>localconfig</TT +>; + if you changed those, you need to modify the + SQL command appropriately. You will need the <TT +CLASS="replaceable" +><I +>$db_pass</I +></TT +> password you set in + <TT +CLASS="filename" +>localconfig</TT +> in + <A +HREF="#localconfig" +>Section 2.2.1</A +>. + </P +><P +>We use an SQL <B +CLASS="command" +>GRANT</B +> command to create a + <SPAN +CLASS="QUOTE" +>"bugs"</SPAN +> + user. This also restricts the + <SPAN +CLASS="QUOTE" +>"bugs"</SPAN +> + user to operations within a database called + <SPAN +CLASS="QUOTE" +>"bugs"</SPAN +>, and only allows the account to connect from + <SPAN +CLASS="QUOTE" +>"localhost"</SPAN +>. + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.</P +><P +>Run the <TT CLASS="filename" ->index.htm</TT ->, and so forth. </P +>mysql</TT +> command-line client and + enter:</P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="screen" +> <TT +CLASS="prompt" +>mysql></TT +> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '<TT +CLASS="replaceable" +><I +>$db_pass</I +></TT +>'; + <TT +CLASS="prompt" +>mysql></TT +> FLUSH PRIVILEGES</PRE +></FONT +></TD +></TR +></TABLE ><DIV CLASS="note" ><P @@ -4152,124 +2251,296 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P ->For more information on Apache and its directives, see the - glossary entry on <A -HREF="#gloss-apache" -><I -CLASS="glossterm" ->Apache</I -></A ->. +>If you are using MySQL 4, you need to add + the <TT +CLASS="computeroutput" +>LOCK TABLES</TT +> and + <TT +CLASS="computeroutput" +>CREATE TEMPORARY TABLES</TT +> permissions + to the list. </P ></TD ></TR ></TABLE ></DIV ></DIV +></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A +NAME="AEN400" +></A +>2.2.3. checksetup.pl</H2 +><P +> Next, rerun <TT +CLASS="filename" +>checksetup.pl</TT +>. It reconfirms + that all the modules are present, and notices the altered + localconfig file, which it assumes you have edited to your + satisfaction. It compiles the UI templates, + connects to the database using the 'bugs' + user you created and the password you defined, and creates the + 'bugs' database and the tables therein. + </P +><P +> After that, it asks for details of an administrator account. Bugzilla + can have multiple administrators - you can create more later - but + it needs one to start off with. + Enter the email address of an administrator, his or her full name, + and a suitable Bugzilla password. + </P +><P +> <TT +CLASS="filename" +>checksetup.pl</TT +> will then finish. You may rerun + <TT +CLASS="filename" +>checksetup.pl</TT +> at any time if you wish. + </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="http" +></A +>2.2.4. Web server</H2 +><P +>Configure your web server according to the instructions in the + appropriate section. The Bugzilla Team recommends Apache. + </P +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A +NAME="http-apache" +></A +>2.2.4.1. Apache <SPAN +CLASS="productname" +>httpd</SPAN +></H3 +><P +>Load <TT +CLASS="filename" +>httpd.conf</TT +> in your editor.</P +><P +>Uncomment (or add) the following line. + This configures Apache to run .cgi files outside the + <TT +CLASS="filename" +>cgi-bin</TT +> directory. + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> AddHandler cgi-script .cgi</PRE +></FONT +></TD +></TR +></TABLE +><P +>Apache uses <TT +CLASS="computeroutput" +><Directory></TT +> + directives to permit fine-grained permission setting. + Add the following two lines to a + <TT +CLASS="computeroutput" +><Directory></TT +> directive that + applies either to the Bugzilla directory or one of its parents + (e.g. the <TT +CLASS="computeroutput" +><Directory /var/www/html></TT +> + directive). + This allows Bugzilla's <TT +CLASS="filename" +>.htaccess</TT +> files to + override global permissions, and allows .cgi files to run in the + Bugzilla directory. + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +> Options +ExecCGI +FollowSymLinks + AllowOverride Limit</PRE +></FONT +></TD +></TR +></TABLE +><P +>Add <TT +CLASS="filename" +>index.cgi</TT +> to the end + of the <TT +CLASS="computeroutput" +>DirectoryIndex</TT +> + line.</P +><P +><TT +CLASS="filename" +>checksetup.pl</TT +> can set tighter permissions + on Bugzilla's files and directories if it knows what user the + webserver runs as. Look for the <TT +CLASS="computeroutput" +>User</TT +> + line in <TT +CLASS="filename" +>httpd.conf</TT +>, and place that value in + the <TT +CLASS="replaceable" +><I +>$webservergroup</I +></TT +> variable in + <TT +CLASS="filename" +>localconfig</TT +>. Then rerun + <TT +CLASS="filename" +>checksetup.pl</TT +>. + </P +></DIV +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A NAME="http-iis" ></A ->4.2.2. Microsoft <SPAN +>2.2.4.2. Microsoft <SPAN CLASS="productname" >Internet Information Services</SPAN -></H2 +></H3 ><P >If you need, or for some reason even want, to use Microsoft's - <SPAN + <SPAN CLASS="productname" >Internet Information Services</SPAN > or - <SPAN + <SPAN CLASS="productname" >Personal Web Server</SPAN > you should be able - to. You will need to configure them to know how to run CGI scripts, - however. This is described in Microsoft Knowledge Base article - <A + to. You will need to configure them to know how to run CGI scripts. + This is described in Microsoft Knowledge Base article + <A HREF="http://support.microsoft.com/support/kb/articles/Q245/2/25.asp" TARGET="_top" >Q245225</A > - for <SPAN + for <SPAN CLASS="productname" >Internet Information Services</SPAN > and - <A + <A HREF="http://support.microsoft.com/support/kb/articles/Q231/9/98.asp" TARGET="_top" >Q231998</A > - for <SPAN + for <SPAN CLASS="productname" >Personal Web Server</SPAN >. - </P + </P ><P >Also, and this can't be stressed enough, make sure that files such as - <TT + <TT CLASS="filename" >localconfig</TT > and your <TT CLASS="filename" >data</TT > - directory are secured as described in <A + directory are secured as described in <A HREF="#security-access" ->Section 4.5.4</A +>Section 2.2.4.4</A >. - </P + </P ></DIV ><DIV CLASS="section" -><HR><H2 +><HR><H3 CLASS="section" ><A NAME="http-aol" ></A ->4.2.3. AOL Server</H2 +>2.2.4.3. AOL Server</H3 ><P >Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. - </P + reported his experience and what appears below is based on that. + </P ><P >AOL Server will have to be configured to run - <A + <A HREF="#gloss-cgi" ><I CLASS="glossterm" >CGI</I ></A > scripts, please consult - the documentation that came with your server for more information on - how to do this. - </P + the documentation that came with your server for more information on + how to do this. + </P ><P >Because AOL Server doesn't support <TT CLASS="filename" >.htaccess</TT > - files, you'll have to create a <A + files, you'll have to create a <A HREF="#gloss-tcl" ><I CLASS="glossterm" >TCL</I ></A > - script. You should create an <TT + script. You should create an <TT CLASS="filename" >aolserver/modules/tcl/filter.tcl</TT > - file (the filename shouldn't matter) with the following contents (change - <TT + file (the filename shouldn't matter) with the following contents (change + <TT CLASS="computeroutput" >/bugzilla/</TT > to the web-based path to - your Bugzilla installation): - </P + your Bugzilla installation): + </P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -4280,20 +2551,20 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> ns_register_filter preauth GET /bugzilla/localconfig filter_deny -ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny -ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny -ns_register_filter preauth GET /bugzilla/*.pl filter_deny -ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny -ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny -ns_register_filter preauth GET /bugzilla/data/* filter_deny -ns_register_filter preauth GET /bugzilla/template/* filter_deny - -proc filter_deny { why } { - ns_log Notice "filter_deny" - return "filter_return" -} - </PRE +> ns_register_filter preauth GET /bugzilla/localconfig filter_deny + ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny + ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny + ns_register_filter preauth GET /bugzilla/*.pl filter_deny + ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny + ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny + ns_register_filter preauth GET /bugzilla/data/* filter_deny + ns_register_filter preauth GET /bugzilla/template/* filter_deny + + proc filter_deny { why } { + ns_log Notice "filter_deny" + return "filter_return" + } + </PRE ></FONT ></TD ></TR @@ -4320,21 +2591,21 @@ ALIGN="LEFT" VALIGN="TOP" ><P >This probably doesn't account for all possible editor backup - files so you may wish to add some additional variations of - <TT + files so you may wish to add some additional variations of + <TT CLASS="filename" >localconfig</TT >. For more information, see - <A + <A HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=186383" TARGET="_top" -> bug 186383</A +> bug 186383</A > or <A HREF="http://online.securityfocus.com/bid/6501" TARGET="_top" >Bugtraq ID 6501</A >. - </P + </P ></TD ></TR ></TABLE @@ -4361,47 +2632,344 @@ ALIGN="LEFT" VALIGN="TOP" ><P >If you are using webdot from research.att.com (the default - configuration for the <TT + configuration for the <TT CLASS="option" >webdotbase</TT > paramater), you - will need to allow access to <TT + will need to allow access to <TT CLASS="filename" >data/webdot/*.dot</TT > - for the reasearch.att.com machine. - </P + for the reasearch.att.com machine. + </P ><P >If you are using a local installation of <A HREF="http://www.graphviz.org" TARGET="_top" >GraphViz</A >, you will need to allow - everybody to access <TT + everybody to access <TT CLASS="filename" >*.png</TT >, - <TT + <TT CLASS="filename" >*.gif</TT >, <TT CLASS="filename" >*.jpg</TT >, and - <TT + <TT CLASS="filename" >*.map</TT > in the - <TT + <TT CLASS="filename" >data/webdot</TT > directory. - </P + </P ></TD ></TR ></TABLE ></DIV ></DIV +><DIV +CLASS="section" +><HR><H3 +CLASS="section" +><A +NAME="security-access" +></A +>2.2.4.4. Web Server Access Controls</H3 +><P +>Users of Apache can skip this section because + Bugzilla ships with <TT +CLASS="filename" +>.htaccess</TT +> files which + restrict access in the manner required. + Users of other webservers, read on. + </P +><P +>There are several files in the Bugzilla directory + that should not be accessible from the web. You need to configure + your webserver so they they aren't. Not doing this may reveal + sensitive information such as database passwords. + </P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>In the main Bugzilla directory, you should:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block: + <TT +CLASS="filename" +>*.pl</TT +>, <TT +CLASS="filename" +>*localconfig*</TT +>, <TT +CLASS="filename" +>runtests.sh</TT +> + </P +></LI +><LI +><P +>But allow: + <TT +CLASS="filename" +>localconfig.js</TT +>, <TT +CLASS="filename" +>localconfig.rdf</TT +> + </P +></LI +></UL +></LI +><LI +><P +>In <TT +CLASS="filename" +>data</TT +>:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +><LI +><P +>But allow: + <TT +CLASS="filename" +>duplicates.rdf</TT +> + </P +></LI +></UL +></LI +><LI +><P +>In <TT +CLASS="filename" +>data/webdot</TT +>:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>If you use a remote webdot server:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +><LI +><P +>But allow + <TT +CLASS="filename" +>*.dot</TT +> + only for the remote webdot server</P +></LI +></UL +></LI +><LI +><P +>Otherwise, if you use a local GraphViz:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +><LI +><P +>But allow: + <TT +CLASS="filename" +>*.png</TT +>, <TT +CLASS="filename" +>*.gif</TT +>, <TT +CLASS="filename" +>*.jpg</TT +>, <TT +CLASS="filename" +>*.map</TT +> + </P +></LI +></UL +></LI +><LI +><P +>And if you don't use any dot:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +></UL +></LI +></UL +></LI +><LI +><P +>In <TT +CLASS="filename" +>Bugzilla</TT +>:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +></UL +></LI +><LI +><P +>In <TT +CLASS="filename" +>template</TT +>:</P +><P +></P +><UL +COMPACT="COMPACT" +><LI +><P +>Block everything</P +></LI +></UL +></LI +></UL +><P +>You should test to make sure that the files mentioned above are + not accessible from the Internet, especially your + <TT +CLASS="filename" +>localconfig</TT +> file which contains your database + password. To test, simply point your web browser at the file; for + example, to test mozilla.org's installation, we'd try to access + <A +HREF="http://bugzilla.mozilla.org/localconfig" +TARGET="_top" +>http://bugzilla.mozilla.org/localconfig</A +>. You should + get a <SPAN +CLASS="errorcode" +>403</SPAN +> <SPAN +CLASS="errorname" +>Forbidden</SPAN +> + error. + </P +></DIV +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="install-config-bugzilla" +></A +>2.2.5. Bugzilla</H2 +><P +> Your Bugzilla should now be working. Access + <TT +CLASS="filename" +>http://<your-bugzilla-server>/</TT +> - + you should see the Bugzilla + front page. If not, consult the Troubleshooting section, + <A +HREF="#troubleshooting" +>Section 2.5</A +>. + </P +><P +> Log in with the administrator account you defined in the last + <TT +CLASS="filename" +>checksetup.pl</TT +> run. You should go through + the parameters on the Edit Parameters page + (see link in the footer) and see if there are any you wish to + change. + They key parameters are documented in <A +HREF="#parameters" +>Section 3.1</A +>; + you should certainly alter + <B +CLASS="command" +>maintainer</B +> and <B +CLASS="command" +>urlbase</B +>; + you may also want to alter + <B +CLASS="command" +>cookiepath</B +> or <B +CLASS="command" +>requirelogin</B +>. + </P +><P +> This would also be a good time to revisit the + <TT +CLASS="filename" +>localconfig</TT +> file and make sure that the + names of the priorities, severities, platforms and operating systems + are those you wish to use when you start creating bugs. Remember + to rerun <TT +CLASS="filename" +>checksetup.pl</TT +> if you change it. + </P +><P +> Bugzilla has several optional features which require extra + configuration. You can read about those in + <A +HREF="#extraconfig" +>Section 2.3</A +>. + </P +></DIV ></DIV ><DIV CLASS="section" @@ -4410,18 +2978,84 @@ CLASS="section" ><A NAME="extraconfig" ></A ->4.3. Optional Additional Configuration</H1 +>2.3. Optional Additional Configuration</H1 +><P +> Bugzilla has a number of optional features. This section describes how + to configure or enable them. + </P ><DIV CLASS="section" -><H2 +><HR><H2 +CLASS="section" +><A +NAME="AEN584" +></A +>2.3.1. Bug Graphs</H2 +><P +>If you have installed the necessary Perl modules you + can start collecting statistics for the nifty Bugzilla + graphs.</P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="screen" +><TT +CLASS="prompt" +>bash#</TT +> <B +CLASS="command" +>crontab -e</B +></PRE +></FONT +></TD +></TR +></TABLE +><P +> This should bring up the crontab file in your editor. + Add a cron entry like this to run + <TT +CLASS="filename" +>collectstats.pl</TT +> + daily at 5 after midnight: + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl</PRE +></FONT +></TD +></TR +></TABLE +><P +>After two days have passed you'll be able to view bug graphs from + the Reports page.</P +></DIV +><DIV +CLASS="section" +><HR><H2 CLASS="section" ><A -NAME="AEN843" +NAME="AEN594" ></A ->4.3.1. Dependency Charts</H2 +>2.3.2. Dependency Charts</H2 ><P ->As well as the text-based dependency graphs, Bugzilla also - supports dependency graphing, using a package called 'dot'. +>As well as the text-based dependency trees, Bugzilla also + supports a graphical view of dependency relationships, using a + package called 'dot'. Exactly how this works is controlled by the 'webdotbase' parameter, which can have one of three values: </P @@ -4456,7 +3090,7 @@ TARGET="_top" > </P ><P ->So, to get this working, install +>The easiest way to get this working is to install <A HREF="http://www.graphviz.org/" TARGET="_top" @@ -4470,137 +3104,37 @@ TARGET="_top" server-side image maps</A > in Apache. Alternatively, you could set up a webdot server, or use the AT&T - public webdot server (the - default for the webdotbase param). Note that AT&T's server won't work - if Bugzilla is only accessible using HARTS. - </P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="AEN858" -></A ->4.3.2. Bug Graphs</H2 -><P ->As long as you installed the GD and Graph::Base Perl modules you - might as well turn on the nifty Bugzilla bug reporting graphs.</P -><P ->Add a cron entry like this to run - <TT -CLASS="filename" ->collectstats.pl</TT -> - daily at 5 after midnight: - <P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD -> <TT -CLASS="computeroutput" -> <TT -CLASS="prompt" ->bash#</TT -> - - <B -CLASS="command" ->crontab -e</B -> - </TT -> - </TD -></TR -><TR -><TD -> <TT -CLASS="computeroutput" ->5 0 * * * cd <your-bugzilla-directory> ; - ./collectstats.pl</TT -> - </TD -></TR -></TBODY -></TABLE -><P -></P + public webdot server. This is the default for the webdotbase param, + but it's often overloaded and slow. Note that AT&T's server + won't work + if Bugzilla is only accessible using HARTS. + <EM +>Editor's note: What the heck is HARTS? Google doesn't know... + </EM > </P -><P ->After two days have passed you'll be able to view bug graphs from - the Bug Reports page.</P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN871" +NAME="AEN610" ></A ->4.3.3. The Whining Cron</H2 +>2.3.3. The Whining Cron</H2 ><P ->By now you have a fully functional Bugzilla, but what good are - bugs if they're not annoying? To help make those bugs more annoying you +>What good are + bugs if they're not annoying? To help make them more so you can set up Bugzilla's automatic whining system to complain at engineers which leave their bugs in the NEW or REOPENED state without triaging them. </P ><P -> This can be done by - adding the following command as a daily crontab entry (for help on that - see that crontab man page): - <P -></P -><TABLE -BORDER="0" -><TBODY -><TR -><TD -> <TT -CLASS="computeroutput" -> <B -CLASS="command" ->cd <your-bugzilla-directory> ; - ./whineatnews.pl</B -> - </TT -> - </TD -></TR -></TBODY -></TABLE -><P -></P -> +> + This can be done by + adding the following command as a daily crontab entry, in the same manner + as explained above for bug graphs. This example runs it at 12.55am. </P -><DIV -CLASS="tip" -><P -></P ><TABLE -CLASS="tip" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/tip.gif" -HSPACE="5" -ALT="Tip"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->Depending on your system, crontab may have several manpages. - The following command should lead you to the most useful page for - this purpose: - <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -4610,18 +3144,66 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> man 5 crontab - </PRE +>55 0 * * * cd <your-bugzilla-directory> ; ./whineatnews.pl</PRE ></FONT ></TD ></TR ></TABLE -> - </P -></TD -></TR -></TABLE ></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patch-viewer" +></A +>2.3.4. Patch Viewer</H2 +><P +> Patch Viewer is the engine behind Bugzilla's graphical display of + code patches. You can integrate this with copies of the + <TT +CLASS="filename" +>cvs</TT +>, <TT +CLASS="filename" +>lxr</TT +> and + <TT +CLASS="filename" +>bonsai</TT +> tools if you have them, by giving + the locations of your installation of these tools in + <TT +CLASS="filename" +>editparams.cgi</TT +>. + </P +><P +> Patch Viewer also optionally will use the + <TT +CLASS="filename" +>cvs</TT +>, <TT +CLASS="filename" +>diff</TT +> and + <TT +CLASS="filename" +>interdiff</TT +> + command-line utilities if they exist on the system. + Interdiff can be obtained from + <A +HREF="http://cyberelk.net/tim/patchutils/" +TARGET="_top" +>http://cyberelk.net/tim/patchutils/</A +>. + If these programs are not in the system path, you can configure + their locations in <TT +CLASS="filename" +>localconfig</TT +>. + </P ></DIV ><DIV CLASS="section" @@ -4630,7 +3212,7 @@ CLASS="section" ><A NAME="bzldap" ></A ->4.3.4. LDAP Authentication</H2 +>2.3.5. LDAP Authentication</H2 ><P >LDAP authentication is a module for Bugzilla's plugin authentication architecture. @@ -4790,7 +3372,7 @@ NAME="param-LDAPBaseDN" ><DD ><P >The LDAPBaseDN parameter should be set to the location in - your LDAP tree that you would like to search for e-mail addresses. + your LDAP tree that you would like to search for email addresses. Your uids should be unique under the DN specified here. </P ><P @@ -4825,7 +3407,7 @@ NAME="param-LDAPmailattribute" ><DD ><P >The LDAPmailattribute parameter should be the name of the - attribute which contains the e-mail address your users will enter + attribute which contains the email address your users will enter into the Bugzilla login boxes. </P ><P @@ -4844,21 +3426,19 @@ CLASS="section" ><A NAME="content-type" ></A ->4.3.5. Preventing untrusted Bugzilla content from executing malicious - Javascript code</H2 +>2.3.6. Prevent users injecting malicious + Javascript</H2 ><P ->It is possible for a Bugzilla attachment to contain malicious - Javascript - code, which would be executed in the domain of your Bugzilla, thereby - making it possible for the attacker to e.g. steal your login cookies. +>It is possible for a Bugzilla user to take advantage of character + set encoding ambiguities to inject HTML into Bugzilla comments. This + could include malicious scripts. Due to internationalization concerns, we are unable to - incorporate by default the code changes necessary to fulfill the CERT - advisory requirements mentioned in + incorporate by default the code changes suggested by <A -HREF="http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3" +HREF="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3" TARGET="_top" ->http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3</A ->. +> the CERT advisory</A +> on this issue. If your installation is for an English speaking audience only, making the change below will prevent this problem. </P @@ -4878,8 +3458,7 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> $self->charset(''); - </PRE +>$self->charset('');</PRE ></FONT ></TD ></TR @@ -4896,8 +3475,7 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> $self->charset('ISO-8859-1'); - </PRE +>$self->charset('ISO-8859-1');</PRE ></FONT ></TD ></TR @@ -4910,42 +3488,22 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="mod_perl" -></A ->4.3.6. Bugzilla and <TT -CLASS="filename" ->mod_perl</TT -></H2 -><P ->Bugzilla is unsupported under mod_perl. Effort is underway - to make it work cleanly in a mod_perl environment, but it is - slow going. - </P -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A NAME="mod-throttle" ></A ->4.3.7. <TT +>2.3.7. <TT CLASS="filename" >mod_throttle</TT -> - - and Security</H2 +></H2 ><P >It is possible for a user, by mistake or on purpose, to access the database many times in a row which can result in very slow access speeds for other users. If your Bugzilla installation is experiencing - this problem , you may install the Apache module + this problem, you may install the Apache module <TT CLASS="filename" >mod_throttle</TT > - - which can limit connections by ip-address. You may download this module + which can limit connections by IP address. You may download this module at <A HREF="http://www.snert.com/Software/mod_throttle/" @@ -4957,21 +3515,66 @@ TARGET="_top" >This module only functions with the Apache web server!</EM > - You may use the + The command you need is <B CLASS="command" >ThrottleClientIP</B -> - - command provided by this module to accomplish this goal. See the +>. See the <A HREF="http://www.snert.com/Software/mod_throttle/" TARGET="_top" ->Module - Instructions</A +>documentation</A > for more information.</P ></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="security-networking" +></A +>2.3.8. TCP/IP Ports</H2 +><P +>A single-box Bugzilla only requires port 80, plus port 25 if + you are using the optional email interface. You should firewall all + other ports and/or disable services listening on them. + </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="security-daemon" +></A +>2.3.9. Daemon Accounts</H2 +><P +>Many daemons, such as Apache's httpd and MySQL's mysqld default to + running as either <SPAN +CLASS="QUOTE" +>"root"</SPAN +> or <SPAN +CLASS="QUOTE" +>"nobody"</SPAN +>. Running + as <SPAN +CLASS="QUOTE" +>"root"</SPAN +> introduces obvious security problems, but the + problems introduced by running everything as <SPAN +CLASS="QUOTE" +>"nobody"</SPAN +> may + not be so obvious. Basically, if you're running every daemon as + <SPAN +CLASS="QUOTE" +>"nobody"</SPAN +> and one of them gets compromised, they all get + compromised. For this reason it is recommended that you create a user + account for each daemon. + </P +></DIV ></DIV ><DIV CLASS="section" @@ -4980,7 +3583,7 @@ CLASS="section" ><A NAME="os-specific" ></A ->4.4. OS Specific Installation Notes</H1 +>2.4. OS-Specific Installation Notes</H1 ><P >Many aspects of the Bugzilla installation can be affected by the the operating system you choose to install it on. Sometimes it can be made @@ -5003,9 +3606,9 @@ CLASS="section" ><A NAME="os-win32" ></A ->4.4.1. Microsoft Windows</H2 +>2.4.1. Microsoft Windows</H2 ><P ->Making Bugzilla work on windows is still a painful processes. +>Making Bugzilla work on Windows is still a painful processes. The Bugzilla Team is working to make it easier, but that goal is not considered a top priority. If you wish to run Bugzilla, we still recommend doing so on a Unix based system such as GNU/Linux. As of this @@ -5017,9 +3620,9 @@ NAME="os-win32" installing Bugzilla on Win32, here are some pointers. Because this is a development version of the guide, these instructions - are subject to change without notice. In fact, the Bugzilla Team hopes - they do as we would like to have Bugzilla resonabally close to "out of - the box" compatibility by the 2.18 release. + are subject to change without notice. In fact, the Bugzilla Team hopes + to have Bugzilla reasonably close to "out of + the box" compatibility with Windows by the 2.18 release. </P ><DIV @@ -5029,7 +3632,7 @@ CLASS="section" ><A NAME="win32-perl" ></A ->4.4.1.1. Win32 Perl</H3 +>2.4.1.1. Win32 Perl</H3 ><P >Perl for Windows can be obtained from <A HREF="http://www.activestate.com/" @@ -5050,12 +3653,12 @@ CLASS="section" ><A NAME="win32-perlmodules" ></A ->4.4.1.2. Perl Modules on Win32</H3 +>2.4.1.2. Perl Modules on Win32</H3 ><P >Bugzilla on Windows requires the same perl modules found in <A HREF="#install-perlmodules" ->Section 4.1.6</A +>Section 2.1.5</A >. The main difference is that windows uses <A HREF="#gloss-ppm" @@ -5122,38 +3725,6 @@ TARGET="_top" ></TR ></TABLE ></DIV -><DIV -CLASS="tip" -><P -></P -><TABLE -CLASS="tip" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/tip.gif" -HSPACE="5" -ALT="Tip"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->A complete list of modules that can be installed using ppm can - be found at <A -HREF="http://www.activestate.com/PPMPackages/5.6plus" -TARGET="_top" ->http://www.activestate.com/PPMPackages/5.6plus</A ->. - </P -></TD -></TR -></TABLE -></DIV ></DIV ><DIV CLASS="section" @@ -5162,11 +3733,11 @@ CLASS="section" ><A NAME="win32-code-changes" ></A ->4.4.1.3. Code changes required to run on win32</H3 +>2.4.1.3. Code changes required to run on win32</H3 ><P >As Bugzilla still doesn't run "out of the box" on - Windows, code has to be modified. This section is an attempt to - list the required changes. + Windows, code has to be modified. This section lists the required + changes. </P ><DIV CLASS="section" @@ -5175,7 +3746,7 @@ CLASS="section" ><A NAME="win32-code-checksetup" ></A ->4.4.1.3.1. Changes to <TT +>2.4.1.3.1. Changes to <TT CLASS="filename" >checksetup.pl</TT ></H4 @@ -5262,12 +3833,12 @@ CLASS="section" ><A NAME="win32-code-bugmail" ></A ->4.4.1.3.2. Changes to <TT +>2.4.1.3.2. Changes to <TT CLASS="filename" >BugMail.pm</TT ></H4 ><P ->To make bug e-mail work on Win32 (until +>To make bug email work on Win32 (until <A HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=84876" TARGET="_top" @@ -5329,7 +3900,7 @@ $smtp->quit; ></TABLE ><P >Don't forget to change the name of your SMTP server and the - domain of the sending e-mail address (after the '@') in the above + domain of the sending email address (after the '@') in the above lines of code.</P ></DIV ></DIV @@ -5340,19 +3911,19 @@ CLASS="section" ><A NAME="win32-http" ></A ->4.4.1.4. Serving the web pages</H3 +>2.4.1.4. Serving the web pages</H3 ><P >As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay attention to the security notes in <A HREF="#security-access" ->Section 4.5.4</A +>Section 2.2.4.4</A >. More information on configuring specific web servers can be found in <A HREF="#http" ->Section 4.2</A +>Section 2.2.4</A >. </P ><DIV @@ -5381,7 +3952,7 @@ HREF="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource" TARGET="_top" >ScriptInterpreterSource</A > - directive in your Apache config, if you don't do this, you'll have + directive in your Apache config to avoid having to modify the first line of every script to contain your path to perl instead of <TT CLASS="filename" @@ -5401,17 +3972,15 @@ CLASS="section" ><A NAME="os-macosx" ></A ->4.4.2. <SPAN +>2.4.2. <SPAN CLASS="productname" >Mac OS X</SPAN ></H2 ><P ->There are a lot of common libraries and utilities out there that - Apple did not include with Mac OS X, but which run perfectly well on it. - The GD library, which Bugzilla needs to do bug graphs, is one of - these.</P +>Apple did not include the GD library with Mac OS X. Bugzilla + needs this for bug graphs.</P ><P ->The easiest way to get a lot of these is with a program called +>You can install it using a program called Fink, which is similar in nature to the CPAN installer, but installs common GNU utilities. Fink is available from <A @@ -5421,7 +3990,10 @@ TARGET="_top" >.</P ><P >Follow the instructions for setting up Fink. Once it's installed, - you'll want to use it to install the gd2 package. + you'll want to use it to install the <TT +CLASS="filename" +>gd2</TT +> package. </P ><P >It will prompt you for a number of dependencies, type 'y' and hit @@ -5433,7 +4005,7 @@ CLASS="glossterm" >CPAN</I ></A > to - install the GD perl module. + install the GD Perl module. </P ><DIV CLASS="note" @@ -5490,7 +4062,7 @@ CLASS="filename" ></TABLE ></DIV ><P ->Also available via Fink is expat. Once running using fink to +>Also available via Fink is expat. After using fink to install the expat package you will be able to install XML::Parser using CPAN. There is one caveat. Unlike recent versions of the GD module, XML::Parser doesn't prompt for the location of the @@ -5595,7 +4167,7 @@ CLASS="section" ><A NAME="os-mandrake" ></A ->4.4.3. Linux-Mandrake 8.0</H2 +>2.4.3. Linux-Mandrake 8.0</H2 ><P >Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the @@ -5683,7 +4255,7 @@ BORDER="0" ALT="(1)"></A ></DT ><DD ->for Bugzilla e-mail integration</DD +>for Bugzilla email integration</DD ></DL ></DIV ></DIV @@ -5693,570 +4265,90 @@ CLASS="section" ><HR><H1 CLASS="section" ><A -NAME="security" -></A ->4.5. Bugzilla Security</H1 -><DIV -CLASS="warning" -><P -></P -><TABLE -CLASS="warning" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/warning.gif" -HSPACE="5" -ALT="Warning"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->Poorly-configured MySQL and Bugzilla installations have - given attackers full access to systems in the past. Please take these - guidelines seriously, even for Bugzilla machines hidden away behind - your firewall. 80% of all computer trespassers are insiders, not - anonymous crackers.</P -><P ->This is not meant to be a comprehensive list of every possible - security issue pertaining to the software mentioned in this section. - There is - no subsitute for reading the information written by the authors of any - software running on your system. - </P -></TD -></TR -></TABLE -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="security-networking" +NAME="troubleshooting" ></A ->4.5.1. TCP/IP Ports</H2 +>2.5. Troubleshooting</H1 ><P ->TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla - only needs 1, or 2 if you need to use features that require e-mail such - as bug moving or the e-mail interface from contrib. You should audit - your server and make sure that you aren't listening on any ports you - don't need to be. You may also wish to use some kind of firewall - software to be sure that trafic can only be recieved on ports you - specify. - </P -></DIV +>This section gives solutions to common Bugzilla installation + problems. If none of the section headings seems to match your + problem, read the general advice. + </P ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="security-mysql" +NAME="general-advice" ></A ->4.5.2. MySQL</H2 -><P ->MySQL ships by default with many settings that should be changed. - By defaults it allows anybody to connect from localhost without a - password and have full administrative capabilities. It also defaults to - not have a root password (this is <EM ->not</EM -> the same as - the system root). Also, many installations default to running - <SPAN -CLASS="application" ->mysqld</SPAN -> as the system root. - </P -><P -></P -><OL -TYPE="1" -><LI -><P ->Consult the documentation that came with your system for - information on making <SPAN -CLASS="application" ->mysqld</SPAN -> run as an - unprivleged user. - </P -></LI -><LI -><P ->You should also be sure to disable the anonymous user account - and set a password for the root user. This is accomplished using the - following commands: - </P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="programlisting" -> <TT -CLASS="prompt" ->bash$</TT -> mysql mysql -<TT -CLASS="prompt" ->mysql></TT -> DELETE FROM user WHERE user = ''; -<TT -CLASS="prompt" ->mysql></TT -> UPDATE user SET password = password('<TT -CLASS="replaceable" -><I ->new_password</I -></TT ->') WHERE user = 'root'; -<TT -CLASS="prompt" ->mysql></TT -> FLUSH PRIVILEGES; - </PRE -></FONT -></TD -></TR -></TABLE -><P ->From this point forward you will need to use - <B -CLASS="command" ->mysql -u root -p</B -> and enter - <TT -CLASS="replaceable" -><I ->new_password</I -></TT -> when prompted when using the - mysql client. - </P -></LI -><LI +>2.5.1. General Advice</H2 ><P ->If you run MySQL on the same machine as your httpd server, you - should consider disabling networking from within MySQL by adding - the following to your <TT +> If you can't get <TT CLASS="filename" ->/etc/my.conf</TT ->: - </P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><FONT -COLOR="#000000" -><PRE -CLASS="programlisting" -> [myslqd] -# Prevent network access to MySQL. -skip-networking - </PRE -></FONT -></TD -></TR -></TABLE -></LI -><LI -><P ->You may also consider running MySQL, or even all of Bugzilla - in a chroot jail; however, instructions for doing that are beyond - the scope of this document. - </P -></LI -></OL -></DIV -><DIV -CLASS="section" -><HR><H2 -CLASS="section" -><A -NAME="security-daemon" -></A ->4.5.3. Daemon Accounts</H2 -><P ->Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either <SPAN -CLASS="QUOTE" ->"root"</SPAN -> or <SPAN -CLASS="QUOTE" ->"nobody"</SPAN ->. Running - as <SPAN -CLASS="QUOTE" ->"root"</SPAN -> introduces obvious security problems, but the - problems introduced by running everything as <SPAN -CLASS="QUOTE" ->"nobody"</SPAN -> may - not be so obvious. Basically, if you're running every daemon as - <SPAN -CLASS="QUOTE" ->"nobody"</SPAN -> and one of them gets compromised, they all get - compromised. For this reason it is recommended that you create a user - account for each daemon. +>checksetup.pl</TT +> to run to + completion, it normally explains what's wrong and how to fix it. + If you can't work it out, or if it's being uncommunicative, post + the errors in the + <A +HREF="news://news.mozilla.org/netscape.public.mozilla.webtools" +TARGET="_top" +>netscape.public.mozilla.webtools</A +> + newsgroup. </P -><DIV -CLASS="note" -><P -></P -><TABLE -CLASS="note" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/note.gif" -HSPACE="5" -ALT="Note"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" ><P ->You will need to set the <TT -CLASS="varname" ->webservergroup</TT -> to - the group you created for your webserver to run as in +> If you have made it all the way through + <A +HREF="#installation" +>Section 2.1</A +> (Installation) and + <A +HREF="#configuration" +>Section 2.2</A +> (Configuration) but + accessing the Bugzilla URL doesn't work, + the first thing to do is to check your webserver error log. For + Apache, this is often located at <TT CLASS="filename" ->localconfig</TT ->. This will allow - <B -CLASS="command" ->./checksetup.pl</B -> to better adjust the file - permissions on your Bugzilla install so as to not require making - anything world-writable. - </P -></TD -></TR -></TABLE -></DIV +>/etc/logs/httpd/error_log</TT +>. The error messages + you see may be self-explanatory enough to enable you to diagnose and + fix the problem. If not, see below for some commonly-encountered + errors. If that doesn't help, post the errors to the newsgroup. + </P ></DIV ><DIV CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="security-access" +NAME="AEN827" ></A ->4.5.4. Web Server Access Controls</H2 -><P ->There are many files that are placed in the Bugzilla directory - area that should not be accessable from the web. Because of the way - Bugzilla is currently laid out, the list of what should and should - not be accessible is rather complicated. - </P -><P ->Users of Apache don't need to worry about this, however, because - Bugzilla ships with .htaccess files which restrict access to all the - sensitive files in this section. Users of other webservers, read on. - </P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->In the main Bugzilla directory, you should:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block: - <TT -CLASS="filename" ->*.pl</TT ->, <TT -CLASS="filename" ->*localconfig*</TT ->, <TT -CLASS="filename" ->runtests.sh</TT -> - </P -></LI -><LI -><P ->But allow: - <TT -CLASS="filename" ->localconfig.js</TT ->, <TT -CLASS="filename" ->localconfig.rdf</TT -> - </P -></LI -></UL -></LI -><LI -><P ->In <TT -CLASS="filename" ->data</TT ->:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -><LI -><P ->But allow: - <TT -CLASS="filename" ->duplicates.rdf</TT -> - </P -></LI -></UL -></LI -><LI -><P ->In <TT -CLASS="filename" ->data/webdot</TT ->:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->If you use a remote webdot server:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -><LI -><P ->But allow - <TT -CLASS="filename" ->*.dot</TT -> - only for the remote webdot server</P -></LI -></UL -></LI -><LI -><P ->Otherwise, if you use a local GraphViz:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -><LI -><P ->But allow: - <TT -CLASS="filename" ->*.png</TT ->, <TT -CLASS="filename" ->*.gif</TT ->, <TT -CLASS="filename" ->*.jpg</TT ->, <TT -CLASS="filename" ->*.map</TT -> - </P -></LI -></UL -></LI -><LI -><P ->And if you don't use any dot:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -></UL -></LI -></UL -></LI -><LI -><P ->In <TT -CLASS="filename" ->Bugzilla</TT ->:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -></UL -></LI -><LI -><P ->In <TT +>2.5.2. I installed a Perl module, but + <TT CLASS="filename" ->template</TT ->:</P -><P -></P -><UL -COMPACT="COMPACT" -><LI -><P ->Block everything</P -></LI -></UL -></LI -></UL +>checksetup.pl</TT +> claims it's not installed!</H2 ><P ->You should test to make sure that the files mentioned above are - not accessible from the Internet, especially your - <TT +> You have two versions of Perl on your machine. You are installing + modules into one, and Bugzilla is using the other. Rerun the CPAN + commands (or manual compile) using the full path to Perl from the + top of <TT CLASS="filename" ->localconfig</TT -> file which contains your database - password. To test, simply point your web browser at the file; for - example, to test mozilla.org's installation, we'd try to access - <A -HREF="http://bugzilla.mozilla.org/localconfig" -TARGET="_top" ->http://bugzilla.mozilla.org/localconfig</A ->. You should - get a <SPAN -CLASS="errorcode" ->403</SPAN -> <SPAN -CLASS="errorname" ->Forbidden</SPAN -> - error. +>checksetup.pl</TT +>. This will make sure you + are installing the modules in the right place. </P -><DIV -CLASS="caution" -><P -></P -><TABLE -CLASS="caution" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/caution.gif" -HSPACE="5" -ALT="Caution"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->Not following the instructions in this section, including - testing, may result in sensitive information being globally - accessible. - </P -></TD -></TR -></TABLE -></DIV -><DIV -CLASS="tip" -><P -></P -><TABLE -CLASS="tip" -WIDTH="100%" -BORDER="0" -><TR -><TD -WIDTH="25" -ALIGN="CENTER" -VALIGN="TOP" -><IMG -SRC="../images/tip.gif" -HSPACE="5" -ALT="Tip"></TD -><TD -ALIGN="LEFT" -VALIGN="TOP" -><P ->You should check <A -HREF="#http" ->Section 4.2</A -> to see if instructions - have been included for your web server. You should also compare those - instructions with this list to make sure everything is properly - accounted for. - </P -></TD -></TR -></TABLE -></DIV -></DIV ></DIV ><DIV CLASS="section" -><HR><H1 -CLASS="section" -><A -NAME="troubleshooting" -></A ->4.6. Troubleshooting</H1 -><P ->This section gives solutions to common Bugzilla installation - problems. - </P -><DIV -CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1206" +NAME="AEN832" ></A ->4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2 +>2.5.3. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2 ><P > Try executing <B CLASS="command" @@ -6279,9 +4371,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1211" +NAME="AEN837" ></A ->4.6.2. DBD::Sponge::db prepare failed</H2 +>2.5.4. DBD::Sponge::db prepare failed</H2 ><P > The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): @@ -6367,7 +4459,7 @@ CLASS="section" ><A NAME="paranoid-security" ></A ->4.6.3. cannot chdir(/var/spool/mqueue)</H2 +>2.5.5. cannot chdir(/var/spool/mqueue)</H2 ><P >If you are installing Bugzilla on SuSE Linux, or some other distributions with @@ -6425,28 +4517,15 @@ CLASS="section" ><A NAME="trouble-filetemp" ></A ->4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT</H2 +>2.5.6. Your vendor has not defined Fcntl macro O_NOINHERIT</H2 ><P >This is caused by a bug in the version of <SPAN CLASS="productname" >File::Temp</SPAN > that is distributed with perl - 5.6.0. Many minor variations of this error have been reported. Examples - can be found in <A -HREF="#trouble-filetemp-errors" ->Figure 4-2</A ->. + 5.6.0. Many minor variations of this error have been reported: </P -><DIV -CLASS="figure" -><A -NAME="trouble-filetemp-errors" -></A -><P -><B ->Figure 4-2. Other File::Temp error messages</B -></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -6457,42 +4536,28 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> Your vendor has not defined Fcntl macro O_NOINHERIT, used +>Your vendor has not defined Fcntl macro O_NOINHERIT, used at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208. Your vendor has not defined Fcntl macro O_EXLOCK, used at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210. Your vendor has not defined Fcntl macro O_TEMPORARY, used -at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233. - </PRE +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.</PRE ></FONT ></TD ></TR ></TABLE -></DIV ><P >Numerous people have reported that upgrading to version 5.6.1 or higher solved the problem for them. A less involved fix is to apply - the patch in <A -HREF="#trouble-filetemp-patch" ->Figure 4-3</A ->. The patch is also + the following patch, which is also available as a <A HREF="../xml/filetemp.patch" TARGET="_top" >patch file</A >. </P -><DIV -CLASS="figure" -><A -NAME="trouble-filetemp-patch" -></A -><P -><B ->Figure 4-3. Patch for File::Temp in Perl 5.6.0</B -></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -6503,7 +4568,7 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="programlisting" -> --- File/Temp.pm.orig Thu Feb 6 16:26:00 2003 +>--- File/Temp.pm.orig Thu Feb 6 16:26:00 2003 +++ File/Temp.pm Thu Feb 6 16:26:23 2003 @@ -205,6 +205,7 @@ # eg CGI::Carp @@ -6520,8 +4585,7 @@ CLASS="programlisting" + local *CORE::GLOBAL::die = sub {}; $bit = &$func(); 1; - }; - </PRE + };</PRE ></FONT ></TD ></TR @@ -6529,14 +4593,13 @@ CLASS="programlisting" ></DIV ></DIV ></DIV -></DIV ><DIV CLASS="chapter" ><HR><H1 ><A NAME="administration" ></A ->Chapter 5. Administering Bugzilla</H1 +>Chapter 3. Administering Bugzilla</H1 ><DIV CLASS="section" ><H1 @@ -6544,7 +4607,7 @@ CLASS="section" ><A NAME="parameters" ></A ->5.1. Bugzilla Configuration</H1 +>3.1. Bugzilla Configuration</H1 ><P >Bugzilla is configured by changing various parameters, accessed from the "Edit parameters" link in the page footer. Here are @@ -6823,7 +4886,7 @@ CLASS="section" ><A NAME="useradmin" ></A ->5.2. User Administration</H1 +>3.2. User Administration</H1 ><DIV CLASS="section" ><H2 @@ -6831,7 +4894,7 @@ CLASS="section" ><A NAME="defaultuser" ></A ->5.2.1. Creating the Default User</H2 +>3.2.1. Creating the Default User</H2 ><P >When you first run checksetup.pl after installing Bugzilla, it will prompt you for the administrative username (email address) and @@ -6876,7 +4939,7 @@ CLASS="section" ><A NAME="manageusers" ></A ->5.2.2. Managing Other Users</H2 +>3.2.2. Managing Other Users</H2 ><DIV CLASS="section" ><H3 @@ -6884,7 +4947,7 @@ CLASS="section" ><A NAME="createnewusers" ></A ->5.2.2.1. Creating new users</H3 +>3.2.2.1. Creating new users</H3 ><P >Your users can create their own user accounts by clicking the "New Account" link at the bottom of each page (assuming they @@ -6957,7 +5020,7 @@ CLASS="section" ><A NAME="modifyusers" ></A ->5.2.2.2. Modifying Users</H3 +>3.2.2.2. Modifying Users</H3 ><P >To see a specific user, search for their login name in the box provided on the "Edit Users" page. To see all users, @@ -7188,7 +5251,7 @@ CLASS="section" ><A NAME="products" ></A ->5.3. Products</H1 +>3.3. Products</H1 ><P > <A HREF="#gloss-product" @@ -7244,7 +5307,7 @@ CLASS="section" ><A NAME="components" ></A ->5.4. Components</H1 +>3.4. Components</H1 ><P >Components are subsections of a Product. E.g. the computer game you are designing may have a "UI" @@ -7299,7 +5362,7 @@ CLASS="section" ><A NAME="versions" ></A ->5.5. Versions</H1 +>3.5. Versions</H1 ><P >Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select @@ -7335,7 +5398,7 @@ CLASS="section" ><A NAME="milestones" ></A ->5.6. Milestones</H1 +>3.6. Milestones</H1 ><P >Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it @@ -7408,7 +5471,7 @@ CLASS="section" ><A NAME="voting" ></A ->5.7. Voting</H1 +>3.7. Voting</H1 ><P >Voting allows users to be given a pot of votes which they can allocate to bugs, to indicate that they'd like them fixed. @@ -7470,7 +5533,7 @@ CLASS="section" ><A NAME="groups" ></A ->5.8. Groups and Group Security</H1 +>3.8. Groups and Group Security</H1 ><P >Groups allow the administrator to isolate bugs or products that should only be seen by certain people. @@ -7653,7 +5716,7 @@ CLASS="section" ><A NAME="upgrading" ></A ->5.9. Upgrading to New Releases</H1 +>3.9. Upgrading to New Releases</H1 ><DIV CLASS="warning" ><P @@ -7712,21 +5775,21 @@ TYPE="1" ><P >Using CVS (<A HREF="#upgrade-cvs" ->Example 5-1</A +>Example 3-1</A >)</P ></LI ><LI ><P >Downloading a new tarball (<A HREF="#upgrade-tarball" ->Example 5-2</A +>Example 3-2</A >)</P ></LI ><LI ><P >Applying the relevant patches (<A HREF="#upgrade-patches" ->Example 5-3</A +>Example 3-3</A >)</P ></LI ></OL @@ -7771,7 +5834,7 @@ NAME="upgrade-cvs" ></A ><P ><B ->Example 5-1. Upgrading using CVS</B +>Example 3-1. Upgrading using CVS</B ></P ><P >Every release of Bugzilla, whether it is a revision or a point @@ -7928,7 +5991,7 @@ NAME="upgrade-tarball" ></A ><P ><B ->Example 5-2. Upgrading using the tarball</B +>Example 3-2. Upgrading using the tarball</B ></P ><P >If you are unable or unwilling to use CVS, another option that's @@ -8084,7 +6147,7 @@ NAME="upgrade-patches" ></A ><P ><B ->Example 5-3. Upgrading using patches</B +>Example 3-3. Upgrading using patches</B ></P ><P >The Bugzilla team will normally make a patch file available for @@ -8164,7 +6227,7 @@ CLASS="filename" > directory so it may make updates using CVS (<A HREF="#upgrade-cvs" ->Example 5-1</A +>Example 3-1</A >) more difficult in the future. </P @@ -8183,7 +6246,7 @@ CLASS="chapter" ><A NAME="customization" ></A ->Chapter 6. Customising Bugzilla</H1 +>Chapter 4. Customising Bugzilla</H1 ><DIV CLASS="section" ><H1 @@ -8191,7 +6254,7 @@ CLASS="section" ><A NAME="cust-templates" ></A ->6.1. Template Customization</H1 +>4.1. Template Customization</H1 ><P > Administrators can configure the look and feel of Bugzilla without having to edit Perl files or face the nightmare of massive merge @@ -8203,7 +6266,7 @@ NAME="cust-templates" determined by the user's browser. More information is available in <A HREF="#template-http-accept" ->Section 6.1.5</A +>Section 4.1.5</A >. </P ><DIV @@ -8211,9 +6274,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1588" +NAME="AEN1208" ></A ->6.1.1. What to Edit</H2 +>4.1.1. What to Edit</H2 ><P > The template directory structure is that there's a top level directory, <TT @@ -8363,9 +6426,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1611" +NAME="AEN1231" ></A ->6.1.2. How To Edit Templates</H2 +>4.1.2. How To Edit Templates</H2 ><DIV CLASS="note" ><P @@ -8443,9 +6506,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1621" +NAME="AEN1241" ></A ->6.1.3. Template Formats</H2 +>4.1.3. Template Formats</H2 ><P > Some CGIs have the ability to use more than one template. For example, buglist.cgi can output bug lists as RDF or two @@ -8505,9 +6568,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1634" +NAME="AEN1254" ></A ->6.1.4. Particular Templates</H2 +>4.1.4. Particular Templates</H2 ><P > There are a few templates you may be particularly interested in customizing for your installation. @@ -8681,7 +6744,7 @@ CLASS="section" ><A NAME="template-http-accept" ></A ->6.1.5. Configuring Bugzilla to Detect the User's Language</H2 +>4.1.5. Configuring Bugzilla to Detect the User's Language</H2 ><P >Bugzilla honours the user's Accept: HTTP header. You can install templates in other languages, and Bugzilla will pick the most appropriate @@ -8697,7 +6760,7 @@ TARGET="_top" >After untarring the localizations (or creating your own) in the <TT CLASS="filename" ->$BUGZILLA_HOME/template</TT +>BUGZILLA_ROOT/template</TT > directory, you must update the <TT CLASS="option" @@ -8720,9 +6783,326 @@ CLASS="section" ><HR><H1 CLASS="section" ><A +NAME="cust-hooks" +></A +>4.2. Template Hooks</H1 +><P +> Template hooks are a way for extensions to Bugzilla to insert code + into the standard Bugzilla templates without modifying the template files + themselves. The hooks mechanism defines a consistent API for extending + the standard templates in a way that cleanly separates standard code + from extension code. Hooks reduce merge conflicts and make it easier + to write extensions that work across multiple versions of Bugzilla, + making upgrading a Bugzilla installation with installed extensions easier. + </P +><P +> A template hook is just a named place in a standard template file + where extension template files for that hook get processed. Each hook + has a corresponding directory in the Bugzilla directory tree. Hooking an + extension template to a hook is as simple as putting the extension file + into the hook's directory. When Bugzilla processes the standard template + and reaches the hook, it will process all extension templates in the + hook's directory. The hooks themselves can be added into any standard + template upon request by extension authors. + </P +><P +> To use hooks to extend a Bugzilla template, first make sure there is + a hook at the appropriate place within the template you want to extend. + Hooks appear in the standard Bugzilla templates as a single directive + in the format + <TT +CLASS="literal" +>[% Hook.process("<TT +CLASS="varname" +>name</TT +>") %]</TT +>, + where <TT +CLASS="varname" +>name</TT +> is the unique (within that template) + name of the hook. + </P +><P +> If you aren't sure which template you want to extend or just want + to browse the available hooks, either use your favorite multi-file search + tool (e.g. <B +CLASS="command" +>grep</B +>) to search the standard templates + for occurrences of <TT +CLASS="methodname" +>Hook.process</TT +> or browse + the directory tree in + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/hook/</TT +>, + which contains a directory for each hook in the following location: + </P +><P +> <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/hook/PATH_TO_STANDARD_TEMPLATE/STANDARD_TEMPLATE_NAME/HOOK_NAME/</TT +> + </P +><P +> If there is no hook at the appropriate place within the Bugzilla template + you want to extend, + <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=User%20Interface" +TARGET="_top" +>file + a bug requesting one</A +>, specifying: + </P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>the template for which you are requesting a hook;</TD +></TR +><TR +><TD +> where in the template you would like the hook to be placed + (line number/position for latest version of template in CVS + or description of location); + </TD +></TR +><TR +><TD +>the purpose of the hook;</TD +></TR +><TR +><TD +>a link to information about your extension, if any.</TD +></TR +></TBODY +></TABLE +><P +></P +><P +> The Bugzilla reviewers will promptly review each hook request, + name the hook, add it to the template, check the new version + of the template into CVS, and create the corresponding directory in + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/hook/</TT +>. + </P +><P +> You may optionally attach a patch to the bug which implements the hook + and check it in yourself after receiving approval from a Bugzilla + reviewer. The developers may suggest changes to the location of the + hook based on their analysis of your needs or so the hook can satisfy + the needs of multiple extensions, but the process of getting hooks + approved and checked in is not as stringent as the process for general + changes to Bugzilla, and any extension, whether released or still in + development, can have hooks added to meet their needs. + </P +><P +> After making sure the hook you need exists (or getting it added if not), + add your extension template to the directory within the Bugzilla + directory tree corresponding to the hook. + </P +><P +> That's it! Now, when the standard template containing the hook + is processed, your extension template will be processed at the point + where the hook appears. + </P +><P +> For example, let's say you have an extension named Projman that adds + project management capabilities to Bugzilla. Projman has an + administration interface <TT +CLASS="filename" +>edit-projects.cgi</TT +>, + and you want to add a link to it into the navigation bar at the bottom + of every Bugzilla page for those users who are authorized + to administer projects. + </P +><P +> The navigation bar is generated by the template file + <TT +CLASS="filename" +>useful-links.html.tmpl</TT +>, which is located in + the <TT +CLASS="filename" +>global/</TT +> subdirectory on the standard Bugzilla + template path + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/default/</TT +>. + Looking in <TT +CLASS="filename" +>useful-links.html.tmpl</TT +>, you find + the following hook at the end of the list of standard Bugzilla + administration links: + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>... + [% ', <a href="editkeywords.cgi">keywords</a>' + IF user.groups.editkeywords %] + [% Hook.process("edit") %] +...</PRE +></FONT +></TD +></TR +></TABLE +><P +> The corresponding directory for this hook is + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/hook/global/useful-links.html.tmpl/edit/</TT +>. + </P +><P +> You put a template named + <TT +CLASS="filename" +>projman-edit-projects.html.tmpl</TT +> + into that directory with the following content: + </P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="programlisting" +>...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %]</PRE +></FONT +></TD +></TR +></TABLE +><P +> Voila! The link now appears after the other administration links in the + navigation bar for users in the <TT +CLASS="literal" +>projman_admins</TT +> group. + </P +><P +> Notes: + </P +><P +></P +><UL +><LI +><P +> You may want to prefix your extension template names + with the name of your extension, e.g. + <TT +CLASS="filename" +>projman-foo.html.tmpl</TT +>, + so they do not conflict with the names of templates installed by + other extensions. + </P +></LI +><LI +><P +> If your extension includes entirely new templates in addition to + extensions of standard templates, it should install those new + templates into an extension-specific subdirectory of the + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/</TT +> + directory. The <TT +CLASS="filename" +>extension/</TT +> directory, like the + <TT +CLASS="filename" +>default/</TT +> and <TT +CLASS="filename" +>custom/</TT +> + directories, is part of the template search path, so putting templates + there enables them to be found by the template processor. + </P +><P +> The template processor looks for templates first in the + <TT +CLASS="filename" +>custom/</TT +> directory (i.e. templates added by the + specific installation), then in the <TT +CLASS="filename" +>extension/</TT +> + directory (i.e. templates added by extensions), and finally in the + <TT +CLASS="filename" +>default/</TT +> directory (i.e. the standard Bugzilla + templates). Thus extension templates can override standard templates, + but installation-specific templates override both. + </P +><P +> Note that overriding standard templates with extension templates + gives you great power but also makes upgrading an installation harder. + As with custom templates, we recommend using this functionality + sparingly and only when absolutely necessary. + </P +></LI +><LI +><P +> Installation customizers can also take advantage of hooks when adding + code to a Bugzilla template. To do so, create directories in + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/custom/hook/</TT +> + equivalent to the directories in + <TT +CLASS="filename" +>BUGZILLA_ROOT/template/en/extension/hook/</TT +> + for the hooks you want to use, then place your customization templates + into those directories. + </P +><P +> Obviously this method of customizing Bugzilla only lets you add code + to the standard templates; you cannot change the existing code. + Nevertheless, for those customizations that only add code, this method + can reduce conflicts when merging changes, making upgrading + your customized Bugzilla installation easier. + </P +></LI +></UL +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A NAME="cust-change-permissions" ></A ->6.2. Customizing Who Can Change What</H1 +>4.3. Customizing Who Can Change What</H1 ><DIV CLASS="warning" ><P @@ -8894,7 +7274,7 @@ CLASS="section" ><A NAME="dbmodify" ></A ->6.3. Modifying Your Running System</H1 +>4.4. Modifying Your Running System</H1 ><P >Bugzilla optimizes database lookups by storing all relatively static information in the @@ -8943,7 +7323,7 @@ CLASS="section" ><A NAME="dbdoc" ></A ->6.4. MySQL Bugzilla Database Introduction</H1 +>4.5. MySQL Bugzilla Database Introduction</H1 ><P >This information comes straight from my life. I was forced to learn how Bugzilla organizes database because of nitpicky requests from users @@ -9003,9 +7383,9 @@ CLASS="section" ><HR><H2 CLASS="section" ><A -NAME="AEN1710" +NAME="AEN1392" ></A ->6.4.1. Bugzilla Database Basics</H2 +>4.5.1. Bugzilla Database Basics</H2 ><P >If you were like me, at this point you're totally clueless about the internals of MySQL, and if it weren't for this executive order from @@ -9117,9 +7497,9 @@ CLASS="section" ><HR><H3 CLASS="section" ><A -NAME="AEN1737" +NAME="AEN1419" ></A ->6.4.1.1. Bugzilla Database Tables</H3 +>4.5.1.1. Bugzilla Database Tables</H3 ><P >Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command:</P @@ -9356,7 +7736,7 @@ CLASS="section" ><A NAME="integration" ></A ->6.5. Integrating Bugzilla with Third-Party Tools</H1 +>4.6. Integrating Bugzilla with Third-Party Tools</H1 ><DIV CLASS="section" ><H2 @@ -9364,7 +7744,7 @@ CLASS="section" ><A NAME="bonsai" ></A ->6.5.1. Bonsai</H2 +>4.6.1. Bonsai</H2 ><P >Bonsai is a web-based tool for managing <A @@ -9390,7 +7770,7 @@ CLASS="section" ><A NAME="cvs" ></A ->6.5.2. CVS</H2 +>4.6.2. CVS</H2 ><P >CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.</P @@ -9426,7 +7806,7 @@ CLASS="section" ><A NAME="scm" ></A ->6.5.3. Perforce SCM</H2 +>4.6.3. Perforce SCM</H2 ><P >You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: @@ -9466,7 +7846,7 @@ CLASS="section" ><A NAME="tinderbox" ></A ->6.5.4. Tinderbox/Tinderbox2</H2 +>4.6.4. Tinderbox/Tinderbox2</H2 ><P >Tinderbox is a continuous-build system which can integrate with Bugzilla - see @@ -9486,6 +7866,1019 @@ TARGET="_top" ></DIV ></DIV ><DIV +CLASS="chapter" +><HR><H1 +><A +NAME="using" +></A +>Chapter 5. Using Bugzilla</H1 +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="using-intro" +></A +>5.1. Introduction</H1 +><P +>This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" +TARGET="_top" +>Landfill</A +>, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and runs an up-to-the-minute version, + so some things may not quite work as this document describes.</P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="myaccount" +></A +>5.2. Create a Bugzilla Account</H1 +><P +>If you want to use Bugzilla, first you need to create an account. + Consult with the administrator responsible for your installation of + Bugzilla for the URL you should use to access it. If you're + test-driving Bugzilla, use this URL: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" +TARGET="_top" +>http://landfill.bugzilla.org/bugzilla-tip/</A +>. + </P +><P +></P +><OL +TYPE="1" +><LI +><P +>Click the + <SPAN +CLASS="QUOTE" +>"Open a new Bugzilla account"</SPAN +> + + link, enter your email address and, optionally, your name in the + spaces provided, then click + <SPAN +CLASS="QUOTE" +>"Create Account"</SPAN +> + + .</P +></LI +><LI +><P +>Within moments, you should receive an email to the address + you provided, which contains your login name (generally the + same as the email address), and a password. + This password is randomly generated, but can be + changed to something more memorable.</P +></LI +><LI +><P +>Click the + <SPAN +CLASS="QUOTE" +>"Log In"</SPAN +> + link in the footer at the bottom of the page in your browser, + enter your email address and password into the spaces provided, and + click + <SPAN +CLASS="QUOTE" +>"Login"</SPAN +>. + </P +></LI +></OL +><P +>You are now logged in. Bugzilla uses cookies to remember you are + logged in so, unless you have cookies disabled or your IP address changes, + you should not have to log in again.</P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="bug_page" +></A +>5.3. Anatomy of a Bug</H1 +><P +>The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1" +TARGET="_top" +> Bug 1 on Landfill</A +> + + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla.</P +><P +></P +><OL +TYPE="1" +><LI +><P +> <EM +>Product and Component</EM +>: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + Components: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +> <EM +>Administration:</EM +> + Administration of a Bugzilla installation.</TD +></TR +><TR +><TD +> <EM +>Bugzilla-General:</EM +> + Anything that doesn't fit in the other components, or spans + multiple components.</TD +></TR +><TR +><TD +> <EM +>Creating/Changing Bugs:</EM +> + Creating, changing, and viewing bugs.</TD +></TR +><TR +><TD +> <EM +>Documentation:</EM +> + The Bugzilla documentation, including The Bugzilla Guide.</TD +></TR +><TR +><TD +> <EM +>Email:</EM +> + Anything to do with email sent by Bugzilla.</TD +></TR +><TR +><TD +> <EM +>Installation:</EM +> + The installation process of Bugzilla.</TD +></TR +><TR +><TD +> <EM +>Query/Buglist:</EM +> + Anything to do with searching for bugs and viewing the + buglists.</TD +></TR +><TR +><TD +> <EM +>Reporting/Charting:</EM +> + Getting reports from Bugzilla.</TD +></TR +><TR +><TD +> <EM +>User Accounts:</EM +> + Anything about managing a user account from the user's perspective. + Saved queries, creating accounts, changing passwords, logging in, + etc.</TD +></TR +><TR +><TD +> <EM +>User Interface:</EM +> + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, + etc.</TD +></TR +></TBODY +></TABLE +><P +></P +> + </P +></LI +><LI +><P +> <EM +>Status and Resolution:</EM +> + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items.</P +></LI +><LI +><P +> <EM +>Assigned To:</EM +> + The person responsible for fixing the bug.</P +></LI +><LI +><P +> <EM +>*URL:</EM +> + A URL associated with the bug, if any.</P +></LI +><LI +><P +> <EM +>Summary:</EM +> + A one-sentence summary of the problem.</P +></LI +><LI +><P +> <EM +>*Status Whiteboard:</EM +> + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.</P +></LI +><LI +><P +> <EM +>*Keywords:</EM +> + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.</P +></LI +><LI +><P +> <EM +>Platform and OS:</EM +> + These indicate the computing environment where the bug was + found.</P +></LI +><LI +><P +> <EM +>Version:</EM +> + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about.</P +></LI +><LI +><P +> <EM +>Priority:</EM +> + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs.</P +></LI +><LI +><P +> <EM +>Severity:</EM +> + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request.</P +></LI +><LI +><P +> <EM +>*Target:</EM +> + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates.</P +></LI +><LI +><P +> <EM +>Reporter:</EM +> + The person who filed the bug.</P +></LI +><LI +><P +> <EM +>CC list:</EM +> + A list of people who get mail when the bug changes.</P +></LI +><LI +><P +> <EM +>Attachments:</EM +> + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.</P +></LI +><LI +><P +> <EM +>*Dependencies:</EM +> + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here.</P +></LI +><LI +><P +> <EM +>*Votes:</EM +> + Whether this bug has any votes.</P +></LI +><LI +><P +> <EM +>Additional Comments:</EM +> + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.</P +></LI +></OL +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="query" +></A +>5.4. Searching for Bugs</H1 +><P +>The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/query.cgi" +TARGET="_top" +>http://landfill.bugzilla.org/bugzilla-tip/query.cgi</A +>.</P +><P +>The Search page has controls for selecting different possible + values for all of the fields in a bug, as described above. For some + fields, multiple values can be selected. In those cases, Bugzilla + returns bugs where the content of the field matches any one of the selected + values. If none is selected, then the field can take any value.</P +><P +>Once you've run a search, you can save it as a Saved Search, which + appears in the page footer.</P +><P +>Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information.</P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="list" +></A +>5.5. Bug Lists</H1 +><P +>If you run a search, a list of matching bugs will be returned. + </P +><P +>The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features can be + accessed using the links at the bottom of the list: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +> <EM +>Long Format:</EM +> + + this gives you a large page with a non-editable summary of the fields + of each bug.</TD +></TR +><TR +><TD +> <EM +>CSV:</EM +> + + get the buglist as comma-separated values, for import into e.g. + a spreadsheet.</TD +></TR +><TR +><TD +> <EM +>Change Columns:</EM +> + + change the bug attributes which appear in the list.</TD +></TR +><TR +><TD +> <EM +>Change several bugs at once:</EM +> + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner.</TD +></TR +><TR +><TD +> <EM +>Send mail to bug owners:</EM +> + + Sends mail to the owners of all bugs on the list.</TD +></TR +><TR +><TD +> <EM +>Edit Search:</EM +> + + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results.</TD +></TR +><TR +><TD +> <EM +>Remember Search As:</EM +> + + You can give a search a name and remember it; a link will appear + in your page footer giving you quick access to run it again later. + </TD +></TR +></TBODY +></TABLE +><P +></P +> + </P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="bugreports" +></A +>5.6. Filing Bugs</H1 +><P +>Years of bug writing experience has been distilled for your + reading pleasure into the + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html" +TARGET="_top" +> Bug Writing Guidelines</A +>. + While some of the advice is Mozilla-specific, the basic principles of + reporting Reproducible, Specific bugs, isolating the Product you are + using, the Version of the Product, the Component which failed, the + Hardware Platform, and Operating System you were using at the time of + the failure go a long way toward ensuring accurate, responsible fixes + for the bug that bit you.</P +><P +>The procedure for filing a test bug is as follows:</P +><P +></P +><OL +TYPE="1" +><LI +><P +>Go to + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/" +TARGET="_top" +> Landfill</A +> + in your browser and click + <A +HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi" +TARGET="_top" +> Enter a new bug report</A +>. + </P +></LI +><LI +><P +>Select a product - any one will do.</P +></LI +><LI +><P +>Fill in the fields. Bugzilla should have made reasonable + guesses, based upon your browser, for the "Platform" and "OS" + drop-down boxes. If they are wrong, change them.</P +></LI +><LI +><P +>Select "Commit" and send in your bug report.</P +></LI +></OL +><P +>Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + </P +><P +> You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + </P +><P +>If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + </P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="patchviewer" +></A +>5.7. Patch Viewer</H1 +><P +>Viewing and reviewing patches in Bugzilla is often difficult due to + lack of context, improper format and the inherent readability issues that + raw patches present. Patch Viewer is an enhancement to Bugzilla designed + to fix that by offering increased context, linking to sections, and + integrating with Bonsai, LXR and CVS.</P +><P +>Patch viewer allows you to:</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>View patches in color, with side-by-side view rather than trying + to interpret the contents of the patch.</TD +></TR +><TR +><TD +>See the difference between two patches.</TD +></TR +><TR +><TD +>Get more context in a patch.</TD +></TR +><TR +><TD +>Collapse and expand sections of a patch for easy + reading.</TD +></TR +><TR +><TD +>Link to a particular section of a patch for discussion or + review</TD +></TR +><TR +><TD +>Go to Bonsai or LXR to see more context, blame, and + cross-references for the part of the patch you are looking at</TD +></TR +><TR +><TD +>Create a rawtext unified format diff out of any patch, no + matter what format it came from</TD +></TR +></TBODY +></TABLE +><P +></P +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_view" +></A +>5.7.1. Viewing Patches in Patch Viewer</H2 +><P +>The main way to view a patch in patch viewer is to click on the + "Diff" link next to a patch in the Attachments list on a bug. You may + also do this within the edit window by clicking the "View Attachment As + Diff" button in the Edit Attachment screen.</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_diff" +></A +>5.7.2. Seeing the Difference Between Two Patches</H2 +><P +>To see the difference between two patches, you must first view the + newer patch in Patch Viewer. Then select the older patch from the + dropdown at the top of the page ("Differences between [dropdown] and + this patch") and click the "Diff" button. This will show you what + is new or changed in the newer patch.</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_context" +></A +>5.7.3. Getting More Context in a Patch</H2 +><P +>To get more context in a patch, you put a number in the textbox at + the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. + This will give you that many lines of context before and after each + change. Alternatively, you can click on the "File" link there and it + will show each change in the full context of the file. This feature only + works against files that were diffed using "cvs diff".</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_collapse" +></A +>5.7.4. Collapsing and Expanding Sections of a Patch</H2 +><P +>To view only a certain set of files in a patch (for example, if a + patch is absolutely huge and you want to only review part of it at a + time), you can click the "(+)" and "(-)" links next to each file (to + expand it or collapse it). If you want to collapse all files or expand + all files, you can click the "Collapse All" and "Expand All" links at the + top of the page.</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_link" +></A +>5.7.5. Linking to a Section of a Patch</H2 +><P +>To link to a section of a patch (for example, if you want to be + able to give someone a URL to show them which part you are talking + about) you simply click the "Link Here" link on the section header. The + resulting URL can be copied and used in discussion. (Copy Link + Location in Mozilla works as well.)</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_bonsai_lxr" +></A +>5.7.6. Going to Bonsai and LXR</H2 +><P +>To go to Bonsai to get blame for the lines you are interested in, + you can click the "Lines XX-YY" link on the section header you are + interested in. This works even if the patch is against an old + version of the file, since Bonsai stores all versions of the file.</P +><P +>To go to LXR, you click on the filename on the file header + (unfortunately, since LXR only does the most recent version, line + numbers are likely to rot).</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="patchviewer_unified_diff" +></A +>5.7.7. Creating a Unified Diff</H2 +><P +>If the patch is not in a format that you like, you can turn it + into a unified diff format by clicking the "Raw Unified" link at the top + of the page.</P +></DIV +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="hintsandtips" +></A +>5.8. Hints and Tips</H1 +><P +>This section distills some Bugzilla tips and best practices + that have been developed.</P +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="AEN1641" +></A +>5.8.1. Autolinkification</H2 +><P +>Bugzilla comments are plain text - so typing <U> will + produce less-than, U, greater-than rather than underlined text. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + "http://www.bugzilla.org" will be turned into a link: + <A +HREF="http://www.bugzilla.org" +TARGET="_top" +>http://www.bugzilla.org</A +>. + Other strings which get linkified in the obvious manner are: + <P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>bug 12345</TD +></TR +><TR +><TD +>comment 7</TD +></TR +><TR +><TD +>bug 23456, comment 53</TD +></TR +><TR +><TD +>attachment 4321</TD +></TR +><TR +><TD +>mailto:george@example.com</TD +></TR +><TR +><TD +>george@example.com</TD +></TR +><TR +><TD +>ftp://ftp.mozilla.org</TD +></TR +><TR +><TD +>Most other sorts of URL</TD +></TR +></TBODY +></TABLE +><P +></P +> + </P +><P +>A corollary here is that if you type a bug number in a comment, + you should put the word "bug" before it, so it gets autolinkified + for the convenience of others. + </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="quicksearch" +></A +>5.8.2. Quicksearch</H2 +><P +>Quicksearch is a single-text-box query tool which uses + metacharacters to indicate what is to be searched. For example, typing + "<TT +CLASS="filename" +>foo|bar</TT +>" + into Quicksearch would search for "foo" or "bar" in the + summary and status whiteboard of a bug; adding + "<TT +CLASS="filename" +>:BazProduct</TT +>" would + search only in that product. + </P +><P +>You'll find the Quicksearch box on Bugzilla's + front page, along with a + <A +HREF="../../quicksearch.html" +TARGET="_top" +>Help</A +> + link which details how to use it.</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="commenting" +></A +>5.8.3. Comments</H2 +><P +>If you are changing the fields on a bug, only comment if + either you have something pertinent to say, or Bugzilla requires it. + Otherwise, you may spam people unnecessarily with bug mail. + To take an example: a user can set up their account to filter out messages + where someone just adds themselves to the CC field of a bug + (which happens a lot.) If you come along, add yourself to the CC field, + and add a comment saying "Adding self to CC", then that person + gets a pointless piece of mail they would otherwise have avoided. + </P +><P +> Don't use sigs in comments. Signing your name ("Bill") is acceptable, + if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. + </P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="attachments" +></A +>5.8.4. Attachments</H2 +><P +> Use attachments, rather than comments, for large chunks of ASCII data, + such as trace, debugging output files, or log files. That way, it doesn't + bloat the bug for everyone who wants to read it, and cause people to + receive fat, useless mails. + </P +><P +>Trim screenshots. There's no need to show the whole screen if + you are pointing out a single-pixel problem. + </P +><P +>Don't attach simple test cases (e.g. one HTML file, one + CSS file and an image) as a ZIP file. Instead, upload them in + reverse order and edit the referring file so that they point to the + attached files. This way, the test case works immediately + out of the bug. + </P +></DIV +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="userpreferences" +></A +>5.9. User Preferences</H1 +><P +>Once you have logged in, you can customise various aspects of + Bugzilla via the "Edit prefs" link in the page footer. + The preferences are split into three tabs:</P +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="accountsettings" +></A +>5.9.1. Account Settings</H2 +><P +>On this tab, you can change your basic account information, + including your password, email address and real name. For security + reasons, in order to change anything on this page you must type your + <EM +>current</EM +> + password into the + <SPAN +CLASS="QUOTE" +>"Password"</SPAN +> + field at the top of the page. + If you attempt to change your email address, a confirmation + email is sent to both the old and new addresses, with a link to use to + confirm the change. This helps to prevent account hijacking.</P +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="emailsettings" +></A +>5.9.2. Email Settings</H2 +><P +>On this tab you can reduce or increase the amount of email sent + you from Bugzilla, opting in our out depending on your relationship to + the bug and the change that was made to it. + </P +><P +> You can also do further filtering on the client side by + using the X-Bugzilla-Reason mail header which Bugzilla + adds to all bugmail. This tells you what relationship you have to the + bug in question, + and can be any of Owner, Reporter, QAcontact, CClist, Voter and + WatchingComponent.</P +><P +>By entering user email names, delineated by commas, into the + "Users to watch" text entry box you can receive a copy of all the + bugmail of other users (security settings permitting.) This powerful + functionality enables seamless transitions as developers change + projects or users go on holiday.</P +><DIV +CLASS="note" +><P +></P +><TABLE +CLASS="note" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +>The ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator.</P +></TD +></TR +></TABLE +></DIV +></DIV +><DIV +CLASS="section" +><HR><H2 +CLASS="section" +><A +NAME="permissionsettings" +></A +>5.9.3. Permissions</H2 +><P +>This is a purely informative page which outlines your current + permissions on this installation of Bugzilla - what product groups you + are in, and whether you can edit bugs or perform various administration + functions.</P +></DIV +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="reporting" +></A +>5.10. Reports</H1 +><P +><EM +>To be written</EM +></P +></DIV +></DIV +><DIV CLASS="appendix" ><HR><H1 ><A @@ -9575,6 +8968,15 @@ HREF="#faq-general-cookie" > Is there an easy way to change the Bugzilla cookie name? </A ></DT +><DT +>A.1.11. <A +HREF="#faq-mod-perl" +> Does bugzilla run under <TT +CLASS="filename" +>mod_perl</TT +>? + </A +></DT ></DL ></DD ><DT @@ -10305,6 +9707,33 @@ CLASS="answer" </P ></DIV ></DIV +><DIV +CLASS="qandaentry" +><DIV +CLASS="question" +><P +><A +NAME="faq-mod-perl" +></A +><B +>A.1.11. </B +> + Does bugzilla run under <TT +CLASS="filename" +>mod_perl</TT +>? + </P +></DIV +><DIV +CLASS="answer" +><P +><B +> </B +> + At present, no. This is being worked on. + </P +></DIV +></DIV ></DIV ><DIV CLASS="qandadiv" @@ -11392,7 +10821,7 @@ CLASS="answer" ><P > Microsoft has some advice on this matter, as well: <A -NAME="AEN2053" +NAME="AEN1977" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -12007,13 +11436,407 @@ CLASS="command" CLASS="appendix" ><HR><H1 ><A +NAME="install-perlmodules-manual" +></A +>Appendix C. Manual Installation of Perl Modules</H1 +><DIV +CLASS="section" +><H1 +CLASS="section" +><A +NAME="modules-manual-instructions" +></A +>C.1. Instructions</H1 +><P +>If you need to install Perl modules manually, here's how it's done. + Download the module using the link given in the next section, and then + apply this magic incantation, as root: + </P +><P +> + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="screen" +><TT +CLASS="prompt" +>bash#</TT +> tar -xzvf <module>.tar.gz +<TT +CLASS="prompt" +>bash#</TT +> cd <module> +<TT +CLASS="prompt" +>bash#</TT +> perl Makefile.PL +<TT +CLASS="prompt" +>bash#</TT +> make +<TT +CLASS="prompt" +>bash#</TT +> make test +<TT +CLASS="prompt" +>bash#</TT +> make install</PRE +></FONT +></TD +></TR +></TABLE +> + </P +></DIV +><DIV +CLASS="section" +><HR><H1 +CLASS="section" +><A +NAME="modules-manual-download" +></A +>C.2. Download Locations</H1 +><P +>Note: some modules are in the core distribution of + ActiveState Perl for Windows. Others are not available. + No PPM links have been provided in either of these two cases. + </P +><P +>CGI: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/CGI.pm/" +TARGET="_top" +>http://search.cpan.org/dist/CGI.pm/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip</A +><br> + Documentation: <A +HREF="http://www.perldoc.com/perl5.8.0/lib/CGI.html" +TARGET="_top" +>http://www.perldoc.com/perl5.8.0/lib/CGI.html</A +><br> + </P +> + </P +><P +>TimeDate: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/TimeDate/" +TARGET="_top" +>http://search.cpan.org/dist/TimeDate/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip</A +><br> + Documentation: <A +HREF="http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm" +TARGET="_top" +>http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm</A +><br> + </P +> + </P +><P +>DBI: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/DBI/" +TARGET="_top" +>http://search.cpan.org/dist/DBI/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip</A +><br> + Documentation: <A +HREF="http://dbi.perl.org/docs/" +TARGET="_top" +>http://dbi.perl.org/docs/</A +><br> + </P +> + </P +><P +>DBD::mysql: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/DBD-mysql/" +TARGET="_top" +>http://search.cpan.org/dist/DBD-mysql/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip</A +><br> + Documentation: <A +HREF="http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm" +TARGET="_top" +>http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm</A +><br> + </P +> + </P +><P +>File::Spec: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/File-Spec/" +TARGET="_top" +>http://search.cpan.org/dist/File-Spec/</A +><br> + PPM Download Page: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip</A +><br> + Documentation: <A +HREF="http://www.perldoc.com/perl5.8.0/lib/File/Spec.html" +TARGET="_top" +>http://www.perldoc.com/perl5.8.0/lib/File/Spec.html</A +><br> + </P +> + </P +><P +>File::Temp: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/File-Temp/" +TARGET="_top" +>http://search.cpan.org/dist/File-Temp/</A +><br> + Documentation: <A +HREF="http://www.perldoc.com/perl5.8.0/lib/File/Temp.html" +TARGET="_top" +>http://www.perldoc.com/perl5.8.0/lib/File/Temp.html</A +><br> + </P +> + </P +><P +>Template Toolkit: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/Template-Toolkit/" +TARGET="_top" +>http://search.cpan.org/dist/Template-Toolkit/</A +><br> + PPM Download Link: <A +HREF="http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz" +TARGET="_top" +>http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz</A +><br> + Documentation: <A +HREF="http://www.template-toolkit.org/docs.html" +TARGET="_top" +>http://www.template-toolkit.org/docs.html</A +><br> + </P +> + </P +><P +>Text::Wrap: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/Text-Tabs+Wrap/" +TARGET="_top" +>http://search.cpan.org/dist/Text-Tabs+Wrap/</A +><br> + Documentation: <A +HREF="http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html" +TARGET="_top" +>http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html</A +><br> + </P +> + </P +><P +>GD: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/GD/" +TARGET="_top" +>http://search.cpan.org/dist/GD/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip</A +><br> + Documentation: <A +HREF="http://stein.cshl.org/WWW/software/GD/" +TARGET="_top" +>http://stein.cshl.org/WWW/software/GD/</A +><br> + </P +> + </P +><P +>Chart::Base: + + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/Chart/" +TARGET="_top" +>http://search.cpan.org/dist/Chart/</A +><br> + </P +> + </P +><P +>GD::Graph: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/GDGraph/" +TARGET="_top" +>http://search.cpan.org/dist/GDGraph/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip</A +><br> + Documentation: <A +HREF="http://search.cpan.org/dist/GDGraph/Graph.pm" +TARGET="_top" +>http://search.cpan.org/dist/GDGraph/Graph.pm</A +><br> + </P +> + </P +><P +>GD::Text::Align: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/GDTextUtil/" +TARGET="_top" +>http://search.cpan.org/dist/GDTextUtil/</A +><br> + PPM Download Page: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip</A +><br> + Documentation: <A +HREF="http://search.cpan.org/dist/GDTextUtil/Text/Align.pm" +TARGET="_top" +>http://search.cpan.org/dist/GDTextUtil/Text/Align.pm</A +><br> + </P +> + </P +><P +>MIME::Parser: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/MIME-tools/" +TARGET="_top" +>http://search.cpan.org/dist/MIME-tools/</A +><br> + PPM Download Link: <A +HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip" +TARGET="_top" +>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip</A +><br> + Documentation: <A +HREF="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm" +TARGET="_top" +>http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm</A +><br> + </P +> + </P +><P +>XML::Parser: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/dist/XML-Parser/" +TARGET="_top" +>http://search.cpan.org/dist/XML-Parser/</A +><br> + Documentation: <A +HREF="http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html" +TARGET="_top" +>http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html</A +><br> + </P +> + </P +><P +>PatchReader: + <P +CLASS="literallayout" +><br> + CPAN Download Page: <A +HREF="http://search.cpan.org/author/JKEISER/PatchReader/" +TARGET="_top" +>http://search.cpan.org/author/JKEISER/PatchReader/</A +><br> + Documentation: <A +HREF="http://www.johnkeiser.com/mozilla/Patch_Viewer.html" +TARGET="_top" +>http://www.johnkeiser.com/mozilla/Patch_Viewer.html</A +><br> + </P +> + </P +></DIV +></DIV +><DIV +CLASS="appendix" +><HR><H1 +><A NAME="gfdl" ></A ->Appendix C. GNU Free Documentation License</H1 +>Appendix D. GNU Free Documentation License</H1 ><P >Version 1.1, March 2000</P ><A -NAME="AEN2183" +NAME="AEN2192" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -12030,7 +11853,7 @@ CLASS="section" ><A NAME="gfdl-0" ></A ->0. PREAMBLE</H1 +>0. Preamble</H1 ><P >The purpose of this License is to make a manual, textbook, or other written document "free" in the sense of freedom: to assure everyone the @@ -12060,7 +11883,7 @@ CLASS="section" ><A NAME="gfdl-1" ></A ->1. APPLICABILITY AND DEFINITIONS</H1 +>1. Applicability and Definition</H1 ><P >This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under @@ -12125,7 +11948,7 @@ CLASS="section" ><A NAME="gfdl-2" ></A ->2. VERBATIM COPYING</H1 +>2. Verbatim Copying</H1 ><P >You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the @@ -12147,7 +11970,7 @@ CLASS="section" ><A NAME="gfdl-3" ></A ->3. COPYING IN QUANTITY</H1 +>3. Copying in Quantity</H1 ><P >If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must @@ -12191,7 +12014,7 @@ CLASS="section" ><A NAME="gfdl-4" ></A ->4. MODIFICATIONS</H1 +>4. Modifications</H1 ><P >You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release @@ -12329,7 +12152,7 @@ CLASS="section" ><A NAME="gfdl-5" ></A ->5. COMBINING DOCUMENTS</H1 +>5. Combining Documents</H1 ><P >You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified @@ -12360,7 +12183,7 @@ CLASS="section" ><A NAME="gfdl-6" ></A ->6. COLLECTIONS OF DOCUMENTS</H1 +>6. Collections of Documents</H1 ><P >You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies @@ -12381,7 +12204,7 @@ CLASS="section" ><A NAME="gfdl-7" ></A ->7. AGGREGATION WITH INDEPENDENT WORKS</H1 +>7. Aggregation with Independent Works</H1 ><P >A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a @@ -12405,7 +12228,7 @@ CLASS="section" ><A NAME="gfdl-8" ></A ->8. TRANSLATION</H1 +>8. Translation</H1 ><P >Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. @@ -12425,7 +12248,7 @@ CLASS="section" ><A NAME="gfdl-9" ></A ->9. TERMINATION</H1 +>9. Termination</H1 ><P >You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to @@ -12442,7 +12265,7 @@ CLASS="section" ><A NAME="gfdl-10" ></A ->10. FUTURE REVISIONS OF THIS LICENSE</H1 +>10. Future Revisions of this License</H1 ><P >The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions @@ -12476,7 +12299,7 @@ NAME="gfdl-howto" of the License in the document and put the following copyright and license notices just after the title page:</P ><A -NAME="AEN2273" +NAME="AEN2282" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -12513,7 +12336,7 @@ CLASS="glossdiv" ><H1 CLASS="glossdiv" ><A -NAME="AEN2278" +NAME="AEN2287" ></A >0-9, high ascii</H1 ><DL @@ -12683,7 +12506,7 @@ TARGET="_top" >For more information about how to configure Apache for Bugzilla, see <A HREF="#http-apache" ->Section 4.2.1</A +>Section 2.2.4.1</A >. </P ></DD @@ -13076,7 +12899,7 @@ TARGET="_top" >Much more detailed information about the suggestions in <A HREF="#security-mysql" ->Section 4.5.2</A +>Section 2.2.2.1</A >. </P ></DD @@ -13377,7 +13200,7 @@ NAME="gloss-zarro" Terry had the following to say: </P ><A -NAME="AEN2513" +NAME="AEN2522" ></A ><TABLE BORDER="0" |