From 96939c32e6ebba28a18f69c9421f5222890a8f3d Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" Date: Thu, 15 Jan 2004 22:34:35 +0000 Subject: [PATCH] Phase 1 of a big documentation update before 2.17.6. --- .../bugzilla/docs/html/Bugzilla-Guide.html | 7540 +++++++---------- webtools/bugzilla/docs/html/about.html | 15 +- .../bugzilla/docs/html/administration.html | 133 +- webtools/bugzilla/docs/html/bug_page.html | 404 + webtools/bugzilla/docs/html/bugreports.html | 197 + webtools/bugzilla/docs/html/cmdline.html | 48 +- webtools/bugzilla/docs/html/components.html | 192 + webtools/bugzilla/docs/html/conventions.html | 56 +- webtools/bugzilla/docs/html/copyright.html | 17 +- webtools/bugzilla/docs/html/credits.html | 113 +- .../docs/html/cust-change-permissions.html | 36 +- .../bugzilla/docs/html/cust-templates.html | 182 +- .../bugzilla/docs/html/customization.html | 225 + webtools/bugzilla/docs/html/database.html | 182 - webtools/bugzilla/docs/html/dbdoc.html | 37 +- webtools/bugzilla/docs/html/dbmodify.html | 29 +- webtools/bugzilla/docs/html/disclaimer.html | 40 +- webtools/bugzilla/docs/html/extraconfig.html | 172 +- webtools/bugzilla/docs/html/faq.html | 544 +- webtools/bugzilla/docs/html/gfdl-0.html | 11 +- webtools/bugzilla/docs/html/gfdl-1.html | 11 +- webtools/bugzilla/docs/html/gfdl-10.html | 11 +- webtools/bugzilla/docs/html/gfdl-2.html | 11 +- webtools/bugzilla/docs/html/gfdl-3.html | 11 +- webtools/bugzilla/docs/html/gfdl-4.html | 11 +- webtools/bugzilla/docs/html/gfdl-5.html | 11 +- webtools/bugzilla/docs/html/gfdl-6.html | 11 +- webtools/bugzilla/docs/html/gfdl-7.html | 11 +- webtools/bugzilla/docs/html/gfdl-8.html | 11 +- webtools/bugzilla/docs/html/gfdl-9.html | 11 +- webtools/bugzilla/docs/html/gfdl-howto.html | 13 +- webtools/bugzilla/docs/html/gfdl.html | 23 +- webtools/bugzilla/docs/html/glossary.html | 17 +- webtools/bugzilla/docs/html/groups.html | 28 +- webtools/bugzilla/docs/html/hintsandtips.html | 47 +- webtools/bugzilla/docs/html/how.html | 823 -- webtools/bugzilla/docs/html/http.html | 697 -- webtools/bugzilla/docs/html/index.html | 275 +- webtools/bugzilla/docs/html/installation.html | 163 +- webtools/bugzilla/docs/html/integration.html | 52 +- webtools/bugzilla/docs/html/introduction.html | 154 - webtools/bugzilla/docs/html/list.html | 209 + webtools/bugzilla/docs/html/milestones.html | 210 + webtools/bugzilla/docs/html/myaccount.html | 207 + webtools/bugzilla/docs/html/newversions.html | 31 +- webtools/bugzilla/docs/html/os-specific.html | 67 +- webtools/bugzilla/docs/html/parameters.html | 13 +- webtools/bugzilla/docs/html/patches.html | 75 +- webtools/bugzilla/docs/html/patchviewer.html | 303 + webtools/bugzilla/docs/html/products.html | 193 + webtools/bugzilla/docs/html/programadmin.html | 392 - webtools/bugzilla/docs/html/query.html | 167 + webtools/bugzilla/docs/html/reporting.html | 150 + webtools/bugzilla/docs/html/rewrite.html | 208 - webtools/bugzilla/docs/html/security.html | 785 -- webtools/bugzilla/docs/html/stepbystep.html | 784 +- .../bugzilla/docs/html/troubleshooting.html | 33 +- webtools/bugzilla/docs/html/upgrading.html | 33 +- webtools/bugzilla/docs/html/useradmin.html | 21 +- .../bugzilla/docs/html/userpreferences.html | 55 +- webtools/bugzilla/docs/html/using.html | 145 +- .../bugzilla/docs/html/variant-fenris.html | 150 - .../docs/html/variant-issuezilla.html | 153 - .../bugzilla/docs/html/variant-perforce.html | 159 - .../bugzilla/docs/html/variant-redhat.html | 168 - .../bugzilla/docs/html/variant-scarab.html | 155 - .../docs/html/variant-sourceforge.html | 156 - webtools/bugzilla/docs/html/variants.html | 185 - webtools/bugzilla/docs/html/versions.html | 173 + webtools/bugzilla/docs/html/voting.html | 21 +- .../what-is-bugzilla.html} | 0 webtools/bugzilla/docs/html/whatis.html | 214 - webtools/bugzilla/docs/html/why-bugzilla.html | 227 + webtools/bugzilla/docs/html/why-tracking.html | 164 + webtools/bugzilla/docs/html/why.html | 208 - webtools/bugzilla/docs/txt/Bugzilla-Guide.txt | 4122 ++++----- webtools/bugzilla/docs/xml/Bugzilla-Guide.xml | 65 +- webtools/bugzilla/docs/xml/about.xml | 147 +- webtools/bugzilla/docs/xml/administration.xml | 1007 +-- webtools/bugzilla/docs/xml/conventions.xml | 31 +- webtools/bugzilla/docs/xml/customization.xml | 787 ++ webtools/bugzilla/docs/xml/faq.xml | 199 +- webtools/bugzilla/docs/xml/installation.xml | 896 +- webtools/bugzilla/docs/xml/integration.xml | 7 +- webtools/bugzilla/docs/xml/introduction.xml | 86 +- webtools/bugzilla/docs/xml/patches.xml | 49 +- webtools/bugzilla/docs/xml/using.xml | 901 +- webtools/bugzilla/docs/xml/variants.xml | 0 88 files changed, 11473 insertions(+), 15613 deletions(-) create mode 100644 webtools/bugzilla/docs/html/bug_page.html create mode 100644 webtools/bugzilla/docs/html/bugreports.html create mode 100644 webtools/bugzilla/docs/html/components.html create mode 100644 webtools/bugzilla/docs/html/customization.html create mode 100644 webtools/bugzilla/docs/html/list.html create mode 100644 webtools/bugzilla/docs/html/milestones.html create mode 100644 webtools/bugzilla/docs/html/myaccount.html create mode 100644 webtools/bugzilla/docs/html/patchviewer.html create mode 100644 webtools/bugzilla/docs/html/products.html create mode 100644 webtools/bugzilla/docs/html/query.html create mode 100644 webtools/bugzilla/docs/html/reporting.html create mode 100644 webtools/bugzilla/docs/html/versions.html rename webtools/bugzilla/docs/{xml/database.xml => html/what-is-bugzilla.html} (100%) create mode 100644 webtools/bugzilla/docs/html/why-bugzilla.html create mode 100644 webtools/bugzilla/docs/html/why-tracking.html create mode 100644 webtools/bugzilla/docs/xml/customization.xml delete mode 100644 webtools/bugzilla/docs/xml/variants.xml diff --git a/webtools/bugzilla/docs/html/Bugzilla-Guide.html b/webtools/bugzilla/docs/html/Bugzilla-Guide.html index 3b3283361bf..b95ae37bd32 100644 --- a/webtools/bugzilla/docs/html/Bugzilla-Guide.html +++ b/webtools/bugzilla/docs/html/Bugzilla-Guide.html @@ -1,10 +1,12 @@ The Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 Development Release

Matthew P. Barnson

Jacob Steenhagen

The Bugzilla Guide - 2.17.5 + Development Release

The Bugzilla Team

2003-11-01

2004-01-15

This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. +> This is the documentation for Bugzilla, a + bug-tracking system from mozilla.org. Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. + that tracks millions of bugs and issues for hundreds of + organizations around the world.

- This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the Bugzilla Documentation component. -

This is a development version of this guide. Information in it - is subject to change before the 2.18 release of this guide - (which will correspond with the 2.18 release of Bugzilla). -

The most current version of this document can always be found on the Bugzilla Documentation PageBugzilla + Documentation Page.

2.1. What is Bugzilla?
2.2. Why Should We Use Bugzilla?Why use a bug-tracking system?
2.3. Why use Bugzilla?
3.1. How do I use Bugzilla?Create a Bugzilla Account
3.2. Anatomy of a Bug
3.3. Searching for Bugs
3.4. Bug Lists
3.5. Filing Bugs
3.6. Patch Viewer
3.7. Hints and Tips
3.3. 3.8. User Preferences
3.9. Reports
4.2. Optional Additional Configuration
4.3. OS Specific Installation Notes
4.4. HTTP Server Configuration
4.3. Optional Additional Configuration
4.4. OS Specific Installation Notes
4.5. Bugzilla Security
4.6. Troubleshooting
5.3. Product, Component, Milestone, and Version AdministrationProducts
5.4. Components
5.5. Versions
5.6. Milestones
5.7. Voting
5.5. 5.8. Groups and Group Security
5.6. Bugzilla Security
5.7. Template Customization
5.8. Change Permission Customization
5.9. Upgrading to New Releases
5.10. 6. Customising Bugzilla
6.1. Template Customization
6.2. Customizing Who Can Change What
6.3. Modifying Your Running System
6.4. MySQL Bugzilla Database Introduction
6.5. Integrating Bugzilla with Third-Party Tools
B. The Bugzilla DatabaseContrib
B.1. Modifying Your Running System
B.2. MySQL Bugzilla Database IntroductionCommand-line Search Interface
C. Useful Patches and Utilities for Bugzilla
C.1. Apache - mod_rewrite - - magic
C.2. Command-line Bugzilla Queries
D. Bugzilla Variants and Competitors
D.1. Red Hat Bugzilla
D.2. Loki Bugzilla (Fenris)
D.3. Issuezilla
D.4. Scarab
D.5. Perforce SCM
D.6. SourceForge
E. GNU Free Documentation License
Installing perl modules with CPAN
4-2. .htaccess files for Apache
5-1. Upgrading using CVS1.1. Copyright InformationAppendix EAppendix C.

--Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla TeamCopyright (c) 2000-2004 The Bugzilla TeamFile and directory namesApplications namesEnvironment variablesCode example

If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact The Bugzilla Team. + please contact the Bugzilla Team.

1.2. Disclaimer

No liability for the contents of this document can be accepted. - Use the concepts, examples, and other content at your own risk. + Follow the instructions herein at your own risk. This document may contain errors and inaccuracies that may damage your system, cause your partner to leave you, your boss to fire you, your cats to @@ -595,35 +564,20 @@ NAME="disclaimer" war. Proceed with caution.

All copyrights are held by their respective owners, unless - specifically noted otherwise. Use of a term in this document - should not be regarded as affecting the validity of any - trademark or service mark. -

Naming of particular products or brands should not be seen as endorsements, with the exception of the term "GNU/Linux". We - wholeheartedly endorse the use of GNU/Linux in every situation - where it is appropriate. It is an extremely versatile, stable, + wholeheartedly endorse the use of GNU/Linux; it is an extremely + versatile, stable, and robust operating system that offers an ideal operating environment for Bugzilla.

You are strongly recommended to make a backup of your system - before installing Bugzilla and at regular intervals thereafter. - If you implement any suggestion in this Guide, implement this one! -

Although the Bugzilla development team has taken great care to - ensure that all easily-exploitable bugs or options are - documented or fixed in the code, security holes surely exist. - Great care should be taken both in the installation and usage of - this software. Carefully consider the implications of installing - other network services with Bugzilla. The Bugzilla development - team members, Netscape Communications, America Online Inc., and - any affiliated developers or sponsors assume no liability for - your use of this product. You have the source code to this - product, and are responsible for auditing it yourself to ensure + ensure that all exploitable bugs or options have been + fixed, security holes surely exist. 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 + the source code, and are responsible for auditing it yourself to ensure your security needs are met.

This is the 2.17.5 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. - This version of the guide, like its associated Bugzilla version is a - development version. Information is subject to change between now and - when 2.18 is released. + This version of the guide, like its associated Bugzilla version, is a + development version. - If you are - reading this from any source other than those below, please - check one of these mirrors to make sure you are reading an - up-to-date version of the Guide.

The newest version of this guide can always be found at http://www.bugzilla.org; including - documentation for past releases and the current development version. -

The documentation for the most recent stable release of Bugzilla can also - be found at - The Linux Documentation Project. +>; however, you should read the version + which came with the Bugzilla release you are using.

The latest version of this document can always be checked out via CVS. @@ -703,116 +643,18 @@ NAME="credits" contribution to the Bugzilla community:

Matthew P. Barnson <mbarnson@sisna.com>

for the Herculaean task of pulling together the Bugzilla Guide - and shepherding it to 2.14. -

Terry Weissman <terry@mozilla.org>

for initially writing Bugzilla and creating the README upon - which the UNIX installation documentation is largely based. -

Tara Hernandez <tara@tequilarists.org>

for keeping Bugzilla development going strong after Terry left - mozilla.org and for running landfill. -

Dave Lawrence <dkl@redhat.com>

for providing insight into the key differences between Red - Hat's customized Bugzilla, and being largely responsible for - Section D.1. -

Dawn Endico <endico@mozilla.org>

for being a hacker extraordinaire and putting up with Matthew's - incessant questions and arguments on irc.mozilla.org in #mozwebtools -

Jacob Steenhagen <jake@bugzilla.org>

for taking over documentation during the 2.17 development - period. -

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. +

Last but not least, all the members of the news://news.mozilla.org/netscape/public/mozilla/webtools netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.

Thanks also go to the following people for significant contributions - to this documentation (in alphabetical order): - Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption - . -

File NamesDirectory Names directory -
Commands to be typedApplications NamesEnvironment VariablesEmphasized word word -
Term found in the glossaryCode Example

+ This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or XML diffs, attached + to a bug filed in the Bugzilla Documentation component. +

2.1. What is Bugzilla?

Bugzilla is a bug- or issue-tracking system. Bug-tracking systems allow individual or groups of developers effectively to keep track - of outstanding problems with their product. - Bugzilla was originally - written by Terry Weissman in a programming language called TCL, to - replace a rudimentary bug-tracking database used internally by Netscape - Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl - it remains to this day. Most commercial defect-tracking software vendors - at the time charged enormous licensing fees, and Bugzilla quickly became - a favorite of the open-source crowd (with its genesis in the open-source - browser project, Mozilla). It is now the de-facto standard - defect-tracking system against which all others are measured. + of outstanding problems with their products.

Do we need more here?

2.2. Why use a bug-tracking system?

For many years, defect-tracking software was principally + the domain of large software development houses. Most smaller shops + simply relied on + shared lists and email to monitor the status of defects. This procedure + was error-prone and tended to cause those bugs judged least significant by + developers to be dropped or ignored.

Integrated + defect-tracking systems reduce downtime, increase productivity, and raise + customer satisfaction with their systems. Along with full disclosure, an + open bug-tracker allows you to keep in touch with your clients + and resellers, to communicate about problems effectively throughout the + data management chain. Many corporations have also discovered that + defect-tracking helps reduce costs by providing IT support + accountability, telephone support knowledge bases, and a common, + well-understood method for accounting for unusual system or software + issues.

2.3. Why use Bugzilla?

Bugzilla boasts many advanced features. These include:

2.2. Why Should We Use Bugzilla?

For many years, defect-tracking software has remained principally - the domain of large software development houses. Even then, most shops - never bothered with bug-tracking software, and instead simply relied on - shared lists and email to monitor the status of defects. This procedure - is error-prone and tends to cause those bugs judged least significant by - developers to be dropped or ignored.

These days, many companies are finding that integrated - defect-tracking systems reduce downtime, increase productivity, and raise - customer satisfaction with their systems. Along with full disclosure, an - open bug-tracker allows manufacturers to keep in touch with their clients - and resellers, to communicate about problems effectively throughout the - data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood system for accounting for unusual system or software - issues.

But why should - you - - use Bugzilla?

Bugzilla is very adaptable to various situations. Known uses currently include IT support queues, Systems Administration deployment @@ -1325,22 +1147,6 @@ TARGET="_top" >, Bugzilla provides a powerful, easy-to-use solution to configuration management and replication problems.

Bugzilla can dramatically increase the productivity and - accountability of individual employees by providing a documented workflow - and positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do - something - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and follow the discussion trail - that led to critical decisions.

Ultimately, Bugzilla puts the power in your hands to improve your - value to your employer or business while providing a usable framework for - your natural attention to detail and knowledge store to flourish.

Chapter 3. Using Bugzilla

3.1. How do I use Bugzilla?

This section contains information for end-users of Bugzilla. - There is a Bugzilla test installation, called - Landfill, - which you are welcome to play with (if it's up.) - However, it does not necessarily - have all Bugzilla features enabled, and often runs cutting-edge versions - of Bugzilla for testing, so some things may work slightly differently - than mentioned here.

3.1.1. Create a Bugzilla Account

3.1. Create a Bugzilla Account

If you want to use Bugzilla, first you need to create an account. - Consult with the administrator responsible for your installation of - Bugzilla for the URL you should use to access it. If you're - test-driving Bugzilla, use this URL: - http://landfill.bugzilla.org/bugzilla-tip/. -

  1. Click the - "Open a new Bugzilla account" - link, enter your email address and, optionally, your name in the - spaces provided, then click - "Create Account" - .

  2. Within moments, you should receive an email to the address - you provided above, which contains your login name (generally the - same as the email address), and a password you can use to access - your account. This password is randomly generated, and can be - changed to something more memorable.

  3. Click the - "Log In" - link in the yellow area at the bottom of the page in your browser, - enter your email address and password into the spaces provided, and - click - "Login". -

You are now logged in. Bugzilla uses cookies for authentication - so, unless your IP address changes, you should not have to log in - again.

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.

3.1.2. Anatomy of a Bug

3.2. Anatomy of a Bug

The core of Bugzilla is the screen which displays a particular - bug. It's a good place to explain some Bugzilla concepts. - Bug 1 on Landfill Bug 1 on Landfill - is a good example. Note that the labels for most fields are hyperlinks; - clicking them will take you to context-sensitive help on that - particular field. Fields marked * may not be present on every - installation of Bugzilla.

  1. Product and Component: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: -

    Administration: - Administration of a Bugzilla installation.
    Bugzilla-General: - Anything that doesn't fit in the other components, or spans - multiple components.
    Creating/Changing Bugs: - Creating, changing, and viewing bugs.
    Documentation: - The Bugzilla documentation, including The Bugzilla Guide.
    Email: - Anything to do with email sent by Bugzilla.
    Installation: - The installation process of Bugzilla.
    Query/Buglist: - Anything to do with searching for bugs and viewing the - buglists.
    Reporting/Charting: - Getting reports from Bugzilla.
    User Accounts: - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc.
    User Interface: - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc.

    -

  2. Status and Resolution: - These define exactly what state the bug is in - from not even - being confirmed as a bug, through to being fixed and the fix - confirmed by Quality Assurance. The different possible values for - Status and Resolution on your installation should be documented in the - context-sensitive help for those items.

  3. Assigned To: - The person responsible for fixing the bug.

  4. *URL: - A URL associated with the bug, if any.

  5. Summary: - A one-sentence summary of the problem.

  6. *Status Whiteboard: - (a.k.a. Whiteboard) A free-form text area for adding short notes - and tags to a bug.

  7. *Keywords: - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression.

  8. Platform and OS: - These indicate the computing environment where the bug was - found.

  9. Version: - The "Version" field is usually used for versions of a product which - have been released, and is set to indicate which versions of a - Component have the particular problem the bug report is - about.

  10. Priority: - The bug assignee uses this field to prioritise his or her bugs. - It's a good idea not to change this on other people's bugs.

  11. Severity: - This indicates how severe the problem is - from blocker - ("application unusable") to trivial ("minor cosmetic issue"). You - can also use this field to indicate whether a bug is an enhancement - request.

  12. *Target: - (a.k.a. Target Milestone) A future version by which the bug is to - be fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not - restricted to numbers, thought - you can use any text strings, such - as dates.

  13. Reporter: - The person who filed the bug.

  14. CC list: - A list of people who get mail when the bug changes.

  15. Attachments: - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section.

  16. *Dependencies: - If this bug cannot be fixed unless other bugs are fixed (depends - on), or this bug stops other bugs being fixed (blocks), their - numbers are recorded here.

  17. *Votes: - Whether this bug has any votes.

  18. Additional Comments: - You can add your two cents to the bug discussion here, if you have - something worthwhile to say.

3.1.3. Searching for Bugs

3.3. Searching for Bugs

The Bugzilla Search page is is the interface where you can find - any bug report, comment, or patch currently in the Bugzilla system. You - can play with it here: - http://landfill.bugzilla.org/bugzilla-tip/query.cgi.

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 one of the selected - values. If none is selected, then the field can take any value.

Once you've defined a search, you can either run it, or save it - as a Remembered Query, which can optionally appear in the footer of - your pages.

Once you've run a search, you can save it as a Saved Search, which + appears in the page footer.

Highly advanced querying is done using Boolean Charts.

Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information.

3.1.4. Bug Lists

3.4. Bug Lists

If you run a search, a list of matching bugs will be returned. - The default search is to return all open bugs on the system - don't try - running this search on a Bugzilla installation with a lot of - bugs!

The format of the list is configurable. For example, it can be - sorted by clicking the column headings. Other useful features can be - accessed using the links at the bottom of the list: -

Long Format: - this gives you a large page with a non-editable summary of the fields - of each bug.
Change Columns: - change the bug attributes which appear in the list.
Change several bugs at once: - If your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner.
Send mail to bug owners: - Sends mail to the owners of all bugs on the list.
Edit this query: - If you didn't get exactly the results you were looking for, you can - return to the Query page through this link and make small revisions - to the query you just made so you get more accurate results.

-

3.1.5. Filing Bugs

3.5. Filing Bugs

Years of bug writing experience has been distilled for your - reading pleasure into the - Bug Writing Guidelines Bug Writing Guidelines. - While some of the advice is Mozilla-specific, the basic principles of - reporting Reproducible, Specific bugs, isolating the Product you are - using, the Version of the Product, the Component which failed, the - Hardware Platform, and Operating System you were using at the time of - the failure go a long way toward ensuring accurate, responsible fixes - for the bug that bit you.

The procedure for filing a test bug is as follows:

  • Go to - Landfill Landfill - in your browser and click - Enter a new bug report Enter a new bug report. -

  • 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.

    • 3.1.6. Patch Viewer

    3.6. Patch Viewer

    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.

    Patch viewer allows you to:

    View patches in color, with side-by-side view rather than trying - to interpret the contents of the patch.
    Collapse and expand sections of a patch for easy - reading.
    Link to a particular section of a patch for discussion or - review
    Go to Bonsai or LXR to see more context, blame, and - cross-references for the part of the patch you are looking at
    Create a rawtext unified format diff out of any patch, no - matter what format it came from

    3.1.6.1. Viewing Patches in Patch Viewer

    3.6.1. Viewing Patches in Patch Viewer

    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.

    3.1.6.2. Seeing the Difference Between Two Patches

    3.6.2. Seeing the Difference Between Two Patches

    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.

    3.1.6.3. Getting More Context in a Patch

    3.6.3. Getting More Context in a Patch

    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".

    3.1.6.4. Collapsing and Expanding Sections of a Patch

    3.6.4. Collapsing and Expanding Sections of a Patch

    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.

    3.1.6.5. Linking to a Section of a Patch

    3.6.5. Linking to a Section of a Patch

    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.)

    3.1.6.6. Going to Bonsai and LXR

    3.6.6. Going to Bonsai and LXR

    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.

    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).

    3.1.6.7. Creating a Unified Diff

    3.6.7. Creating a Unified Diff

    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.

    3.2. Hints and Tips3.7. Hints and Tips

    This section distills some Bugzilla tips and best practices that have been developed.

    3.2.1. Autolinkification

    3.7.1. Autolinkification

    Bugzilla comments are plain text - so posting HTML will result - in literal HTML tags rather than being interpreted by a browser. +>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 + "http://www.bugzilla.org" will be turned into a link: comment 7bug 23456, comment 533.2.2. Quicksearch3.7.2. Quicksearch

    Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing @@ -2155,7 +1953,7 @@ CLASS="section" >3.2.3. Comments3.7.3. Comments

    If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. @@ -2168,7 +1966,7 @@ NAME="commenting"

    Don't use sigs in comments. Signing your name ("Bill") is acceptable, - particularly if you do it out of habit, but full mail/news-style + if you do it out of habit, but full mail/news-style four line ASCII art creations are not.

    3.2.4. Attachments3.7.4. Attachments

    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 @@ -2203,9 +2001,9 @@ CLASS="section" >

    3.2.5. Filing Bugs

    3.7.5. Filing Bugs

    Try to make sure that everything said in the summary is also said in the first comment. Summaries are often updated and this will @@ -2231,11 +2029,11 @@ CLASS="section" >3.3. User Preferences3.8. User Preferences

    Once you have logged in, you can customise various aspects of Bugzilla via the "Edit prefs" link in the page footer. - The preferences are split into four tabs:

    3.3.1. Account Settings

    3.8.1. Account Settings

    On this tab, you can change your basic account information, including your password, email address and real name. For security @@ -2268,13 +2066,19 @@ CLASS="section" >3.3.2. Email Settings3.8.2. Email Settings

    On this tab you can reduce or increase the amount of email sent you from Bugzilla, opting in our out depending on your relationship to - the bug and the change that was made to it. (Note that you can also do - client-side filtering using the X-Bugzilla-Reason header which Bugzilla - adds to all bugmail.)

    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.

    By entering user email names, delineated by commas, into the "Users to watch" text entry box you can receive a copy of all the @@ -2315,23 +2119,9 @@ CLASS="section" >

    3.3.3. Page Footer

    On the Search page, you can store queries in Bugzilla, so if you - regularly run a particular query it is just a drop-down menu away. - Once you have a stored query, you can come - here to request that it also be displayed in your page footer.

    3.3.4. Permissions

    3.8.3. Permissions

    This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you @@ -2339,6 +2129,19 @@ NAME="permissionsettings" functions.

    3.9. Reports

    To be written

    Section 4.3Section 4.4, so be sure to check out that section before you start your installation.

    Section 4.3.1Section 4.4.1.

    You are strongly recommended to make a backup of your system + before installing Bugzilla and at regular intervals thereafter. +

    The listing below is a basic step-by-step list. More information can be found in the sections below. Minimum versions will be included in parenthesis where appropriate. @@ -2454,15 +2261,6 @@ TYPE="1" >

  • Install MySQL - (3.23.41) -

  • Install Perl @@ -2472,9 +2270,10 @@ HREF="#install-perl" >

  • Install Perl ModulesInstall MySQL + (3.23.41)

  • Install Perl Modules +

  • Setup the MySQL Database @@ -2508,9 +2315,31 @@ CLASS="section" >

    4.1.1. Perl

    Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from http://www.perl.com. + 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, + 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.

    • 4.1.1. MySQL

    4.1.2. MySQL

    Visit the MySQL homepage at option as mentioned in Section 5.6.2Section 4.5.2 for the added security.

    4.1.2.1. Configuring MySQL

    This first thing you'll want to do is make sure you've given the + "root" user a password as suggested in + Section 4.5.2. For clarity, these instructions will + assume that your MySQL user for Bugzilla will be "bugs_user", + the database will be called "bugs_db" and the password for + the "bugs_user" user is "bugs_password". You + should, of course, substitute the values you intend to use for your site. +

    Most people use "bugs" for both the user and + database name. +

    Next, we use an SQL GRANT command to create a + "bugs_user" + user, and grant sufficient permissions for checksetup.pl, which we'll + use later, to work its magic. This also restricts the + "bugs_user" + user to operations within a database called + "bugs_db", and only allows the account to connect from + "localhost". + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.

    
  mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
+         DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
+         IDENTIFIED BY 'bugs_password';
+  mysql> FLUSH PRIVILEGES;
+

    If you are using MySQL 4, the bugs user also needs to be granted + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions. +

    4.1.2. Perl

    4.1.3. HTTP Server

    Any machine that doesn't have Perl on it is a sad machine indeed. - Perl can be got in source form from You have freedom of choice here, pretty much any web server that + is capable of running CGI + scripts will work. Section 4.2 has more information about + configuring web servers to work with Bugzilla. +

    We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us by filing a bug in http://www.perl.comBugzilla Documentation. - 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, - 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.

    4.1.4. Bugzilla

    You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + "nobody"). + You may decide to put the files in the main web space for your + web server or perhaps in + /usr/local + with a symbolic link in the web space that points to the Bugzilla + directory.

    If you symlink the bugzilla directory into your Apache's HTML + hierarchy, you may receive + Forbidden + errors unless you add the + "FollowSymLinks" + directive to the <Directory> entry for the HTML root + in httpd.conf.

    Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install + checksetup.pl + script, which locks down your installation.

    The default Bugzilla distribution is not designed to be placed + in a cgi-bin directory (this + includes any directory which is configured using the + ScriptAlias directive of Apache). +

    4.1.3. Perl Modules4.1.5. Perl Modules

    Perl modules can be found using for CPAN and Section 4.3.1.2Section 4.4.1.2 for PPM.

    The process of untaring the module as defined in +>The process of untarring the module as defined in 4.1.3.1. Bundle::Bugzilla4.1.5.1. Bundle::Bugzilla

    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 @@ -3132,7 +3257,7 @@ CLASS="section" >4.1.3.2. AppConfig (1.52)4.1.5.2. AppConfig (1.52)

    Dependency for Template Toolkit. We probably don't need to specifically check for it anymore. @@ -3145,7 +3270,7 @@ CLASS="section" >4.1.3.3. CGI (2.88)4.1.5.3. CGI (2.88)

    The CGI module parses form elements and cookies and does many other usefule things. It come as a part of recent perl distributions, but @@ -3178,7 +3303,7 @@ CLASS="section" >4.1.3.4. Data::Dumper (any)4.1.5.4. Data::Dumper (any)

    The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later @@ -3212,7 +3337,7 @@ CLASS="section" >4.1.3.5. TimeDate modules (2.21)4.1.5.5. TimeDate modules (2.21)

    Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. @@ -3247,7 +3372,7 @@ CLASS="section" >4.1.3.6. DBI (1.32)4.1.5.6. DBI (1.32)

    The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done @@ -3281,7 +3406,7 @@ CLASS="section" >4.1.3.7. MySQL-related modules4.1.5.7. MySQL-related modules

    The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -3326,7 +3451,7 @@ CLASS="section" >4.1.3.8. File::Spec (0.82)4.1.5.8. File::Spec (0.82)

    File::Spec is a perl module that allows file operations, such as generating full path names, to work cross platform. @@ -3358,7 +3483,7 @@ CLASS="section" >4.1.3.9. File::Temp (any)4.1.5.9. File::Temp (any)

    File::Temp is used to generate a temporary filename that is guaranteed to be unique. It comes as a standard part of perl @@ -3390,7 +3515,7 @@ CLASS="section" >4.1.3.10. Template Toolkit (2.08)4.1.5.10. Template Toolkit (2.08)

    When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except @@ -3424,7 +3549,7 @@ CLASS="section" >4.1.3.11. Text::Wrap (2001.0131)4.1.5.11. Text::Wrap (2001.0131)

    Text::Wrap is designed to proved intelligent text wrapping.

    4.1.3.12. GD (1.20) [optional]4.1.5.12. GD (1.20) [optional]

    The GD library was written by Thomas Boutell a long while ago to programmatically generate images in C. Since then it's become the @@ -3560,7 +3685,7 @@ CLASS="section" >4.1.3.13. Chart::Base (0.99c) [optional]4.1.5.13. Chart::Base (0.99c) [optional]

    The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been @@ -3589,7 +3714,7 @@ CLASS="section" >4.1.3.14. XML::Parser (any) [Optional]4.1.5.14. XML::Parser (any) [Optional]

    XML::Parser is used by the 4.1.3.15. GD::Graph (any) [Optional]4.1.5.15. GD::Graph (any) [Optional]

    In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -3656,7 +3781,7 @@ CLASS="section" >4.1.3.16. GD::Text::Align (any) [Optional]4.1.5.16. GD::Text::Align (any) [Optional]

    GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -3688,7 +3813,7 @@ CLASS="section" >4.1.3.17. MIME::Parser (any) [Optional]4.1.5.17. MIME::Parser (any) [Optional]

    MIME::Parser is only needed if you want to use the e-mail interface located in the 4.1.3.18. PatchReader (0.9.1) [Optional]4.1.5.18. PatchReader (0.9.1) [Optional]

    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 @@ -3759,350 +3884,15 @@ CLASS="section" >

    4.1.4. HTTP Server

    You have freedom of choice here, pretty much any web server that - is capable of running CGI - scripts will work. Section 4.4 has more information about - configuring web servers to work with Bugzilla. -

    We strongly recommend Apache as the web server to use. The - Bugzilla Guide installation instructions, in general, assume you are - using Apache. If you have got Bugzilla working using another webserver, - please share your experiences with us by filing a bug in Bugzilla Documentation. -

    4.1.5. Bugzilla

    You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - "nobody"). - You may decide to put the files in the main web space for your - web server or perhaps in - /usr/local - with a symbolic link in the web space that points to the Bugzilla - directory.

    If you symlink the bugzilla directory into your Apache's HTML - hierarchy, you may receive - Forbidden - errors unless you add the - "FollowSymLinks" - directive to the <Directory> entry for the HTML root - in httpd.conf.

    Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install - checksetup.pl - script, which locks down your installation.

    The default Bugzilla distribution is not designed to be placed - in a cgi-bin directory (this - includes any directory which is configured using the - ScriptAlias directive of Apache). This will probably - change as part of - bug - 44659. -

    4.1.6. Setting Up the MySQL Database

    After you've gotten all the software installed and working you're - ready to start preparing the database for its life as the back end to - a high quality bug tracker.

    This first thing you'll want to do is make sure you've given the - "root" user a password as suggested in - Section 5.6.2. For clarity, these instructions will - assume that your MySQL user for Bugzilla will be "bugs_user", - the database will be called "bugs_db" and the password for - the "bugs_user" user is "bugs_password". You - should, of course, substitute the values you intend to use for your site. -

    Most people use "bugs" for both the user and - database name. -

    Next, we use an SQL GRANT command to create a - "bugs_user" - user, and grant sufficient permissions for checksetup.pl, which we'll - use later, to work its magic. This also restricts the - "bugs_user" - user to operations within a database called - "bugs_db", and only allows the account to connect from - "localhost". - Modify it to reflect your setup if you will be connecting from - another machine or as a different user.

    
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
-       DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
-       IDENTIFIED BY 'bugs_password';
-mysql> FLUSH PRIVILEGES;
-

    If you are using MySQL 4, the bugs user also needs to be granted - the LOCK TABLES and - CREATE TEMPORARY TABLES permissions. -

    4.1.7. 4.1.6. checksetup.pl

    Next, run the magic checksetup.pl script. (Many thanks to - Holger Schurig - for writing this script!) - This script is designed to make sure your perl modules are the correct +>Next, run the magic checksetup.pl script. + This is designed to make sure your perl modules are the correct version and your MySQL database and other configuration options are consistent with the Bugzilla CGI files. It will make sure Bugzilla files and directories have reasonable @@ -4238,9 +4028,9 @@ CLASS="section" >

    4.1.8. Configuring Bugzilla

    4.1.7. Configuring Bugzilla

    You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. @@ -4256,17 +4046,415 @@ CLASS="section" >

    4.2. HTTP Server Configuration

    The Bugzilla Team recommends Apache when using Bugzilla, however, any web server + that can be configured to run CGI scripts + should be able to handle Bugzilla. No matter what web server you choose, but + especially if you choose something other than Apache, you should be sure to read + Section 4.5.4. +

    The plan for this section is to eventually document the specifics of how to lock + down permissions on individual web servers. +

    4.2.1. Apache httpd

    You will have to make sure that Apache is properly + configured to run the Bugzilla CGI scripts. You also need to make sure + that the .htaccess files created by + ./checksetup.pl are allowed to override Apache's normal access + permissions or else important password information may be exposed to the + Internet. +

    You need to configure Apache to run .cgi files outside the + cgi-bin directory. + Open your + httpd.conf file and make sure the + following line exists and is uncommented:

    
AddHandler cgi-script .cgi
+

    To allow .htaccess files to override + permissions and .cgi files to run in the Bugzilla directory, make sure + the following two lines are in a Directory + directive that applies to the Bugzilla directory on your system + (either the Bugzilla directory or one of its parents). + 

    
Options +ExecCGI
+AllowOverride Limit
+

    You should modify the <DirectoryIndex> parameter for + the Apache virtual host running your Bugzilla installation to + allow index.cgi as the index page for a + directory, as well as the usual index.html, + index.htm, and so forth.

    For more information on Apache and its directives, see the + glossary entry on Apache. +

    4.2.2. Microsoft Internet Information Services

    If you need, or for some reason even want, to use Microsoft's + Internet Information Services or + Personal Web Server you should be able + to. You will need to configure them to know how to run CGI scripts, + however. This is described in Microsoft Knowledge Base article + Q245225 + for Internet Information Services and + Q231998 + for Personal Web Server. +

    Also, and this can't be stressed enough, make sure that files such as + localconfig and your data + directory are secured as described in Section 4.5.4. +

    4.2.3. AOL Server

    Ben FrantzDale reported success using AOL Server with Bugzilla. He + reported his experience and what appears below is based on that. +

    AOL Server will have to be configured to run + CGI scripts, please consult + the documentation that came with your server for more information on + how to do this. +

    Because AOL Server doesn't support .htaccess + files, you'll have to create a TCL + script. You should create an aolserver/modules/tcl/filter.tcl + file (the filename shouldn't matter) with the following contents (change + /bugzilla/ to the web-based path to + your Bugzilla installation): + 

    
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/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"
+}
+

    This probably doesn't account for all possible editor backup + files so you may wish to add some additional variations of + localconfig. For more information, see + bug 186383 or Bugtraq ID 6501. +

    If you are using webdot from research.att.com (the default + configuration for the webdotbase paramater), you + will need to allow access to data/webdot/*.dot + for the reasearch.att.com machine. +

    If you are using a local installation of GraphViz, you will need to allow + everybody to access *.png, + *.gif, *.jpg, and + *.map in the + data/webdot directory. +

    4.2. Optional Additional Configuration

    4.3. Optional Additional Configuration

    4.2.1. Dependency Charts

    4.3.1. Dependency Charts

    As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. @@ -4328,9 +4516,9 @@ CLASS="section" >

    4.2.2. Bug Graphs

    4.3.2. Bug Graphs

    As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs.

    4.2.3. The Whining Cron

    4.3.3. The Whining Cron

    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 @@ -4478,47 +4666,11 @@ CLASS="section" >4.2.4. LDAP Authentication

    4.3.4. LDAP Authentication

    LDAP authentication has been rewritten for the 2.18 release of - Bugzilla. It no longer requires the Mozilla::LDAP module and now uses - Net::LDAP instead. This rewrite was part of a larger landing that - allowed for additional authentication schemes to be easily added - (bug - 180642). -

    This patch originally landed in 21-Mar-2003 and was included - in the 2.17.4 development release. -

    LDAP authentication is a module for Bugzilla's plugin + authentication architecture. +

    The existing authentication scheme for Bugzilla uses email addresses as the primary user ID, and a @@ -4728,26 +4880,26 @@ CLASS="section" >4.2.5. Preventing untrusted Bugzilla content from executing malicious +>4.3.5. Preventing untrusted Bugzilla content from executing malicious Javascript code

    It is possible for a Bugzilla to execute malicious Javascript - code. Due to internationalization concerns, we are unable to - incorporate the code changes necessary to fulfill the CERT advisory - requirements mentioned in +>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. + Due to internationalization concerns, we are unable to + incorporate by default the code changes necessary to fulfill the CERT + advisory requirements mentioned in http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3. - Making the change below will fix the problem if your installation is for - an English speaking audience. + If your installation is for an English speaking audience only, making the + change below will prevent this problem.

    Telling Bugzilla to output a charset as part of the HTTP header is - much easier in version 2.18 and higher (including any cvs - pull after 4-May-2003 and development release after 2.17.5) than it was - in previous versions. Simply locate the following line in +>Simply locate the following line in Bugzilla/CGI.pm

    
    # Make sure that we don't send any charset headers
-    $self->charset('');
+>
    $self->charset('');
       
    
    # Send all data using the ISO-8859-1 charset
-    $self->charset('ISO-8859-1');
+>
    $self->charset('ISO-8859-1');

    Using <meta> tags to set the charset is not - recommended, as there's a bug in Netscape 4.x which causes pages - marked up in this way to load twice. See - bug 126266 - for more information including progress toward making - bugzilla charset aware by default. -

    4.2.6. directoryindex for the Bugzilla default page.

    You should modify the <DirectoryIndex> parameter for - the Apache virtual host running your Bugzilla installation to - allow index.cgi as the index page for a - directory, as well as the usual index.html, - index.htm, and so forth.

    4.2.7. Bugzilla and 4.3.6. Bugzilla and mod_perl4.2.8. 4.3.7. mod_throttle @@ -4929,7 +5016,7 @@ CLASS="section" >4.3. OS Specific Installation Notes4.4. OS Specific Installation Notes

    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 @@ -4952,9 +5039,9 @@ CLASS="section" >4.3.1. Microsoft Windows4.4.1. Microsoft Windows

    Making Bugzilla work on windows is still a very 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 @@ -4978,7 +5065,7 @@ CLASS="section" >4.3.1.1. Win32 Perl4.4.1.1. Win32 Perl

    Perl for Windows can be obtained from 4.3.1.2. Perl Modules on Win324.4.1.2. Perl Modules on Win32

    Bugzilla on Windows requires the same perl modules found in Section 4.1.3Section 4.1.5. The main difference is that windows uses 4.3.1.3. Code changes required to run on win324.4.1.3. Code changes required to run on win32

    Unfortunately, Bugzilla still doesn't run "out of the box" on - Windows. There is work in progress to make this easier, but until that - happens code will have to be modified. This section is an attempt to - list the required changes. It is an attempt to be all inclusive, but - there may be other changes required. If you find something is missing, - please file a bug in Bugzilla Documentation. +>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.

    4.3.1.3.1. Changes to 4.4.1.3.1. Changes to checksetup.pl4.3.1.3.2. Changes to 4.4.1.3.2. Changes to BugMail.pmbug 84876 lands), the - simplest way is to have Net::SMTP installed and change this (in - Bugzilla/BugMail.pm):

    4.3.1.4. Serving the web pages4.4.1.4. Serving the web pages

    As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay attention to the security notes in Section 5.6.4Section 4.5.4. More information on configuring specific web servers can be found in Section 4.4Section 4.2.

    4.3.2. 4.4.2. Mac OS X4.3.3. Linux-Mandrake 8.04.4.3. Linux-Mandrake 8.0

    Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the @@ -5652,459 +5729,9 @@ CLASS="section" >

    4.4. HTTP Server Configuration

    The Bugzilla Team recommends Apache when using Bugzilla, however, any web server - that can be configured to run CGI scripts - should be able to handle Bugzilla. No matter what web server you choose, but - especially if you choose something other than Apache, you should be sure to read - Section 5.6.4. -

    The plan for this section is to eventually document the specifics of how to lock - down permissions on individual web servers. -

    4.4.1. Apache httpd

    As mentioned above, the Bugzilla Team recommends Apache for use - with Bugzilla. You will have to make sure that Apache is properly - configured to run the Bugzilla CGI scripts. You also need to make sure - that the .htaccess files created by - ./checksetup.pl (shown in Example 4-2 - for the curious) are allowed to override Apache's normal access - permissions or else important password information may be exposed to the - Internet. -

    Many Apache installations are not configured to run scripts - anywhere but in the cgi-bin - directory; however, we recommend that Bugzilla not be installed in the - cgi-bin, otherwise the static - files such as images and JavaScript - will not work correctly. To allow scripts to run in the normal - web space, the following changes should be made to your - httpd.conf file. -

    To allow files with a .cgi extension to be run, make sure the - following line exists and is uncommented:

    
AddHandler cgi-script .cgi
-

    To allow .htaccess files to override - permissions and .cgi files to run in the Bugzilla directory, make sure - the following two lines are in a Directory - directive that applies to the Bugzilla directory on your system - (either the Bugzilla directory or one of its parents). - 

    
Options +ExecCGI
-AllowOverride Limit
-

    For more information on Apache and its directives, see the - glossary entry on Apache. -

    Example 4-2. .htaccess files for Apache

    $BUGZILLA_HOME/.htaccess - 
    
# don't allow people to retrieve non-cgi executable files or our private data
-<FilesMatch ^(.*\.pl|.*localconfig.*|runtests.sh)$>
-  deny from all
-</FilesMatch>
-<FilesMatch ^(localconfig.js|localconfig.rdf)$>
-  allow from all
-</FilesMatch>
-
    -

    $BUGZILLA_HOME/data/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory; the only exception is duplicates.rdf, which is used by
-# duplicates.xul and must be loadable over the web
-deny from all
-<Files duplicates.rdf>
-  allow from all
-</Files>
-
    -

    $BUGZILLA_HOME/data/webdot - 
    
# Restrict access to .dot files to the public webdot server at research.att.com 
-# if research.att.com ever changed their IP, or if you use a different
-# webdot server, you'll need to edit this
-<FilesMatch ^[0-9]+\.dot$>
-  Allow from 192.20.225.10
-  Deny from all
-</FilesMatch>
-
-# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
-# .map files
-<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
-  Allow from all
-</FilesMatch>
-
-# And no directory listings, either.
-Deny from all
-
    -

    $BUGZILLA_HOME/Bugzilla/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
    -

    $BUGZILLA_HOME/template/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
    -

    4.4.2. Microsoft Internet Information Services

    If you need, or for some reason even want, to use Microsoft's - Internet Information Services or - Personal Web Server you should be able - to. You will need to configure them to know how to run CGI scripts, - however. This is described in Microsoft Knowledge Base article - Q245225 - for Internet Information Services and - Q231998 - for Personal Web Server. -

    Also, and this can't be stressed enough, make sure that files such as - localconfig and your data - directory are secured as described in Section 5.6.4. -

    4.4.3. AOL Server

    Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. -

    AOL Server will have to be configured to run - CGI scripts, please consult - the documentation that came with your server for more information on - how to do this. -

    Because AOL Server doesn't support .htaccess - files, you'll have to create a TCL - script. You should create an aolserver/modules/tcl/filter.tcl - file (the filename shouldn't matter) with the following contents (change - /bugzilla/ to the web-based path to - your Bugzilla installation): - 

    
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
-ns_register_filter preauth GET /bugzilla/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"
-}
-
    4.5. Bugzilla Security

    This probably doesn't account for all possible editor backup - files so you may wish to add some additional variations of - localconfig. For more information, see - bug 186383 or Bugtraq ID 6501. -

    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.

    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. +

    4.5.1. TCP/IP Ports

    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. +

    4.5.2. MySQL

    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 not the same as + the system root). Also, many installations default to running + mysqld as the system root. +

    1. Consult the documentation that came with your system for + information on making mysqld run as an + unprivleged user. +

    2. 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: + 

      
bash$ mysql mysql
+mysql> DELETE FROM user WHERE user = '';
+mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
+mysql> FLUSH PRIVILEGES;
+

      From this point forward you will need to use + mysql -u root -p and enter + new_password when prompted when using the + mysql client. +

    3. 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 /etc/my.conf: + 

      
[myslqd]
+# Prevent network access to MySQL.
+skip-networking
+

    4. 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. +

    4.5.3. Daemon Accounts

    Many daemons, such as Apache's httpd and MySQL's mysqld default to + running as either "root" or "nobody". Running + as "root" introduces obvious security problems, but the + problems introduced by running everything as "nobody" may + not be so obvious. Basically, if you're running every daemon as + "nobody" 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. +

    If you are using webdot from research.att.com (the default - configuration for the webdotbase paramater), you - will need to allow access to You will need to set the webservergroup to + the group you created for your webserver to run as in + data/webdot/*.dot - for the reasearch.att.com machine. +>localconfig. This will allow + ./checksetup.pl to better adjust the file + permissions on your Bugzilla install so as to not require making + anything world-writable.

    4.5.4. Web Server Access Controls

    If you are using a local installation of GraphViz, you will need to allow - everybody to access 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. +

    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. +

    • In the main Bugzilla directory, you should:

      • Block: + *.pl, *localconfig*, runtests.sh +

      • But allow: + localconfig.js, localconfig.rdf +

    • In data:

      • Block everything

      • But allow: + duplicates.rdf +

    • In data/webdot:

      • If you use a remote webdot server:

        • Block everything

        • But allow + *.dot + only for the remote webdot server

      • Otherwise, if you use a local GraphViz:

        • Block everything

        • But allow: + *.png, - , *.gif, *.jpg, and - , *.map in the - +

      • And if you don't use any dot:

        • Block everything

    • In data/webdot directory. +>Bugzilla:

      • Block everything

    • In template:

      • Block everything

    You should test to make sure that the files mentioned above are + not accessible from the Internet, especially your + localconfig 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 + http://bugzilla.mozilla.org/localconfig. You should + get a 403 Forbidden + error. +

    Not following the instructions in this section, including + testing, may result in sensitive information being globally + accessible. +

    4.5. Troubleshooting4.6. Troubleshooting

    This section gives solutions to common Bugzilla installation problems. @@ -6227,9 +6290,9 @@ CLASS="section" >

    4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

    4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

    Try executing

    4.5.2. DBD::Sponge::db prepare failed

    4.6.2. DBD::Sponge::db prepare failed

    The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): @@ -6340,7 +6403,7 @@ CLASS="section" >4.5.3. cannot chdir(/var/spool/mqueue)4.6.3. cannot chdir(/var/spool/mqueue)

    If you are installing Bugzilla on SuSE Linux, or some other distributions with @@ -6398,7 +6461,7 @@ CLASS="section" >4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT

    This is caused by a bug in the version of

    The

    As a guide, mozilla.org began needing +> As a guide, on reasonably old hardware, mozilla.org began needing "shadowdb"

    Don't disable the administrator account!

    Don't disable all the administrator accounts!

    You should check Section 4.2 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.

    5.3. Product, Component, Milestone, and Version Administration

    5.3.1. Products

    5.3. Products

    Products Products - are the broadest category in Bugzilla, and tend to represent real-world - shipping products. E.g. if your company makes computer games, - you should have one product per game, perhaps a "Common" product for - units of technology used in multiple games, and maybe a few special - products (Website, Administration...)

    Many of Bugzilla's settings are configurable on a per-product - basis. The number of "votes" available to users is set per-product, - as is the number of votes - required to move a bug automatically from the UNCONFIRMED status to the - NEW status.

    To create a new product:

  • Enter the name of the product and a description. The - Description field may contain HTML.

    • Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get out - of the UNCOMFIRMED state", and "Version" options yet. We'll cover - those in a few moments. -

    5.3.2. Components

    5.4. Components

    Components are subsections of a Product. E.g. the computer game - you are designing may have a "UI" - component, an "API" component, a "Sound System" component, and a - "Plugins" component, each overseen by a different programmer. It - often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or - company.

    Each component has a owner and (if you turned it on in the parameters), - a QA Contact. The owner should be the primary person who fixes bugs in - that component. The QA Contact should be the person who will ensure - these bugs are completely fixed. The Owner, QA Contact, and Reporter - will get email when new bugs are created in this Component and when - these bugs change. Default Owner and Default QA Contact fields only - dictate the - Each component has a owner and (if you turned it on in the parameters), + a QA Contact. The owner should be the primary person who fixes bugs in + that component. The QA Contact should be the person who will ensure + these bugs are completely fixed. The Owner, QA Contact, and Reporter + will get email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields only + dictate the + default assignments; - these can be changed on bug submission, or at any later point in - a bug's life.

    To create a new Component:

  • Select the "Edit components" link from the "Edit product" - page

  • Fill out the "Component" field, a short "Description", - the "Initial Owner" and "Initial QA Contact" (if enabled.) - The Component and Description fields may contain HTML; - the "Initial Owner" field must be a login name - already existing in the database. -

    • 5.3.3. Versions

    5.5. Versions

    Versions are the revisions of the product, such as "Flinders - 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select - field; the usual practice is to select the most recent version with - the bug. -

    To create and edit Versions:

  • You will notice that the product already has the default - version "undefined". Click the "Add" link in the bottom right.

  • Enter the name of the Version. This field takes text only. - Then click the "Add" button.

    • 5.3.4. Milestones

    5.6. Milestones

    Milestones are "targets" that you plan to get a bug fixed by. For - example, you have a bug that you plan to fix for your 3.0 release, it - would be assigned the milestone of 3.0.

    Milestone options will only appear for a Product if you turned - on the "usetargetmilestone" Param in the "Edit Parameters" screen. -

    To create new Milestones, set Default Milestones, and set - Milestone URL:

    1. Select "Add" in the bottom right corner. - text

    2. Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "sortkey", which is a positive or negative - number (-255 to 255) that defines where in the list this particular - milestone appears. This is because milestones often do not - occur in alphanumeric order For example, "Future" might be - after "Release 1.2". Select "Add".

    3. From the Edit product screen, you can enter the URL of a - page which gives information about your milestones and what - they mean.

      If you want your milestone document to be restricted so - that it can only be viewed by people in a particular Bugzilla - group, the best way is to attach the document to a bug in that - group, and make the URL the URL of that attachment.

    5.4. Voting

    5.7. Voting

    Voting allows users to be given a pot of votes which they can allocate to bugs, to indicate that they'd like them fixed. @@ -7481,7 +7506,7 @@ CLASS="section" >5.5. Groups and Group Security5.8. Groups and Group Security

    Groups allow the administrator to isolate bugs or products that should only be seen by certain people. @@ -7620,9 +7645,10 @@ ALT="Warning">

    The User Regexp is a perl regexp and, if not anchored, will match - any part of an address. So, if you do not want to grant access - into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use +>If specifying a domain in the regexp, make sure you end + the regexp with a $. Otherwise, when granting access to + "@mycompany\.com", you will allow access to + 'badperson@mycompany.com.cracker.net'. You need to use '@mycompany\.com$' as the regexp.

    5.6. Bugzilla Security

    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.

    These instructions must, of necessity, be somewhat vague since - Bugzilla runs on so many different platforms. If you have refinements - of these directions, please submit a bug to Bugzilla Documentation. -

    This is not meant to be a comprehensive list of every possible - security issue regarding the tools mentioned in this section. There is - no subsitute for reading the information written by the authors of any - software running on your system. -

    5.6.1. TCP/IP Ports

    TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla - only needs 1... 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. -

    5.6.2. MySQL

    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 not the same as - the system root). Also, many installations default to running - mysqld as the system root. -

    1. Consult the documentation that came with your system for - information on making mysqld run as an - unprivleged user. -

    2. 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: - 

      
bash$ mysql mysql
-mysql> DELETE FROM user WHERE user = '';
-mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
-mysql> FLUSH PRIVILEGES;
-

      From this point forward you will need to use - mysql -u root -p and enter - new_password when prompted when using the - mysql client. -

    3. 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 /etc/my.conf: - 

      
[myslqd]
-# Prevent network access to MySQL.
-skip-networking
-

    4. 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. -

    5.6.3. Daemon Accounts

    Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either "root" or "nobody". Running - as "root" introduces obvious security problems, but the - problems introduced by running everything as "nobody" may - not be so obvious. Basically, if you're running every daemon as - "nobody" and one of them gets comprimised, they all get - comprimised. For this reason it is recommended that you create a user - account for each daemon. -

    You will need to set the webservergroup to - the group you created for your webserver to run as in - localconfig. This will allow - ./checksetup.pl to better adjust the file - permissions on your Bugzilla install so as to not require making - anything world-writable. -

    5.6.4. Web Server Access Controls

    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 layed out, the list of what should and should - not be accessible is rather complicated. A new installation method - is currently in the works which should solve this by allowing files - that shouldn't be accessible from the web to be placed in directory - outside the webroot. See - bug 44659 for more information. -

    • In the main Bugzilla directory, you should:

      • Block: - *.pl, *localconfig*, runtests.sh -

      • But allow: - localconfig.js, localconfig.rdf -

    • In data:

      • Block everything

      • But allow: - duplicates.rdf -

    • In data/webdot:

      • If you use a remote webdot server:

        • Block everything

        • But allow - *.dot - only for the remote webdot server

      • Otherwise, if you use a local GraphViz:

        • Block everything

        • But allow: - *.png, *.gif, *.jpg, *.map -

      • And if you don't use any dot:

        • Block everything

    • In Bugzilla:

      • Block everything

    • In template:

      • Block everything

    Bugzilla ships with the ability to generate - .htaccess files instructing - Apache which files - should and should not be accessible. For more information, see - Section 4.4.1. -

    You should test to make sure that the files mentioned above are - not accessible from the Internet, especially your - localconfig 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 - http://bugzilla.mozilla.org/localconfig. You should - get a 403 Forbidden - error. -

    Not following the instructions in this section, including - testing, may result in sensitive information being globally - accessible. -

    You should check Section 4.4 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. -

    5.7. Template Customization

    One of the large changes for 2.16 was the templatization of the - entire user-facing UI, using the - Template Toolkit. - Administrators can now configure the look and feel of Bugzilla without - having to edit Perl files or face the nightmare of massive merge - conflicts when they upgrade to a newer version in the future. -

    Templatization also makes localized versions of Bugzilla possible, - for the first time. As of version 2.17.4 which will soon - become 2.18, it's possible to have Bugzilla's language determined by - the user's browser. More information is available in - Section 5.7.5. -

    5.7.1. What to Edit

    There are two different ways of editing of Bugzilla's templates, - and which you use depends mainly on how you upgrade Bugzilla. The - template directory structure is that there's a top level directory, - template, which contains a directory for - each installed localization. The default English templates are - therefore in en. Underneath that, there - is the default directory and optionally the - custom directory. The default - directory contains all the templates shipped with Bugzilla, whereas - the custom directory does not exist at first and - must be created if you want to use it. -

    The first method of making customizations is to directly edit the - templates in template/en/default. This is - probably the best method for small changes if you are going to use - the CVS method of upgrading, because if you then execute a - cvs update, any template fixes will get - automagically merged into your modified versions. -

    If you use this method, your installation will break if CVS conflicts - occur. -

    The other method is to copy the templates into a mirrored directory - structure under template/en/custom. The templates - in this directory automatically override those in default. - This is the technique you - need to use if you use the overwriting method of upgrade, because - otherwise your changes will be lost. This method is also better if - you are using the CVS method of upgrading and are going to make major - changes, because it is guaranteed that the contents of this directory - will not be touched during an upgrade, and you can then decide whether - to continue using your own templates, or make the effort to merge your - changes into the new versions by hand. -

    If you use this method, your installation may break if incompatible - changes are made to the template interface. If such changes are made - they will be documented in the release notes, provided you are using a - stable release of Bugzilla. If you use using unstable code, you will - need to deal with this one yourself, although if possible the changes - will be mentioned before they occur in the deprecations section of the - previous stable release's release notes. -

    Don't directly edit the compiled templates in - data/template/* - your - changes will be lost when Template Toolkit recompiles them. -

    It is recommended that you run ./checksetup.pl - after any template edits, especially if you've created a new file in - the custom directory. -

    5.7.2. How To Edit Templates

    The syntax of the Template Toolkit language is beyond the scope of - this guide. It's reasonably easy to pick up by looking at the current - templates; or, you can read the manual, available on the - Template Toolkit home - page. However, you should particularly remember (for security - reasons) to always HTML filter things which come from the database or - user input, to prevent cross-site scripting attacks. -

    However, one thing you should take particular care about is the need - to properly HTML filter data that has been passed into the template. - This means that if the data can possibly contain special HTML characters - such as <, and the data was not intended to be HTML, they need to be - converted to entity form, ie &lt;. You use the 'html' filter in the - Template Toolkit to do this. If you fail to do this, you may open up - your installation to cross-site scripting attacks. -

    Also note that Bugzilla adds a few filters of its own, that are not - in standard Template Toolkit. In particular, the 'url_quote' filter - can convert characters that are illegal or have special meaning in URLs, - such as &, to the encoded form, ie %26. This actually encodes most - characters (but not the common ones such as letters and numbers and so - on), including the HTML-special characters, so there's never a need to - HTML filter afterwards. -

    Editing templates is a good way of doing a "poor man's custom fields". - For example, if you don't use the Status Whiteboard, but want to have - a free-form text entry box for "Build Identifier", then you can just - edit the templates to change the field labels. It's still be called - status_whiteboard internally, but your users don't need to know that. -

    If you are making template changes that you intend on submitting back - for inclusion in standard Bugzilla, you should read the relevant - sections of the - Developers' - Guide. -

    5.7.3. Template Formats

    Some CGIs have the ability to use more than one template. For - example, buglist.cgi can output bug lists as RDF or two - different forms of HTML (complex and simple). (Try this out - by appending &format=simple to a buglist.cgi - URL on your Bugzilla installation.) This - mechanism, called template 'formats', is extensible. -

    To see if a CGI supports multiple output formats, grep the - CGI for "ValidateOutputFormat". If it's not present, adding - multiple format support isn't too hard - see how it's done in - other CGIs. -

    To make a new format template for a CGI which supports this, - open a current template for - that CGI and take note of the INTERFACE comment (if present.) This - comment defines what variables are passed into this template. If - there isn't one, I'm afraid you'll have to read the template and - the code to find out what information you get. -

    Write your template in whatever markup or text style is appropriate. -

    You now need to decide what content type you want your template - served as. Open up the localconfig file and find the - $contenttypes - variable. If your content type is not there, add it. Remember - the three- or four-letter tag assigned to you content type. - This tag will be part of the template filename. -

    Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. - Try out the template by calling the CGI as - <cginame>.cgi?format=<formatname> . -

    5.7.4. Particular Templates

    There are a few templates you may be particularly interested in - customizing for your installation. -

    index.html.tmpl: - This is the Bugzilla front page. -

    global/header.html.tmpl: - This defines the header that goes on all Bugzilla pages. - The header includes the banner, which is what appears to users - and is probably what you want to edit instead. However the - header also includes the HTML HEAD section, so you could for - example add a stylesheet or META tag by editing the header. -

    global/banner.html.tmpl: - This contains the "banner", the part of the header that appears - at the top of all Bugzilla pages. The default banner is reasonably - barren, so you'll probably want to customize this to give your - installation a distinctive look and feel. It is recommended you - preserve the Bugzilla version number in some form so the version - you are running can be determined, and users know what docs to read. -

    global/footer.html.tmpl: - This defines the footer that goes on all Bugzilla pages. Editing - this is another way to quickly get a distinctive look and feel for - your Bugzilla installation. -

    bug/create/user-message.html.tmpl: - This is a message that appears near the top of the bug reporting page. - By modifying this, you can tell your users how they should report - bugs. -

    bug/process/midair.html.tmpl: - This is the page used if two people submit simultaneous changes to the - same bug. The second person to submit their changes will get this page - to tell them what the first person did, and ask if they wish to - overwrite those changes or go back and revisit the bug. The default - title and header on this page read "Mid-air collision detected!" If - you work in the aviation industry, or other environment where this - might be found offensive (yes, we have true stories of this happening) - you'll want to change this to something more appropriate for your - environment. -

    bug/create/create.html.tmpl and - bug/create/comment.txt.tmpl: - You may wish to get bug submitters to give certain bits of structured - information, each in a separate input widget, for which there is not a - field in the database. The bug entry system has been designed in an - extensible fashion to enable you to define arbitrary fields and widgets, - and have their values appear formatted in the initial - Description, rather than in database fields. An example of this - is the mozilla.org - guided - bug submission form. -

    To make this work, create a custom template for - enter_bug.cgi (the default template, on which you - could base it, is create.html.tmpl), - and either call it create.html.tmpl or use a format and - call it create-<formatname>.html.tmpl. - Put it in the custom/bug/create - directory. In it, add widgets for each piece of information you'd like - collected - such as a build number, or set of steps to reproduce. -

    Then, create a template like - custom/bug/create/comment.txt.tmpl, also named - after your format if you are using one, which - references the form fields you have created. When a bug report is - submitted, the initial comment attached to the bug report will be - formatted according to the layout of this template. -

    For example, if your enter_bug template had a field - 
    <input type="text" name="buildid" size="30">
    - and then your comment.txt.tmpl had - 
    BuildID: [% form.buildid %]
    - then - 
    BuildID: 20020303
    - would appear in the initial checkin comment. -

    5.7.5. Configuring Bugzilla to Detect the User's Language

    Begining in version 2.18 (first introduced in version - 2.17.4), it's now possible to have the users web browser tell Bugzilla - which language templates to use for each visitor (using the HTTP_ACCEPT - header). For this to work, Bugzilla needs to have the correct language - templates installed for the version of Bugzilla you are using. Many - language templates can be obtained from http://www.bugzilla.org/download.html#localizations. Instructions - for submitting new languages are also available from that location. -

    After untarring the localizations (or creating your own) in the - [Bugzilla_Root]/template directory, - you must update the languages parameter to contain any - localizations you'd like to permit. You may also wish to set the - defaultlanguage parameter to something other than - "en" if you don't want Engish to be the default language. -

    5.8. Change Permission Customization

    This feature should be considered experimental; the Bugzilla code you - will be changing is not stable, and could change or move between - versions. Be aware that if you make modifications to it, you may have - to re-make them or port them if Bugzilla changes internally between - versions. -

    Companies often have rules about which employees, or classes of employees, - are allowed to change certain things in the bug system. For example, - only the bug's designated QA Contact may be allowed to VERIFY the bug. - Bugzilla has been - designed to make it easy for you to write your own custom rules to define - who is allowed to make what sorts of value transition. -

    For maximum flexibility, customizing this means editing Bugzilla's Perl - code. This gives the administrator complete control over exactly who is - allowed to do what. The relevant function is called - CheckCanChangeField(), - and is found in process_bug.cgi in your - Bugzilla directory. If you open that file and grep for - "sub CheckCanChangeField", you'll find it. -

    This function has been carefully commented to allow you to see exactly - how it works, and give you an idea of how to make changes to it. Certain - marked sections should not be changed - these are the "plumbing" which - makes the rest of the function work. In between those sections, you'll - find snippets of code like: - 
        # Allow the owner to change anything.
-    if ($ownerid eq $whoid) {
-        return 1;
-    }
    - It's fairly obvious what this piece of code does. -

    So, how does one go about changing this function? Well, simple changes - can be made just be removing pieces - for example, if you wanted to - prevent any user adding a comment to a bug, just remove the lines marked - "Allow anyone to change comments." And if you want the reporter to have - no special rights on bugs they have filed, just remove the entire section - which refers to him. -

    More complex customizations are not much harder. Basically, you add - a check in the right place in the function, i.e. after all the variables - you are using have been set up. So, don't look at $ownerid before - $ownerid has been obtained from the database. You can either add a - positive check, which returns 1 (allow) if certain conditions are true, - or a negative check, which returns 0 (deny.) E.g.: - 
        if ($field eq "qacontact") {
-        if (Bugzilla->user->groups("quality_assurance")) {
-            return 1;
-        } 
-        else {
-            return 0;
-        }
-    }
    - This says that only users in the group "quality_assurance" can change - the QA Contact field of a bug. Getting more weird: - 
        if (($field eq "priority") &&
-        (Bugzilla->user->email =~ /.*\@example\.com$/))
-    {
-        if ($oldvalue eq "P1") {
-            return 1;
-        } 
-        else {
-            return 0;
-        }
-    }
    - This says that if the user is trying to change the priority field, - and their email address is @example.com, they can only do so if the - old value of the field was "P1". Not very useful, but illustrative. -

    For a list of possible field names, look in - data/versioncache for the list called - @::log_columns. If you need help writing custom - rules for your organization, ask in the newsgroup. -

    5.9. Upgrading to New Releases

    Chapter 6. Customising Bugzilla

    6.1. Template Customization

    Administrators can configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. +

    Templatization also makes localized versions of Bugzilla possible, + for the first time. It's possible to have Bugzilla's UI language + determined by the user's browser. More information is available in + Section 6.1.5. +

    6.1.1. What to Edit

    The template directory structure is that there's a top level directory, + template, which contains a directory for + each installed localization. The default English templates are + therefore in en. Underneath that, there + is the default directory and optionally the + custom directory. The default + directory contains all the templates shipped with Bugzilla, whereas + the custom directory does not exist at first and + must be created if you want to use it. +

    There are two different ways of editing Bugzilla's templates, + and which you use depends mainly on the method you plan to use to + upgrade Bugzilla. + The first method of making customizations is to directly edit the + templates in template/en/default. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + cvs update, any template fixes will get + automagically merged into your modified versions. +

    If you use this method, your installation will break if CVS conflicts + occur. +

    The other method is to copy the templates to be modified into a + mirrored directory + structure under template/en/custom. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. +

    If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. +

    Don't directly edit the compiled templates in + data/template/* - your + changes will be lost when Template Toolkit recompiles them. +

    It is recommended that you run ./checksetup.pl + after any template edits, especially if you've created a new file in + the custom directory. +

    6.1.2. How To Edit Templates

    If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + Developers' + Guide. +

    The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + Template Toolkit home + page. +

    One thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you forget, you may open up + your installation to cross-site scripting attacks. +

    Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. +

    Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. +

    6.1.3. Template Formats

    Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending &format=simple to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. +

    To see if a CGI supports multiple output formats, grep the + CGI for "GetFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs, e.g. config.cgi. +

    To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. +

    Write your template in whatever markup or text style is appropriate. +

    You now need to decide what content type you want your template + served as. Open up the localconfig file and find the + $contenttypes + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. +

    Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. + Try out the template by calling the CGI as + <cginame>.cgi?format=<formatname> . +

    6.1.4. Particular Templates

    There are a few templates you may be particularly interested in + customizing for your installation. +

    index.html.tmpl: + This is the Bugzilla front page. +

    global/header.html.tmpl: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. +

    global/banner.html.tmpl: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customize this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. +

    global/footer.html.tmpl: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. +

    bug/create/user-message.html.tmpl: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. +

    bug/create/create.html.tmpl and + bug/create/comment.txt.tmpl: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + guided + bug submission form. +

    To make this work, create a custom template for + enter_bug.cgi (the default template, on which you + could base it, is create.html.tmpl), + and either call it create.html.tmpl or use a format and + call it create-<formatname>.html.tmpl. + Put it in the custom/bug/create + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. +

    Then, create a template like + custom/bug/create/comment.txt.tmpl, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. +

    For example, if your enter_bug template had a field + 
    <input type="text" name="buildid" size="30">
    + and then your comment.txt.tmpl had + 
    BuildID: [% form.buildid %]
    + then + 
    BuildID: 20020303
    + would appear in the initial checkin comment. +

    6.1.5. Configuring Bugzilla to Detect the User's Language

    Bugzilla honours the user's Accept: HTTP header. You can install + templates in other languages, and Bugzilla will pick the most appropriate + according to a priority order defined by you. Many + language templates can be obtained from http://www.bugzilla.org/download.html#localizations. Instructions + for submitting new languages are also available from that location. +

    After untarring the localizations (or creating your own) in the + $BUGZILLA_HOME/template directory, + you must update the languages parameter to contain any + localizations you'd like to permit. You may also wish to set the + defaultlanguage parameter to something other than + "en" if you don't want Engish to be the default language. +

    6.2. Customizing Who Can Change What

    This feature should be considered experimental; the Bugzilla code you + will be changing is not stable, and could change or move between + versions. Be aware that if you make modifications as outlined here, + you may have + to re-make them or port them if Bugzilla changes internally between + versions, and you upgrade. +

    Companies often have rules about which employees, or classes of employees, + are allowed to change certain things in the bug system. For example, + only the bug's designated QA Contact may be allowed to VERIFY the bug. + Bugzilla has been + designed to make it easy for you to write your own custom rules to define + who is allowed to make what sorts of value transition. +

    For maximum flexibility, customizing this means editing Bugzilla's Perl + code. This gives the administrator complete control over exactly who is + allowed to do what. The relevant function is called + CheckCanChangeField(), + and is found in process_bug.cgi in your + Bugzilla directory. If you open that file and grep for + "sub CheckCanChangeField", you'll find it. +

    This function has been carefully commented to allow you to see exactly + how it works, and give you an idea of how to make changes to it. Certain + marked sections should not be changed - these are the "plumbing" which + makes the rest of the function work. In between those sections, you'll + find snippets of code like: + 
        # Allow the owner to change anything.
+    if ($ownerid eq $whoid) {
+        return 1;
+    }
    + It's fairly obvious what this piece of code does. +

    So, how does one go about changing this function? Well, simple changes + can be made just be removing pieces - for example, if you wanted to + prevent any user adding a comment to a bug, just remove the lines marked + "Allow anyone to change comments." And if you want the reporter to have + no special rights on bugs they have filed, just remove the entire section + which refers to him. +

    More complex customizations are not much harder. Basically, you add + a check in the right place in the function, i.e. after all the variables + you are using have been set up. So, don't look at $ownerid before + $ownerid has been obtained from the database. You can either add a + positive check, which returns 1 (allow) if certain conditions are true, + or a negative check, which returns 0 (deny.) E.g.: + 
        if ($field eq "qacontact") {
+        if (Bugzilla->user->groups("quality_assurance")) {
+            return 1;
+        } 
+        else {
+            return 0;
+        }
+    }
    + This says that only users in the group "quality_assurance" can change + the QA Contact field of a bug. Getting more weird: + 
        if (($field eq "priority") &&
+        (Bugzilla->user->email =~ /.*\@example\.com$/))
+    {
+        if ($oldvalue eq "P1") {
+            return 1;
+        } 
+        else {
+            return 0;
+        }
+    }
    + This says that if the user is trying to change the priority field, + and their email address is @example.com, they can only do so if the + old value of the field was "P1". Not very useful, but illustrative. +

    For a list of possible field names, look in + data/versioncache for the list called + @::log_columns. If you need help writing custom + rules for your organization, ask in the newsgroup. +

    6.3. Modifying Your Running System

    Bugzilla optimizes database lookups by storing all relatively + static information in the + versioncache file, located in the + data/ + subdirectory under your installation directory.

    If you make a change to the structural data in your database (the + versions table for example), or to the + "constants" + + encoded in defparams.pl, you will need to remove + the cached content from the data directory (by doing a + "rm data/versioncache" + + ), or your changes won't show up.

    versioncache + gets automatically regenerated whenever it's more than + an hour old, so Bugzilla will eventually notice your changes by itself, + but generally you want it to notice right away, so that you can test + things.

    6.4. MySQL Bugzilla Database Introduction

    This information comes straight from my life. I was forced to learn + how Bugzilla organizes database because of nitpicky requests from users + for tiny changes in wording, rather than having people re-educate + themselves or figure out how to work our procedures around the tool. It + sucks, but it can and will happen to you, so learn how the schema works + and deal with it when it comes.

    So, here you are with your brand-new installation of Bugzilla. + You've got MySQL set up, Apache working right, Perl DBI and DBD talking + to the database flawlessly. Maybe you've even entered a few test bugs to + make sure email's working; people seem to be notified of new bugs and + changes, and you can enter and edit bugs to your heart's content. Perhaps + you've gone through the trouble of setting up a gateway for people to + submit bugs to your database via email, have had a few people test it, + and received rave reviews from your beta testers.

    What's the next thing you do? Outline a training strategy for your + development team, of course, and bring them up to speed on the new tool + you've labored over for hours.

    Your first training session starts off very well! You have a + captive audience which seems enraptured by the efficiency embodied in + this thing called "Bugzilla". You are caught up describing the nifty + features, how people can save favorite queries in the database, set them + up as headers and footers on their pages, customize their layouts, + generate reports, track status with greater efficiency than ever before, + leap tall buildings with a single bound and rescue Jane from the clutches + of Certain Death!

    But Certain Death speaks up -- a tiny voice, from the dark corners + of the conference room. "I have a concern," the voice hisses from the + darkness, "about the use of the word 'verified'."

    The room, previously filled with happy chatter, lapses into + reverential silence as Certain Death (better known as the Vice President + of Software Engineering) continues. "You see, for two years we've used + the word 'verified' to indicate that a developer or quality assurance + engineer has confirmed that, in fact, a bug is valid. I don't want to + lose two years of training to a new software product. You need to change + the bug status of 'verified' to 'approved' as soon as possible. To avoid + confusion, of course."

    Oh no! Terror strikes your heart, as you find yourself mumbling + "yes, yes, I don't think that would be a problem," You review the changes + with Certain Death, and continue to jabber on, "no, it's not too big a + change. I mean, we have the source code, right? You know, 'Use the + Source, Luke' and all that... no problem," All the while you quiver + inside like a beached jellyfish bubbling, burbling, and boiling on a hot + Jamaican sand dune...

    Thus begins your adventure into the heart of Bugzilla. You've been + forced to learn about non-portable enum() fields, varchar columns, and + tinyint definitions. The Adventure Awaits You!

    6.4.1. Bugzilla Database Basics

    If you were like me, at this point you're totally clueless about + the internals of MySQL, and if it weren't for this executive order from + the Vice President you couldn't care less about the difference between + a + "bigint" + + and a + "tinyint" + + entry in MySQL. I recommend you refer to the + MySQL documentation + . Below are the basics you need to know about the Bugzilla database. + Check the chart above for more details.

    1. To connect to your database:

      bash# + + mysql + + -u root +

      If this works without asking you for a password, + shame on you + + ! You should have locked your security down like the installation + instructions told you to. You can find details on locking down + your database in the Bugzilla FAQ in this directory (under + "Security"), or more robust security generalities in the + MySQL + searchable documentation. +

    2. You should now be at a prompt that looks like this:

      mysql> +

      At the prompt, if + "bugs" + + is the name you chose in the + localconfig + + file for your Bugzilla database, type:

      mysql + + use bugs; +

    +

    6.4.1.1. Bugzilla Database Tables

    Imagine your MySQL database as a series of spreadsheets, and + you won't be too far off. If you use this command:

    mysql> + show tables from bugs; +

    you'll be able to see the names of all the + "spreadsheets" + (tables) in your database.

    From the command issued above, ou should have some + output that looks like this: +
    
+-------------------+
+| Tables in bugs    |
++-------------------+
+| attachments       |
+| bugs              |
+| bugs_activity     |
+| cc                |
+| components        |
+| dependencies      |
+| fielddefs         |
+| groups            |
+| keyworddefs       |
+| keywords          |
+| logincookies      |
+| longdescs         |
+| milestones        |
+| namedqueries      |
+| products          |
+| profiles          |
+| profiles_activity |
+| tokens            |
+| versions          |
+| votes             |
+| watch             |
++-------------------+
+
    +


    +  Here's an overview of what each table does. Most columns in each table have
    +descriptive names that make it fairly trivial to figure out their jobs.
    +
    +attachments: This table stores all attachments to bugs. It tends to be your
    +largest table, yet also generally has the fewest entries because file
    +attachments are so (relatively) large.
    +
    +bugs:  This is the core of your system. The bugs table stores most of the
    +current information about a bug, with the exception of the info stored in the
    +other tables.
    +
    +bugs_activity:  This stores information regarding what changes are made to bugs
    +when -- a history file.
    +
    +cc:  This tiny table simply stores all the CC information for any bug which has
    +any entries in the CC field of the bug. Note that, like most other tables in
    +Bugzilla, it does not refer to users by their user names, but by their unique
    +userid, stored as a primary key in the profiles table.
    +
    +components: This stores the programs and components (or products and
    +components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
    +(product) field is the full name of the product, rather than some other unique
    +identifier, like bug_id and user_id are elsewhere in the database.
    +
    +dependencies: Stores data about those cool dependency trees.
    +
    +fielddefs:  A nifty table that defines other tables. For instance, when you
    +submit a form that changes the value of "AssignedTo" this table allows
    +translation to the actual field name "assigned_to" for entry into MySQL.
    +
    +groups:  defines bitmasks for groups. A bitmask is a number that can uniquely
    +identify group memberships. For instance, say the group that is allowed to
    +tweak parameters is assigned a value of "1", the group that is allowed to edit
    +users is assigned a "2", and the group that is allowed to create new groups is
    +assigned the bitmask of "4". By uniquely combining the group bitmasks (much
    +like the chmod command in UNIX,) you can identify a user is allowed to tweak
    +parameters and create groups, but not edit users, by giving him a bitmask of
    +"5", or a user allowed to edit users and create groups, but not tweak
    +parameters, by giving him a bitmask of "6" Simple, huh?
    +  If this makes no sense to you, try this at the mysql prompt:
    +mysql> select * from groups;
    +  You'll see the list, it makes much more sense that way.
    +
    +keyworddefs:  Definitions of keywords to be used
    +
    +keywords: Unlike what you'd think, this table holds which keywords are
    +associated with which bug id's.
    +
    +logincookies: This stores every login cookie ever assigned to you for every
    +machine you've ever logged into Bugzilla from. Curiously, it never does any
    +housecleaning -- I see cookies in this file I've not used for months. However,
    +since Bugzilla never expires your cookie (for convenience' sake), it makes
    +sense.
    +
    +longdescs:  The meat of bugzilla -- here is where all user comments are stored!
    +You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
    +sparingly -- that's only the amount of space the Old Testament from the Bible
    +would take (uncompressed, 16 megabytes). Each comment is keyed to the
    +bug_id to which it's attached, so the order is necessarily chronological, for
    +comments are played back in the order in which they are received.
    +
    +milestones:  Interesting that milestones are associated with a specific product
    +in this table, but Bugzilla does not yet support differing milestones by
    +product through the standard configuration interfaces.
    +
    +namedqueries:  This is where everybody stores their "custom queries". Very
    +cool feature; it beats the tar out of having to bookmark each cool query you
    +construct.
    +
    +products:  What products you have, whether new bug entries are allowed for the
    +product, what milestone you're working toward on that product, votes, etc. It
    +will be nice when the components table supports these same features, so you
    +could close a particular component for bug entry without having to close an
    +entire product...
    +
    +profiles:  Ahh, so you were wondering where your precious user information was
    +stored?  Here it is!  With the passwords in plain text for all to see! (but
    +sshh... don't tell your users!)
    +
    +profiles_activity:  Need to know who did what when to who's profile?  This'll
    +tell you, it's a pretty complete history.
    +
    +versions:  Version information for every product
    +
    +votes:  Who voted for what when
    +
    +watch:  Who (according to userid) is watching who's bugs (according to their
    +userid).
    +
    +
    +===
    +THE DETAILS
    +===
    +
    +  Ahh, so you're wondering just what to do with the information above?  At the
    +mysql prompt, you can view any information about the columns in a table with
    +this command (where "table" is the name of the table you wish to view):
    +
    +mysql> show columns from table;
    +
    +  You can also view all the data in a table with this command:
    +
    +mysql> select * from table;
    +
    +  -- note: this is a very bad idea to do on, for instance, the "bugs" table if
    +you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
    +50,000 bugs play across your screen.
    +
    +  You can limit the display from above a little with the command, where
    +"column" is the name of the column for which you wish to restrict information:
    +
    +mysql> select * from table where (column = "some info");
    +
    +  -- or the reverse of this
    +
    +mysql> select * from table where (column != "some info");
    +
    +  Let's take our example from the introduction, and assume you need to change
    +the word "verified" to "approved" in the resolution field. We know from the
    +above information that the resolution is likely to be stored in the "bugs"
    +table. Note we'll need to change a little perl code as well as this database
    +change, but I won't plunge into that in this document. Let's verify the
    +information is stored in the "bugs" table:
    +
    +mysql> show columns from bugs
    +
    +  (exceedingly long output truncated here)
    +| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
    +
    +  Sorry about that long line. We see from this that the "bug status" column is
    +an "enum field", which is a MySQL peculiarity where a string type field can
    +only have certain types of entries. While I think this is very cool, it's not
    +standard SQL. Anyway, we need to add the possible enum field entry
    +'APPROVED' by altering the "bugs" table.
    +
    +mysql> ALTER table bugs CHANGE bug_status bug_status
    +    -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
    +    -> "VERIFIED", "APPROVED", "CLOSED") not null;
    +
    +    (note we can take three lines or more -- whatever you put in before the
    +semicolon is evaluated as a single expression)
    +
    +Now if you do this:
    +
    +mysql> show columns from bugs;
    +
    +  you'll see that the bug_status field has an extra "APPROVED" enum that's
    +available!  Cool thing, too, is that this is reflected on your query page as
    +well -- you can query by the new status. But how's it fit into the existing
    +scheme of things?
    +  Looks like you need to go back and look for instances of the word "verified"
    +in the perl code for Bugzilla -- wherever you find "verified", change it to
    +"approved" and you're in business (make sure that's a case-insensitive search).
    +Although you can query by the enum field, you can't give something a status
    +of "APPROVED" until you make the perl changes. Note that this change I
    +mentioned can also be done by editing checksetup.pl, which automates a lot of
    +this. But you need to know this stuff anyway, right?
    +

    5.10. Integrating Bugzilla with Third-Party Tools

    6.5. Integrating Bugzilla with Third-Party Tools

    5.10.1. Bonsai

    6.5.1. Bonsai

    Bonsai is a web-based tool for managing 5.10.2. CVS6.5.2. CVS

    CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.

    5.10.3. Perforce SCM6.5.3. Perforce SCM

    You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: @@ -9681,9 +9502,22 @@ CLASS="section" >5.10.4. Tinderbox/Tinderbox26.5.4. Tinderbox/Tinderbox2

    We need Tinderbox integration information.

    Tinderbox is a continuous-build system which can integrate with + Bugzilla - see + http://www.mozilla.org/projects/tinderbox for details + of Tinderbox, and + http://tinderbox.mozilla.org/showbuilds.cgi to see it + in action.

    A.1.1. Where can I find information about Bugzilla?
    A.1.2. What license is Bugzilla distributed under?
    A.1.3. A.1.2. How do I get commercial support for Bugzilla?
    A.1.4. A.1.3. What major companies or projects are currently using Bugzilla for bug-tracking?
    A.1.5. A.1.4. Who maintains Bugzilla?
    A.1.6. A.1.5. How does Bugzilla stack up against other bug-tracking databases?
    A.1.7. A.1.6. Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?
    A.1.8. A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL.
    A.1.9. A.1.8. What is
    A.1.10. A.1.9. My perl is not located at
    A.1.11. A.1.10. Is there an easy way to change the Bugzilla cookie name?
    A.2.2. Can Bugzilla integrate with - Perforce (SCM software)? -
    A.2.3. Does Bugzilla allow the user to track multiple projects? -
    A.2.4. If I am on many projects, and search for all bugs assigned to me, will - Bugzilla list them for me and allow me to sort by project, severity etc? -
    A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, - are there any that are NOT allowed? -
    A.2.6. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and @@ -9834,35 +9636,28 @@ HREF="#faq-phb-priorities"
    A.2.7. A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :)
    A.2.8. A.2.4. Is there email notification and if so, what do you see when you get an email?
    A.2.9. Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? -
    A.2.10. A.2.5. Do users have to have any particular type of email application?
    A.2.11. A.2.6. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be @@ -9871,28 +9666,21 @@ HREF="#faq-phb-data"
    A.2.12. A.2.7. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable?
    A.2.13. A.2.8. Can a user create and save reports? Can they do this in Word format? Excel format?
    A.2.14. Does Bugzilla have the ability to search by word, phrase, compound - search? -
    A.2.15. A.2.9. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use @@ -9900,29 +9688,29 @@ HREF="#faq-phb-midair"
    A.2.16. A.2.10. Are there any backup features provided?
    A.2.17. A.2.11. Can users be on the system while a backup is in progress?
    A.2.18. A.2.12. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an - "Out-of-the-Box" solution. + "out-of-the-box" solution?
    A.2.19. A.2.13. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to @@ -9932,7 +9720,7 @@ HREF="#faq-phb-installtime"
    A.2.20. A.2.14. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -9960,14 +9748,6 @@ HREF="#faq-security-knownproblems" > Are there any security problems with Bugzilla?
    A.3.3. I've implemented the security fixes mentioned in Chris Yeh's security - advisory of 5/10/2000 advising not to run MySQL as root, and am running into - problems with MySQL no longer working correctly. -
    A.4.3. I want whineatnews.pl to whine at something more, or other than, only new +> I want whineatnews.pl to whine at something different to only new bugs. How do I do it?
    A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? -
    A.4.5. How do I set up the email interface to submit/change bugs via email?
    A.4.6. A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives?
    A.4.7. A.4.6. How come email from Bugzilla changes never reaches me?

    A.1.1. - Where can I find information about Bugzilla?

    - You can stay up-to-date with the latest Bugzilla - information at http://www.bugzilla.org/. -

    A.1.2. A.1.1. What license is Bugzilla distributed under?

    A.1.3. A.1.2. How do I get commercial support for Bugzilla?

    http://www.collab.net/ offers - Bugzilla as part of their standard offering to large projects. - They do have some minimum fees that are pretty hefty, and generally - aren't interested in small projects. -

    There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing to make themselves available for generous compensation. @@ -10304,7 +10039,7 @@ CLASS="question" NAME="faq-general-companies" >A.1.4. A.1.3. What major companies or projects are currently using Bugzilla for bug-tracking? @@ -10322,9 +10057,9 @@ CLASS="answer" Bugzilla sites to track bugs in their products. We have a fairly complete list available on our website at http://bugzilla.org/installation_list.htmlhttp://bugzilla.org/installation-list/. If you have an installation of Bugzilla and would like to be added to the list, whether it's a public install or not, simply e-mail @@ -10334,11 +10069,7 @@ CLASS="email" HREF="mailto:gerv@mozilla.org" >gerv@mozilla.org>. Keep in mind that it's kinda - difficult to get onto the "high-profile" list ;). +>.

    A.1.5. A.1.4. Who maintains Bugzilla?

    A.1.6. A.1.5. How does Bugzilla stack up against other bug-tracking databases?

    A.1.7. A.1.6. Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software? @@ -10459,7 +10190,7 @@ CLASS="question" NAME="faq-general-mysql" >A.1.8. A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL. @@ -10504,7 +10235,7 @@ CLASS="question" NAME="faq-general-bonsaitools" >A.1.9. A.1.8. What is A.1.10. A.1.9. My perl is not located at A.1.11. A.1.10. Is there an easy way to change the Bugzilla cookie name?

    2. Managerial Questions

    Questions likely to be asked by managers. :-) -

    -

    - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the web. -

    A.2.2. - Can Bugzilla integrate with - Perforce (SCM software)? -

    - Yes! You can find more information elsewhere in "The Bugzilla - Guide" in the "Integration with Third-Party Products" section. -

    A.2.3. - Does Bugzilla allow the user to track multiple projects? -

    - Absolutely! You can track any number of Products that can each be - composed of any number of Components. -

    A.2.4. - If I am on many projects, and search for all bugs assigned to me, will - Bugzilla list them for me and allow me to sort by project, severity etc? -

    - Yes. -

    A.2.5. - Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, - are there any that are NOT allowed? -

    - Yes - any sort of attachment is allowed, although administrators can - configure a maximum size. - Bugzilla gives the user the option of either using the MIME-type - supplied by the browser, choosing from a pre-defined list or - manually typing any arbitrary MIME-type. + It is web and e-mail based.

    A.2.6. A.2.2. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and @@ -10825,7 +10420,7 @@ CLASS="question" NAME="faq-phb-reporting" >A.2.7. A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -10863,7 +10458,7 @@ CLASS="question" NAME="faq-phb-email" >A.2.8. A.2.4. Is there email notification and if so, what do you see when you get an email? @@ -10876,7 +10471,7 @@ CLASS="answer" > Email notification is user-configurable. By default, the bug id and - Summary of the bug report accompany each email notification, along with + summary of the bug report accompany each email notification, along with a list of the changes made.

    A.2.9. - Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? -

    - Yes. -

    A.2.10. A.2.5. Do users have to have any particular type of email application? @@ -10974,7 +10544,7 @@ CLASS="question" NAME="faq-phb-data" >A.2.11. A.2.6. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be @@ -10991,7 +10561,7 @@ CLASS="answer" Bugzilla can output buglists as HTML (the default), CSV or RDF. The link for CSV can be found at the bottom of the buglist in HTML format. This CSV format can easily be imported into MS Excel or - other spread-sheet applications. + other spreadsheet applications.

    To use the RDF format of the buglist it is necessary to append a @@ -11000,7 +10570,7 @@ CLASS="computeroutput" >&ctype=rdf to the URL. RDF is meant to be machine readable and thus it is assumed that the - URL would be generated progmatically so there is no user visible + URL would be generated programatically so there is no user visible link to this format.

    A.2.12. A.2.7. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? @@ -11074,7 +10644,7 @@ CLASS="question" NAME="faq-phb-reports" >A.2.13. A.2.8. Can a user create and save reports? Can they do this in Word format? Excel format? @@ -11096,36 +10666,10 @@ CLASS="qandaentry" CLASS="question" >

    A.2.14. - Does Bugzilla have the ability to search by word, phrase, compound - search? -

    - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. -

    A.2.15. A.2.9. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use @@ -11152,7 +10696,7 @@ CLASS="question" NAME="faq-phb-backup" >A.2.16. A.2.10. Are there any backup features provided?

    A.2.17. A.2.11. Can users be on the system while a backup is in progress?

    A.2.18. A.2.12. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an - "Out-of-the-Box" solution. + "out-of-the-box" solution?

    A.2.19. A.2.13. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to @@ -11276,7 +10820,7 @@ CLASS="question" NAME="faq-phb-cost" >A.2.20. A.2.14. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -11358,34 +10902,6 @@ CLASS="answer"

    A.3.3. - I've implemented the security fixes mentioned in Chris Yeh's security - advisory of 5/10/2000 advising not to run MySQL as root, and am running into - problems with MySQL no longer working correctly. -

    - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts - mysqld. -

    A.4.3. - I want whineatnews.pl to whine at something more, or other than, only new + I want whineatnews.pl to whine at something different to only new bugs. How do I do it?

    A.4.4. - I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? -

    - You can call bug_email.pl directly from your aliases file, with - an entry like this: -

    bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" -

    - However, this is fairly nasty and subject to problems; you also - need to set up your smrsh (sendmail restricted shell) to allow - it. In a pinch, though, it can work. -

    A.4.5. A.4.4. How do I set up the email interface to submit/change bugs via email?

    A.4.6. A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? @@ -11568,7 +11045,21 @@ CLASS="answer" > - If you are using an alternate sendmail, try enabling + sendmailnow in editparams.cgi. + +

    If you are using an alternate on. -

    If you are using sendmail, try enabling - sendmailnow in editparams.cgi. -

    A.4.7. A.4.6. How come email from Bugzilla changes never reaches me?

    If you never receive mail from Bugzilla, chances you do not have +> If you never receive mail from Bugzilla, chances are you do not have sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked to, "/usr/lib/sendmail".

    - Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle, + but it is now so old as to be obsolete, and is totally unsupported. Red Hat's newer version (based on 2.17.1 and soon to be merged into the main distribution) runs on PostgreSQL. At this time we know of - no recent ports of Bugzilla to Oracle but do intend to support it - in the future (possibly the 2.20 time-frame). + no recent ports of Bugzilla to Oracle; to be honest, Bugzilla + doesn't need what Oracle offers.

    utility (./sanitycheck.cgi in the - Bugzilla_home directory) from your web browser to see! If - it finishes without errors, you're +>sanitycheck.cgi    ) from your web browser to see! + If it finishes without errors, you're probably OK. If it doesn't come back @@ -11951,7 +11428,7 @@ CLASS="answer" >

    Microsoft has some advice on this matter, as well:

    Appendix B. The Bugzilla Database

    This document really needs to be updated with more fleshed out - information about primary keys, interrelationships, and maybe some nifty - tables to document dependencies. Any takers?

    B.1. Modifying Your Running System

    Bugzilla optimizes database lookups by storing all relatively - static information in the - versioncache file, located in the - data/ - subdirectory under your installation directory.

    If you make a change to the structural data in your database (the - versions table for example), or to the - "constants" - - encoded in defparams.pl, you will need to remove - the cached content from the data directory (by doing a - "rm data/versioncache" - - ), or your changes won't show up.

    versioncache - gets automatically regenerated whenever it's more than - an hour old, so Bugzilla will eventually notice your changes by itself, - but generally you want it to notice right away, so that you can test - things.

    B.2. MySQL Bugzilla Database Introduction

    This information comes straight from my life. I was forced to learn - how Bugzilla organizes database because of nitpicky requests from users - for tiny changes in wording, rather than having people re-educate - themselves or figure out how to work our procedures around the tool. It - sucks, but it can and will happen to you, so learn how the schema works - and deal with it when it comes.

    So, here you are with your brand-new installation of Bugzilla. - You've got MySQL set up, Apache working right, Perl DBI and DBD talking - to the database flawlessly. Maybe you've even entered a few test bugs to - make sure email's working; people seem to be notified of new bugs and - changes, and you can enter and edit bugs to your heart's content. Perhaps - you've gone through the trouble of setting up a gateway for people to - submit bugs to your database via email, have had a few people test it, - and received rave reviews from your beta testers.

    What's the next thing you do? Outline a training strategy for your - development team, of course, and bring them up to speed on the new tool - you've labored over for hours.

    Your first training session starts off very well! You have a - captive audience which seems enraptured by the efficiency embodied in - this thing called "Bugzilla". You are caught up describing the nifty - features, how people can save favorite queries in the database, set them - up as headers and footers on their pages, customize their layouts, - generate reports, track status with greater efficiency than ever before, - leap tall buildings with a single bound and rescue Jane from the clutches - of Certain Death!

    But Certain Death speaks up -- a tiny voice, from the dark corners - of the conference room. "I have a concern," the voice hisses from the - darkness, "about the use of the word 'verified'."

    The room, previously filled with happy chatter, lapses into - reverential silence as Certain Death (better known as the Vice President - of Software Engineering) continues. "You see, for two years we've used - the word 'verified' to indicate that a developer or quality assurance - engineer has confirmed that, in fact, a bug is valid. I don't want to - lose two years of training to a new software product. You need to change - the bug status of 'verified' to 'approved' as soon as possible. To avoid - confusion, of course."

    Oh no! Terror strikes your heart, as you find yourself mumbling - "yes, yes, I don't think that would be a problem," You review the changes - with Certain Death, and continue to jabber on, "no, it's not too big a - change. I mean, we have the source code, right? You know, 'Use the - Source, Luke' and all that... no problem," All the while you quiver - inside like a beached jellyfish bubbling, burbling, and boiling on a hot - Jamaican sand dune...

    Thus begins your adventure into the heart of Bugzilla. You've been - forced to learn about non-portable enum() fields, varchar columns, and - tinyint definitions. The Adventure Awaits You!

    B.2.1. Bugzilla Database Basics

    If you were like me, at this point you're totally clueless about - the internals of MySQL, and if it weren't for this executive order from - the Vice President you couldn't care less about the difference between - a - "bigint" - - and a - "tinyint" - - entry in MySQL. I recommend you refer to the - MySQL documentation - . Below are the basics you need to know about the Bugzilla database. - Check the chart above for more details.

    1. To connect to your database:

      bash# - - mysql - - -u root -

      If this works without asking you for a password, - shame on you - - ! You should have locked your security down like the installation - instructions told you to. You can find details on locking down - your database in the Bugzilla FAQ in this directory (under - "Security"), or more robust security generalities in the - MySQL - searchable documentation. -

    2. You should now be at a prompt that looks like this:

      mysql> -

      At the prompt, if - "bugs" - - is the name you chose in the - localconfig - - file for your Bugzilla database, type:

      mysql - - use bugs; -

    -

    B.2.1.1. Bugzilla Database Tables

    Imagine your MySQL database as a series of spreadsheets, and - you won't be too far off. If you use this command:

    mysql> - show tables from bugs; -

    you'll be able to see the names of all the - "spreadsheets" - (tables) in your database.

    From the command issued above, ou should have some - output that looks like this: -
    
+-------------------+
-| Tables in bugs    |
-+-------------------+
-| attachments       |
-| bugs              |
-| bugs_activity     |
-| cc                |
-| components        |
-| dependencies      |
-| fielddefs         |
-| groups            |
-| keyworddefs       |
-| keywords          |
-| logincookies      |
-| longdescs         |
-| milestones        |
-| namedqueries      |
-| products          |
-| profiles          |
-| profiles_activity |
-| tokens            |
-| versions          |
-| votes             |
-| watch             |
-+-------------------+
-
    -


    -  Here's an overview of what each table does. Most columns in each table have
    -descriptive names that make it fairly trivial to figure out their jobs.
    -
    -attachments: This table stores all attachments to bugs. It tends to be your
    -largest table, yet also generally has the fewest entries because file
    -attachments are so (relatively) large.
    -
    -bugs:  This is the core of your system. The bugs table stores most of the
    -current information about a bug, with the exception of the info stored in the
    -other tables.
    -
    -bugs_activity:  This stores information regarding what changes are made to bugs
    -when -- a history file.
    -
    -cc:  This tiny table simply stores all the CC information for any bug which has
    -any entries in the CC field of the bug. Note that, like most other tables in
    -Bugzilla, it does not refer to users by their user names, but by their unique
    -userid, stored as a primary key in the profiles table.
    -
    -components: This stores the programs and components (or products and
    -components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
    -(product) field is the full name of the product, rather than some other unique
    -identifier, like bug_id and user_id are elsewhere in the database.
    -
    -dependencies: Stores data about those cool dependency trees.
    -
    -fielddefs:  A nifty table that defines other tables. For instance, when you
    -submit a form that changes the value of "AssignedTo" this table allows
    -translation to the actual field name "assigned_to" for entry into MySQL.
    -
    -groups:  defines bitmasks for groups. A bitmask is a number that can uniquely
    -identify group memberships. For instance, say the group that is allowed to
    -tweak parameters is assigned a value of "1", the group that is allowed to edit
    -users is assigned a "2", and the group that is allowed to create new groups is
    -assigned the bitmask of "4". By uniquely combining the group bitmasks (much
    -like the chmod command in UNIX,) you can identify a user is allowed to tweak
    -parameters and create groups, but not edit users, by giving him a bitmask of
    -"5", or a user allowed to edit users and create groups, but not tweak
    -parameters, by giving him a bitmask of "6" Simple, huh?
    -  If this makes no sense to you, try this at the mysql prompt:
    -mysql> select * from groups;
    -  You'll see the list, it makes much more sense that way.
    -
    -keyworddefs:  Definitions of keywords to be used
    -
    -keywords: Unlike what you'd think, this table holds which keywords are
    -associated with which bug id's.
    -
    -logincookies: This stores every login cookie ever assigned to you for every
    -machine you've ever logged into Bugzilla from. Curiously, it never does any
    -housecleaning -- I see cookies in this file I've not used for months. However,
    -since Bugzilla never expires your cookie (for convenience' sake), it makes
    -sense.
    -
    -longdescs:  The meat of bugzilla -- here is where all user comments are stored!
    -You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
    -sparingly -- that's only the amount of space the Old Testament from the Bible
    -would take (uncompressed, 16 megabytes). Each comment is keyed to the
    -bug_id to which it's attached, so the order is necessarily chronological, for
    -comments are played back in the order in which they are received.
    -
    -milestones:  Interesting that milestones are associated with a specific product
    -in this table, but Bugzilla does not yet support differing milestones by
    -product through the standard configuration interfaces.
    -
    -namedqueries:  This is where everybody stores their "custom queries". Very
    -cool feature; it beats the tar out of having to bookmark each cool query you
    -construct.
    -
    -products:  What products you have, whether new bug entries are allowed for the
    -product, what milestone you're working toward on that product, votes, etc. It
    -will be nice when the components table supports these same features, so you
    -could close a particular component for bug entry without having to close an
    -entire product...
    -
    -profiles:  Ahh, so you were wondering where your precious user information was
    -stored?  Here it is!  With the passwords in plain text for all to see! (but
    -sshh... don't tell your users!)
    -
    -profiles_activity:  Need to know who did what when to who's profile?  This'll
    -tell you, it's a pretty complete history.
    -
    -versions:  Version information for every product
    -
    -votes:  Who voted for what when
    -
    -watch:  Who (according to userid) is watching who's bugs (according to their
    -userid).
    -
    -
    -===
    -THE DETAILS
    -===
    -
    -  Ahh, so you're wondering just what to do with the information above?  At the
    -mysql prompt, you can view any information about the columns in a table with
    -this command (where "table" is the name of the table you wish to view):
    -
    -mysql> show columns from table;
    -
    -  You can also view all the data in a table with this command:
    -
    -mysql> select * from table;
    -
    -  -- note: this is a very bad idea to do on, for instance, the "bugs" table if
    -you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
    -50,000 bugs play across your screen.
    -
    -  You can limit the display from above a little with the command, where
    -"column" is the name of the column for which you wish to restrict information:
    -
    -mysql> select * from table where (column = "some info");
    -
    -  -- or the reverse of this
    -
    -mysql> select * from table where (column != "some info");
    -
    -  Let's take our example from the introduction, and assume you need to change
    -the word "verified" to "approved" in the resolution field. We know from the
    -above information that the resolution is likely to be stored in the "bugs"
    -table. Note we'll need to change a little perl code as well as this database
    -change, but I won't plunge into that in this document. Let's verify the
    -information is stored in the "bugs" table:
    -
    -mysql> show columns from bugs
    -
    -  (exceedingly long output truncated here)
    -| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
    -
    -  Sorry about that long line. We see from this that the "bug status" column is
    -an "enum field", which is a MySQL peculiarity where a string type field can
    -only have certain types of entries. While I think this is very cool, it's not
    -standard SQL. Anyway, we need to add the possible enum field entry
    -'APPROVED' by altering the "bugs" table.
    -
    -mysql> ALTER table bugs CHANGE bug_status bug_status
    -    -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
    -    -> "VERIFIED", "APPROVED", "CLOSED") not null;
    -
    -    (note we can take three lines or more -- whatever you put in before the
    -semicolon is evaluated as a single expression)
    -
    -Now if you do this:
    -
    -mysql> show columns from bugs;
    -
    -  you'll see that the bug_status field has an extra "APPROVED" enum that's
    -available!  Cool thing, too, is that this is reflected on your query page as
    -well -- you can query by the new status. But how's it fit into the existing
    -scheme of things?
    -  Looks like you need to go back and look for instances of the word "verified"
    -in the perl code for Bugzilla -- wherever you find "verified", change it to
    -"approved" and you're in business (make sure that's a case-insensitive search).
    -Although you can query by the enum field, you can't give something a status
    -of "APPROVED" until you make the perl changes. Note that this change I
    -mentioned can also be done by editing checksetup.pl, which automates a lot of
    -this. But you need to know this stuff anyway, right?
    -

    Appendix C. Useful Patches and Utilities for Bugzilla

    Appendix B. Contrib

    Are you looking for a way to put your Bugzilla into overdrive? Catch - some of the niftiest tricks here in this section.

    C.1. Apache - There are a number of unofficial Bugzilla add-ons in the + mod_rewrite$BUGZILLA_ROOT/contrib/ - - magic

    Apache's - mod_rewrite - - module lets you do some truly amazing things with URL rewriting. Here are - a couple of examples of what you can do.

    1. Make it so if someone types - http://www.foo.com/12345 - - , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try - setting up your VirtualHost section for Bugzilla with a rule like - this:

      
<VirtualHost 12.34.56.78>
-RewriteEngine On
-RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
-</VirtualHost>
-

    2. There are many, many more things you can do with mod_rewrite. - Please refer to the mod_rewrite documentation at - http://www.apache.org. -

    C.2. Command-line Bugzilla Queries

    B.1. Command-line Search Interface

    There are a suite of Unix utilities for querying Bugzilla from the +>There are a suite of Unix utilities for searching Bugzilla from the command line. They live in the

    Appendix D. Bugzilla Variants and Competitors

    I created this section to answer questions about Bugzilla competitors - and variants, then found a wonderful site which covers an awful lot of what - I wanted to discuss. Rather than quote it in its entirety, I'll simply - refer you here: - http://linas.org/linux/pm.html. -

    D.1. Red Hat Bugzilla

    Red Hat's old fork of Bugzilla which was based on version 2.8 is now - obsolete. The newest version in use is based on version 2.17.1 and is in - the process of being integrated into the main Bugzilla source tree. The - back-end is modified to work with PostgreSQL instead of MySQL and they have - custom templates to get their desired look and feel, but other than that it - is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of - effort to make sure that the changes he made could be integrated back into - the main tree. - Bug 98304 - exists to track this integration. -

    URL: http://bugzilla.redhat.com/bugzilla/ -

    This section last updated 24 Dec 2002

    D.2. Loki Bugzilla (Fenris)

    Fenris was a fork from Bugzilla made by Loki Games; when - Loki went into receivership, it died. While Loki's other code lives on, - its custodians recommend Bugzilla for future bug-tracker deployments. -

    This section last updated 27 Jul 2002

    D.3. Issuezilla

    Issuezilla was another fork from Bugzilla, made by collab.net and - hosted at tigris.org. It is also dead; the primary focus of bug-tracking - at tigris.org is their Java-based bug-tracker, - Section D.4.

    This section last updated 27 Jul 2002

    D.4. Scarab

    Scarab is a new open source bug-tracking system built using Java - Servlet technology. It is currently at version 1.0 beta 13.

    URL: http://scarab.tigris.org/ -

    This section last updated 18 Jan 2003

    D.5. Perforce SCM

    Although Perforce isn't really a bug tracker, it can be used as - such through the "jobs" - functionality.

    URL: http://www.perforce.com/perforce/technotes/note052.html -

    This section last updated 27 Jul 2002

    D.6. SourceForge

    SourceForge is a way of coordinating geographically - distributed free software and open source projects over the Internet. - It has a built-in bug tracker, but it's not highly thought of.

    URL: http://www.sourceforge.net -

    This section last updated 27 Jul 2002

    Appendix E. GNU Free Documentation License

    Appendix C. GNU Free Documentation License

    Version 1.1, March 2000

    0-9, high ascii

    For more information about how to configure Apache for Bugzilla, see Section 4.4.1Section 4.2.1.

    Much more detailed information about the suggestions in Section 5.6.2Section 4.5.2.

    About This GuideThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix C. Useful Patches and Utilities for BugzillaAppendix B. ContribC.2. Command-line Bugzilla QueriesB.1. Command-line Search Interface

    There are a suite of Unix utilities for querying Bugzilla from the +>There are a suite of Unix utilities for searching Bugzilla from the command line. They live in the PrevNextApache - mod_rewrite - - magicContrib

    GNU Free Documentation License
    The Bugzilla Guide - 2.17.5 Development Release
    The Bugzilla Guide - 2.17.5 Development ReleaseAdministering BugzillaThe Bugzilla Guide - 2.17.5 Development Release
    5.3. Product, Component, Milestone, and Version Administration
    5.3.1. Products
    5.3.2. 5.4. Components
    5.3.3. 5.5. Versions
    5.3.4. 5.6. Milestones
    5.4. 5.7. Voting
    5.5. 5.8. Groups and Group Security
    5.6. Bugzilla Security
    5.6.1. TCP/IP Ports
    5.6.2. MySQL
    5.6.3. Daemon Accounts
    5.6.4. Web Server Access Controls
    5.7. Template Customization
    5.7.1. What to Edit
    5.7.2. How To Edit Templates
    5.7.3. Template Formats
    5.7.4. Particular Templates
    5.7.5. Configuring Bugzilla to Detect the User's Language
    5.8. Change Permission Customization
    5.9. Upgrading to New Releases
    5.10. Integrating Bugzilla with Third-Party Tools
    5.10.1. Bonsai
    5.10.2. CVS
    5.10.3. Perforce SCM
    5.10.4. Tinderbox/Tinderbox2
    Anatomy of a Bug
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.2. Anatomy of a Bug

    The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + Bug 1 on Landfill + + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla.

    1. Product and Component: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + Components: +

      Administration: + Administration of a Bugzilla installation.
      Bugzilla-General: + Anything that doesn't fit in the other components, or spans + multiple components.
      Creating/Changing Bugs: + Creating, changing, and viewing bugs.
      Documentation: + The Bugzilla documentation, including The Bugzilla Guide.
      Email: + Anything to do with email sent by Bugzilla.
      Installation: + The installation process of Bugzilla.
      Query/Buglist: + Anything to do with searching for bugs and viewing the + buglists.
      Reporting/Charting: + Getting reports from Bugzilla.
      User Accounts: + Anything about managing a user account from the user's perspective. + Saved queries, creating accounts, changing passwords, logging in, + etc.
      User Interface: + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, + etc.

      +

    2. Status and Resolution: + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items.

    3. Assigned To: + The person responsible for fixing the bug.

    4. *URL: + A URL associated with the bug, if any.

    5. Summary: + A one-sentence summary of the problem.

    6. *Status Whiteboard: + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.

    7. *Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.

    8. Platform and OS: + These indicate the computing environment where the bug was + found.

    9. Version: + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about.

    10. Priority: + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs.

    11. Severity: + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request.

    12. *Target: + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates.

    13. Reporter: + The person who filed the bug.

    14. CC list: + A list of people who get mail when the bug changes.

    15. Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.

    16. *Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here.

    17. *Votes: + Whether this bug has any votes.

    18. Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.

    PrevHomeNext
    Create a Bugzilla AccountUpSearching for Bugs
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/bugreports.html b/webtools/bugzilla/docs/html/bugreports.html new file mode 100644 index 00000000000..91df7f3ba34 --- /dev/null +++ b/webtools/bugzilla/docs/html/bugreports.html @@ -0,0 +1,197 @@ +Filing Bugs
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.5. Filing Bugs

    Years of bug writing experience has been distilled for your + reading pleasure into the + Bug Writing Guidelines. + While some of the advice is Mozilla-specific, the basic principles of + reporting Reproducible, Specific bugs, isolating the Product you are + using, the Version of the Product, the Component which failed, the + Hardware Platform, and Operating System you were using at the time of + the failure go a long way toward ensuring accurate, responsible fixes + for the bug that bit you.

    The procedure for filing a test bug is as follows:

    1. Go to + Landfill + in your browser and click + Enter a new bug report. +

    2. Select a product - any one will do.

    3. Fill in the fields. Bugzilla should have made reasonable + guesses, based upon your browser, for the "Platform" and "OS" + drop-down boxes. If they are wrong, change them.

    4. Select "Commit" and send in your bug report.

    PrevHomeNext
    Bug ListsUpPatch Viewer
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/cmdline.html b/webtools/bugzilla/docs/html/cmdline.html index 70af1510a48..be3ee0a5ee8 100644 --- a/webtools/bugzilla/docs/html/cmdline.html +++ b/webtools/bugzilla/docs/html/cmdline.html @@ -1,25 +1,24 @@ Command-line Bugzilla QueriesCommand-line Search Interface    		The Bugzilla Guide - 2.17.5 Development Release
    PrevNextBugzilla Variants and Competitors
    Components
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 5. Administering BugzillaNext

    5.4. Components

    Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.

    Each component has a owner and (if you turned it on in the parameters), + a QA Contact. The owner should be the primary person who fixes bugs in + that component. The QA Contact should be the person who will ensure + these bugs are completely fixed. The Owner, QA Contact, and Reporter + will get email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields only + dictate the + default assignments; + these can be changed on bug submission, or at any later point in + a bug's life.

    To create a new Component:

    1. Select the "Edit components" link from the "Edit product" + page

    2. Select the "Add" link in the bottom right.

    3. Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. +

    PrevHomeNext
    ProductsUpVersions
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/conventions.html b/webtools/bugzilla/docs/html/conventions.html index 5ba3317d3db..d646b30ef60 100644 --- a/webtools/bugzilla/docs/html/conventions.html +++ b/webtools/bugzilla/docs/html/conventions.html @@ -4,9 +4,11 @@ >Document ConventionsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release

    File NamesFile and directory namesDirectory Names directory - Commands to be typedApplications NamesApplications namesEnvironment VariablesEnvironment variablesEmphasized word word - Term found in the glossaryCode ExampleCode example

    + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or XML diffs, attached + to a bug filed in the Bugzilla Documentation component. +

    Copyright InformationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release1.1. Copyright InformationAppendix EAppendix C.

    --Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla TeamCopyright (c) 2000-2004 The Bugzilla TeamThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseChapter 6. Customising Bugzilla5.8. Change Permission Customization6.2. Customizing Who Can Change What

    This feature should be considered experimental; the Bugzilla code you will be changing is not stable, and could change or move between - versions. Be aware that if you make modifications to it, you may have + versions. Be aware that if you make modifications as outlined here, + you may have to re-make them or port them if Bugzilla changes internally between - versions. + versions, and you upgrade.

    NextUpUpgrading to New ReleasesModifying Your Running System

    If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact The Bugzilla Team. + please contact the Bugzilla Team.

    Credits
    		The Bugzilla Guide - 2.17.5 Development Release

    Matthew P. Barnson <mbarnson@sisna.com>

    for the Herculaean task of pulling together the Bugzilla Guide - and shepherding it to 2.14. -

    Terry Weissman <terry@mozilla.org>

    for initially writing Bugzilla and creating the README upon - which the UNIX installation documentation is largely based. -

    Tara Hernandez <tara@tequilarists.org>

    for keeping Bugzilla development going strong after Terry left - mozilla.org and for running landfill. -

    Dave Lawrence <dkl@redhat.com>

    for providing insight into the key differences between Red - Hat's customized Bugzilla, and being largely responsible for - Section D.1. -

    Dawn Endico <endico@mozilla.org>

    for being a hacker extraordinaire and putting up with Matthew's - incessant questions and arguments on irc.mozilla.org in #mozwebtools -

    Jacob Steenhagen <jake@bugzilla.org>

    for taking over documentation during the 2.17 development - period. -

    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. +

    Last but not least, all the members of the news://news.mozilla.org/netscape/public/mozilla/webtools netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.

    Thanks also go to the following people for significant contributions - to this documentation (in alphabetical order): - Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption - . -

    Change Permission CustomizationCustomizing Who Can Change What
    		The Bugzilla Guide - 2.17.5 Development Release
    Chapter 5. Administering BugzillaNext
    Template CustomizationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevChapter 5. Administering BugzillaChapter 6. Customising Bugzilla5.7. Template Customization6.1. Template Customization

    One of the large changes for 2.16 was the templatization of the - entire user-facing UI, using the - Template Toolkit. - Administrators can now configure the look and feel of Bugzilla without +> Administrators can configure the look and feel of Bugzilla without having to edit Perl files or face the nightmare of massive merge conflicts when they upgrade to a newer version in the future.

    Templatization also makes localized versions of Bugzilla possible, - for the first time. As of version 2.17.4 which will soon - become 2.18, it's possible to have Bugzilla's language determined by - the user's browser. More information is available in + for the first time. It's possible to have Bugzilla's UI language + determined by the user's browser. More information is available in Section 5.7.5Section 6.1.5.

    5.7.1. What to Edit

    6.1.1. What to Edit

    There are two different ways of editing of Bugzilla's templates, - and which you use depends mainly on how you upgrade Bugzilla. The - template directory structure is that there's a top level directory, +> The template directory structure is that there's a top level directory, template

    The first method of making customizations is to directly edit the +> There are two different ways of editing Bugzilla's templates, + and which you use depends mainly on the method you plan to use to + upgrade Bugzilla. + The first method of making customizations is to directly edit the templates in template/en/default

    The other method is to copy the templates into a mirrored directory +> The other method is to copy the templates to be modified into a + mirrored directory structure under template/en/custom

    5.7.2. How To Edit Templates

    The syntax of the Template Toolkit language is beyond the scope of - this guide. It's reasonably easy to pick up by looking at the current - templates; or, you can read the manual, available on the - Template Toolkit home - page. However, you should particularly remember (for security - reasons) to always HTML filter things which come from the database or - user input, to prevent cross-site scripting attacks. -

    However, one thing you should take particular care about is the need - to properly HTML filter data that has been passed into the template. - This means that if the data can possibly contain special HTML characters - such as <, and the data was not intended to be HTML, they need to be - converted to entity form, ie &lt;. You use the 'html' filter in the - Template Toolkit to do this. If you fail to do this, you may open up - your installation to cross-site scripting attacks. -

    Also note that Bugzilla adds a few filters of its own, that are not - in standard Template Toolkit. In particular, the 'url_quote' filter - can convert characters that are illegal or have special meaning in URLs, - such as &, to the encoded form, ie %26. This actually encodes most - characters (but not the common ones such as letters and numbers and so - on), including the HTML-special characters, so there's never a need to - HTML filter afterwards. -

    Editing templates is a good way of doing a "poor man's custom fields". - For example, if you don't use the Status Whiteboard, but want to have - a free-form text entry box for "Build Identifier", then you can just - edit the templates to change the field labels. It's still be called - status_whiteboard internally, but your users don't need to know that. -

    6.1.2. How To Edit Templates

    The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + Template Toolkit home + page. +

    One thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you forget, you may open up + your installation to cross-site scripting attacks. +

    Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. +

    Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. +

    5.7.3. Template Formats

    6.1.3. Template Formats

    Some CGIs have the ability to use more than one template. For example, buglist.cgi can output bug lists as RDF or two @@ -350,9 +345,9 @@ CLASS="filename"

    To see if a CGI supports multiple output formats, grep the - CGI for "ValidateOutputFormat". If it's not present, adding + CGI for "GetFormat". If it's not present, adding multiple format support isn't too hard - see how it's done in - other CGIs. + other CGIs, e.g. config.cgi.

    To make a new format template for a CGI which supports this, @@ -396,9 +391,9 @@ CLASS="section" >

    5.7.4. Particular Templates

    6.1.4. Particular Templates

    There are a few templates you may be particularly interested in customizing for your installation. @@ -454,21 +449,6 @@ CLASS="command" >

    bug/process/midair.html.tmpl: - This is the page used if two people submit simultaneous changes to the - same bug. The second person to submit their changes will get this page - to tell them what the first person did, and ask if they wish to - overwrite those changes or go back and revisit the bug. The default - title and header on this page read "Mid-air collision detected!" If - you work in the aviation industry, or other environment where this - might be found offensive (yes, we have true stories of this happening) - you'll want to change this to something more appropriate for your - environment. -

    bug/create/create.html.tmpl and 5.7.5. Configuring Bugzilla to Detect the User's Language6.1.5. Configuring Bugzilla to Detect the User's Language

    Begining in version 2.18 (first introduced in version - 2.17.4), it's now possible to have the users web browser tell Bugzilla - which language templates to use for each visitor (using the HTTP_ACCEPT - header). For this to work, Bugzilla needs to have the correct language - templates installed for the version of Bugzilla you are using. Many +>Bugzilla honours the user's Accept: HTTP header. You can install + templates in other languages, and Bugzilla will pick the most appropriate + according to a priority order defined by you. Many language templates can be obtained from After untarring the localizations (or creating your own) in the [Bugzilla_Root]/template$BUGZILLA_HOME/template directory, you must update the PrevBugzilla SecurityCustomising BugzillaUpChange Permission CustomizationCustomizing Who Can Change What

    Customising Bugzilla
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevNext
    PrevHomeNext
    Upgrading to New Releases Template Customization
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/database.html b/webtools/bugzilla/docs/html/database.html index d9bc26c2cad..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/database.html +++ b/webtools/bugzilla/docs/html/database.html @@ -1,182 +0,0 @@ -The Bugzilla Database
    The Bugzilla Guide - 2.17.5 Development Release
    PrevNext

    Appendix B. The Bugzilla Database

    This document really needs to be updated with more fleshed out - information about primary keys, interrelationships, and maybe some nifty - tables to document dependencies. Any takers?

    PrevHomeNext
    The Bugzilla FAQ Modifying Your Running System
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/dbdoc.html b/webtools/bugzilla/docs/html/dbdoc.html index 8f250c0f64a..73a7e61c4f7 100644 --- a/webtools/bugzilla/docs/html/dbdoc.html +++ b/webtools/bugzilla/docs/html/dbdoc.html @@ -4,19 +4,21 @@ >MySQL Bugzilla Database IntroductionThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix B. The Bugzilla DatabaseChapter 6. Customising BugzillaNextB.2. MySQL Bugzilla Database Introduction6.4. MySQL Bugzilla Database Introduction

    This information comes straight from my life. I was forced to learn how Bugzilla organizes database because of nitpicky requests from users @@ -134,9 +137,9 @@ CLASS="section" >

    B.2.1. Bugzilla Database Basics

    6.4.1. Bugzilla Database Basics

    If you were like me, at this point you're totally clueless about the internals of MySQL, and if it weren't for this executive order from @@ -248,9 +251,9 @@ CLASS="section" >

    B.2.1.1. Bugzilla Database Tables

    6.4.1.1. Bugzilla Database Tables

    Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command:

    NextUpUseful Patches and Utilities for BugzillaIntegrating Bugzilla with Third-Party ToolsModifying Your Running SystemThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevAppendix B. The Bugzilla DatabaseChapter 6. Customising BugzillaB.1. Modifying Your Running System6.3. Modifying Your Running System

    Bugzilla optimizes database lookups by storing all relatively static information in the @@ -132,7 +135,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevThe Bugzilla DatabaseCustomizing Who Can Change WhatUpDisclaimerThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release1.2. Disclaimer

    No liability for the contents of this document can be accepted. - Use the concepts, examples, and other content at your own risk. + Follow the instructions herein at your own risk. This document may contain errors and inaccuracies that may damage your system, cause your partner to leave you, your boss to fire you, your cats to @@ -85,35 +88,20 @@ NAME="disclaimer" war. Proceed with caution.

    All copyrights are held by their respective owners, unless - specifically noted otherwise. Use of a term in this document - should not be regarded as affecting the validity of any - trademark or service mark. -

    Naming of particular products or brands should not be seen as endorsements, with the exception of the term "GNU/Linux". We - wholeheartedly endorse the use of GNU/Linux in every situation - where it is appropriate. It is an extremely versatile, stable, + wholeheartedly endorse the use of GNU/Linux; it is an extremely + versatile, stable, and robust operating system that offers an ideal operating environment for Bugzilla.

    You are strongly recommended to make a backup of your system - before installing Bugzilla and at regular intervals thereafter. - If you implement any suggestion in this Guide, implement this one! -

    Although the Bugzilla development team has taken great care to - ensure that all easily-exploitable bugs or options are - documented or fixed in the code, security holes surely exist. - Great care should be taken both in the installation and usage of - this software. Carefully consider the implications of installing - other network services with Bugzilla. The Bugzilla development - team members, Netscape Communications, America Online Inc., and - any affiliated developers or sponsors assume no liability for - your use of this product. You have the source code to this - product, and are responsible for auditing it yourself to ensure + ensure that all exploitable bugs or options have been + fixed, security holes surely exist. 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 + the source code, and are responsible for auditing it yourself to ensure your security needs are met.

    Optional Additional ConfigurationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev4.2. Optional Additional Configuration4.3. Optional Additional Configuration

    4.2.1. Dependency Charts

    4.3.1. Dependency Charts

    As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. @@ -144,9 +147,9 @@ CLASS="section" >

    4.2.2. Bug Graphs

    4.3.2. Bug Graphs

    As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs.

    4.2.3. The Whining Cron

    4.3.3. The Whining Cron

    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 @@ -294,47 +297,11 @@ CLASS="section" >4.2.4. LDAP Authentication

    4.3.4. LDAP Authentication

    LDAP authentication has been rewritten for the 2.18 release of - Bugzilla. It no longer requires the Mozilla::LDAP module and now uses - Net::LDAP instead. This rewrite was part of a larger landing that - allowed for additional authentication schemes to be easily added - (bug - 180642). -

    This patch originally landed in 21-Mar-2003 and was included - in the 2.17.4 development release. -

    LDAP authentication is a module for Bugzilla's plugin + authentication architecture. +

    The existing authentication scheme for Bugzilla uses email addresses as the primary user ID, and a @@ -544,26 +511,26 @@ CLASS="section" >4.2.5. Preventing untrusted Bugzilla content from executing malicious +>4.3.5. Preventing untrusted Bugzilla content from executing malicious Javascript code

    It is possible for a Bugzilla to execute malicious Javascript - code. Due to internationalization concerns, we are unable to - incorporate the code changes necessary to fulfill the CERT advisory - requirements mentioned in +>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. + Due to internationalization concerns, we are unable to + incorporate by default the code changes necessary to fulfill the CERT + advisory requirements mentioned in http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3. - Making the change below will fix the problem if your installation is for - an English speaking audience. + If your installation is for an English speaking audience only, making the + change below will prevent this problem.

    Telling Bugzilla to output a charset as part of the HTTP header is - much easier in version 2.18 and higher (including any cvs - pull after 4-May-2003 and development release after 2.17.5) than it was - in previous versions. Simply locate the following line in +>Simply locate the following line in Bugzilla/CGI.pm

    
    # Make sure that we don't send any charset headers
-    $self->charset('');
+>
    $self->charset('');
       
    
    # Send all data using the ISO-8859-1 charset
-    $self->charset('ISO-8859-1');
+>
    $self->charset('ISO-8859-1');

    Using <meta> tags to set the charset is not - recommended, as there's a bug in Netscape 4.x which causes pages - marked up in this way to load twice. See - bug 126266 - for more information including progress toward making - bugzilla charset aware by default. -

    4.2.6. directoryindex for the Bugzilla default page.

    You should modify the <DirectoryIndex> parameter for - the Apache virtual host running your Bugzilla installation to - allow index.cgi as the index page for a - directory, as well as the usual index.html, - index.htm, and so forth.

    4.2.7. Bugzilla and 4.3.6. Bugzilla and mod_perl4.2.8. 4.3.7. mod_throttle @@ -754,7 +656,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevStep-by-step InstallHTTP Server ConfigurationThe Bugzilla FAQThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseNext
    A.1.1. Where can I find information about Bugzilla?
    A.1.2. What license is Bugzilla distributed under?
    A.1.3. A.1.2. How do I get commercial support for Bugzilla?
    A.1.4. A.1.3. What major companies or projects are currently using Bugzilla for bug-tracking?
    A.1.5. A.1.4. Who maintains Bugzilla?
    A.1.6. A.1.5. How does Bugzilla stack up against other bug-tracking databases?
    A.1.7. A.1.6. Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?
    A.1.8. A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL.
    A.1.9. A.1.8. What is
    A.1.10. A.1.9. My perl is not located at
    A.1.11. A.1.10. Is there an easy way to change the Bugzilla cookie name?
    A.2.2. Can Bugzilla integrate with - Perforce (SCM software)? -
    A.2.3. Does Bugzilla allow the user to track multiple projects? -
    A.2.4. If I am on many projects, and search for all bugs assigned to me, will - Bugzilla list them for me and allow me to sort by project, severity etc? -
    A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, - are there any that are NOT allowed? -
    A.2.6. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and @@ -211,35 +182,28 @@ HREF="faq.html#faq-phb-priorities"
    A.2.7. A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :)
    A.2.8. A.2.4. Is there email notification and if so, what do you see when you get an email?
    A.2.9. Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? -
    A.2.10. A.2.5. Do users have to have any particular type of email application?
    A.2.11. A.2.6. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be @@ -248,28 +212,21 @@ HREF="faq.html#faq-phb-data"
    A.2.12. A.2.7. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable?
    A.2.13. A.2.8. Can a user create and save reports? Can they do this in Word format? Excel format?
    A.2.14. Does Bugzilla have the ability to search by word, phrase, compound - search? -
    A.2.15. A.2.9. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use @@ -277,29 +234,29 @@ HREF="faq.html#faq-phb-midair"
    A.2.16. A.2.10. Are there any backup features provided?
    A.2.17. A.2.11. Can users be on the system while a backup is in progress?
    A.2.18. A.2.12. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an - "Out-of-the-Box" solution. + "out-of-the-box" solution?
    A.2.19. A.2.13. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to @@ -309,7 +266,7 @@ HREF="faq.html#faq-phb-installtime"
    A.2.20. A.2.14. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -337,14 +294,6 @@ HREF="faq.html#faq-security-knownproblems" > Are there any security problems with Bugzilla?
    A.3.3. I've implemented the security fixes mentioned in Chris Yeh's security - advisory of 5/10/2000 advising not to run MySQL as root, and am running into - problems with MySQL no longer working correctly. -
    A.4.3. I want whineatnews.pl to whine at something more, or other than, only new +> I want whineatnews.pl to whine at something different to only new bugs. How do I do it?
    A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? -
    A.4.5. How do I set up the email interface to submit/change bugs via email?
    A.4.6. A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives?
    A.4.7. A.4.6. How come email from Bugzilla changes never reaches me?

    A.1.1. - Where can I find information about Bugzilla?

    - You can stay up-to-date with the latest Bugzilla - information at http://www.bugzilla.org/. -

    A.1.2. A.1.1. What license is Bugzilla distributed under?

    A.1.3. A.1.2. How do I get commercial support for Bugzilla?

    http://www.collab.net/ offers - Bugzilla as part of their standard offering to large projects. - They do have some minimum fees that are pretty hefty, and generally - aren't interested in small projects. -

    There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing to make themselves available for generous compensation. @@ -681,7 +585,7 @@ CLASS="question" NAME="faq-general-companies" >A.1.4. A.1.3. What major companies or projects are currently using Bugzilla for bug-tracking? @@ -699,9 +603,9 @@ CLASS="answer" Bugzilla sites to track bugs in their products. We have a fairly complete list available on our website at http://bugzilla.org/installation_list.htmlhttp://bugzilla.org/installation-list/. If you have an installation of Bugzilla and would like to be added to the list, whether it's a public install or not, simply e-mail @@ -711,11 +615,7 @@ CLASS="email" HREF="mailto:gerv@mozilla.org" >gerv@mozilla.org>. Keep in mind that it's kinda - difficult to get onto the "high-profile" list ;). +>.

    A.1.5. A.1.4. Who maintains Bugzilla?

    A.1.6. A.1.5. How does Bugzilla stack up against other bug-tracking databases?

    A.1.7. A.1.6. Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software? @@ -836,7 +736,7 @@ CLASS="question" NAME="faq-general-mysql" >A.1.8. A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL. @@ -881,7 +781,7 @@ CLASS="question" NAME="faq-general-bonsaitools" >A.1.9. A.1.8. What is A.1.10. A.1.9. My perl is not located at A.1.11. A.1.10. Is there an easy way to change the Bugzilla cookie name?

    2. Managerial Questions

    Questions likely to be asked by managers. :-) -

    -

    - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the web. -

    A.2.2. - Can Bugzilla integrate with - Perforce (SCM software)? -

    - Yes! You can find more information elsewhere in "The Bugzilla - Guide" in the "Integration with Third-Party Products" section. -

    A.2.3. - Does Bugzilla allow the user to track multiple projects? -

    - Absolutely! You can track any number of Products that can each be - composed of any number of Components. -

    A.2.4. - If I am on many projects, and search for all bugs assigned to me, will - Bugzilla list them for me and allow me to sort by project, severity etc? -

    - Yes. -

    A.2.5. - Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, - are there any that are NOT allowed? -

    - Yes - any sort of attachment is allowed, although administrators can - configure a maximum size. - Bugzilla gives the user the option of either using the MIME-type - supplied by the browser, choosing from a pre-defined list or - manually typing any arbitrary MIME-type. + It is web and e-mail based.

    A.2.6. A.2.2. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and @@ -1202,7 +966,7 @@ CLASS="question" NAME="faq-phb-reporting" >A.2.7. A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -1240,7 +1004,7 @@ CLASS="question" NAME="faq-phb-email" >A.2.8. A.2.4. Is there email notification and if so, what do you see when you get an email? @@ -1253,7 +1017,7 @@ CLASS="answer" > Email notification is user-configurable. By default, the bug id and - Summary of the bug report accompany each email notification, along with + summary of the bug report accompany each email notification, along with a list of the changes made.

    A.2.9. - Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? -

    - Yes. -

    A.2.10. A.2.5. Do users have to have any particular type of email application? @@ -1351,7 +1090,7 @@ CLASS="question" NAME="faq-phb-data" >A.2.11. A.2.6. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be @@ -1368,7 +1107,7 @@ CLASS="answer" Bugzilla can output buglists as HTML (the default), CSV or RDF. The link for CSV can be found at the bottom of the buglist in HTML format. This CSV format can easily be imported into MS Excel or - other spread-sheet applications. + other spreadsheet applications.

    To use the RDF format of the buglist it is necessary to append a @@ -1377,7 +1116,7 @@ CLASS="computeroutput" >&ctype=rdf to the URL. RDF is meant to be machine readable and thus it is assumed that the - URL would be generated progmatically so there is no user visible + URL would be generated programatically so there is no user visible link to this format.

    A.2.12. A.2.7. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? @@ -1451,7 +1190,7 @@ CLASS="question" NAME="faq-phb-reports" >A.2.13. A.2.8. Can a user create and save reports? Can they do this in Word format? Excel format? @@ -1473,36 +1212,10 @@ CLASS="qandaentry" CLASS="question" >

    A.2.14. - Does Bugzilla have the ability to search by word, phrase, compound - search? -

    - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. -

    A.2.15. A.2.9. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use @@ -1529,7 +1242,7 @@ CLASS="question" NAME="faq-phb-backup" >A.2.16. A.2.10. Are there any backup features provided?

    A.2.17. A.2.11. Can users be on the system while a backup is in progress?

    A.2.18. A.2.12. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an - "Out-of-the-Box" solution. + "out-of-the-box" solution?

    A.2.19. A.2.13. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to @@ -1653,7 +1366,7 @@ CLASS="question" NAME="faq-phb-cost" >A.2.20. A.2.14. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -1735,34 +1448,6 @@ CLASS="answer"

    A.3.3. - I've implemented the security fixes mentioned in Chris Yeh's security - advisory of 5/10/2000 advising not to run MySQL as root, and am running into - problems with MySQL no longer working correctly. -

    - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts - mysqld. -

    A.4.3. - I want whineatnews.pl to whine at something more, or other than, only new + I want whineatnews.pl to whine at something different to only new bugs. How do I do it?

    A.4.4. - I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? -

    - You can call bug_email.pl directly from your aliases file, with - an entry like this: -

    bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" -

    - However, this is fairly nasty and subject to problems; you also - need to set up your smrsh (sendmail restricted shell) to allow - it. In a pinch, though, it can work. -

    A.4.5. A.4.4. How do I set up the email interface to submit/change bugs via email?

    A.4.6. A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? @@ -1945,7 +1591,21 @@ CLASS="answer" > - If you are using an alternate sendmail, try enabling + sendmailnow in editparams.cgi. + +

    If you are using an alternate on. -

    If you are using sendmail, try enabling - sendmailnow in editparams.cgi. -

    A.4.7. A.4.6. How come email from Bugzilla changes never reaches me?

    If you never receive mail from Bugzilla, chances you do not have +> If you never receive mail from Bugzilla, chances are you do not have sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked to, "/usr/lib/sendmail".

    - Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle, + but it is now so old as to be obsolete, and is totally unsupported. Red Hat's newer version (based on 2.17.1 and soon to be merged into the main distribution) runs on PostgreSQL. At this time we know of - no recent ports of Bugzilla to Oracle but do intend to support it - in the future (possibly the 2.20 time-frame). + no recent ports of Bugzilla to Oracle; to be honest, Bugzilla + doesn't need what Oracle offers.

    utility (./sanitycheck.cgi in the - Bugzilla_home directory) from your web browser to see! If - it finishes without errors, you're +>sanitycheck.cgi    ) from your web browser to see! + If it finishes without errors, you're probably OK. If it doesn't come back @@ -2328,7 +1974,7 @@ CLASS="answer" >

    Microsoft has some advice on this matter, as well:

    NextThe Bugzilla DatabaseContribPREAMBLEThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseAPPLICABILITY AND DEFINITIONSThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseFUTURE REVISIONS OF THIS LICENSEThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseVERBATIM COPYINGThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseCOPYING IN QUANTITYThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseMODIFICATIONSThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseCOMBINING DOCUMENTSThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseCOLLECTIONS OF DOCUMENTSThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseAGGREGATION WITH INDEPENDENT WORKSThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseTRANSLATIONThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseTERMINATIONThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation LicenseHow to use this License for your documentsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation License
    GNU Free Documentation LicenseThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevAppendix E. GNU Free Documentation LicenseAppendix C. GNU Free Documentation License

    Version 1.1, March 2000

    PrevSourceForgeCommand-line Search InterfaceGlossaryThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release

    0-9, high ascii

    For more information about how to configure Apache for Bugzilla, see Section 4.4.1Section 4.2.1.

    Much more detailed information about the suggestions in Section 5.6.2Section 4.5.2.

    Groups and Group SecurityThe Bugzilla Guide - 2.17.5 + Development Release5.5. Groups and Group Security5.8. Groups and Group Security

    Groups allow the administrator to isolate bugs or products that should only be seen by certain people. @@ -213,9 +216,10 @@ ALT="Warning">

    The User Regexp is a perl regexp and, if not anchored, will match - any part of an address. So, if you do not want to grant access - into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use +>If specifying a domain in the regexp, make sure you end + the regexp with a $. Otherwise, when granting access to + "@mycompany\.com", you will allow access to + 'badperson@mycompany.com.cracker.net'. You need to use '@mycompany\.com$' as the regexp.

    NextBugzilla SecurityUpgrading to New Releases
    The Bugzilla Guide - 2.17.5 Development Release
    Next
    Hints and TipsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev3.2. Hints and Tips3.7. Hints and Tips

    This section distills some Bugzilla tips and best practices that have been developed.

    3.2.1. Autolinkification

    3.7.1. Autolinkification

    Bugzilla comments are plain text - so posting HTML will result - in literal HTML tags rather than being interpreted by a browser. +>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 + "http://www.bugzilla.org" will be turned into a link: comment 7bug 23456, comment 533.2.2. Quicksearch3.7.2. Quicksearch

    Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing @@ -183,7 +190,7 @@ CLASS="section" >3.2.3. Comments3.7.3. Comments

    If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. @@ -196,7 +203,7 @@ NAME="commenting"

    Don't use sigs in comments. Signing your name ("Bill") is acceptable, - particularly if you do it out of habit, but full mail/news-style + if you do it out of habit, but full mail/news-style four line ASCII art creations are not.

    3.2.4. Attachments3.7.4. Attachments

    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 @@ -231,9 +238,9 @@ CLASS="section" >

    3.2.5. Filing Bugs

    3.7.5. Filing Bugs

    Try to make sure that everything said in the summary is also said in the first comment. Summaries are often updated and this will @@ -268,7 +275,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevHow do I use Bugzilla?Patch ViewerHow do I use Bugzilla?

    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 3. Using BugzillaNext

    3.1. How do I use Bugzilla?

    This section contains information for end-users of Bugzilla. - There is a Bugzilla test installation, called - Landfill, - which you are welcome to play with (if it's up.) - However, it does not necessarily - have all Bugzilla features enabled, and often runs cutting-edge versions - of Bugzilla for testing, so some things may work slightly differently - than mentioned here.

    3.1.1. Create a Bugzilla Account

    If you want to use Bugzilla, first you need to create an account. - Consult with the administrator responsible for your installation of - Bugzilla for the URL you should use to access it. If you're - test-driving Bugzilla, use this URL: - http://landfill.bugzilla.org/bugzilla-tip/. -

    1. Click the - "Open a new Bugzilla account" - - link, enter your email address and, optionally, your name in the - spaces provided, then click - "Create Account" - - .

    2. Within moments, you should receive an email to the address - you provided above, which contains your login name (generally the - same as the email address), and a password you can use to access - your account. This password is randomly generated, and can be - changed to something more memorable.

    3. Click the - "Log In" - link in the yellow area at the bottom of the page in your browser, - enter your email address and password into the spaces provided, and - click - "Login". -

    You are now logged in. Bugzilla uses cookies for authentication - so, unless your IP address changes, you should not have to log in - again.

    3.1.2. Anatomy of a Bug

    The core of Bugzilla is the screen which displays a particular - bug. It's a good place to explain some Bugzilla concepts. - Bug 1 on Landfill - - is a good example. Note that the labels for most fields are hyperlinks; - clicking them will take you to context-sensitive help on that - particular field. Fields marked * may not be present on every - installation of Bugzilla.

    1. Product and Component: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: -

      Administration: - Administration of a Bugzilla installation.
      Bugzilla-General: - Anything that doesn't fit in the other components, or spans - multiple components.
      Creating/Changing Bugs: - Creating, changing, and viewing bugs.
      Documentation: - The Bugzilla documentation, including The Bugzilla Guide.
      Email: - Anything to do with email sent by Bugzilla.
      Installation: - The installation process of Bugzilla.
      Query/Buglist: - Anything to do with searching for bugs and viewing the - buglists.
      Reporting/Charting: - Getting reports from Bugzilla.
      User Accounts: - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc.
      User Interface: - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc.

      -

    2. Status and Resolution: - - These define exactly what state the bug is in - from not even - being confirmed as a bug, through to being fixed and the fix - confirmed by Quality Assurance. The different possible values for - Status and Resolution on your installation should be documented in the - context-sensitive help for those items.

    3. Assigned To: - The person responsible for fixing the bug.

    4. *URL: - A URL associated with the bug, if any.

    5. Summary: - A one-sentence summary of the problem.

    6. *Status Whiteboard: - (a.k.a. Whiteboard) A free-form text area for adding short notes - and tags to a bug.

    7. *Keywords: - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression.

    8. Platform and OS: - These indicate the computing environment where the bug was - found.

    9. Version: - The "Version" field is usually used for versions of a product which - have been released, and is set to indicate which versions of a - Component have the particular problem the bug report is - about.

    10. Priority: - The bug assignee uses this field to prioritise his or her bugs. - It's a good idea not to change this on other people's bugs.

    11. Severity: - This indicates how severe the problem is - from blocker - ("application unusable") to trivial ("minor cosmetic issue"). You - can also use this field to indicate whether a bug is an enhancement - request.

    12. *Target: - (a.k.a. Target Milestone) A future version by which the bug is to - be fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not - restricted to numbers, thought - you can use any text strings, such - as dates.

    13. Reporter: - The person who filed the bug.

    14. CC list: - A list of people who get mail when the bug changes.

    15. Attachments: - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section.

    16. *Dependencies: - If this bug cannot be fixed unless other bugs are fixed (depends - on), or this bug stops other bugs being fixed (blocks), their - numbers are recorded here.

    17. *Votes: - Whether this bug has any votes.

    18. Additional Comments: - You can add your two cents to the bug discussion here, if you have - something worthwhile to say.

    3.1.3. Searching for Bugs

    The Bugzilla Search page is is the interface where you can find - any bug report, comment, or patch currently in the Bugzilla system. You - can play with it here: - http://landfill.bugzilla.org/bugzilla-tip/query.cgi.

    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 one of the selected - values. If none is selected, then the field can take any value.

    Once you've defined a search, you can either run it, or save it - as a Remembered Query, which can optionally appear in the footer of - your pages.

    Highly advanced querying is done using Boolean Charts.

    3.1.4. Bug Lists

    If you run a search, a list of matching bugs will be returned. - The default search is to return all open bugs on the system - don't try - running this search on a Bugzilla installation with a lot of - bugs!

    The format of the list is configurable. For example, it can be - sorted by clicking the column headings. Other useful features can be - accessed using the links at the bottom of the list: -

    Long Format: - - this gives you a large page with a non-editable summary of the fields - of each bug.
    Change Columns: - - change the bug attributes which appear in the list.
    Change several bugs at once: - - If your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner.
    Send mail to bug owners: - - Sends mail to the owners of all bugs on the list.
    Edit this query: - - If you didn't get exactly the results you were looking for, you can - return to the Query page through this link and make small revisions - to the query you just made so you get more accurate results.

    -

    3.1.5. Filing Bugs

    Years of bug writing experience has been distilled for your - reading pleasure into the - Bug Writing Guidelines. - While some of the advice is Mozilla-specific, the basic principles of - reporting Reproducible, Specific bugs, isolating the Product you are - using, the Version of the Product, the Component which failed, the - Hardware Platform, and Operating System you were using at the time of - the failure go a long way toward ensuring accurate, responsible fixes - for the bug that bit you.

    The procedure for filing a test bug is as follows:

    1. Go to - Landfill - in your browser and click - Enter a new bug report. -

    2. Select a product - any one will do.

    3. Fill in the fields. Bugzilla should have made reasonable - guesses, based upon your browser, for the "Platform" and "OS" - drop-down boxes. If they are wrong, change them.

    4. Select "Commit" and send in your bug report.

    3.1.6. Patch Viewer

    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.

    Patch viewer allows you to:

    View patches in color, with side-by-side view rather than trying - to interpret the contents of the patch.
    See the difference between two patches.
    Get more context in a patch.
    Collapse and expand sections of a patch for easy - reading.
    Link to a particular section of a patch for discussion or - review
    Go to Bonsai or LXR to see more context, blame, and - cross-references for the part of the patch you are looking at
    Create a rawtext unified format diff out of any patch, no - matter what format it came from

    3.1.6.1. Viewing Patches in Patch Viewer

    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.

    3.1.6.2. Seeing the Difference Between Two Patches

    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.

    3.1.6.3. Getting More Context in a Patch

    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".

    3.1.6.4. Collapsing and Expanding Sections of a Patch

    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.

    3.1.6.5. Linking to a Section of a Patch

    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.)

    3.1.6.6. Going to Bonsai and LXR

    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.

    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).

    3.1.6.7. Creating a Unified Diff

    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.

    PrevHomeNext
    Using BugzillaUpHints and Tips
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/http.html b/webtools/bugzilla/docs/html/http.html index 8f3b76d05e7..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/http.html +++ b/webtools/bugzilla/docs/html/http.html @@ -1,697 +0,0 @@ -HTTP Server Configuration
    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 4. InstallationNext

    4.4. HTTP Server Configuration

    The Bugzilla Team recommends Apache when using Bugzilla, however, any web server - that can be configured to run CGI scripts - should be able to handle Bugzilla. No matter what web server you choose, but - especially if you choose something other than Apache, you should be sure to read - Section 5.6.4. -

    The plan for this section is to eventually document the specifics of how to lock - down permissions on individual web servers. -

    4.4.1. Apache httpd

    As mentioned above, the Bugzilla Team recommends Apache for use - with Bugzilla. You will have to make sure that Apache is properly - configured to run the Bugzilla CGI scripts. You also need to make sure - that the .htaccess files created by - ./checksetup.pl (shown in Example 4-2 - for the curious) are allowed to override Apache's normal access - permissions or else important password information may be exposed to the - Internet. -

    Many Apache installations are not configured to run scripts - anywhere but in the cgi-bin - directory; however, we recommend that Bugzilla not be installed in the - cgi-bin, otherwise the static - files such as images and JavaScript - will not work correctly. To allow scripts to run in the normal - web space, the following changes should be made to your - httpd.conf file. -

    To allow files with a .cgi extension to be run, make sure the - following line exists and is uncommented:

    
AddHandler cgi-script .cgi
-

    To allow .htaccess files to override - permissions and .cgi files to run in the Bugzilla directory, make sure - the following two lines are in a Directory - directive that applies to the Bugzilla directory on your system - (either the Bugzilla directory or one of its parents). - 

    
Options +ExecCGI
-AllowOverride Limit
-

    For more information on Apache and its directives, see the - glossary entry on Apache. -

    Example 4-2. .htaccess files for Apache

    $BUGZILLA_HOME/.htaccess - 
    
# don't allow people to retrieve non-cgi executable files or our private data
-<FilesMatch ^(.*\.pl|.*localconfig.*|runtests.sh)$>
-  deny from all
-</FilesMatch>
-<FilesMatch ^(localconfig.js|localconfig.rdf)$>
-  allow from all
-</FilesMatch>
-
    -

    $BUGZILLA_HOME/data/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory; the only exception is duplicates.rdf, which is used by
-# duplicates.xul and must be loadable over the web
-deny from all
-<Files duplicates.rdf>
-  allow from all
-</Files>
-
    -

    $BUGZILLA_HOME/data/webdot - 
    
# Restrict access to .dot files to the public webdot server at research.att.com 
-# if research.att.com ever changed their IP, or if you use a different
-# webdot server, you'll need to edit this
-<FilesMatch ^[0-9]+\.dot$>
-  Allow from 192.20.225.10
-  Deny from all
-</FilesMatch>
-
-# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
-# .map files
-<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
-  Allow from all
-</FilesMatch>
-
-# And no directory listings, either.
-Deny from all
-
    -

    $BUGZILLA_HOME/Bugzilla/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
    -

    $BUGZILLA_HOME/template/.htaccess - 
    
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
    -

    4.4.2. Microsoft Internet Information Services

    If you need, or for some reason even want, to use Microsoft's - Internet Information Services or - Personal Web Server you should be able - to. You will need to configure them to know how to run CGI scripts, - however. This is described in Microsoft Knowledge Base article - Q245225 - for Internet Information Services and - Q231998 - for Personal Web Server. -

    Also, and this can't be stressed enough, make sure that files such as - localconfig and your data - directory are secured as described in Section 5.6.4. -

    4.4.3. AOL Server

    Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. -

    AOL Server will have to be configured to run - CGI scripts, please consult - the documentation that came with your server for more information on - how to do this. -

    Because AOL Server doesn't support .htaccess - files, you'll have to create a TCL - script. You should create an aolserver/modules/tcl/filter.tcl - file (the filename shouldn't matter) with the following contents (change - /bugzilla/ to the web-based path to - your Bugzilla installation): - 

    
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
-ns_register_filter preauth GET /bugzilla/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"
-}
-

    This probably doesn't account for all possible editor backup - files so you may wish to add some additional variations of - localconfig. For more information, see - bug 186383 or Bugtraq ID 6501. -

    If you are using webdot from research.att.com (the default - configuration for the webdotbase paramater), you - will need to allow access to data/webdot/*.dot - for the reasearch.att.com machine. -

    If you are using a local installation of GraphViz, you will need to allow - everybody to access *.png, - *.gif, *.jpg, and - *.map in the - data/webdot directory. -

    PrevHomeNext
    OS Specific Installation NotesUpTroubleshooting
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/index.html b/webtools/bugzilla/docs/html/index.html index 3c91d11aaf7..61cce5ee5fc 100644 --- a/webtools/bugzilla/docs/html/index.html +++ b/webtools/bugzilla/docs/html/index.html @@ -1,10 +1,12 @@ The Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseThe Bugzilla Guide - 2.17.5 Development Release

    Matthew P. Barnson

    Jacob Steenhagen

    The Bugzilla Guide - 2.17.5 + Development Release

    The Bugzilla Team

    2003-11-01

    2004-01-15

    This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. +> This is the documentation for Bugzilla, a + bug-tracking system from mozilla.org. Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. + that tracks millions of bugs and issues for hundreds of + organizations around the world.

    - This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the Bugzilla Documentation component. -

    This is a development version of this guide. Information in it - is subject to change before the 2.18 release of this guide - (which will correspond with the 2.18 release of Bugzilla). -

    The most current version of this document can always be found on the Bugzilla Documentation PageBugzilla + Documentation Page.

    2.1. What is Bugzilla?
    2.2. Why Should We Use Bugzilla?Why use a bug-tracking system?
    2.3. Why use Bugzilla?
    3.1. How do I use Bugzilla?Create a Bugzilla Account
    3.2. Anatomy of a Bug
    3.3. Searching for Bugs
    3.4. Bug Lists
    3.5. Filing Bugs
    3.6. Patch Viewer
    3.7. Hints and Tips
    3.3. 3.8. User Preferences
    3.9. Reports
    4.2. Optional Additional Configuration
    4.3. OS Specific Installation Notes
    4.4. HTTP Server Configuration
    4.3. Optional Additional Configuration
    4.4. OS Specific Installation Notes
    4.5. Bugzilla Security
    4.6. Troubleshooting
    5.3. Product, Component, Milestone, and Version AdministrationProducts
    5.4. Components
    5.5. Versions
    5.6. Milestones
    5.7. Voting
    5.5. 5.8. Groups and Group Security
    5.6. Bugzilla Security
    5.7. Template Customization
    5.8. Change Permission Customization
    5.9. Upgrading to New Releases
    5.10. 6. Customising Bugzilla
    6.1. Template Customization
    6.2. Customizing Who Can Change What
    6.3. Modifying Your Running System
    6.4. MySQL Bugzilla Database Introduction
    6.5. Integrating Bugzilla with Third-Party Tools
    B. The Bugzilla DatabaseContrib
    B.1. Modifying Your Running System
    B.2. MySQL Bugzilla Database IntroductionCommand-line Search Interface
    C. Useful Patches and Utilities for Bugzilla
    C.1. Apache - mod_rewrite - - magic
    C.2. Command-line Bugzilla Queries
    D. Bugzilla Variants and Competitors
    D.1. Red Hat Bugzilla
    D.2. Loki Bugzilla (Fenris)
    D.3. Issuezilla
    D.4. Scarab
    D.5. Perforce SCM
    D.6. SourceForge
    E. GNU Free Documentation License
    Installing perl modules with CPAN
    4-2. .htaccess files for Apache
    5-1. Upgrading using CVSInstallationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev
    4.1.1. MySQL
    4.1.2. Perl
    4.1.3. Perl Modules4.1.2. MySQL
    4.1.4. 4.1.3. HTTP Server
    4.1.5. 4.1.4. Bugzilla
    4.1.6. Setting Up the MySQL Database4.1.5. Perl Modules
    4.1.7. 4.1.6. checksetup.pl
    4.1.8. 4.1.7. Configuring Bugzilla
    4.2. HTTP Server Configuration
    4.2.1. Apache httpd
    4.2.2. Microsoft Internet Information Services
    4.2.3. AOL Server
    4.3. Optional Additional Configuration
    4.2.1. 4.3.1. Dependency Charts
    4.2.2. 4.3.2. Bug Graphs
    4.2.3. 4.3.3. The Whining Cron
    4.2.4. 4.3.4. LDAP Authentication
    4.2.5. 4.3.5. Preventing untrusted Bugzilla content from executing malicious Javascript code
    4.2.6. directoryindex for the Bugzilla default page.
    4.2.7. 4.3.6. Bugzilla and
    4.2.8. 4.3.7.
    4.3. 4.4. OS Specific Installation Notes
    4.3.1. 4.4.1. Microsoft Windows
    4.3.2. 4.4.2.
    4.3.3. 4.4.3. Linux-Mandrake 8.0
    4.4. HTTP Server Configuration4.5. Bugzilla Security
    4.4.1. Apache httpd4.5.1. TCP/IP Ports
    4.4.2. Microsoft Internet Information Services4.5.2. MySQL
    4.4.3. AOL Server4.5.3. Daemon Accounts
    4.5.4. Web Server Access Controls
    4.5. 4.6. Troubleshooting
    4.5.1. 4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1
    4.5.2. 4.6.2. DBD::Sponge::db prepare failed
    4.5.3. 4.6.3. cannot chdir(/var/spool/mqueue)
    4.5.4. 4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT
    PrevUser PreferencesReportsIntegrating Bugzilla with Third-Party ToolsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevChapter 5. Administering BugzillaChapter 6. Customising Bugzilla5.10. Integrating Bugzilla with Third-Party Tools6.5. Integrating Bugzilla with Third-Party Tools

    5.10.1. Bonsai

    6.5.1. Bonsai

    Bonsai is a web-based tool for managing 5.10.2. CVS6.5.2. CVS

    CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.

    5.10.3. Perforce SCM6.5.3. Perforce SCM

    You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: @@ -184,9 +187,22 @@ CLASS="section" >5.10.4. Tinderbox/Tinderbox26.5.4. Tinderbox/Tinderbox2

    We need Tinderbox integration information.

    Tinderbox is a continuous-build system which can integrate with + Bugzilla - see + http://www.mozilla.org/projects/tinderbox for details + of Tinderbox, and + http://tinderbox.mozilla.org/showbuilds.cgi to see it + in action.

    PrevUpgrading to New ReleasesMySQL Bugzilla Database IntroductionUpIntroduction
    The Bugzilla Guide - 2.17.5 Development Release
    PrevNext

    Chapter 2. Introduction

    PrevHomeNext
    Document Conventions What is Bugzilla?
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/list.html b/webtools/bugzilla/docs/html/list.html new file mode 100644 index 00000000000..6f6be44dba4 --- /dev/null +++ b/webtools/bugzilla/docs/html/list.html @@ -0,0 +1,209 @@ +Bug Lists
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.4. Bug Lists

    If you run a search, a list of matching bugs will be returned. +

    The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features can be + accessed using the links at the bottom of the list: +

    Long Format: + + this gives you a large page with a non-editable summary of the fields + of each bug.
    Change Columns: + + change the bug attributes which appear in the list.
    Change several bugs at once: + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner.
    Send mail to bug owners: + + Sends mail to the owners of all bugs on the list.
    Edit this query: + + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results.

    +

    PrevHomeNext
    Searching for BugsUpFiling Bugs
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/milestones.html b/webtools/bugzilla/docs/html/milestones.html new file mode 100644 index 00000000000..8188a3d43f0 --- /dev/null +++ b/webtools/bugzilla/docs/html/milestones.html @@ -0,0 +1,210 @@ +Milestones
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 5. Administering BugzillaNext

    5.6. Milestones

    Milestones are "targets" that you plan to get a bug fixed by. For + example, you have a bug that you plan to fix for your 3.0 release, it + would be assigned the milestone of 3.0.

    Milestone options will only appear for a Product if you turned + on the "usetargetmilestone" Param in the "Edit Parameters" screen. +

    To create new Milestones, set Default Milestones, and set + Milestone URL:

    1. Select "Edit milestones" from the "Edit product" page.

    2. Select "Add" in the bottom right corner. + text

    3. Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this particular + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add".

    4. From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean.

    PrevHomeNext
    VersionsUpVoting
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/myaccount.html b/webtools/bugzilla/docs/html/myaccount.html new file mode 100644 index 00000000000..17ba42ddaa7 --- /dev/null +++ b/webtools/bugzilla/docs/html/myaccount.html @@ -0,0 +1,207 @@ +Create a Bugzilla Account
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.1. Create a Bugzilla Account

    If you want to use Bugzilla, first you need to create an account. + Consult with the administrator responsible for your installation of + Bugzilla for the URL you should use to access it. If you're + test-driving Bugzilla, use this URL: + http://landfill.bugzilla.org/bugzilla-tip/. +

    1. Click the + "Open a new Bugzilla account" + + link, enter your email address and, optionally, your name in the + spaces provided, then click + "Create Account" + + .

    2. Within moments, you should receive an email to the address + you provided, 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.

    3. Click the + "Log In" + 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 + "Login". +

    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.

    PrevHomeNext
    Using BugzillaUpAnatomy of a Bug
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/newversions.html b/webtools/bugzilla/docs/html/newversions.html index 4648dd8429f..9dad859db47 100644 --- a/webtools/bugzilla/docs/html/newversions.html +++ b/webtools/bugzilla/docs/html/newversions.html @@ -4,9 +4,11 @@ >New VersionsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release This is the 2.17.5 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. - This version of the guide, like its associated Bugzilla version is a - development version. Information is subject to change between now and - when 2.18 is released. + This version of the guide, like its associated Bugzilla version, is a + development version. - If you are - reading this from any source other than those below, please - check one of these mirrors to make sure you are reading an - up-to-date version of the Guide.

    The newest version of this guide can always be found at http://www.bugzilla.org; including - documentation for past releases and the current development version. -

    The documentation for the most recent stable release of Bugzilla can also - be found at - The Linux Documentation Project. +>; however, you should read the version + which came with the Bugzilla release you are using.

    The latest version of this document can always be checked out via CVS. diff --git a/webtools/bugzilla/docs/html/os-specific.html b/webtools/bugzilla/docs/html/os-specific.html index f3d786844f6..425fc5b6b5e 100644 --- a/webtools/bugzilla/docs/html/os-specific.html +++ b/webtools/bugzilla/docs/html/os-specific.html @@ -4,9 +4,11 @@ >OS Specific Installation NotesThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseNext4.3. OS Specific Installation Notes4.4. OS Specific Installation Notes

    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 @@ -97,9 +100,9 @@ CLASS="section" >4.3.1. Microsoft Windows4.4.1. Microsoft Windows

    Making Bugzilla work on windows is still a very 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 @@ -123,7 +126,7 @@ CLASS="section" >4.3.1.1. Win32 Perl4.4.1.1. Win32 Perl

    Perl for Windows can be obtained from 4.3.1.2. Perl Modules on Win324.4.1.2. Perl Modules on Win32

    Bugzilla on Windows requires the same perl modules found in Section 4.1.3Section 4.1.5. The main difference is that windows uses 4.3.1.3. Code changes required to run on win324.4.1.3. Code changes required to run on win32

    Unfortunately, Bugzilla still doesn't run "out of the box" on - Windows. There is work in progress to make this easier, but until that - happens code will have to be modified. This section is an attempt to - list the required changes. It is an attempt to be all inclusive, but - there may be other changes required. If you find something is missing, - please file a bug in Bugzilla Documentation. +>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.

    4.3.1.3.1. Changes to 4.4.1.3.1. Changes to checksetup.pl4.3.1.3.2. Changes to 4.4.1.3.2. Changes to BugMail.pmbug 84876 lands), the - simplest way is to have Net::SMTP installed and change this (in - Bugzilla/BugMail.pm):

    4.3.1.4. Serving the web pages4.4.1.4. Serving the web pages

    As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay attention to the security notes in Section 5.6.4Section 4.5.4. More information on configuring specific web servers can be found in Section 4.4Section 4.2.

    4.3.2. 4.4.2. Mac OS X4.3.3. Linux-Mandrake 8.04.4.3. Linux-Mandrake 8.0

    Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the @@ -826,7 +819,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" >NextHTTP Server ConfigurationBugzilla Security

    Bugzilla ConfigurationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development Release

    The

    As a guide, mozilla.org began needing +> As a guide, on reasonably old hardware, mozilla.org began needing "shadowdb"Useful Patches and Utilities for BugzillaContribThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevNextAppendix C. Useful Patches and Utilities for Bugzilla

    Appendix B. Contrib

    Are you looking for a way to put your Bugzilla into overdrive? Catch - some of the niftiest tricks here in this section.

    There are a number of unofficial Bugzilla add-ons in the + $BUGZILLA_ROOT/contrib/ + directory. This section documents them.

    PrevNextMySQL Bugzilla Database IntroductionThe Bugzilla FAQApache - mod_rewrite - - magicCommand-line Search Interface
    Patch Viewer
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.6. Patch Viewer

    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.

    Patch viewer allows you to:

    View patches in color, with side-by-side view rather than trying + to interpret the contents of the patch.
    See the difference between two patches.
    Get more context in a patch.
    Collapse and expand sections of a patch for easy + reading.
    Link to a particular section of a patch for discussion or + review
    Go to Bonsai or LXR to see more context, blame, and + cross-references for the part of the patch you are looking at
    Create a rawtext unified format diff out of any patch, no + matter what format it came from

    3.6.1. Viewing Patches in Patch Viewer

    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.

    3.6.2. Seeing the Difference Between Two Patches

    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.

    3.6.3. Getting More Context in a Patch

    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".

    3.6.4. Collapsing and Expanding Sections of a Patch

    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.

    3.6.5. Linking to a Section of a Patch

    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.)

    3.6.6. Going to Bonsai and LXR

    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.

    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).

    3.6.7. Creating a Unified Diff

    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.

    PrevHomeNext
    Filing BugsUpHints and Tips
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/products.html b/webtools/bugzilla/docs/html/products.html new file mode 100644 index 00000000000..7debc465f4e --- /dev/null +++ b/webtools/bugzilla/docs/html/products.html @@ -0,0 +1,193 @@ +Products
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 5. Administering BugzillaNext

    5.3. Products

    Products + + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...)

    Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes + required to move a bug automatically from the UNCONFIRMED status to the + NEW status.

    To create a new product:

    1. Select "products" from the footer

    2. Select the "Add" link in the bottom right

    3. Enter the name of the product and a description. The + Description field may contain HTML.

    Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single bug", + "Number of votes a bug in this Product needs to automatically get out + of the UNCOMFIRMED state", and "Version" options yet. We'll cover + those in a few moments. +

    PrevHomeNext
    User AdministrationUpComponents
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/programadmin.html b/webtools/bugzilla/docs/html/programadmin.html index f72058bfd53..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/programadmin.html +++ b/webtools/bugzilla/docs/html/programadmin.html @@ -1,392 +0,0 @@ -Product, Component, Milestone, and Version Administration
    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 5. Administering BugzillaNext

    5.3. Product, Component, Milestone, and Version Administration

    5.3.1. Products

    Products - - are the broadest category in Bugzilla, and tend to represent real-world - shipping products. E.g. if your company makes computer games, - you should have one product per game, perhaps a "Common" product for - units of technology used in multiple games, and maybe a few special - products (Website, Administration...)

    Many of Bugzilla's settings are configurable on a per-product - basis. The number of "votes" available to users is set per-product, - as is the number of votes - required to move a bug automatically from the UNCONFIRMED status to the - NEW status.

    To create a new product:

    1. Select "products" from the footer

    2. Select the "Add" link in the bottom right

    3. Enter the name of the product and a description. The - Description field may contain HTML.

    Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get out - of the UNCOMFIRMED state", and "Version" options yet. We'll cover - those in a few moments. -

    5.3.2. Components

    Components are subsections of a Product. E.g. the computer game - you are designing may have a "UI" - component, an "API" component, a "Sound System" component, and a - "Plugins" component, each overseen by a different programmer. It - often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or - company.

    Each component has a owner and (if you turned it on in the parameters), - a QA Contact. The owner should be the primary person who fixes bugs in - that component. The QA Contact should be the person who will ensure - these bugs are completely fixed. The Owner, QA Contact, and Reporter - will get email when new bugs are created in this Component and when - these bugs change. Default Owner and Default QA Contact fields only - dictate the - default assignments; - these can be changed on bug submission, or at any later point in - a bug's life.

    To create a new Component:

    1. Select the "Edit components" link from the "Edit product" - page

    2. Select the "Add" link in the bottom right.

    3. Fill out the "Component" field, a short "Description", - the "Initial Owner" and "Initial QA Contact" (if enabled.) - The Component and Description fields may contain HTML; - the "Initial Owner" field must be a login name - already existing in the database. -

    5.3.3. Versions

    Versions are the revisions of the product, such as "Flinders - 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select - field; the usual practice is to select the most recent version with - the bug. -

    To create and edit Versions:

    1. From the "Edit product" screen, select "Edit Versions"

    2. You will notice that the product already has the default - version "undefined". Click the "Add" link in the bottom right.

    3. Enter the name of the Version. This field takes text only. - Then click the "Add" button.

    5.3.4. Milestones

    Milestones are "targets" that you plan to get a bug fixed by. For - example, you have a bug that you plan to fix for your 3.0 release, it - would be assigned the milestone of 3.0.

    Milestone options will only appear for a Product if you turned - on the "usetargetmilestone" Param in the "Edit Parameters" screen. -

    To create new Milestones, set Default Milestones, and set - Milestone URL:

    1. Select "Edit milestones" from the "Edit product" page.

    2. Select "Add" in the bottom right corner. - text

    3. Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "sortkey", which is a positive or negative - number (-255 to 255) that defines where in the list this particular - milestone appears. This is because milestones often do not - occur in alphanumeric order For example, "Future" might be - after "Release 1.2". Select "Add".

    4. From the Edit product screen, you can enter the URL of a - page which gives information about your milestones and what - they mean.

      If you want your milestone document to be restricted so - that it can only be viewed by people in a particular Bugzilla - group, the best way is to attach the document to a bug in that - group, and make the URL the URL of that attachment.

    PrevHomeNext
    User AdministrationUpVoting
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/query.html b/webtools/bugzilla/docs/html/query.html new file mode 100644 index 00000000000..0fd4fc1826c --- /dev/null +++ b/webtools/bugzilla/docs/html/query.html @@ -0,0 +1,167 @@ +Searching for Bugs
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.3. Searching for Bugs

    The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + http://landfill.bugzilla.org/bugzilla-tip/query.cgi.

    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.

    Once you've run a search, you can save it as a Saved Search, which + appears in the page footer.

    Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information.

    PrevHomeNext
    Anatomy of a BugUpBug Lists
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/reporting.html b/webtools/bugzilla/docs/html/reporting.html new file mode 100644 index 00000000000..df5d9d0ce16 --- /dev/null +++ b/webtools/bugzilla/docs/html/reporting.html @@ -0,0 +1,150 @@ +Reports
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 3. Using BugzillaNext

    3.9. Reports

    To be written

    PrevHomeNext
    User PreferencesUpInstallation
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/rewrite.html b/webtools/bugzilla/docs/html/rewrite.html index e986b814e08..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/rewrite.html +++ b/webtools/bugzilla/docs/html/rewrite.html @@ -1,208 +0,0 @@ -Apache - mod_rewrite - - magic
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix C. Useful Patches and Utilities for BugzillaNext

    C.1. Apache - mod_rewrite - - magic

    Apache's - mod_rewrite - - module lets you do some truly amazing things with URL rewriting. Here are - a couple of examples of what you can do.

    1. Make it so if someone types - http://www.foo.com/12345 - - , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try - setting up your VirtualHost section for Bugzilla with a rule like - this:

      
<VirtualHost 12.34.56.78>
-RewriteEngine On
-RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
-</VirtualHost>
-

    2. There are many, many more things you can do with mod_rewrite. - Please refer to the mod_rewrite documentation at - http://www.apache.org. -

    PrevHomeNext
    Useful Patches and Utilities for BugzillaUpCommand-line Bugzilla Queries
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/security.html b/webtools/bugzilla/docs/html/security.html index c3fa0749992..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/security.html +++ b/webtools/bugzilla/docs/html/security.html @@ -1,785 +0,0 @@ -Bugzilla Security
    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 5. Administering BugzillaNext

    5.6. Bugzilla Security

    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.

    These instructions must, of necessity, be somewhat vague since - Bugzilla runs on so many different platforms. If you have refinements - of these directions, please submit a bug to Bugzilla Documentation. -

    This is not meant to be a comprehensive list of every possible - security issue regarding the tools mentioned in this section. There is - no subsitute for reading the information written by the authors of any - software running on your system. -

    5.6.1. TCP/IP Ports

    TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla - only needs 1... 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. -

    5.6.2. MySQL

    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 not the same as - the system root). Also, many installations default to running - mysqld as the system root. -

    1. Consult the documentation that came with your system for - information on making mysqld run as an - unprivleged user. -

    2. 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: - 

      
bash$ mysql mysql
-mysql> DELETE FROM user WHERE user = '';
-mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
-mysql> FLUSH PRIVILEGES;
-

      From this point forward you will need to use - mysql -u root -p and enter - new_password when prompted when using the - mysql client. -

    3. 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 /etc/my.conf: - 

      
[myslqd]
-# Prevent network access to MySQL.
-skip-networking
-

    4. 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. -

    5.6.3. Daemon Accounts

    Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either "root" or "nobody". Running - as "root" introduces obvious security problems, but the - problems introduced by running everything as "nobody" may - not be so obvious. Basically, if you're running every daemon as - "nobody" and one of them gets comprimised, they all get - comprimised. For this reason it is recommended that you create a user - account for each daemon. -

    You will need to set the webservergroup to - the group you created for your webserver to run as in - localconfig. This will allow - ./checksetup.pl to better adjust the file - permissions on your Bugzilla install so as to not require making - anything world-writable. -

    5.6.4. Web Server Access Controls

    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 layed out, the list of what should and should - not be accessible is rather complicated. A new installation method - is currently in the works which should solve this by allowing files - that shouldn't be accessible from the web to be placed in directory - outside the webroot. See - bug 44659 for more information. -

    • In the main Bugzilla directory, you should:

      • Block: - *.pl, *localconfig*, runtests.sh -

      • But allow: - localconfig.js, localconfig.rdf -

    • In data:

      • Block everything

      • But allow: - duplicates.rdf -

    • In data/webdot:

      • If you use a remote webdot server:

        • Block everything

        • But allow - *.dot - only for the remote webdot server

      • Otherwise, if you use a local GraphViz:

        • Block everything

        • But allow: - *.png, *.gif, *.jpg, *.map -

      • And if you don't use any dot:

        • Block everything

    • In Bugzilla:

      • Block everything

    • In template:

      • Block everything

    Bugzilla ships with the ability to generate - .htaccess files instructing - Apache which files - should and should not be accessible. For more information, see - Section 4.4.1. -

    You should test to make sure that the files mentioned above are - not accessible from the Internet, especially your - localconfig 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 - http://bugzilla.mozilla.org/localconfig. You should - get a 403 Forbidden - error. -

    Not following the instructions in this section, including - testing, may result in sensitive information being globally - accessible. -

    You should check Section 4.4 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. -

    PrevHomeNext
    Groups and Group SecurityUpTemplate Customization
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/stepbystep.html b/webtools/bugzilla/docs/html/stepbystep.html index 48e443702b2..dfbf1a14bad 100644 --- a/webtools/bugzilla/docs/html/stepbystep.html +++ b/webtools/bugzilla/docs/html/stepbystep.html @@ -4,9 +4,11 @@ >Step-by-step InstallThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseNextSection 4.3Section 4.4, so be sure to check out that section before you start your installation.

    Section 4.3.1Section 4.4.1.

    You are strongly recommended to make a backup of your system + before installing Bugzilla and at regular intervals thereafter. +

    The listing below is a basic step-by-step list. More information can be found in the sections below. Minimum versions will be included in parenthesis where appropriate. @@ -174,15 +181,6 @@ TYPE="1" >

  • Install MySQL - (3.23.41) -

  • Install Perl @@ -192,9 +190,10 @@ HREF="stepbystep.html#install-perl" >

  • Install Perl ModulesInstall MySQL + (3.23.41)

  • Install Perl Modules +

  • Setup the MySQL Database @@ -228,9 +235,31 @@ CLASS="section" >

    4.1.1. Perl

    Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from http://www.perl.com. + 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, + 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.

    • 4.1.1. MySQL

    4.1.2. MySQL

    Visit the MySQL homepage at option as mentioned in Section 5.6.2Section 4.5.2 for the added security.

    4.1.2.1. Configuring MySQL

    This first thing you'll want to do is make sure you've given the + "root" user a password as suggested in + Section 4.5.2. For clarity, these instructions will + assume that your MySQL user for Bugzilla will be "bugs_user", + the database will be called "bugs_db" and the password for + the "bugs_user" user is "bugs_password". You + should, of course, substitute the values you intend to use for your site. +

    Most people use "bugs" for both the user and + database name. +

    Next, we use an SQL GRANT command to create a + "bugs_user" + user, and grant sufficient permissions for checksetup.pl, which we'll + use later, to work its magic. This also restricts the + "bugs_user" + user to operations within a database called + "bugs_db", and only allows the account to connect from + "localhost". + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.

    
  mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
+         DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
+         IDENTIFIED BY 'bugs_password';
+  mysql> FLUSH PRIVILEGES;
+

    If you are using MySQL 4, the bugs user also needs to be granted + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions. +

    4.1.2. Perl

    4.1.3. HTTP Server

    Any machine that doesn't have Perl on it is a sad machine indeed. - Perl can be got in source form from You have freedom of choice here, pretty much any web server that + is capable of running CGI + scripts will work. Section 4.2 has more information about + configuring web servers to work with Bugzilla. +

    We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us by filing a bug in http://www.perl.comBugzilla Documentation. - 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, - 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.

    4.1.4. Bugzilla

    You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + "nobody"). + You may decide to put the files in the main web space for your + web server or perhaps in + /usr/local + with a symbolic link in the web space that points to the Bugzilla + directory.

    If you symlink the bugzilla directory into your Apache's HTML + hierarchy, you may receive + Forbidden + errors unless you add the + "FollowSymLinks" + directive to the <Directory> entry for the HTML root + in httpd.conf.

    Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install + checksetup.pl + script, which locks down your installation.

    The default Bugzilla distribution is not designed to be placed + in a cgi-bin directory (this + includes any directory which is configured using the + ScriptAlias directive of Apache). +

    4.1.3. Perl Modules4.1.5. Perl Modules

    Perl modules can be found using for CPAN and Section 4.3.1.2Section 4.4.1.2 for PPM.

    The process of untaring the module as defined in +>The process of untarring the module as defined in 4.1.3.1. Bundle::Bugzilla4.1.5.1. Bundle::Bugzilla

    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 @@ -852,7 +1177,7 @@ CLASS="section" >4.1.3.2. AppConfig (1.52)4.1.5.2. AppConfig (1.52)

    Dependency for Template Toolkit. We probably don't need to specifically check for it anymore. @@ -865,7 +1190,7 @@ CLASS="section" >4.1.3.3. CGI (2.88)4.1.5.3. CGI (2.88)

    The CGI module parses form elements and cookies and does many other usefule things. It come as a part of recent perl distributions, but @@ -898,7 +1223,7 @@ CLASS="section" >4.1.3.4. Data::Dumper (any)4.1.5.4. Data::Dumper (any)

    The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later @@ -932,7 +1257,7 @@ CLASS="section" >4.1.3.5. TimeDate modules (2.21)4.1.5.5. TimeDate modules (2.21)

    Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. @@ -967,7 +1292,7 @@ CLASS="section" >4.1.3.6. DBI (1.32)4.1.5.6. DBI (1.32)

    The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done @@ -1001,7 +1326,7 @@ CLASS="section" >4.1.3.7. MySQL-related modules4.1.5.7. MySQL-related modules

    The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -1046,7 +1371,7 @@ CLASS="section" >4.1.3.8. File::Spec (0.82)4.1.5.8. File::Spec (0.82)

    File::Spec is a perl module that allows file operations, such as generating full path names, to work cross platform. @@ -1078,7 +1403,7 @@ CLASS="section" >4.1.3.9. File::Temp (any)4.1.5.9. File::Temp (any)

    File::Temp is used to generate a temporary filename that is guaranteed to be unique. It comes as a standard part of perl @@ -1110,7 +1435,7 @@ CLASS="section" >4.1.3.10. Template Toolkit (2.08)4.1.5.10. Template Toolkit (2.08)

    When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except @@ -1144,7 +1469,7 @@ CLASS="section" >4.1.3.11. Text::Wrap (2001.0131)4.1.5.11. Text::Wrap (2001.0131)

    Text::Wrap is designed to proved intelligent text wrapping.

    4.1.3.12. GD (1.20) [optional]4.1.5.12. GD (1.20) [optional]

    The GD library was written by Thomas Boutell a long while ago to programmatically generate images in C. Since then it's become the @@ -1280,7 +1605,7 @@ CLASS="section" >4.1.3.13. Chart::Base (0.99c) [optional]4.1.5.13. Chart::Base (0.99c) [optional]

    The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been @@ -1309,7 +1634,7 @@ CLASS="section" >4.1.3.14. XML::Parser (any) [Optional]4.1.5.14. XML::Parser (any) [Optional]

    XML::Parser is used by the 4.1.3.15. GD::Graph (any) [Optional]4.1.5.15. GD::Graph (any) [Optional]

    In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -1376,7 +1701,7 @@ CLASS="section" >4.1.3.16. GD::Text::Align (any) [Optional]4.1.5.16. GD::Text::Align (any) [Optional]

    GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -1408,7 +1733,7 @@ CLASS="section" >4.1.3.17. MIME::Parser (any) [Optional]4.1.5.17. MIME::Parser (any) [Optional]

    MIME::Parser is only needed if you want to use the e-mail interface located in the 4.1.3.18. PatchReader (0.9.1) [Optional]4.1.5.18. PatchReader (0.9.1) [Optional]

    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 @@ -1479,350 +1804,15 @@ CLASS="section" >

    4.1.4. HTTP Server

    You have freedom of choice here, pretty much any web server that - is capable of running CGI - scripts will work. Section 4.4 has more information about - configuring web servers to work with Bugzilla. -

    We strongly recommend Apache as the web server to use. The - Bugzilla Guide installation instructions, in general, assume you are - using Apache. If you have got Bugzilla working using another webserver, - please share your experiences with us by filing a bug in Bugzilla Documentation. -

    4.1.5. Bugzilla

    You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - "nobody"). - You may decide to put the files in the main web space for your - web server or perhaps in - /usr/local - with a symbolic link in the web space that points to the Bugzilla - directory.

    If you symlink the bugzilla directory into your Apache's HTML - hierarchy, you may receive - Forbidden - errors unless you add the - "FollowSymLinks" - directive to the <Directory> entry for the HTML root - in httpd.conf.

    Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install - checksetup.pl - script, which locks down your installation.

    The default Bugzilla distribution is not designed to be placed - in a cgi-bin directory (this - includes any directory which is configured using the - ScriptAlias directive of Apache). This will probably - change as part of - bug - 44659. -

    4.1.6. Setting Up the MySQL Database

    After you've gotten all the software installed and working you're - ready to start preparing the database for its life as the back end to - a high quality bug tracker.

    This first thing you'll want to do is make sure you've given the - "root" user a password as suggested in - Section 5.6.2. For clarity, these instructions will - assume that your MySQL user for Bugzilla will be "bugs_user", - the database will be called "bugs_db" and the password for - the "bugs_user" user is "bugs_password". You - should, of course, substitute the values you intend to use for your site. -

    Most people use "bugs" for both the user and - database name. -

    Next, we use an SQL GRANT command to create a - "bugs_user" - user, and grant sufficient permissions for checksetup.pl, which we'll - use later, to work its magic. This also restricts the - "bugs_user" - user to operations within a database called - "bugs_db", and only allows the account to connect from - "localhost". - Modify it to reflect your setup if you will be connecting from - another machine or as a different user.

    
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
-       DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
-       IDENTIFIED BY 'bugs_password';
-mysql> FLUSH PRIVILEGES;
-

    If you are using MySQL 4, the bugs user also needs to be granted - the LOCK TABLES and - CREATE TEMPORARY TABLES permissions. -

    4.1.7. 4.1.6. checksetup.pl

    Next, run the magic checksetup.pl script. (Many thanks to - Holger Schurig - for writing this script!) - This script is designed to make sure your perl modules are the correct +>Next, run the magic checksetup.pl script. + This is designed to make sure your perl modules are the correct version and your MySQL database and other configuration options are consistent with the Bugzilla CGI files. It will make sure Bugzilla files and directories have reasonable @@ -1958,9 +1948,9 @@ CLASS="section" >

    4.1.8. Configuring Bugzilla

    4.1.7. Configuring Bugzilla

    You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. @@ -2005,7 +1995,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" >NextOptional Additional ConfigurationHTTP Server Configuration

    TroubleshootingThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev4.5. Troubleshooting4.6. Troubleshooting

    This section gives solutions to common Bugzilla installation problems. @@ -84,9 +87,9 @@ CLASS="section" >

    4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

    4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

    Try executing

    4.5.2. DBD::Sponge::db prepare failed

    4.6.2. DBD::Sponge::db prepare failed

    The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): @@ -197,7 +200,7 @@ CLASS="section" >4.5.3. cannot chdir(/var/spool/mqueue)4.6.3. cannot chdir(/var/spool/mqueue)

    If you are installing Bugzilla on SuSE Linux, or some other distributions with @@ -255,7 +258,7 @@ CLASS="section" >4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT

    This is caused by a bug in the version of PrevHTTP Server ConfigurationBugzilla SecurityUpgrading to New ReleasesThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevNextPrevNextChange Permission CustomizationGroups and Group SecurityIntegrating Bugzilla with Third-Party ToolsCustomising Bugzilla

    User AdministrationThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseNext

    Don't disable the administrator account!

    Don't disable all the administrator accounts!

    NextProduct, Component, Milestone, and Version AdministrationProductsUser PreferencesThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleaseNext3.3. User Preferences3.8. User Preferences

    Once you have logged in, you can customise various aspects of Bugzilla via the "Edit prefs" link in the page footer. - The preferences are split into four tabs:

    3.3.1. Account Settings

    3.8.1. Account Settings

    On this tab, you can change your basic account information, including your password, email address and real name. For security @@ -111,13 +114,19 @@ CLASS="section" >3.3.2. Email Settings3.8.2. Email Settings

    On this tab you can reduce or increase the amount of email sent you from Bugzilla, opting in our out depending on your relationship to - the bug and the change that was made to it. (Note that you can also do - client-side filtering using the X-Bugzilla-Reason header which Bugzilla - adds to all bugmail.)

    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.

    By entering user email names, delineated by commas, into the "Users to watch" text entry box you can receive a copy of all the @@ -158,23 +167,9 @@ CLASS="section" >

    3.3.3. Page Footer

    On the Search page, you can store queries in Bugzilla, so if you - regularly run a particular query it is just a drop-down menu away. - Once you have a stored query, you can come - here to request that it also be displayed in your page footer.

    3.3.4. Permissions

    3.8.3. Permissions

    This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you @@ -216,7 +211,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" >NextInstallationReports

    Using BugzillaThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrevNext
    3.1. How do I use Bugzilla?Create a Bugzilla Account
    3.2. Anatomy of a Bug
    3.3. Searching for Bugs
    3.4. Bug Lists
    3.5. Filing Bugs
    3.6. Patch Viewer
    3.1.1. Create a Bugzilla Account3.6.1. Viewing Patches in Patch Viewer
    3.1.2. Anatomy of a Bug3.6.2. Seeing the Difference Between Two Patches
    3.1.3. Searching for Bugs3.6.3. Getting More Context in a Patch
    3.1.4. Bug Lists3.6.4. Collapsing and Expanding Sections of a Patch
    3.1.5. Filing Bugs3.6.5. Linking to a Section of a Patch
    3.1.6. Patch Viewer3.6.6. Going to Bonsai and LXR
    3.6.7. Creating a Unified Diff
    3.2. 3.7. Hints and Tips
    3.2.1. 3.7.1. Autolinkification
    3.2.2. 3.7.2. Quicksearch
    3.2.3. 3.7.3. Comments
    3.2.4. 3.7.4. Attachments
    3.2.5. 3.7.5. Filing Bugs
    3.3. 3.8. User Preferences
    3.3.1. 3.8.1. Account Settings
    3.3.2. 3.8.2. Email Settings
    3.3.3. Page Footer
    3.3.4. 3.8.3. Permissions
    3.9. Reports

    This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + Landfill, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and runs an up-to-the-minute version, + so some things may not quite work as this document describes.

    PrevNextWhy Should We Use Bugzilla?Why use Bugzilla?How do I use Bugzilla?Create a Bugzilla Account
    Loki Bugzilla (Fenris)
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.2. Loki Bugzilla (Fenris)

    Fenris was a fork from Bugzilla made by Loki Games; when - Loki went into receivership, it died. While Loki's other code lives on, - its custodians recommend Bugzilla for future bug-tracker deployments. -

    This section last updated 27 Jul 2002

    PrevHomeNext
    Red Hat BugzillaUpIssuezilla
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variant-issuezilla.html b/webtools/bugzilla/docs/html/variant-issuezilla.html index 599b04a7e4e..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variant-issuezilla.html +++ b/webtools/bugzilla/docs/html/variant-issuezilla.html @@ -1,153 +0,0 @@ -Issuezilla
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.3. Issuezilla

    Issuezilla was another fork from Bugzilla, made by collab.net and - hosted at tigris.org. It is also dead; the primary focus of bug-tracking - at tigris.org is their Java-based bug-tracker, - Section D.4.

    This section last updated 27 Jul 2002

    PrevHomeNext
    Loki Bugzilla (Fenris)UpScarab
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variant-perforce.html b/webtools/bugzilla/docs/html/variant-perforce.html index 7f90944f7c6..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variant-perforce.html +++ b/webtools/bugzilla/docs/html/variant-perforce.html @@ -1,159 +0,0 @@ -Perforce SCM
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.5. Perforce SCM

    Although Perforce isn't really a bug tracker, it can be used as - such through the "jobs" - functionality.

    URL: http://www.perforce.com/perforce/technotes/note052.html -

    This section last updated 27 Jul 2002

    PrevHomeNext
    ScarabUpSourceForge
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variant-redhat.html b/webtools/bugzilla/docs/html/variant-redhat.html index 8560dac6c4d..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variant-redhat.html +++ b/webtools/bugzilla/docs/html/variant-redhat.html @@ -1,168 +0,0 @@ -Red Hat Bugzilla
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.1. Red Hat Bugzilla

    Red Hat's old fork of Bugzilla which was based on version 2.8 is now - obsolete. The newest version in use is based on version 2.17.1 and is in - the process of being integrated into the main Bugzilla source tree. The - back-end is modified to work with PostgreSQL instead of MySQL and they have - custom templates to get their desired look and feel, but other than that it - is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of - effort to make sure that the changes he made could be integrated back into - the main tree. - Bug 98304 - exists to track this integration. -

    URL: http://bugzilla.redhat.com/bugzilla/ -

    This section last updated 24 Dec 2002

    PrevHomeNext
    Bugzilla Variants and CompetitorsUpLoki Bugzilla (Fenris)
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variant-scarab.html b/webtools/bugzilla/docs/html/variant-scarab.html index d7684ed2639..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variant-scarab.html +++ b/webtools/bugzilla/docs/html/variant-scarab.html @@ -1,155 +0,0 @@ -Scarab
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.4. Scarab

    Scarab is a new open source bug-tracking system built using Java - Servlet technology. It is currently at version 1.0 beta 13.

    URL: http://scarab.tigris.org/ -

    This section last updated 18 Jan 2003

    PrevHomeNext
    IssuezillaUpPerforce SCM
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variant-sourceforge.html b/webtools/bugzilla/docs/html/variant-sourceforge.html index b9601607f63..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variant-sourceforge.html +++ b/webtools/bugzilla/docs/html/variant-sourceforge.html @@ -1,156 +0,0 @@ -SourceForge
    The Bugzilla Guide - 2.17.5 Development Release
    PrevAppendix D. Bugzilla Variants and CompetitorsNext

    D.6. SourceForge

    SourceForge is a way of coordinating geographically - distributed free software and open source projects over the Internet. - It has a built-in bug tracker, but it's not highly thought of.

    URL: http://www.sourceforge.net -

    This section last updated 27 Jul 2002

    PrevHomeNext
    Perforce SCMUpGNU Free Documentation License
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/variants.html b/webtools/bugzilla/docs/html/variants.html index 731738863d6..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/variants.html +++ b/webtools/bugzilla/docs/html/variants.html @@ -1,185 +0,0 @@ -Bugzilla Variants and Competitors
    The Bugzilla Guide - 2.17.5 Development Release
    PrevNext

    Appendix D. Bugzilla Variants and Competitors

    I created this section to answer questions about Bugzilla competitors - and variants, then found a wonderful site which covers an awful lot of what - I wanted to discuss. Rather than quote it in its entirety, I'll simply - refer you here: - http://linas.org/linux/pm.html. -

    PrevHomeNext
    Command-line Bugzilla Queries Red Hat Bugzilla
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/versions.html b/webtools/bugzilla/docs/html/versions.html new file mode 100644 index 00000000000..9e5fc8b5f97 --- /dev/null +++ b/webtools/bugzilla/docs/html/versions.html @@ -0,0 +1,173 @@ +Versions
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 5. Administering BugzillaNext

    5.5. Versions

    Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the earliest version known to have + the bug. +

    To create and edit Versions:

    1. From the "Edit product" screen, select "Edit Versions"

    2. You will notice that the product already has the default + version "undefined". Click the "Add" link in the bottom right.

    3. Enter the name of the Version. This field takes text only. + Then click the "Add" button.

    PrevHomeNext
    ComponentsUpMilestones
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/voting.html b/webtools/bugzilla/docs/html/voting.html index f791108b03b..3e01dd18142 100644 --- a/webtools/bugzilla/docs/html/voting.html +++ b/webtools/bugzilla/docs/html/voting.html @@ -4,16 +4,18 @@ >VotingThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev5.4. Voting5.7. Voting

    Voting allows users to be given a pot of votes which they can allocate to bugs, to indicate that they'd like them fixed. @@ -145,7 +148,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevProduct, Component, Milestone, and Version AdministrationMilestonesWhat is Bugzilla?

    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 2. IntroductionNext

    2.1. What is Bugzilla?

    Bugzilla is a bug- or issue-tracking system. Bug-tracking - systems allow individual or groups of developers effectively to keep track - of outstanding problems with their product. - Bugzilla was originally - written by Terry Weissman in a programming language called TCL, to - replace a rudimentary bug-tracking database used internally by Netscape - Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl - it remains to this day. Most commercial defect-tracking software vendors - at the time charged enormous licensing fees, and Bugzilla quickly became - a favorite of the open-source crowd (with its genesis in the open-source - browser project, Mozilla). It is now the de-facto standard - defect-tracking system against which all others are measured. -

    Bugzilla boasts many advanced features. These include: -

    • Powerful searching

    • User-configurable email notifications of bug changes

    • Full change history

    • Inter-bug dependency tracking and graphing

    • Excellent attachment management

    • Integrated, product-based, granular security schema

    • Fully security-audited, and runs under Perl's taint mode

    • A robust, stable RDBMS back-end

    • Web, XML, email and console interfaces

    • Completely customisable and/or localisable web user - interface

    • Extensive configurability

    • Smooth upgrade pathway between versions

    -

    PrevHomeNext
    IntroductionUpWhy Should We Use Bugzilla?
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/why-bugzilla.html b/webtools/bugzilla/docs/html/why-bugzilla.html new file mode 100644 index 00000000000..f3da40066e3 --- /dev/null +++ b/webtools/bugzilla/docs/html/why-bugzilla.html @@ -0,0 +1,227 @@ +Why use Bugzilla?
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 2. IntroductionNext

    2.3. Why use Bugzilla?

    Bugzilla boasts many advanced features. These include: +

    • Powerful searching

    • User-configurable email notifications of bug changes

    • Full change history

    • Inter-bug dependency tracking and graphing

    • Excellent attachment management

    • Integrated, product-based, granular security schema

    • Fully security-audited, and runs under Perl's taint mode

    • A robust, stable RDBMS back-end

    • Web, XML, email and console interfaces

    • Completely customisable and/or localisable web user + interface

    • Extensive configurability

    • Smooth upgrade pathway between versions

    +

    Bugzilla is very adaptable to various situations. Known uses + currently include IT support queues, Systems Administration deployment + management, chip design and development problem tracking (both + pre-and-post fabrication), and software and hardware bug tracking for + luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems. + Combined with systems such as + CVS, + Bonsai, or + Perforce SCM, Bugzilla + provides a powerful, easy-to-use solution to configuration management and + replication problems.

    PrevHomeNext
    Why use a bug-tracking system?UpUsing Bugzilla
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/why-tracking.html b/webtools/bugzilla/docs/html/why-tracking.html new file mode 100644 index 00000000000..bb22e002092 --- /dev/null +++ b/webtools/bugzilla/docs/html/why-tracking.html @@ -0,0 +1,164 @@ +Why use a bug-tracking system?
    The Bugzilla Guide - 2.17.5 + Development Release
    PrevChapter 2. IntroductionNext

    2.2. Why use a bug-tracking system?

    For many years, defect-tracking software was principally + the domain of large software development houses. Most smaller shops + simply relied on + shared lists and email to monitor the status of defects. This procedure + was error-prone and tended to cause those bugs judged least significant by + developers to be dropped or ignored.

    Integrated + defect-tracking systems reduce downtime, increase productivity, and raise + customer satisfaction with their systems. Along with full disclosure, an + open bug-tracker allows you to keep in touch with your clients + and resellers, to communicate about problems effectively throughout the + data management chain. Many corporations have also discovered that + defect-tracking helps reduce costs by providing IT support + accountability, telephone support knowledge bases, and a common, + well-understood method for accounting for unusual system or software + issues.

    PrevHomeNext
    What is Bugzilla?UpWhy use Bugzilla?
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/html/why.html b/webtools/bugzilla/docs/html/why.html index d1e3b813e61..e69de29bb2d 100644 --- a/webtools/bugzilla/docs/html/why.html +++ b/webtools/bugzilla/docs/html/why.html @@ -1,208 +0,0 @@ -Why Should We Use Bugzilla?
    The Bugzilla Guide - 2.17.5 Development Release
    PrevChapter 2. IntroductionNext

    2.2. Why Should We Use Bugzilla?

    For many years, defect-tracking software has remained principally - the domain of large software development houses. Even then, most shops - never bothered with bug-tracking software, and instead simply relied on - shared lists and email to monitor the status of defects. This procedure - is error-prone and tends to cause those bugs judged least significant by - developers to be dropped or ignored.

    These days, many companies are finding that integrated - defect-tracking systems reduce downtime, increase productivity, and raise - customer satisfaction with their systems. Along with full disclosure, an - open bug-tracker allows manufacturers to keep in touch with their clients - and resellers, to communicate about problems effectively throughout the - data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood system for accounting for unusual system or software - issues.

    But why should - you - - use Bugzilla?

    Bugzilla is very adaptable to various situations. Known uses - currently include IT support queues, Systems Administration deployment - management, chip design and development problem tracking (both - pre-and-post fabrication), and software and hardware bug tracking for - luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems. - Combined with systems such as - CVS, - Bonsai, or - Perforce SCM, Bugzilla - provides a powerful, easy-to-use solution to configuration management and - replication problems.

    Bugzilla can dramatically increase the productivity and - accountability of individual employees by providing a documented workflow - and positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do - something - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and follow the discussion trail - that led to critical decisions.

    Ultimately, Bugzilla puts the power in your hands to improve your - value to your employer or business while providing a usable framework for - your natural attention to detail and knowledge store to flourish.

    PrevHomeNext
    What is Bugzilla?UpUsing Bugzilla
    \ No newline at end of file diff --git a/webtools/bugzilla/docs/txt/Bugzilla-Guide.txt b/webtools/bugzilla/docs/txt/Bugzilla-Guide.txt index 39b249eba05..d7cf3974c66 100644 --- a/webtools/bugzilla/docs/txt/Bugzilla-Guide.txt +++ b/webtools/bugzilla/docs/txt/Bugzilla-Guide.txt @@ -1,25 +1,14 @@ + The Bugzilla Guide - 2.17.5 Development Release -Matthew P. Barnson - -Jacob Steenhagen - The Bugzilla Team - 2003-11-01 + 2004-01-15 - This is the documentation for Bugzilla, the mozilla.org bug-tracking - system. Bugzilla is an enterprise-class piece of software that powers - issue-tracking for hundreds of organizations around the world, - tracking millions of bugs. - - This documentation is maintained in DocBook 4.1.2 XML format. Changes - are best submitted as plain text or XML diffs, attached to a bug filed - in the Bugzilla Documentation component. - - This is a development version of this guide. Information in it is - subject to change before the 2.18 release of this guide (which will - correspond with the 2.18 release of Bugzilla). + This is the documentation for Bugzilla, a bug-tracking system from + mozilla.org. Bugzilla is an enterprise-class piece of software that + tracks millions of bugs and issues for hundreds of organizations + around the world. The most current version of this document can always be found on the Bugzilla Documentation Page. @@ -37,56 +26,56 @@ The Bugzilla Team 2. Introduction 2.1. What is Bugzilla? - 2.2. Why Should We Use Bugzilla? + 2.2. Why use a bug-tracking system? + 2.3. Why use Bugzilla? 3. Using Bugzilla - 3.1. How do I use Bugzilla? - 3.2. Hints and Tips - 3.3. User Preferences + 3.1. Create a Bugzilla Account + 3.2. Anatomy of a Bug + 3.3. Searching for Bugs + 3.4. Bug Lists + 3.5. Filing Bugs + 3.6. Patch Viewer + 3.7. Hints and Tips + 3.8. User Preferences + 3.9. Reports 4. Installation 4.1. Step-by-step Install - 4.2. Optional Additional Configuration - 4.3. OS Specific Installation Notes - 4.4. HTTP Server Configuration - 4.5. Troubleshooting + 4.2. HTTP Server Configuration + 4.3. Optional Additional Configuration + 4.4. OS Specific Installation Notes + 4.5. Bugzilla Security + 4.6. Troubleshooting 5. Administering Bugzilla 5.1. Bugzilla Configuration 5.2. User Administration - 5.3. Product, Component, Milestone, and Version Administration - 5.4. Voting - 5.5. Groups and Group Security - 5.6. Bugzilla Security - 5.7. Template Customization - 5.8. Change Permission Customization + 5.3. Products + 5.4. Components + 5.5. Versions + 5.6. Milestones + 5.7. Voting + 5.8. Groups and Group Security 5.9. Upgrading to New Releases - 5.10. Integrating Bugzilla with Third-Party Tools + + 6. Customising Bugzilla + + 6.1. Template Customization + 6.2. Customizing Who Can Change What + 6.3. Modifying Your Running System + 6.4. MySQL Bugzilla Database Introduction + 6.5. Integrating Bugzilla with Third-Party Tools A. The Bugzilla FAQ - B. The Bugzilla Database + B. Contrib - B.1. Modifying Your Running System - B.2. MySQL Bugzilla Database Introduction + B.1. Command-line Search Interface - C. Useful Patches and Utilities for Bugzilla - - C.1. Apache mod_rewrite magic - C.2. Command-line Bugzilla Queries - - D. Bugzilla Variants and Competitors - - D.1. Red Hat Bugzilla - D.2. Loki Bugzilla (Fenris) - D.3. Issuezilla - D.4. Scarab - D.5. Perforce SCM - D.6. SourceForge - - E. GNU Free Documentation License + C. GNU Free Documentation License 0. PREAMBLE 1. APPLICABILITY AND DEFINITIONS @@ -110,7 +99,6 @@ The Bugzilla Team List of Examples 4-1. Installing perl modules with CPAN - 4-2. .htaccess files for Apache 5-1. Upgrading using CVS 5-2. Upgrading using the tarball 5-3. Upgrading using patches @@ -122,72 +110,52 @@ Chapter 1. About This Guide - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 or - any later version published by the Free Software Foundation; with no - Invariant Sections, no Front-Cover Texts, and with no Back-Cover - Texts. A copy of the license is included in Appendix E. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 or + any later version published by the Free Software Foundation; with no + Invariant Sections, no Front-Cover Texts, and with no Back-Cover + Texts. A copy of the license is included in Appendix C. - --Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla Team + --Copyright (c) 2000-2004 The Bugzilla Team If you have any questions regarding this document, its copyright, or - publishing this document in non-electronic form, please contact The + publishing this document in non-electronic form, please contact the Bugzilla Team. _________________________________________________________________ 1.2. Disclaimer - No liability for the contents of this document can be accepted. Use - the concepts, examples, and other content at your own risk. This - document may contain errors and inaccuracies that may damage your - system, cause your partner to leave you, your boss to fire you, your - cats to pee on your furniture and clothing, and global thermonuclear - war. Proceed with caution. - - All copyrights are held by their respective owners, unless - specifically noted otherwise. Use of a term in this document should - not be regarded as affecting the validity of any trademark or service - mark. + No liability for the contents of this document can be accepted. Follow + the instructions herein at your own risk. This document may contain + errors and inaccuracies that may damage your system, cause your + partner to leave you, your boss to fire you, your cats to pee on your + furniture and clothing, and global thermonuclear war. Proceed with + caution. Naming of particular products or brands should not be seen as endorsements, with the exception of the term "GNU/Linux". We - wholeheartedly endorse the use of GNU/Linux in every situation where - it is appropriate. It is an extremely versatile, stable, and robust - operating system that offers an ideal operating environment for - Bugzilla. - - You are strongly recommended to make a backup of your system before - installing Bugzilla and at regular intervals thereafter. If you - implement any suggestion in this Guide, implement this one! + wholeheartedly endorse the use of GNU/Linux; it is an extremely + versatile, stable, and robust operating system that offers an ideal + operating environment for Bugzilla. Although the Bugzilla development team has taken great care to ensure - that all easily-exploitable bugs or options are documented or fixed in - the code, security holes surely exist. Great care should be taken both - in the installation and usage of this software. Carefully consider the - implications of installing other network services with Bugzilla. The - Bugzilla development team members, Netscape Communications, America - Online Inc., and any affiliated developers or sponsors assume no - liability for your use of this product. You have the source code to - this product, and are responsible for auditing it yourself to ensure - your security needs are met. + that all exploitable bugs or options have been fixed, security holes + surely exist. 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 the source code, + and are responsible for auditing it yourself to ensure your security + needs are met. _________________________________________________________________ 1.3. New Versions This is the 2.17.5 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. This version of the guide, like - its associated Bugzilla version is a development version. Information - is subject to change between now and when 2.18 is released. If you are - reading this from any source other than those below, please check one - of these mirrors to make sure you are reading an up-to-date version of - the Guide. + its associated Bugzilla version, is a development version. The newest version of this guide can always be found at - http://www.bugzilla.org; including documentation for past releases and - the current development version. - - The documentation for the most recent stable release of Bugzilla can - also be found at The Linux Documentation Project. + http://www.bugzilla.org; however, you should read the version which + came with the Bugzilla release you are using. The latest version of this document can always be checked out via CVS. Please follow the Mozilla CVS instructions and check out the @@ -204,41 +172,14 @@ Chapter 1. About This Guide efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: - Matthew P. Barnson - for the Herculaean task of pulling together the Bugzilla Guide - and shepherding it to 2.14. - - Terry Weissman - for initially writing Bugzilla and creating the README upon - which the UNIX installation documentation is largely based. - - Tara Hernandez - for keeping Bugzilla development going strong after Terry left - mozilla.org and for running landfill. - - Dave Lawrence - for providing insight into the key differences between Red - Hat's customized Bugzilla, and being largely responsible for - Section D.1. - - Dawn Endico - for being a hacker extraordinaire and putting up with Matthew's - incessant questions and arguments on irc.mozilla.org in - #mozwebtools - - Jacob Steenhagen - for taking over documentation during the 2.17 development - period. + 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. Last but not least, all the members of the - news://news.mozilla.org/netscape/public/mozilla/webtools newsgroup. - Without your discussions, insight, suggestions, and patches, this - could never have happened. - - Thanks also go to the following people for significant contributions - to this documentation (in alphabetical order): Andrew Pearson, Ben - FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, - Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption . + netscape.public.mozilla.webtools newsgroup. Without your discussions, + insight, suggestions, and patches, this could never have happened. _________________________________________________________________ 1.5. Document Conventions @@ -248,42 +189,40 @@ Chapter 1. About This Guide Descriptions Appearance Warnings - Caution - Don't run with scissors! + Don't run with scissors! Hint - Tip - Would you like a breath mint? + Would you like a breath mint? Notes - Note - Dear John... + Dear John... Information requiring special attention - Warning - Read this or the cat gets it. - File Names filename - Directory Names directory + Read this or the cat gets it. + File and directory names filename Commands to be typed command - Applications Names application + Applications names application Prompt of users command under bash shell bash$ Prompt of root users command under bash shell bash# Prompt of user command under tcsh shell tcsh$ - Environment Variables VARIABLE - Emphasized word word + Environment variables VARIABLE Term found in the glossary Bugzilla - Code Example - - Beginning and end of paragraph - + Code example + +Beginning and end of paragraph + + + This documentation is maintained in DocBook 4.1.2 XML format. Changes + are best submitted as plain text or XML diffs, attached to a bug filed + in the Bugzilla Documentation component. _________________________________________________________________ Chapter 2. Introduction @@ -292,16 +231,31 @@ Chapter 2. Introduction Bugzilla is a bug- or issue-tracking system. Bug-tracking systems allow individual or groups of developers effectively to keep track of - outstanding problems with their product. Bugzilla was originally - written by Terry Weissman in a programming language called TCL, to - replace a rudimentary bug-tracking database used internally by - Netscape Communications. Terry later ported Bugzilla to Perl from TCL, - and in Perl it remains to this day. Most commercial defect-tracking - software vendors at the time charged enormous licensing fees, and - Bugzilla quickly became a favorite of the open-source crowd (with its - genesis in the open-source browser project, Mozilla). It is now the - de-facto standard defect-tracking system against which all others are - measured. + outstanding problems with their products. + + Do we need more here? + _________________________________________________________________ + +2.2. Why use a bug-tracking system? + + For many years, defect-tracking software was principally the domain of + large software development houses. Most smaller shops simply relied on + shared lists and email to monitor the status of defects. This + procedure was error-prone and tended to cause those bugs judged least + significant by developers to be dropped or ignored. + + Integrated defect-tracking systems reduce downtime, increase + productivity, and raise customer satisfaction with their systems. + Along with full disclosure, an open bug-tracker allows you to keep in + touch with your clients and resellers, to communicate about problems + effectively throughout the data management chain. Many corporations + have also discovered that defect-tracking helps reduce costs by + providing IT support accountability, telephone support knowledge + bases, and a common, well-understood method for accounting for unusual + system or software issues. + _________________________________________________________________ + +2.3. Why use Bugzilla? Bugzilla boasts many advanced features. These include: @@ -317,29 +271,6 @@ Chapter 2. Introduction * Completely customisable and/or localisable web user interface * Extensive configurability * Smooth upgrade pathway between versions - _________________________________________________________________ - -2.2. Why Should We Use Bugzilla? - - For many years, defect-tracking software has remained principally the - domain of large software development houses. Even then, most shops - never bothered with bug-tracking software, and instead simply relied - on shared lists and email to monitor the status of defects. This - procedure is error-prone and tends to cause those bugs judged least - significant by developers to be dropped or ignored. - - These days, many companies are finding that integrated defect-tracking - systems reduce downtime, increase productivity, and raise customer - satisfaction with their systems. Along with full disclosure, an open - bug-tracker allows manufacturers to keep in touch with their clients - and resellers, to communicate about problems effectively throughout - the data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood system for accounting for unusual system or software - issues. - - But why should you use Bugzilla? Bugzilla is very adaptable to various situations. Known uses currently include IT support queues, Systems Administration deployment @@ -349,34 +280,18 @@ Chapter 2. Introduction Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a powerful, easy-to-use solution to configuration management and replication problems. - - Bugzilla can dramatically increase the productivity and accountability - of individual employees by providing a documented workflow and - positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do something - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and follow the discussion trail that - led to critical decisions. - - Ultimately, Bugzilla puts the power in your hands to improve your - value to your employer or business while providing a usable framework - for your natural attention to detail and knowledge store to flourish. _________________________________________________________________ Chapter 3. Using Bugzilla -3.1. How do I use Bugzilla? - This section contains information for end-users of Bugzilla. There is a Bugzilla test installation, called Landfill, which you are welcome to play with (if it's up.) However, it does not necessarily have all - Bugzilla features enabled, and often runs cutting-edge versions of - Bugzilla for testing, so some things may work slightly differently - than mentioned here. + Bugzilla features enabled, and runs an up-to-the-minute version, so + some things may not quite work as this document describes. _________________________________________________________________ -3.1.1. Create a Bugzilla Account +3.1. Create a Bugzilla Account If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of @@ -388,19 +303,19 @@ Chapter 3. Using Bugzilla address and, optionally, your name in the spaces provided, then click "Create Account" . 2. Within moments, you should receive an email to the address you - provided above, which contains your login name (generally the same - as the email address), and a password you can use to access your - account. This password is randomly generated, and can be changed - to something more memorable. - 3. Click the "Log In" link in the yellow area at the bottom of the - page in your browser, enter your email address and password into - the spaces provided, and click "Login". + 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. + 3. Click the "Log In" 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 "Login". - You are now logged in. Bugzilla uses cookies for authentication so, - unless your IP address changes, you should not have to log in again. + 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. _________________________________________________________________ -3.1.2. Anatomy of a Bug +3.2. Anatomy of a Bug The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. Bug 1 on Landfill @@ -415,22 +330,22 @@ Chapter 3. Using Bugzilla several Components: Administration: Administration of a Bugzilla installation. - Bugzilla-General: Anything that doesn't fit in the other components, - or spans multiple components. + Bugzilla-General: Anything that doesn't fit in the other components, + or spans multiple components. Creating/Changing Bugs: Creating, changing, and viewing bugs. - Documentation: The Bugzilla documentation, including The Bugzilla - Guide. + Documentation: The Bugzilla documentation, including The Bugzilla + Guide. Email: Anything to do with email sent by Bugzilla. Installation: The installation process of Bugzilla. - Query/Buglist: Anything to do with searching for bugs and viewing the - buglists. + Query/Buglist: Anything to do with searching for bugs and viewing the + buglists. Reporting/Charting: Getting reports from Bugzilla. - User Accounts: Anything about managing a user account from the user's - perspective. Saved queries, creating accounts, changing passwords, - logging in, etc. - User Interface: General issues having to do with the user interface - cosmetics (not functionality) including cosmetic issues, HTML - templates, etc. + User Accounts: Anything about managing a user account from the user's + perspective. Saved queries, creating accounts, changing passwords, + logging in, etc. + User Interface: General issues having to do with the user interface + cosmetics (not functionality) including cosmetic issues, HTML + templates, etc. 2. Status and Resolution: These define exactly what state the bug is in - from not even being confirmed as a bug, through to being fixed and the fix confirmed by Quality Assurance. The different @@ -476,7 +391,7 @@ Chapter 3. Using Bugzilla discussion here, if you have something worthwhile to say. _________________________________________________________________ -3.1.3. Searching for Bugs +3.3. Searching for Bugs The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You @@ -486,21 +401,19 @@ Chapter 3. Using Bugzilla 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 one of the selected values. If - none is selected, then the field can take any value. + where the content of the field matches any one of the selected values. + If none is selected, then the field can take any value. - Once you've defined a search, you can either run it, or save it as a - Remembered Query, which can optionally appear in the footer of your - pages. + Once you've run a search, you can save it as a Saved Search, which + appears in the page footer. - Highly advanced querying is done using Boolean Charts. + Highly advanced querying is done using Boolean Charts. See the Boolean + Charts help link on the Search page for more information. _________________________________________________________________ -3.1.4. Bug Lists +3.4. Bug Lists - If you run a search, a list of matching bugs will be returned. The - default search is to return all open bugs on the system - don't try - running this search on a Bugzilla installation with a lot of bugs! + If you run a search, a list of matching bugs will be returned. The format of the list is configurable. For example, it can be sorted by clicking the column headings. Other useful features can be accessed @@ -520,7 +433,7 @@ Chapter 3. Using Bugzilla accurate results. _________________________________________________________________ -3.1.5. Filing Bugs +3.5. Filing Bugs Years of bug writing experience has been distilled for your reading pleasure into the Bug Writing Guidelines. While some of the advice is @@ -541,7 +454,7 @@ Chapter 3. Using Bugzilla 4. Select "Commit" and send in your bug report. _________________________________________________________________ -3.1.6. Patch Viewer +3.6. Patch Viewer Viewing and reviewing patches in Bugzilla is often difficult due to lack of context, improper format and the inherent readability issues @@ -563,7 +476,7 @@ Chapter 3. Using Bugzilla format it came from _________________________________________________________________ -3.1.6.1. Viewing Patches in Patch Viewer +3.6.1. Viewing Patches in Patch Viewer 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 @@ -571,7 +484,7 @@ Chapter 3. Using Bugzilla button in the Edit Attachment screen. _________________________________________________________________ -3.1.6.2. Seeing the Difference Between Two Patches +3.6.2. Seeing the Difference Between Two Patches To see the difference between two patches, you must first view the newer patch in Patch Viewer. Then select the older patch from the @@ -580,7 +493,7 @@ Chapter 3. Using Bugzilla new or changed in the newer patch. _________________________________________________________________ -3.1.6.3. Getting More Context in a Patch +3.6.3. Getting More Context in a Patch 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 @@ -590,7 +503,7 @@ Chapter 3. Using Bugzilla against files that were diffed using "cvs diff". _________________________________________________________________ -3.1.6.4. Collapsing and Expanding Sections of a Patch +3.6.4. Collapsing and Expanding Sections of a Patch 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 @@ -600,7 +513,7 @@ Chapter 3. Using Bugzilla the top of the page. _________________________________________________________________ -3.1.6.5. Linking to a Section of a Patch +3.6.5. Linking to a Section of a Patch 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) @@ -609,7 +522,7 @@ Chapter 3. Using Bugzilla Location in Mozilla works as well.) _________________________________________________________________ -3.1.6.6. Going to Bonsai and LXR +3.6.6. Going to Bonsai and LXR 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 @@ -621,29 +534,30 @@ Chapter 3. Using Bugzilla numbers are likely to rot). _________________________________________________________________ -3.1.6.7. Creating a Unified Diff +3.6.7. Creating a Unified Diff 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. _________________________________________________________________ -3.2. Hints and Tips +3.7. Hints and Tips This section distills some Bugzilla tips and best practices that have been developed. _________________________________________________________________ -3.2.1. Autolinkification +3.7.1. Autolinkification - Bugzilla comments are plain text - so posting HTML will result in - literal HTML tags rather than being interpreted by a browser. However, + Bugzilla comments are plain text - so typing 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 http://www.bugzilla.org. Other strings which get - linkified in the obvious manner are: + text in comments. For example, the text "http://www.bugzilla.org" will + be turned into a link: http://www.bugzilla.org. Other strings which + get linkified in the obvious manner are: bug 12345 + comment 7 bug 23456, comment 53 attachment 4321 mailto:george@example.com @@ -656,7 +570,7 @@ Chapter 3. Using Bugzilla convenience of others. _________________________________________________________________ -3.2.2. Quicksearch +3.7.2. Quicksearch Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing "foo|bar" into @@ -668,7 +582,7 @@ Chapter 3. Using Bugzilla Help link which details how to use it. _________________________________________________________________ -3.2.3. Comments +3.7.3. Comments If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. Otherwise, @@ -680,11 +594,11 @@ Chapter 3. Using Bugzilla mail they would otherwise have avoided. Don't use sigs in comments. Signing your name ("Bill") is acceptable, - particularly if you do it out of habit, but full mail/news-style four - line ASCII art creations are not. + if you do it out of habit, but full mail/news-style four line ASCII + art creations are not. _________________________________________________________________ -3.2.4. Attachments +3.7.4. Attachments Use attachments, rather than comments, for large chunks of ASCII data, such as trace, debugging output files, or log files. That way, it @@ -700,7 +614,7 @@ Chapter 3. Using Bugzilla way, the test case works immediately out of the bug. _________________________________________________________________ -3.2.5. Filing Bugs +3.7.5. Filing Bugs 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 @@ -715,14 +629,14 @@ Chapter 3. Using Bugzilla Feel free to CC the person who duped it if they are not already CCed. _________________________________________________________________ -3.3. User Preferences +3.8. User Preferences Once you have logged in, you can customise various aspects of Bugzilla via the "Edit prefs" link in the page footer. The preferences are - split into four tabs: + split into three tabs: _________________________________________________________________ -3.3.1. Account Settings +3.8.1. Account Settings On this tab, you can change your basic account information, including your password, email address and real name. For security reasons, in @@ -733,13 +647,17 @@ Chapter 3. Using Bugzilla change. This helps to prevent account hijacking. _________________________________________________________________ -3.3.2. Email Settings +3.8.2. Email Settings On this tab you can reduce or increase the amount of email sent you from Bugzilla, opting in our out depending on your relationship to the - bug and the change that was made to it. (Note that you can also do - client-side filtering using the X-Bugzilla-Reason header which - Bugzilla adds to all bugmail.) + bug and the change that was made to it. + + 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. 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 @@ -749,19 +667,11 @@ Chapter 3. Using Bugzilla Note - The ability to watch other users may not be available in all Bugzilla - installations. If you can't see it, ask your administrator. + The ability to watch other users may not be available in all Bugzilla + installations. If you can't see it, ask your administrator. _________________________________________________________________ -3.3.3. Page Footer - - On the Search page, you can store queries in Bugzilla, so if you - regularly run a particular query it is just a drop-down menu away. - Once you have a stored query, you can come here to request that it - also be displayed in your page footer. - _________________________________________________________________ - -3.3.4. Permissions +3.8.3. Permissions This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you @@ -769,6 +679,11 @@ Chapter 3. Using Bugzilla administration functions. _________________________________________________________________ +3.9. Reports + + To be written + _________________________________________________________________ + Chapter 4. Installation 4.1. Step-by-step Install @@ -777,23 +692,23 @@ Chapter 4. Installation operating systems including almost all Unix clones and Microsoft Windows. Many operating systems have utilities that make installation easier or quirks that make it harder. We have tried to collect that - information in Section 4.3, so be sure to check out that section + information in Section 4.4, so be sure to check out that section before you start your installation. Note - 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 Section 4.3.1. + 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 Section 4.4.1. - Warning + Warning - While installing Bugzilla, it is a good idea to ensure that there is - some kind of 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. + While installing Bugzilla, it is a good idea to ensure that there is + some kind of 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. This guide assumes that you already have your operating system installed, network configured, and have administrative access to the @@ -802,29 +717,42 @@ Chapter 4. Installation have to either make sure all the required software is installed or get somebody with administrative access to install it for you. + You are strongly recommended to make a backup of your system before + installing Bugzilla and at regular intervals thereafter. + The listing below is a basic step-by-step list. More information can be found in the sections below. Minimum versions will be included in parenthesis where appropriate. - 1. Install MySQL (3.23.41) - 2. Install Perl (5.6) - 3. Install Perl Modules - 4. Install a Webserver - 5. Put Bugzilla in the Webspace + 1. Install Perl (5.6) + 2. Install MySQL (3.23.41) + 3. Install a Webserver + 4. Put Bugzilla in the Webspace + 5. Install Perl Modules 6. Setup the MySQL Database _________________________________________________________________ -4.1.1. MySQL +4.1.1. Perl + + Any machine that doesn't have Perl on it is a sad machine indeed. Perl + can be got in source form from http://www.perl.com. 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, 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. + _________________________________________________________________ + +4.1.2. MySQL Visit the MySQL homepage at http://www.mysql.com to grab and install the latest stable release of the server. Note - Many of the binary versions of MySQL store their data files in /var. - On some Unix systems, this is part of a smaller root partition, and - may not have room for your bug database. You can set the data - directory as an option to configure if you build MySQL from source - yourself. + Many of the binary versions of MySQL store their data files in /var. + On some Unix systems, this is part of a smaller root partition, and + may not have room for your bug database. You can set the data + directory as an option to configure if you build MySQL from source + yourself. If you install from something other than a packaging/installation system (such as .rpm, .dep, .exe, or .msi) you will need to configure @@ -838,26 +766,88 @@ Chapter 4. Installation set this value to be slightly larger than that parameter. Figure 4-1. Set Max Packet Size in MySQL - [mysqld] - # Allow packets up to 1M - set-variable = max_allowed_packet=1M +[mysqld] +# Allow packets up to 1M +set-variable = max_allowed_packet=1M If you are running Bugzilla and MySQL on the same machine, you may also wish to utilize the skip-networking option as mentioned in - Section 5.6.2 for the added security. + Section 4.5.2 for the added security. _________________________________________________________________ -4.1.2. Perl +4.1.2.1. Configuring MySQL - Any machine that doesn't have Perl on it is a sad machine indeed. Perl - can be got in source form from http://www.perl.com. 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, 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. + This first thing you'll want to do is make sure you've given the + "root" user a password as suggested in Section 4.5.2. For clarity, + these instructions will assume that your MySQL user for Bugzilla will + be "bugs_user", the database will be called "bugs_db" and the password + for the "bugs_user" user is "bugs_password". You should, of course, + substitute the values you intend to use for your site. + + Note + + Most people use "bugs" for both the user and database name. + + Next, we use an SQL GRANT command to create a "bugs_user" user, and + grant sufficient permissions for checksetup.pl, which we'll use later, + to work its magic. This also restricts the "bugs_user" user to + operations within a database called "bugs_db", and only allows the + account to connect from "localhost". Modify it to reflect your setup + if you will be connecting from another machine or as a different user. + mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost + IDENTIFIED BY 'bugs_password'; + mysql> FLUSH PRIVILEGES; + + Note + + If you are using MySQL 4, the bugs user also needs to be granted the + LOCK TABLES and CREATE TEMPORARY TABLES permissions. _________________________________________________________________ -4.1.3. Perl Modules +4.1.3. HTTP Server + + You have freedom of choice here, pretty much any web server that is + capable of running CGI scripts will work. Section 4.2 has more + information about configuring web servers to work with Bugzilla. + + Note + + We strongly recommend Apache as the web server to use. The Bugzilla + Guide installation instructions, in general, assume you are using + Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us by filing a bug in Bugzilla + Documentation. + _________________________________________________________________ + +4.1.4. Bugzilla + + You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + "nobody"). You may decide to put the files in the main web space for + your web server or perhaps in /usr/local with a symbolic link in the + web space that points to the Bugzilla directory. + + Tip + + If you symlink the bugzilla directory into your Apache's HTML + hierarchy, you may receive Forbidden errors unless you add the + "FollowSymLinks" directive to the entry for the HTML root + in httpd.conf. + + Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install checksetup.pl script, which locks down + your installation. + + Caution + + The default Bugzilla distribution is not designed to be placed in a + cgi-bin directory (this includes any directory which is configured + using the ScriptAlias directive of Apache). + _________________________________________________________________ + +4.1.5. Perl Modules Perl modules can be found using CPAN on Unix based systems or PPM on Win32. The root servers have a real tendency to bog down, so please @@ -865,39 +855,39 @@ Chapter 4. Installation Good instuctions can be found for using each of these services on their respective websites. The basics can be found in Example 4-1 for - CPAN and Section 4.3.1.2 for PPM. + CPAN and Section 4.4.1.2 for PPM. Example 4-1. Installing perl modules with CPAN The easy way: - bash# perl -MCPAN -e 'install ""' +bash# perl -MCPAN -e 'install ""' Or the hard way: - bash# tar xzvf .tar.gz (1) - bash# cd (2) - bash# perl Makefile.PL - bash# make - bash# make test - bash# make install +bash# tar xzvf .tar.gz (1) +bash# cd (2) +bash# perl Makefile.PL +bash# make +bash# make test +bash# make install - (1) + (1) This assumes that you've already downloaded the .tar.gz to the current working directory. - (2) - The process of untaring the module as defined in (1) will + (2) + The process of untarring the module as defined in (1) will create the directory. Tip - Many people complain that Perl modules will not install for them. Most - times, the error messages complain that they are missing a file in - "@INC". Virtually every time, this error is due to permissions being - set too restrictively for you to compile Perl modules or not having - the necessary Perl development libraries installed on your system. - Consult your local UNIX systems administrator for help solving these - permissions issues; if you are the local UNIX sysadmin, please consult - the newsgroup/mailing list for further assistance or hire someone to - help you out. + Many people complain that Perl modules will not install for them. Most + times, the error messages complain that they are missing a file in + "@INC". Virtually every time, this error is due to permissions being + set too restrictively for you to compile Perl modules or not having + the necessary Perl development libraries installed on your system. + Consult your local UNIX systems administrator for help solving these + permissions issues; if you are the local UNIX sysadmin, please consult + the newsgroup/mailing list for further assistance or hire someone to + help you out. Perl Modules (minimum version): @@ -924,7 +914,7 @@ Chapter 4. Installation 7. PatchReader (0.9.1) for pretty HTML view of patches _________________________________________________________________ -4.1.3.1. Bundle::Bugzilla +4.1.5.1. Bundle::Bugzilla 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 @@ -935,25 +925,25 @@ Chapter 4. Installation Assuming your perl was installed with CPAN (most unix installations are), using Bundle::Bugzilla is really easy. Simply follow along with the commands below. - bash# perl -MCPAN -eshell (1) - cpan shell -- CPAN exploration and modules installation (v1.63) - ReadLine support enabled +bash# perl -MCPAN -eshell (1) +cpan shell -- CPAN exploration and modules installation (v1.63) +ReadLine support enabled - cpan> +cpan> - (1) + (1) At this point, unless you've used CPAN on this machine before, you'll have to go through a series of configuration steps. _________________________________________________________________ -4.1.3.2. AppConfig (1.52) +4.1.5.2. AppConfig (1.52) Dependency for Template Toolkit. We probably don't need to specifically check for it anymore. _________________________________________________________________ -4.1.3.3. CGI (2.88) +4.1.5.3. CGI (2.88) The CGI module parses form elements and cookies and does many other usefule things. It come as a part of recent perl distributions, but @@ -965,7 +955,7 @@ Chapter 4. Installation Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html _________________________________________________________________ -4.1.3.4. Data::Dumper (any) +4.1.5.4. Data::Dumper (any) The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later sub-releases of @@ -979,7 +969,7 @@ Chapter 4. Installation r.html _________________________________________________________________ -4.1.3.5. TimeDate modules (2.21) +4.1.5.5. TimeDate modules (2.21) Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This @@ -994,7 +984,7 @@ Chapter 4. Installation ormat.pm _________________________________________________________________ -4.1.3.6. DBI (1.32) +4.1.5.6. DBI (1.32) The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done correctly the DBI @@ -1007,7 +997,7 @@ Chapter 4. Installation Documentation: http://dbi.perl.org/doc/ _________________________________________________________________ -4.1.3.7. MySQL-related modules +4.1.5.7. MySQL-related modules The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -1032,7 +1022,7 @@ Chapter 4. Installation ysql.pod _________________________________________________________________ -4.1.3.8. File::Spec (0.82) +4.1.5.8. File::Spec (0.82) File::Spec is a perl module that allows file operations, such as generating full path names, to work cross platform. @@ -1044,7 +1034,7 @@ Chapter 4. Installation html _________________________________________________________________ -4.1.3.9. File::Temp (any) +4.1.5.9. File::Temp (any) File::Temp is used to generate a temporary filename that is guaranteed to be unique. It comes as a standard part of perl @@ -1056,7 +1046,7 @@ Chapter 4. Installation html _________________________________________________________________ -4.1.3.10. Template Toolkit (2.08) +4.1.5.10. Template Toolkit (2.08) When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except that it is @@ -1070,7 +1060,7 @@ Chapter 4. Installation Documentation: http://www.template-toolkit.org/docs.html _________________________________________________________________ -4.1.3.11. Text::Wrap (2001.0131) +4.1.5.11. Text::Wrap (2001.0131) Text::Wrap is designed to proved intelligent text wrapping. @@ -1080,7 +1070,7 @@ Chapter 4. Installation html _________________________________________________________________ -4.1.3.12. GD (1.20) [optional] +4.1.5.12. GD (1.20) [optional] The GD library was written by Thomas Boutell a long while ago to programmatically generate images in C. Since then it's become the @@ -1092,16 +1082,16 @@ Chapter 4. Installation Note - The Perl GD library requires some other libraries that may or may not - be installed on your system, including libpng and libgd. The full - requirements are listed in the Perl GD library README. If compiling GD - fails, it's probably because you're missing a required library. + The Perl GD library requires some other libraries that may or may not + be installed on your system, including libpng and libgd. The full + requirements are listed in the Perl GD library README. If compiling GD + fails, it's probably because you're missing a required library. Tip - The version of the GD perl module you need is very closely tied to the - libgd version installed on your system. If you have a version 1.x of - libgd the 2.x versions of the GD perl module won't work for you. + The version of the GD perl module you need is very closely tied to the + libgd version installed on your system. If you have a version 1.x of + libgd the 2.x versions of the GD perl module won't work for you. CPAN Download Page: http://search.cpan.org/dist/GD/ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips @@ -1109,7 +1099,7 @@ Chapter 4. Installation Documentation: http://stein.cshl.org/WWW/software/GD/ _________________________________________________________________ -4.1.3.13. Chart::Base (0.99c) [optional] +4.1.5.13. Chart::Base (0.99c) [optional] The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched @@ -1121,7 +1111,7 @@ Chapter 4. Installation /6xx-builds-only/Chart.zip _________________________________________________________________ -4.1.3.14. XML::Parser (any) [Optional] +4.1.5.14. XML::Parser (any) [Optional] XML::Parser is used by the importxml.pl script. You only need it if you are going to be importing bugs (such as for bug moving). @@ -1133,7 +1123,7 @@ Chapter 4. Installation .html _________________________________________________________________ -4.1.3.15. GD::Graph (any) [Optional] +4.1.5.15. GD::Graph (any) [Optional] In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -1144,7 +1134,7 @@ Chapter 4. Installation Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm _________________________________________________________________ -4.1.3.16. GD::Text::Align (any) [Optional] +4.1.5.16. GD::Text::Align (any) [Optional] GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -1156,7 +1146,7 @@ Chapter 4. Installation gn.pm _________________________________________________________________ -4.1.3.17. MIME::Parser (any) [Optional] +4.1.5.17. MIME::Parser (any) [Optional] MIME::Parser is only needed if you want to use the e-mail interface located in the contrib directory. @@ -1168,7 +1158,7 @@ Chapter 4. Installation /Parser.pm _________________________________________________________________ -4.1.3.18. PatchReader (0.9.1) [Optional] +4.1.5.18. PatchReader (0.9.1) [Optional] 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 @@ -1186,93 +1176,15 @@ Chapter 4. Installation html _________________________________________________________________ -4.1.4. HTTP Server +4.1.6. checksetup.pl - You have freedom of choice here, pretty much any web server that is - capable of running CGI scripts will work. Section 4.4 has more - information about configuring web servers to work with Bugzilla. - - Note - - We strongly recommend Apache as the web server to use. The Bugzilla - Guide installation instructions, in general, assume you are using - Apache. If you have got Bugzilla working using another webserver, - please share your experiences with us by filing a bug in Bugzilla - Documentation. - _________________________________________________________________ - -4.1.5. Bugzilla - - You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - "nobody"). You may decide to put the files in the main web space for - your web server or perhaps in /usr/local with a symbolic link in the - web space that points to the Bugzilla directory. - - Tip - - If you symlink the bugzilla directory into your Apache's HTML - hierarchy, you may receive Forbidden errors unless you add the - "FollowSymLinks" directive to the entry for the HTML root - in httpd.conf. - - Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install checksetup.pl script, which locks down - your installation. - - Caution - - The default Bugzilla distribution is not designed to be placed in a - cgi-bin directory (this includes any directory which is configured - using the ScriptAlias directive of Apache). This will probably change - as part of bug 44659. - _________________________________________________________________ - -4.1.6. Setting Up the MySQL Database - - After you've gotten all the software installed and working you're - ready to start preparing the database for its life as the back end to - a high quality bug tracker. - - This first thing you'll want to do is make sure you've given the - "root" user a password as suggested in Section 5.6.2. For clarity, - these instructions will assume that your MySQL user for Bugzilla will - be "bugs_user", the database will be called "bugs_db" and the password - for the "bugs_user" user is "bugs_password". You should, of course, - substitute the values you intend to use for your site. - - Note - - Most people use "bugs" for both the user and database name. - - Next, we use an SQL GRANT command to create a "bugs_user" user, and - grant sufficient permissions for checksetup.pl, which we'll use later, - to work its magic. This also restricts the "bugs_user" user to - operations within a database called "bugs_db", and only allows the - account to connect from "localhost". Modify it to reflect your setup - if you will be connecting from another machine or as a different user. - mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, - DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost - IDENTIFIED BY 'bugs_password'; - mysql> FLUSH PRIVILEGES; - - Note - - If you are using MySQL 4, the bugs user also needs to be granted the - LOCK TABLES and CREATE TEMPORARY TABLES permissions. - _________________________________________________________________ - -4.1.7. checksetup.pl - - Next, run the magic checksetup.pl script. (Many thanks to Holger - Schurig for writing this script!) This script is designed to make sure - your perl modules are the correct version and your MySQL database and - other configuration options are consistent with the Bugzilla CGI + Next, run the magic checksetup.pl script. This is designed to make + sure your perl modules are the correct version and your MySQL database + and other configuration options are consistent with the Bugzilla CGI files. It will make sure Bugzilla files and directories have reasonable permissions, set up the data directory, and create all the MySQL tables. - bash# ./checksetup.pl +bash# ./checksetup.pl The first time you run it, it will create a file called localconfig. @@ -1296,21 +1208,123 @@ Chapter 4. Installation Note - 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. + 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. _________________________________________________________________ -4.1.8. Configuring Bugzilla +4.1.7. Configuring Bugzilla You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. They key parameters are documented in Section 5.1. _________________________________________________________________ -4.2. Optional Additional Configuration +4.2. HTTP Server Configuration -4.2.1. Dependency Charts + The Bugzilla Team recommends Apache when using Bugzilla, however, any + web server that can be configured to run CGI scripts should be able to + handle Bugzilla. No matter what web server you choose, but especially + if you choose something other than Apache, you should be sure to read + Section 4.5.4. + + The plan for this section is to eventually document the specifics of + how to lock down permissions on individual web servers. + _________________________________________________________________ + +4.2.1. Apache httpd + + You will have to make sure that Apache is properly configured to run + the Bugzilla CGI scripts. You also need to make sure that the + .htaccess files created by ./checksetup.pl are allowed to override + Apache's normal access permissions or else important password + information may be exposed to the Internet. + + You need to configure Apache to run .cgi files outside the cgi-bin + directory. Open your httpd.conf file and make sure the following line + exists and is uncommented: +AddHandler cgi-script .cgi + + To allow .htaccess files to override permissions and .cgi files to run + in the Bugzilla directory, make sure the following two lines are in a + Directory directive that applies to the Bugzilla directory on your + system (either the Bugzilla directory or one of its parents). +Options +ExecCGI +AllowOverride Limit + + You should modify the parameter for the Apache + virtual host running your Bugzilla installation to allow index.cgi as + the index page for a directory, as well as the usual index.html, + index.htm, and so forth. + + Note + + For more information on Apache and its directives, see the glossary + entry on Apache. + _________________________________________________________________ + +4.2.2. Microsoft Internet Information Services + + If you need, or for some reason even want, to use Microsoft's Internet + Information Services or Personal Web Server you should be able to. You + will need to configure them to know how to run CGI scripts, however. + This is described in Microsoft Knowledge Base article Q245225 for + Internet Information Services and Q231998 for Personal Web Server. + + Also, and this can't be stressed enough, make sure that files such as + localconfig and your data directory are secured as described in + Section 4.5.4. + _________________________________________________________________ + +4.2.3. AOL Server + + Ben FrantzDale reported success using AOL Server with Bugzilla. He + reported his experience and what appears below is based on that. + + AOL Server will have to be configured to run CGI scripts, please + consult the documentation that came with your server for more + information on how to do this. + + Because AOL Server doesn't support .htaccess files, you'll have to + create a TCL script. You should create an + aolserver/modules/tcl/filter.tcl file (the filename shouldn't matter) + with the following contents (change /bugzilla/ to the web-based path + to your Bugzilla installation): +ns_register_filter preauth GET /bugzilla/localconfig filter_deny +ns_register_filter preauth GET /bugzilla/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" +} + + Warning + + This probably doesn't account for all possible editor backup files so + you may wish to add some additional variations of localconfig. For + more information, see bug 186383 or Bugtraq ID 6501. + + Note + + If you are using webdot from research.att.com (the default + configuration for the webdotbase paramater), you will need to allow + access to data/webdot/*.dot for the reasearch.att.com machine. + + If you are using a local installation of GraphViz, you will need to + allow everybody to access *.png, *.gif, *.jpg, and *.map in the + data/webdot directory. + _________________________________________________________________ + +4.3. Optional Additional Configuration + +4.3.1. Dependency Charts As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. Exactly how this @@ -1330,7 +1344,7 @@ Chapter 4. Installation Bugzilla is only accessible using HARTS. _________________________________________________________________ -4.2.2. Bug Graphs +4.3.2. Bug Graphs As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs. @@ -1345,7 +1359,7 @@ Chapter 4. Installation Bug Reports page. _________________________________________________________________ -4.2.3. The Whining Cron +4.3.3. The Whining Cron By now you have a fully functional Bugzilla, but what good are bugs if they're not annoying? To help make those bugs more annoying you can @@ -1357,27 +1371,18 @@ Chapter 4. Installation cd ; ./whineatnews.pl - Tip + Tip - Depending on your system, crontab may have several manpages. The - following command should lead you to the most useful page for this - purpose: - - man 5 crontab + Depending on your system, crontab may have several manpages. The + following command should lead you to the most useful page for this + purpose: + man 5 crontab _________________________________________________________________ -4.2.4. LDAP Authentication +4.3.4. LDAP Authentication - Note - - LDAP authentication has been rewritten for the 2.18 release of - Bugzilla. It no longer requires the Mozilla::LDAP module and now uses - Net::LDAP instead. This rewrite was part of a larger landing that - allowed for additional authentication schemes to be easily added (bug - 180642). - - This patch originally landed in 21-Mar-2003 and was included in the - 2.17.4 development release. + LDAP authentication is a module for Bugzilla's plugin authentication + architecture. The existing authentication scheme for Bugzilla uses email addresses as the primary user ID, and a password to authenticate that user. All @@ -1395,14 +1400,14 @@ Chapter 4. Installation tasks are still handled by email address, not LDAP username. You still assign bugs by email address, query on users by email address, etc. - Caution + Caution - Because the Bugzilla account is not created until the first time a - user logs in, a user who has not yet logged is unknown to Bugzilla. - This means they cannot be used as an assignee or QA contact (default - or otherwise), added to any cc list, or any other such operation. One - possible workaround is the bugzilla_ldapsync.rb script in the contrib - directory. Another possible solution is fixing bug 201069. + Because the Bugzilla account is not created until the first time a + user logs in, a user who has not yet logged is unknown to Bugzilla. + This means they cannot be used as an assignee or QA contact (default + or otherwise), added to any cc list, or any other such operation. One + possible workaround is the bugzilla_ldapsync.rb script in the contrib + directory. Another possible solution is fixing bug 201069. Parameters required to use LDAP Authentication: @@ -1452,52 +1457,33 @@ Chapter 4. Installation Ex. "mail" _________________________________________________________________ -4.2.5. Preventing untrusted Bugzilla content from executing malicious +4.3.5. Preventing untrusted Bugzilla content from executing malicious Javascript code - It is possible for a Bugzilla to execute malicious Javascript code. - Due to internationalization concerns, we are unable to incorporate the - code changes necessary to fulfill the CERT advisory requirements - mentioned in - http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3. - Making the change below will fix the problem if your installation is - for an English speaking audience. + 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. Due to internationalization concerns, we are + unable to incorporate by default the code changes necessary to fulfill + the CERT advisory requirements mentioned in + http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3. If + your installation is for an English speaking audience only, making the + change below will prevent this problem. - Telling Bugzilla to output a charset as part of the HTTP header is - much easier in version 2.18 and higher (including any cvs pull after - 4-May-2003 and development release after 2.17.5) than it was in - previous versions. Simply locate the following line in - Bugzilla/CGI.pm: - # Make sure that we don't send any charset headers - $self->charset(''); + Simply locate the following line in Bugzilla/CGI.pm: + $self->charset(''); and change it to: - # Send all data using the ISO-8859-1 charset - $self->charset('ISO-8859-1'); - - Note - - Using tags to set the charset is not recommended, as there's a - bug in Netscape 4.x which causes pages marked up in this way to load - twice. See bug 126266 for more information including progress toward - making bugzilla charset aware by default. + $self->charset('ISO-8859-1'); _________________________________________________________________ -4.2.6. directoryindex for the Bugzilla default page. - - You should modify the parameter for the Apache - virtual host running your Bugzilla installation to allow index.cgi as - the index page for a directory, as well as the usual index.html, - index.htm, and so forth. - _________________________________________________________________ - -4.2.7. Bugzilla and mod_perl +4.3.6. Bugzilla and mod_perl Bugzilla is unsupported under mod_perl. Effort is underway to make it work cleanly in a mod_perl environment, but it is slow going. _________________________________________________________________ -4.2.8. mod_throttle and Security +4.3.7. mod_throttle and Security It is possible for a user, by mistake or on purpose, to access the database many times in a row which can result in very slow access @@ -1511,7 +1497,7 @@ Javascript code Instructions for more information. _________________________________________________________________ -4.3. OS Specific Installation Notes +4.4. OS Specific Installation Notes 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 @@ -1523,9 +1509,9 @@ Javascript code covered, please file a bug in Bugzilla Documentation. _________________________________________________________________ -4.3.1. Microsoft Windows +4.4.1. Microsoft Windows - Making Bugzilla work on windows is still a very painful processes. The + 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 @@ -1540,104 +1526,99 @@ Javascript code compatibility by the 2.18 release. _________________________________________________________________ -4.3.1.1. Win32 Perl +4.4.1.1. Win32 Perl Perl for Windows can be obtained from ActiveState. You should be able to find a compiled binary at http://aspn.activestate.com/ASPN/Downloads/ActivePerl/. _________________________________________________________________ -4.3.1.2. Perl Modules on Win32 +4.4.1.2. Perl Modules on Win32 Bugzilla on Windows requires the same perl modules found in Section - 4.1.3. The main difference is that windows uses PPM instead of CPAN. - C:\perl> ppm + 4.1.5. The main difference is that windows uses PPM instead of CPAN. +C:\perl> ppm Note - The above syntax should work for all modules with the exception of - Template Toolkit. The Template Toolkit website suggests using the - instructions on OpenInteract's website. + The above syntax should work for all modules with the exception of + Template Toolkit. The Template Toolkit website suggests using the + instructions on OpenInteract's website. Tip - A complete list of modules that can be installed using ppm can be - found at http://www.activestate.com/PPMPackages/5.6plus. + A complete list of modules that can be installed using ppm can be + found at http://www.activestate.com/PPMPackages/5.6plus. _________________________________________________________________ -4.3.1.3. Code changes required to run on win32 +4.4.1.3. Code changes required to run on win32 - Unfortunately, Bugzilla still doesn't run "out of the box" on Windows. - There is work in progress to make this easier, but until that happens - code will have to be modified. This section is an attempt to list the - required changes. It is an attempt to be all inclusive, but there may - be other changes required. If you find something is missing, please - file a bug in Bugzilla Documentation. + 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. _________________________________________________________________ -4.3.1.3.1. Changes to checksetup.pl +4.4.1.3.1. Changes to checksetup.pl In checksetup.pl, the line reading: - my $mysql_binaries = `which mysql`; +my $mysql_binaries = `which mysql`; to - my $mysql_binaries = "D:\\mysql\\bin\\mysql"; +my $mysql_binaries = "D:\\mysql\\bin\\mysql"; And you'll also need to change: - my $webservergid = getgrnam($my_webservergroup) +my $webservergid = getgrnam($my_webservergroup) to - my $webservergid = '8' +my $webservergid = '8' _________________________________________________________________ -4.3.1.3.2. Changes to BugMail.pm +4.4.1.3.2. Changes to BugMail.pm To make bug e-mail work on Win32 (until bug 84876 lands), the simplest - way is to have Net::SMTP installed and change this (in - Bugzilla/BugMail.pm): - open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") || - die "Can't open sendmail"; + way is to have the Net::SMTP Perl module installed and change this: +open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") || + die "Can't open sendmail"; - print SENDMAIL trim($msg) . "\n"; - close SENDMAIL; +print SENDMAIL trim($msg) . "\n"; +close SENDMAIL; to - use Net::SMTP; - my $smtp_server = 'smtp.mycompany.com'; # change this +use Net::SMTP; +my $smtp_server = 'smtp.mycompany.com'; # change this - # Use die on error, so that the mail will be in the 'unsent mails' and - # can be sent from the sanity check page. - my $smtp = Net::SMTP->new($smtp_server) || - die 'Cannot connect to server \'$smtp_server\''; +# Use die on error, so that the mail will be in the 'unsent mails' and +# can be sent from the sanity check page. +my $smtp = Net::SMTP->new($smtp_server) || + die 'Cannot connect to server \'$smtp_server\''; - $smtp->mail('bugzilla-daemon@mycompany.com'); # change this - $smtp->to($person); - $smtp->data(); - $smtp->datasend($msg); - $smtp->dataend(); - $smtp->quit; +$smtp->mail('bugzilla-daemon@mycompany.com'); # change this +$smtp->to($person); +$smtp->data(); +$smtp->datasend($msg); +$smtp->dataend(); +$smtp->quit; 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 lines of code. _________________________________________________________________ -4.3.1.4. Serving the web pages +4.4.1.4. Serving the web pages As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay - attention to the security notes in Section 5.6.4. More information on - configuring specific web servers can be found in Section 4.4. + attention to the security notes in Section 4.5.4. More information on + configuring specific web servers can be found in Section 4.2. Note - If using Apache on windows, you can set the ScriptInterpreterSource - directive in your Apache config, if you don't do this, you'll have to - modify the first line of every script to contain your path to perl - instead of /usr/bin/perl. + If using Apache on windows, you can set the ScriptInterpreterSource + directive in your Apache config, if you don't do this, you'll have to + modify the first line of every script to contain your path to perl + instead of /usr/bin/perl. _________________________________________________________________ -4.3.2. Mac OS X +4.4.2. Mac OS X There are a lot of common libraries and utilities out there that Apple did not include with Mac OS X, but which run perfectly well on it. The @@ -1657,210 +1638,186 @@ Javascript code Note - To prevent creating conflicts with the software that Apple installs by - default, Fink creates its own directory tree at /sw where it installs - most of the software that it installs. This means your libraries and - headers be at /sw/lib and /sw/include instead of /usr/lib and - /usr/local/include. When the Perl module config script asks where your - libgd is, be sure to tell it /sw/lib. + To prevent creating conflicts with the software that Apple installs by + default, Fink creates its own directory tree at /sw where it installs + most of the software that it installs. This means your libraries and + headers be at /sw/lib and /sw/include instead of /usr/lib and + /usr/local/include. When the Perl module config script asks where your + libgd is, be sure to tell it /sw/lib. Also available via Fink is expat. Once running 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 required libraries. When using CPAN, you will need to use the following command sequence: - # perl -MCPAN -e'look XML::Parser' (1) - # perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include - # make; make test; make install (2) - # exit (3) +# perl -MCPAN -e'look XML::Parser' (1) +# perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include +# make; make test; make install (2) +# exit (3) - (1) (3) + (1) (3) The look command will download the module and spawn a new shell with the extracted files as the current working directory. The exit command will return you to your original shell. - (2) + (2) You should watch the output from these make commands, especially "make test" as errors may prevent XML::Parser from functioning correctly with Bugzilla. _________________________________________________________________ -4.3.3. Linux-Mandrake 8.0 +4.4.3. Linux-Mandrake 8.0 Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the urpmi utility. If you follow these commands, you should have everything you need for Bugzilla, and ./checksetup.pl should not complain about any missing libraries. You may already have some of these installed. - bash# urpmi perl-mysql - bash# urpmi perl-chart - bash# urpmi perl-gd - bash# urpmi perl-MailTools (1) - bash# urpmi apache-modules +bash# urpmi perl-mysql +bash# urpmi perl-chart +bash# urpmi perl-gd +bash# urpmi perl-MailTools (1) +bash# urpmi apache-modules - (1) + (1) for Bugzilla e-mail integration _________________________________________________________________ -4.4. HTTP Server Configuration +4.5. Bugzilla Security - The Bugzilla Team recommends Apache when using Bugzilla, however, any - web server that can be configured to run CGI scripts should be able to - handle Bugzilla. No matter what web server you choose, but especially - if you choose something other than Apache, you should be sure to read - Section 5.6.4. + Warning - The plan for this section is to eventually document the specifics of - how to lock down permissions on individual web servers. + 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. + + 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. _________________________________________________________________ -4.4.1. Apache httpd +4.5.1. TCP/IP Ports - As mentioned above, the Bugzilla Team recommends Apache for use with - Bugzilla. You will have to make sure that Apache is properly - configured to run the Bugzilla CGI scripts. You also need to make sure - that the .htaccess files created by ./checksetup.pl (shown in Example - 4-2 for the curious) are allowed to override Apache's normal access - permissions or else important password information may be exposed to - the Internet. + 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. + _________________________________________________________________ - Many Apache installations are not configured to run scripts anywhere - but in the cgi-bin directory; however, we recommend that Bugzilla not - be installed in the cgi-bin, otherwise the static files such as images - and JavaScript will not work correctly. To allow scripts to run in the - normal web space, the following changes should be made to your - httpd.conf file. +4.5.2. MySQL - To allow files with a .cgi extension to be run, make sure the - following line exists and is uncommented: - AddHandler cgi-script .cgi + 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 not the same as the system root). + Also, many installations default to running mysqld as the system root. - To allow .htaccess files to override permissions and .cgi files to run - in the Bugzilla directory, make sure the following two lines are in a - Directory directive that applies to the Bugzilla directory on your - system (either the Bugzilla directory or one of its parents). - Options +ExecCGI - AllowOverride Limit + 1. Consult the documentation that came with your system for + information on making mysqld run as an unprivleged user. + 2. 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: + +bash$ mysql mysql +mysql> DELETE FROM user WHERE user = ''; +mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; +mysql> FLUSH PRIVILEGES; + + + From this point forward you will need to use mysql -u root -p and + enter new_password when prompted when using the mysql client. + 3. 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 /etc/my.conf: + +[myslqd] +# Prevent network access to MySQL. +skip-networking + + + 4. 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. + _________________________________________________________________ + +4.5.3. Daemon Accounts + + Many daemons, such as Apache's httpd and MySQL's mysqld default to + running as either "root" or "nobody". Running as "root" introduces + obvious security problems, but the problems introduced by running + everything as "nobody" may not be so obvious. Basically, if you're + running every daemon as "nobody" 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. Note - For more information on Apache and its directives, see the glossary - entry on Apache. - - Example 4-2. .htaccess files for Apache - - $BUGZILLA_HOME/.htaccess - # don't allow people to retrieve non-cgi executable files or our private data - - deny from all - - - allow from all - - - $BUGZILLA_HOME/data/.htaccess - # nothing in this directory is retrievable unless overriden by an .htaccess - # in a subdirectory; the only exception is duplicates.rdf, which is used by - # duplicates.xul and must be loadable over the web - deny from all - - allow from all - - - $BUGZILLA_HOME/data/webdot -# Restrict access to .dot files to the public webdot server at research.att.com - -# if research.att.com ever changed their IP, or if you use a different -# webdot server, you'll need to edit this - - Allow from 192.20.225.10 - Deny from all - - -# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and -# .map files - - Allow from all - - -# And no directory listings, either. -Deny from all - - $BUGZILLA_HOME/Bugzilla/.htaccess - # nothing in this directory is retrievable unless overriden by an .htaccess - # in a subdirectory - deny from all - - $BUGZILLA_HOME/template/.htaccess - # nothing in this directory is retrievable unless overriden by an .htaccess - # in a subdirectory - deny from all + You will need to set the webservergroup to the group you created for + your webserver to run as in localconfig. This will allow + ./checksetup.pl to better adjust the file permissions on your Bugzilla + install so as to not require making anything world-writable. _________________________________________________________________ -4.4.2. Microsoft Internet Information Services +4.5.4. Web Server Access Controls - If you need, or for some reason even want, to use Microsoft's Internet - Information Services or Personal Web Server you should be able to. You - will need to configure them to know how to run CGI scripts, however. - This is described in Microsoft Knowledge Base article Q245225 for - Internet Information Services and Q231998 for Personal Web Server. + 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. - Also, and this can't be stressed enough, make sure that files such as - localconfig and your data directory are secured as described in - Section 5.6.4. + 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. + + * In the main Bugzilla directory, you should: + + Block: *.pl, *localconfig*, runtests.sh + + But allow: localconfig.js, localconfig.rdf + * In data: + + Block everything + + But allow: duplicates.rdf + * In data/webdot: + + If you use a remote webdot server: + o Block everything + o But allow *.dot only for the remote webdot server + + Otherwise, if you use a local GraphViz: + o Block everything + o But allow: *.png, *.gif, *.jpg, *.map + + And if you don't use any dot: + o Block everything + * In Bugzilla: + + Block everything + * In template: + + Block everything + + You should test to make sure that the files mentioned above are not + accessible from the Internet, especially your localconfig 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 http://bugzilla.mozilla.org/localconfig. You should + get a 403 Forbidden error. + + Caution + + Not following the instructions in this section, including testing, may + result in sensitive information being globally accessible. + + Tip + + You should check Section 4.2 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. _________________________________________________________________ -4.4.3. AOL Server - - Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. - - AOL Server will have to be configured to run CGI scripts, please - consult the documentation that came with your server for more - information on how to do this. - - Because AOL Server doesn't support .htaccess files, you'll have to - create a TCL script. You should create an - aolserver/modules/tcl/filter.tcl file (the filename shouldn't matter) - with the following contents (change /bugzilla/ to the web-based path - to your Bugzilla installation): - ns_register_filter preauth GET /bugzilla/localconfig filter_deny - ns_register_filter preauth GET /bugzilla/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" - } - - Warning - - This probably doesn't account for all possible editor backup files so - you may wish to add some additional variations of localconfig. For - more information, see bug 186383 or Bugtraq ID 6501. - - Note - - If you are using webdot from research.att.com (the default - configuration for the webdotbase paramater), you will need to allow - access to data/webdot/*.dot for the reasearch.att.com machine. - - If you are using a local installation of GraphViz, you will need to - allow everybody to access *.png, *.gif, *.jpg, and *.map in the - data/webdot directory. - _________________________________________________________________ - -4.5. Troubleshooting +4.6. Troubleshooting This section gives solutions to common Bugzilla installation problems. _________________________________________________________________ -4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1 +4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1 Try executing perl -MCPAN -e 'install CPAN' and then continuing. @@ -1873,7 +1830,7 @@ Deny from all commandline above should fix things. _________________________________________________________________ -4.5.2. DBD::Sponge::db prepare failed +4.6.2. DBD::Sponge::db prepare failed The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): @@ -1885,23 +1842,23 @@ Deny from all To fix this, go to /lib/DBD/sponge.pm in your Perl installation and replace - my $numFields; - if ($attribs->{'NUM_OF_FIELDS'}) { - $numFields = $attribs->{'NUM_OF_FIELDS'}; - } elsif ($attribs->{'NAME'}) { - $numFields = @{$attribs->{NAME}}; + my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAME'}) { + $numFields = @{$attribs->{NAME}}; by - my $numFields; - if ($attribs->{'NUM_OF_FIELDS'}) { - $numFields = $attribs->{'NUM_OF_FIELDS'}; - } elsif ($attribs->{'NAMES'}) { - $numFields = @{$attribs->{NAMES}}; + my $numFields; + if ($attribs->{'NUM_OF_FIELDS'}) { + $numFields = $attribs->{'NUM_OF_FIELDS'}; + } elsif ($attribs->{'NAMES'}) { + $numFields = @{$attribs->{NAMES}}; (note the S added to NAME.) _________________________________________________________________ -4.5.3. cannot chdir(/var/spool/mqueue) +4.6.3. cannot chdir(/var/spool/mqueue) If you are installing Bugzilla on SuSE Linux, or some other distributions with "paranoid" security options, it is possible that @@ -1913,45 +1870,45 @@ Deny from all problem. _________________________________________________________________ -4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT +4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT This is caused by a bug in the version of File::Temp that is distributed with perl 5.6.0. Many minor variations of this error have been reported. Examples can be found in Figure 4-2. Figure 4-2. Other File::Temp error messages - 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_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_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. +Your vendor has not defined Fcntl macro O_TEMPORARY, used +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233. 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 Figure 4-3. The patch is also available as a patch file. Figure 4-3. Patch for File::Temp in Perl 5.6.0 - --- 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 - local $SIG{__DIE__} = sub {}; - local $SIG{__WARN__} = sub {}; - + local *CORE::GLOBAL::die = sub {}; - $bit = &$func(); - 1; - }; - @@ -226,6 +227,7 @@ - # eg CGI::Carp - local $SIG{__DIE__} = sub {}; - local $SIG{__WARN__} = sub {}; - + local *CORE::GLOBAL::die = sub {}; - $bit = &$func(); - 1; - }; +--- 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 + local $SIG{__DIE__} = sub {}; + local $SIG{__WARN__} = sub {}; ++ local *CORE::GLOBAL::die = sub {}; + $bit = &$func(); + 1; + }; +@@ -226,6 +227,7 @@ + # eg CGI::Carp + local $SIG{__DIE__} = sub {}; + local $SIG{__WARN__} = sub {}; ++ local *CORE::GLOBAL::die = sub {}; + $bit = &$func(); + 1; + }; _________________________________________________________________ Chapter 5. Administering Bugzilla @@ -1991,7 +1948,7 @@ Chapter 5. Administering Bugzilla not yet take advantage of features such as transactions which would justify this speed decrease. The Bugzilla team are, however, happy to hear about any experiences with row level locking and - Bugzilla + Bugzilla. The "shadowdb" parameter was designed to get around this limitation. While only a single user is allowed to write to a table at a time, reads can continue unimpeded on a read-only @@ -1999,9 +1956,9 @@ Chapter 5. Administering Bugzilla double, a shadow database can cause an enormous performance improvement when implemented on extremely high-traffic Bugzilla databases. - As a guide, mozilla.org began needing "shadowdb" when they reached - around 40,000 Bugzilla users with several hundred Bugzilla bug - changes and comments per day. + As a guide, on reasonably old hardware, mozilla.org began needing + "shadowdb" when they reached around 40,000 Bugzilla users with + several hundred Bugzilla bug changes and comments per day. The value of the parameter defines the name of the shadow bug database. You will need to set the host and port settings from the params page, and set up replication in your database server so @@ -2047,12 +2004,12 @@ Chapter 5. Administering Bugzilla wise idea to require comments when users resolve, reassign, or reopen bugs at the very least. - Note + Note - It is generally far better to require a developer comment when - resolving bugs than not. Few things are more annoying to bug database - users than having a developer mark a bug "fixed" without any comment - as to what the fix was (or even that it was truly fixed!) + It is generally far better to require a developer comment when + resolving bugs than not. Few things are more annoying to bug database + users than having a developer mark a bug "fixed" without any comment + as to what the fix was (or even that it was truly fixed!) 13. supportwatchers: Turning on this option allows users to ask to receive copies of all a particular other user's bug email. This is, of course, subject to the groupset restrictions on the bug; if @@ -2075,10 +2032,10 @@ Chapter 5. Administering Bugzilla Tip - If you wish to add more administrative users, add them to the "admin" - group and, optionally, add edit the tweakparams, editusers, - creategroups, editcomponents, and editkeywords groups to add the - entire admin group to those groups. + If you wish to add more administrative users, add them to the "admin" + group and, optionally, add edit the tweakparams, editusers, + creategroups, editcomponents, and editkeywords groups to add the + entire admin group to those groups. _________________________________________________________________ 5.2.2. Managing Other Users @@ -2095,15 +2052,15 @@ Chapter 5. Administering Bugzilla 2. Fill out the form presented. This page is self-explanatory. When done, click "Submit". - Note + Note - Adding a user this way will not send an email informing them of their - username and password. While useful for creating dummy accounts - (watchers which shuttle mail to another system, for instance, or email - addresses which are a mailing list), in general it is preferable to - log out and use the "New Account" button to create users, as it will - pre-populate all the required fields and also notify the user of her - account name and password. + Adding a user this way will not send an email informing them of their + username and password. While useful for creating dummy accounts + (watchers which shuttle mail to another system, for instance, or email + addresses which are a mailing list), in general it is preferable to + log out and use the "New Account" button to create users, as it will + pre-populate all the required fields and also notify the user of her + account name and password. _________________________________________________________________ 5.2.2.2. Modifying Users @@ -2139,13 +2096,13 @@ Chapter 5. Administering Bugzilla Warning - Don't disable the administrator account! + Don't disable all the administrator accounts! - Note + Note - The user can still submit bugs via the e-mail gateway, if you set it - up, even if the disabled text field is filled in. The e-mail gateway - should not be enabled for secure installations of Bugzilla. + The user can still submit bugs via the e-mail gateway, if you set it + up, even if the disabled text field is filled in. The e-mail gateway + should not be enabled for secure installations of Bugzilla. * : If you have created some groups, e.g. "securitysensitive", then checkboxes will appear here to allow you to add users to, or remove them from, these groups. @@ -2180,9 +2137,7 @@ Chapter 5. Administering Bugzilla the "editbugs" privilege to edit bugs in these products. _________________________________________________________________ -5.3. Product, Component, Milestone, and Version Administration - -5.3.1. Products +5.3. Products Products are the broadest category in Bugzilla, and tend to represent real-world shipping products. E.g. if your company makes computer @@ -2209,7 +2164,7 @@ Chapter 5. Administering Bugzilla few moments. _________________________________________________________________ -5.3.2. Components +5.4. Components Components are subsections of a Product. E.g. the computer game you are designing may have a "UI" component, an "API" component, a "Sound @@ -2238,12 +2193,12 @@ Chapter 5. Administering Bugzilla database. _________________________________________________________________ -5.3.3. Versions +5.5. Versions Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select - field; the usual practice is to select the most recent version with - the bug. + field; the usual practice is to select the earliest version known to + have the bug. To create and edit Versions: @@ -2254,7 +2209,7 @@ Chapter 5. Administering Bugzilla click the "Add" button. _________________________________________________________________ -5.3.4. Milestones +5.6. Milestones Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it @@ -2262,8 +2217,8 @@ Chapter 5. Administering Bugzilla Note - Milestone options will only appear for a Product if you turned on the - "usetargetmilestone" Param in the "Edit Parameters" screen. + Milestone options will only appear for a Product if you turned on the + "usetargetmilestone" Param in the "Edit Parameters" screen. To create new Milestones, set Default Milestones, and set Milestone URL: @@ -2278,16 +2233,9 @@ Chapter 5. Administering Bugzilla after "Release 1.2". Select "Add". 4. From the Edit product screen, you can enter the URL of a page which gives information about your milestones and what they mean. - - Tip - - If you want your milestone document to be restricted so that it can - only be viewed by people in a particular Bugzilla group, the best way - is to attach the document to a bug in that group, and make the URL the - URL of that attachment. _________________________________________________________________ -5.4. Voting +5.7. Voting Voting allows users to be given a pot of votes which they can allocate to bugs, to indicate that they'd like them fixed. This allows @@ -2314,7 +2262,7 @@ Chapter 5. Administering Bugzilla "Update". _________________________________________________________________ -5.5. Groups and Group Security +5.8. Groups and Group Security Groups allow the administrator to isolate bugs or products that should only be seen by certain people. The association between products and @@ -2358,12 +2306,12 @@ Chapter 5. Administering Bugzilla fulfill the Regular Expression into the new group. When you have finished, click "Add". - Warning + Warning - The User Regexp is a perl regexp and, if not anchored, will match any - part of an address. So, if you do not want to grant access into - 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use - '@mycompany\.com$' as the regexp. + If specifying a domain in the regexp, make sure you end the regexp + with a $. Otherwise, when granting access to "@mycompany\.com", you + will allow access to 'badperson@mycompany.com.cracker.net'. You need + to use '@mycompany\.com$' as the regexp. 4. After you add your new group, edit the new group. On the edit page, you can specify other groups that should be included in this group and which groups should be permitted to add and delete users @@ -2377,463 +2325,14 @@ Chapter 5. Administering Bugzilla in that product. _________________________________________________________________ -5.6. Bugzilla Security +5.9. Upgrading to New Releases Warning - 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. - - Note - - These instructions must, of necessity, be somewhat vague since - Bugzilla runs on so many different platforms. If you have refinements - of these directions, please submit a bug to Bugzilla Documentation. - - Warning - - This is not meant to be a comprehensive list of every possible - security issue regarding the tools mentioned in this section. There is - no subsitute for reading the information written by the authors of any - software running on your system. - _________________________________________________________________ - -5.6.1. TCP/IP Ports - - TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla only - needs 1... 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. - _________________________________________________________________ - -5.6.2. MySQL - - 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 not the same as the system root). - Also, many installations default to running mysqld as the system root. - - 1. Consult the documentation that came with your system for - information on making mysqld run as an unprivleged user. - 2. 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: - -bash$ mysql mysql -mysql> DELETE FROM user WHERE user = ''; -mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; -mysql> FLUSH PRIVILEGES; - - - From this point forward you will need to use mysql -u root -p and - enter new_password when prompted when using the mysql client. - 3. 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 /etc/my.conf: - - [myslqd] - # Prevent network access to MySQL. - skip-networking - - - 4. 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. - _________________________________________________________________ - -5.6.3. Daemon Accounts - - Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either "root" or "nobody". Running as "root" introduces - obvious security problems, but the problems introduced by running - everything as "nobody" may not be so obvious. Basically, if you're - running every daemon as "nobody" and one of them gets comprimised, - they all get comprimised. For this reason it is recommended that you - create a user account for each daemon. - - Note - - You will need to set the webservergroup to the group you created for - your webserver to run as in localconfig. This will allow - ./checksetup.pl to better adjust the file permissions on your Bugzilla - install so as to not require making anything world-writable. - _________________________________________________________________ - -5.6.4. Web Server Access Controls - - 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 layed out, the list of what should and should - not be accessible is rather complicated. A new installation method is - currently in the works which should solve this by allowing files that - shouldn't be accessible from the web to be placed in directory outside - the webroot. See bug 44659 for more information. - - * In the main Bugzilla directory, you should: - + Block: *.pl, *localconfig*, runtests.sh - + But allow: localconfig.js, localconfig.rdf - * In data: - + Block everything - + But allow: duplicates.rdf - * In data/webdot: - + If you use a remote webdot server: - o Block everything - o But allow *.dot only for the remote webdot server - + Otherwise, if you use a local GraphViz: - o Block everything - o But allow: *.png, *.gif, *.jpg, *.map - + And if you don't use any dot: - o Block everything - * In Bugzilla: - + Block everything - * In template: - + Block everything - - Tip - - Bugzilla ships with the ability to generate .htaccess files - instructing Apache which files should and should not be accessible. - For more information, see Section 4.4.1. - - You should test to make sure that the files mentioned above are not - accessible from the Internet, especially your localconfig 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 http://bugzilla.mozilla.org/localconfig. You should - get a 403 Forbidden error. - - Caution - - Not following the instructions in this section, including testing, may - result in sensitive information being globally accessible. - - Tip - - You should check Section 4.4 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. - _________________________________________________________________ - -5.7. Template Customization - - One of the large changes for 2.16 was the templatization of the entire - user-facing UI, using the Template Toolkit. Administrators can now - configure the look and feel of Bugzilla without having to edit Perl - files or face the nightmare of massive merge conflicts when they - upgrade to a newer version in the future. - - Templatization also makes localized versions of Bugzilla possible, for - the first time. As of version 2.17.4 which will soon become 2.18, it's - possible to have Bugzilla's language determined by the user's browser. - More information is available in Section 5.7.5. - _________________________________________________________________ - -5.7.1. What to Edit - - There are two different ways of editing of Bugzilla's templates, and - which you use depends mainly on how you upgrade Bugzilla. The template - directory structure is that there's a top level directory, template, - which contains a directory for each installed localization. The - default English templates are therefore in en. Underneath that, there - is the default directory and optionally the custom directory. The - default directory contains all the templates shipped with Bugzilla, - whereas the custom directory does not exist at first and must be - created if you want to use it. - - The first method of making customizations is to directly edit the - templates in template/en/default. This is probably the best method for - small changes if you are going to use the CVS method of upgrading, - because if you then execute a cvs update, any template fixes will get - automagically merged into your modified versions. - - If you use this method, your installation will break if CVS conflicts - occur. - - The other method is to copy the templates into a mirrored directory - structure under template/en/custom. The templates in this directory - automatically override those in default. This is the technique you - need to use if you use the overwriting method of upgrade, because - otherwise your changes will be lost. This method is also better if you - are using the CVS method of upgrading and are going to make major - changes, because it is guaranteed that the contents of this directory - will not be touched during an upgrade, and you can then decide whether - to continue using your own templates, or make the effort to merge your - changes into the new versions by hand. - - If you use this method, your installation may break if incompatible - changes are made to the template interface. If such changes are made - they will be documented in the release notes, provided you are using a - stable release of Bugzilla. If you use using unstable code, you will - need to deal with this one yourself, although if possible the changes - will be mentioned before they occur in the deprecations section of the - previous stable release's release notes. - - Note - - Don't directly edit the compiled templates in data/template/* - your - changes will be lost when Template Toolkit recompiles them. - - Note - - It is recommended that you run ./checksetup.pl after any template - edits, especially if you've created a new file in the custom - directory. - _________________________________________________________________ - -5.7.2. How To Edit Templates - - The syntax of the Template Toolkit language is beyond the scope of - this guide. It's reasonably easy to pick up by looking at the current - templates; or, you can read the manual, available on the Template - Toolkit home page. However, you should particularly remember (for - security reasons) to always HTML filter things which come from the - database or user input, to prevent cross-site scripting attacks. - - However, one thing you should take particular care about is the need - to properly HTML filter data that has been passed into the template. - This means that if the data can possibly contain special HTML - characters such as <, and the data was not intended to be HTML, they - need to be converted to entity form, ie <. You use the 'html' - filter in the Template Toolkit to do this. If you fail to do this, you - may open up your installation to cross-site scripting attacks. - - Also note that Bugzilla adds a few filters of its own, that are not in - standard Template Toolkit. In particular, the 'url_quote' filter can - convert characters that are illegal or have special meaning in URLs, - such as &, to the encoded form, ie %26. This actually encodes most - characters (but not the common ones such as letters and numbers and so - on), including the HTML-special characters, so there's never a need to - HTML filter afterwards. - - Editing templates is a good way of doing a "poor man's custom fields". - For example, if you don't use the Status Whiteboard, but want to have - a free-form text entry box for "Build Identifier", then you can just - edit the templates to change the field labels. It's still be called - status_whiteboard internally, but your users don't need to know that. - - Note - - If you are making template changes that you intend on submitting back - for inclusion in standard Bugzilla, you should read the relevant - sections of the Developers' Guide. - _________________________________________________________________ - -5.7.3. Template Formats - - Some CGIs have the ability to use more than one template. For example, - buglist.cgi can output bug lists as RDF or two different forms of HTML - (complex and simple). (Try this out by appending &format=simple to a - buglist.cgi URL on your Bugzilla installation.) This mechanism, called - template 'formats', is extensible. - - To see if a CGI supports multiple output formats, grep the CGI for - "ValidateOutputFormat". If it's not present, adding multiple format - support isn't too hard - see how it's done in other CGIs. - - To make a new format template for a CGI which supports this, open a - current template for that CGI and take note of the INTERFACE comment - (if present.) This comment defines what variables are passed into this - template. If there isn't one, I'm afraid you'll have to read the - template and the code to find out what information you get. - - Write your template in whatever markup or text style is appropriate. - - You now need to decide what content type you want your template served - as. Open up the localconfig file and find the $contenttypes variable. - If your content type is not there, add it. Remember the three- or - four-letter tag assigned to you content type. This tag will be part of - the template filename. - - Save the template as -..tmpl. - Try out the template by calling the CGI as - .cgi?format= . - _________________________________________________________________ - -5.7.4. Particular Templates - - There are a few templates you may be particularly interested in - customizing for your installation. - - index.html.tmpl: This is the Bugzilla front page. - - global/header.html.tmpl: This defines the header that goes on all - Bugzilla pages. The header includes the banner, which is what appears - to users and is probably what you want to edit instead. However the - header also includes the HTML HEAD section, so you could for example - add a stylesheet or META tag by editing the header. - - global/banner.html.tmpl: This contains the "banner", the part of the - header that appears at the top of all Bugzilla pages. The default - banner is reasonably barren, so you'll probably want to customize this - to give your installation a distinctive look and feel. It is - recommended you preserve the Bugzilla version number in some form so - the version you are running can be determined, and users know what - docs to read. - - global/footer.html.tmpl: This defines the footer that goes on all - Bugzilla pages. Editing this is another way to quickly get a - distinctive look and feel for your Bugzilla installation. - - bug/create/user-message.html.tmpl: This is a message that appears near - the top of the bug reporting page. By modifying this, you can tell - your users how they should report bugs. - - bug/process/midair.html.tmpl: This is the page used if two people - submit simultaneous changes to the same bug. The second person to - submit their changes will get this page to tell them what the first - person did, and ask if they wish to overwrite those changes or go back - and revisit the bug. The default title and header on this page read - "Mid-air collision detected!" If you work in the aviation industry, or - other environment where this might be found offensive (yes, we have - true stories of this happening) you'll want to change this to - something more appropriate for your environment. - - bug/create/create.html.tmpl and bug/create/comment.txt.tmpl: You may - wish to get bug submitters to give certain bits of structured - information, each in a separate input widget, for which there is not a - field in the database. The bug entry system has been designed in an - extensible fashion to enable you to define arbitrary fields and - widgets, and have their values appear formatted in the initial - Description, rather than in database fields. An example of this is the - mozilla.org guided bug submission form. - - To make this work, create a custom template for enter_bug.cgi (the - default template, on which you could base it, is create.html.tmpl), - and either call it create.html.tmpl or use a format and call it - create-.html.tmpl. Put it in the custom/bug/create - directory. In it, add widgets for each piece of information you'd like - collected - such as a build number, or set of steps to reproduce. - - Then, create a template like custom/bug/create/comment.txt.tmpl, also - named after your format if you are using one, which references the - form fields you have created. When a bug report is submitted, the - initial comment attached to the bug report will be formatted according - to the layout of this template. - - For example, if your enter_bug template had a field - - - and then your comment.txt.tmpl had - BuildID: [% form.buildid %] - - then - BuildID: 20020303 - - would appear in the initial checkin comment. - _________________________________________________________________ - -5.7.5. Configuring Bugzilla to Detect the User's Language - - Begining in version 2.18 (first introduced in version 2.17.4), it's - now possible to have the users web browser tell Bugzilla which - language templates to use for each visitor (using the HTTP_ACCEPT - header). For this to work, Bugzilla needs to have the correct language - templates installed for the version of Bugzilla you are using. Many - language templates can be obtained from - http://www.bugzilla.org/download.html#localizations. Instructions for - submitting new languages are also available from that location. - - After untarring the localizations (or creating your own) in the - [Bugzilla_Root]/template directory, you must update the languages - parameter to contain any localizations you'd like to permit. You may - also wish to set the defaultlanguage parameter to something other than - "en" if you don't want Engish to be the default language. - _________________________________________________________________ - -5.8. Change Permission Customization - - Warning - - This feature should be considered experimental; the Bugzilla code you - will be changing is not stable, and could change or move between - versions. Be aware that if you make modifications to it, you may have - to re-make them or port them if Bugzilla changes internally between - versions. - - Companies often have rules about which employees, or classes of - employees, are allowed to change certain things in the bug system. For - example, only the bug's designated QA Contact may be allowed to VERIFY - the bug. Bugzilla has been designed to make it easy for you to write - your own custom rules to define who is allowed to make what sorts of - value transition. - - For maximum flexibility, customizing this means editing Bugzilla's - Perl code. This gives the administrator complete control over exactly - who is allowed to do what. The relevant function is called - CheckCanChangeField(), and is found in process_bug.cgi in your - Bugzilla directory. If you open that file and grep for "sub - CheckCanChangeField", you'll find it. - - This function has been carefully commented to allow you to see exactly - how it works, and give you an idea of how to make changes to it. - Certain marked sections should not be changed - these are the - "plumbing" which makes the rest of the function work. In between those - sections, you'll find snippets of code like: - # Allow the owner to change anything. - if ($ownerid eq $whoid) { - return 1; - } - - It's fairly obvious what this piece of code does. - - So, how does one go about changing this function? Well, simple changes - can be made just be removing pieces - for example, if you wanted to - prevent any user adding a comment to a bug, just remove the lines - marked "Allow anyone to change comments." And if you want the reporter - to have no special rights on bugs they have filed, just remove the - entire section which refers to him. - - More complex customizations are not much harder. Basically, you add a - check in the right place in the function, i.e. after all the variables - you are using have been set up. So, don't look at $ownerid before - $ownerid has been obtained from the database. You can either add a - positive check, which returns 1 (allow) if certain conditions are - true, or a negative check, which returns 0 (deny.) E.g.: - if ($field eq "qacontact") { - if (Bugzilla->user->groups("quality_assurance")) { - return 1; - } - else { - return 0; - } - } - - This says that only users in the group "quality_assurance" can change - the QA Contact field of a bug. Getting more weird: - if (($field eq "priority") && - (Bugzilla->user->email =~ /.*\@example\.com$/)) - { - if ($oldvalue eq "P1") { - return 1; - } - else { - return 0; - } - } - - This says that if the user is trying to change the priority field, and - their email address is @example.com, they can only do so if the old - value of the field was "P1". Not very useful, but illustrative. - - For a list of possible field names, look in data/versioncache for the - list called @::log_columns. If you need help writing custom rules for - your organization, ask in the newsgroup. - _________________________________________________________________ - -5.9. Upgrading to New Releases - - Warning - - Upgrading is a one-way process. You should backup your database and - current Bugzilla directory before attempting the upgrade. If you wish - to revert to the old Bugzilla version for any reason, you will have to - restore from these backups. + Upgrading is a one-way process. You should backup your database and + current Bugzilla directory before attempting the upgrade. If you wish + to revert to the old Bugzilla version for any reason, you will have to + restore from these backups. Upgrading Bugzilla is something we all want to do from time to time, be it to get new features or pick up the latest security fix. How easy @@ -2884,65 +2383,65 @@ mysql> FLUSH PRIVILEGES; Tip - If you can do this, updating using CVS is probably the most painless - method, especially if you have a lot of local changes. - bash$ cd /var/www/html/bugzilla - bash$ cvs login - Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot - CVS password: anonymous - bash$ cvs -q update -r BUGZILLA-2_16_2 -dP - P checksetup.pl - P collectstats.pl - P globals.pl - P docs/rel_notes.txt - P template/en/default/list/quips.html.tmpl + If you can do this, updating using CVS is probably the most painless + method, especially if you have a lot of local changes. +bash$ cd /var/www/html/bugzilla +bash$ cvs login +Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot +CVS password: anonymous +bash$ cvs -q update -r BUGZILLA-2_16_2 -dP +P checksetup.pl +P collectstats.pl +P globals.pl +P docs/rel_notes.txt +P template/en/default/list/quips.html.tmpl Caution - If a line in the output from cvs update begins with a C that - represents a file with local changes that CVS was unable to properly - merge. You need to resolve these conflicts manually before Bugzilla - (or at least the portion using that file) will be usable. + If a line in the output from cvs update begins with a C that + represents a file with local changes that CVS was unable to properly + merge. You need to resolve these conflicts manually before Bugzilla + (or at least the portion using that file) will be usable. Note - You also need to run ./checksetup.pl before your Bugzilla upgrade will - be complete. + You also need to run ./checksetup.pl before your Bugzilla upgrade will + be complete. Example 5-2. Upgrading using the tarball If you are unable or unwilling to use CVS, another option that's always available is to download the latest tarball. This is the most difficult option to use, especially if you have local changes. - bash$ cd /var/www/html - bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz - Output omitted - bash$ tar xzvf bugzilla-2.16.2.tar.gz - bugzilla-2.16.2/ - bugzilla-2.16.2/.cvsignore - bugzilla-2.16.2/1x1.gif - Output truncated - bash$ cd bugzilla-2.16.2 - bash$ cp ../bugzilla/localconfig* . - bash$ cp -r ../bugzilla/data . - bash$ cd .. - bash$ mv bugzilla bugzilla.old - bash$ mv bugzilla-2.16.2 bugzilla - bash$ cd bugzilla - bash$ ./checksetup.pl - Output omitted +bash$ cd /var/www/html +bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz +Output omitted +bash$ tar xzvf bugzilla-2.16.2.tar.gz +bugzilla-2.16.2/ +bugzilla-2.16.2/.cvsignore +bugzilla-2.16.2/1x1.gif +Output truncated +bash$ cd bugzilla-2.16.2 +bash$ cp ../bugzilla/localconfig* . +bash$ cp -r ../bugzilla/data . +bash$ cd .. +bash$ mv bugzilla bugzilla.old +bash$ mv bugzilla-2.16.2 bugzilla +bash$ cd bugzilla +bash$ ./checksetup.pl +Output omitted Warning - The cp commands both end with periods which is a very important - detail, it tells the shell that the destination directory is the - current working directory. Also, the period at the beginning of the - ./checksetup.pl is important and can not be omitted. + The cp commands both end with periods which is a very important + detail, it tells the shell that the destination directory is the + current working directory. Also, the period at the beginning of the + ./checksetup.pl is important and can not be omitted. Note - You will now have to reapply any changes you have made to your local - installation manually. + You will now have to reapply any changes you have made to your local + installation manually. Example 5-3. Upgrading using patches @@ -2950,13 +2449,12 @@ mysql> FLUSH PRIVILEGES; revisions to go from the most recent revision to the new one. You could also read the release notes and grab the patches attached to the mentioned bug, but it is safer to use the released patch file as - sometimes patches get changed before they get checked in (for minor - spelling fixes and the like). It is also theorectically possible to - scour the fixed bug list and pick and choose which patches to apply - from a point release, but this is not recommended either as what - you'll end up with is a hodge podge Bugzilla that isn't really any - version. This would also make it more difficult to upgrade in the - future. + sometimes patches get changed before they get checked in. It is also + theoretically possible to scour the fixed bug list and pick and choose + which patches to apply from a point release, but this is not + recommended either as what you'll end up with is a hodge podge + Bugzilla that isn't really any version. This would also make it more + difficult to upgrade in the future. bash$ cd /var/www/html/bugzilla bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.1-to-2.16.2.diff.gz Output omitted @@ -2968,884 +2466,304 @@ patching file globals.pl Caution - If you do this, beware that this doesn't change the entires in your - CVS directory so it may make updates using CVS (Example 5-1) more - difficult in the future. + If you do this, beware that this doesn't change the entires in your + CVS directory so it may make updates using CVS (Example 5-1) more + difficult in the future. _________________________________________________________________ -5.10. Integrating Bugzilla with Third-Party Tools +Chapter 6. Customising Bugzilla -5.10.1. Bonsai +6.1. Template Customization - Bonsai is a web-based tool for managing CVS, the Concurrent Versioning - System . Using Bonsai, administrators can control open/closed status - of trees, query a fast relational database back-end for change, - branch, and comment information, and view changes made since the last - time the tree was closed. Bonsai also integrates with Tinderbox, the - Mozilla automated build management system. + Administrators can configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + + Templatization also makes localized versions of Bugzilla possible, for + the first time. It's possible to have Bugzilla's UI language + determined by the user's browser. More information is available in + Section 6.1.5. _________________________________________________________________ -5.10.2. CVS - - CVS integration is best accomplished, at this point, using the - Bugzilla Email Gateway. - - Follow the instructions in this Guide for enabling Bugzilla e-mail - integration. Ensure that your check-in script sends an email to your - Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can - have CVS check-in comments append to your Bugzilla bug. If you want to - have the bug be closed automatically, you'll have to modify the - contrib/bugzilla_email_append.pl script. - - There is also a CVSZilla project, based upon somewhat dated Bugzilla - code, to integrate CVS and Bugzilla through CVS' ability to email. - Check it out at: http://homepages.kcbbs.gen.nz/~tonyg/. - _________________________________________________________________ - -5.10.3. Perforce SCM - - You can find the project page for Bugzilla and Teamtrack Perforce - integration (p4dti) at: http://www.ravenbrook.com/project/p4dti/ . - "p4dti" is now an officially supported product from Perforce, and you - can find the "Perforce Public Depot" p4dti page at - http://public.perforce.com/public/perforce/p4dti/index.html . - - Integration of Perforce with Bugzilla, once patches are applied, is - seamless. Perforce replication information will appear below the - comments of each bug. Be certain you have a matching set of patches - for the Bugzilla version you are installing. p4dti is designed to - support multiple defect trackers, and maintains its own documentation - for it. Please consult the pages linked above for further information. - _________________________________________________________________ - -5.10.4. Tinderbox/Tinderbox2 - - We need Tinderbox integration information. - _________________________________________________________________ - -Appendix A. The Bugzilla FAQ - - This FAQ includes questions not covered elsewhere in the Guide. - - 1. General Questions - - A.1.1. Where can I find information about Bugzilla? - A.1.2. What license is Bugzilla distributed under? - A.1.3. How do I get commercial support for Bugzilla? - A.1.4. What major companies or projects are currently using - Bugzilla for bug-tracking? - - A.1.5. Who maintains Bugzilla? - A.1.6. How does Bugzilla stack up against other bug-tracking - databases? - - A.1.7. Why doesn't Bugzilla offer this or that feature or - compatibility with this other tracking software? - - A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL. - - A.1.9. What is /usr/bonsaitools/bin/perl? - A.1.10. My perl is not located at /usr/bin/perl, is there an easy - way to change it everywhere it needs to be changed? - - A.1.11. Is there an easy way to change the Bugzilla cookie name? - - 2. Managerial Questions - - A.2.1. Is Bugzilla web-based, or do you have to have specific - software or a specific operating system on your machine? - - A.2.2. Can Bugzilla integrate with Perforce (SCM software)? - A.2.3. Does Bugzilla allow the user to track multiple projects? - A.2.4. If I am on many projects, and search for all bugs assigned - to me, will Bugzilla list them for me and allow me to - sort by project, severity etc? - - A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs - etc)? If yes, are there any that are NOT allowed? - - A.2.6. Does Bugzilla allow us to define our own priorities and - levels? Do we have complete freedom to change the labels - of fields and format of them, and the choice of - acceptable values? - - A.2.7. Does Bugzilla provide any reporting features, metrics, - graphs, etc? You know, the type of stuff that management - likes to see. :) - - A.2.8. Is there email notification and if so, what do you see - when you get an email? - - A.2.9. Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? - - A.2.10. Do users have to have any particular type of email - application? - - A.2.11. Does Bugzilla allow data to be imported and exported? If - I had outsiders write up a bug report using a MS Word bug - template, could that template be imported into "matching" - fields? If I wanted to take the results of a query and - export that data to MS Excel, could I do that? - - A.2.12. Has anyone converted Bugzilla to another language to be - used in other countries? Is it localizable? - - A.2.13. Can a user create and save reports? Can they do this in - Word format? Excel format? - - A.2.14. Does Bugzilla have the ability to search by word, phrase, - compound search? - - A.2.15. Does Bugzilla provide record locking when there is - simultaneous access to the same bug? Does the second - person get a notice that the bug is in use or how are - they notified? - - A.2.16. Are there any backup features provided? - A.2.17. Can users be on the system while a backup is in progress? - - A.2.18. What type of human resources are needed to be on staff to - install and maintain Bugzilla? Specifically, what type of - skills does the person need to have? I need to find out - if we were to go with Bugzilla, what types of individuals - would we need to hire and how much would that cost vs - buying an "Out-of-the-Box" solution. - - A.2.19. What time frame are we looking at if we decide to hire - people to install and maintain the Bugzilla? Is this - something that takes hours or weeks to install and a - couple of hours per week to maintain and customize or is - this a multi-week install process, plus a full time job - for 1 person, 2 people, etc? - - A.2.20. Is there any licensing fee or other fees for using - Bugzilla? Any out-of-pocket cost other than the bodies - needed as identified above? - - 3. Bugzilla Security - - A.3.1. How do I completely disable MySQL security if it's giving - me problems (I've followed the instructions in the - installation section of this guide)? - - A.3.2. Are there any security problems with Bugzilla? - A.3.3. I've implemented the security fixes mentioned in Chris - Yeh's security advisory of 5/10/2000 advising not to run - MySQL as root, and am running into problems with MySQL no - longer working correctly. - - 4. Bugzilla Email - - A.4.1. I have a user who doesn't want to receive any more email - from Bugzilla. How do I stop it entirely for this user? - - A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send - email to anyone but me. How do I do it? - - A.4.3. I want whineatnews.pl to whine at something more, or other - than, only new bugs. How do I do it? - - A.4.4. I don't like/want to use Procmail to hand mail off to - bug_email.pl. What alternatives do I have? - - A.4.5. How do I set up the email interface to submit/change bugs - via email? - - A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's - extremely slow. What gives? - - A.4.7. How come email from Bugzilla changes never reaches me? - - 5. Bugzilla Database - - A.5.1. I've heard Bugzilla can be used with Oracle? - A.5.2. I think my database might be corrupted, or contain invalid - entries. What do I do? - - A.5.3. I want to manually edit some entries in my database. How? - A.5.4. I think I've set up MySQL permissions correctly, but - Bugzilla still can't connect. - - A.5.5. How do I synchronize bug information among multiple - different Bugzilla databases? - - 6. Bugzilla and Win32 - - A.6.1. What is the easiest way to run Bugzilla on Win32 - (Win98+/NT/2K)? - - A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? - A.6.3. CGI's are failing with a "something.cgi is not a valid - Windows NT application" error. Why? - - A.6.4. I'm having trouble with the perl modules for NT not being - able to talk to to the database. - - 7. Bugzilla Usage - - A.7.1. How do I change my user name (email address) in Bugzilla? - A.7.2. The query page is very confusing. Isn't there a simpler - way to query? - - A.7.3. I'm confused by the behavior of the "accept" button in the - Show Bug form. Why doesn't it assign the bug to me when I - accept it? - - A.7.4. I can't upload anything into the database via the "Create - Attachment" link. What am I doing wrong? - - A.7.5. How do I change a keyword in Bugzilla, once some bugs are - using it? - - A.7.6. Why can't I close bugs from the "Change Several Bugs at - Once" page? - - 8. Bugzilla Hacking - - A.8.1. What kind of style should I use for templatization? - A.8.2. What bugs are in Bugzilla right now? - A.8.3. How can I change the default priority to a null value? For - instance, have the default priority be "---" instead of - "P2"? - - A.8.4. What's the best way to submit patches? What guidelines - should I follow? - -1. General Questions - - A.1.1. Where can I find information about Bugzilla? - - You can stay up-to-date with the latest Bugzilla information at - http://www.bugzilla.org/. - - A.1.2. What license is Bugzilla distributed under? - - Bugzilla is covered by the Mozilla Public License. See details at - http://www.mozilla.org/MPL/. - - A.1.3. How do I get commercial support for Bugzilla? - - http://bugzilla.org/consulting.html is a list of people and companies - who have asked us to list them as consultants for Bugzilla. - - http://www.collab.net/ offers Bugzilla as part of their standard - offering to large projects. They do have some minimum fees that are - pretty hefty, and generally aren't interested in small projects. - - There are several experienced Bugzilla hackers on the mailing - list/newsgroup who are willing to make themselves available for - generous compensation. Try sending a message to the mailing list - asking for a volunteer. - - A.1.4. What major companies or projects are currently using Bugzilla - for bug-tracking? - - There are dozens of major companies with public Bugzilla sites to - track bugs in their products. We have a fairly complete list available - on our website at http://bugzilla.org/installation_list.html. If you - have an installation of Bugzilla and would like to be added to the - list, whether it's a public install or not, simply e-mail Gerv - . Keep in mind that it's kinda difficult to get onto - the "high-profile" list ;). - - A.1.5. Who maintains Bugzilla? - - A core team, led by Dave Miller (justdave@bugzilla.org). - - A.1.6. How does Bugzilla stack up against other bug-tracking - databases? - - We can't find any head-to-head comparisons of Bugzilla against other - defect-tracking software. If you know of one, please get in touch. - However, from the author's personal experience with other - bug-trackers, Bugzilla offers superior performance on commodity - hardware, better price (free!), more developer- friendly features - (such as stored queries, email integration, and platform - independence), improved scalability, open source code, greater - flexibility, and superior ease-of-use. - - If you happen to be a commercial bug-tracker vendor, please step - forward with a list of advantages your product has over Bugzilla. We'd - be happy to include it in the "Competitors" section. - - A.1.7. Why doesn't Bugzilla offer this or that feature or - compatibility with this other tracking software? - - It may be that the support has not been built yet, or that you have - not yet found it. Bugzilla is making tremendous strides in usability, - customizability, scalability, and user interface. It is widely - considered the most complete and popular open-source bug-tracking - software in existence. - - That doesn't mean it can't use improvement! You can help the project - along by either hacking a patch yourself that supports the - functionality you require, or else submitting a "Request for - Enhancement" (RFE) using the bug submission interface at - bugzilla.mozilla.org. - - A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on - Oracle/Sybase/Msql/PostgreSQL/MSSQL. - - MySQL was originally chosen because it is free, easy to install, and - was available for the hardware Netscape intended to run it on. - - There is currently work in progress to make Bugzilla work on - PostgreSQL and Sybase in the default distribution. You can track the - progress of these initiatives in bug 98304 and bug 173130 - respectively. - - Once both of these are done, adding support for additional database - servers should be trivial. - - A.1.9. What is /usr/bonsaitools/bin/perl? - - Bugzilla used to have the path to perl on the shebang line set to - /usr/bonsaitools/bin/perl because when Terry first started writing the - code for mozilla.org he needed a version of Perl and other tools that - were completely under his control. This location was abandoned for the - 2.18 release in favor of the more sensible /usr/bin/perl. If you - installed an older verion of Bugzilla and created the symlink we - suggested, you can remove it now (provided that you don't have - anything else, such as Bonsai, using it and you don't intend to - reinstall an older version of Bugzilla). - - A.1.10. My perl is not located at /usr/bin/perl, is there an easy way - to change it everywhere it needs to be changed? - - Yes, the following bit of perl magic will change all the shebang - lines. Be sure to change /usr/local/bin/perl to your path to the perl - binary. - perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - - A.1.11. Is there an easy way to change the Bugzilla cookie name? - - At present, no. - -2. Managerial Questions +6.1.1. What to Edit + + The template directory structure is that there's a top level + directory, template, which contains a directory for each installed + localization. The default English templates are therefore in en. + Underneath that, there is the default directory and optionally the + custom directory. The default directory contains all the templates + shipped with Bugzilla, whereas the custom directory does not exist at + first and must be created if you want to use it. + + There are two different ways of editing Bugzilla's templates, and + which you use depends mainly on the method you plan to use to upgrade + Bugzilla. The first method of making customizations is to directly + edit the templates in template/en/default. This is probably the best + method for small changes if you are going to use the CVS method of + upgrading, because if you then execute a cvs update, any template + fixes will get automagically merged into your modified versions. + + If you use this method, your installation will break if CVS conflicts + occur. + + The other method is to copy the templates to be modified into a + mirrored directory structure under template/en/custom. The templates + in this directory automatically override those in default. This is the + technique you need to use if you use the overwriting method of + upgrade, because otherwise your changes will be lost. This method is + also better if you are using the CVS method of upgrading and are going + to make major changes, because it is guaranteed that the contents of + this directory will not be touched during an upgrade, and you can then + decide whether to continue using your own templates, or make the + effort to merge your changes into the new versions by hand. + + If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. Note - Questions likely to be asked by managers. :-) - - A.2.1. Is Bugzilla web-based, or do you have to have specific software - or a specific operating system on your machine? - - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the - web. - - A.2.2. Can Bugzilla integrate with Perforce (SCM software)? - - Yes! You can find more information elsewhere in "The Bugzilla Guide" - in the "Integration with Third-Party Products" section. - - A.2.3. Does Bugzilla allow the user to track multiple projects? - - Absolutely! You can track any number of Products that can each be - composed of any number of Components. - - A.2.4. If I am on many projects, and search for all bugs assigned to - me, will Bugzilla list them for me and allow me to sort by project, - severity etc? - - Yes. - - A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? - If yes, are there any that are NOT allowed? - - Yes - any sort of attachment is allowed, although administrators can - configure a maximum size. Bugzilla gives the user the option of either - using the MIME-type supplied by the browser, choosing from a - pre-defined list or manually typing any arbitrary MIME-type. - - A.2.6. Does Bugzilla allow us to define our own priorities and levels? - Do we have complete freedom to change the labels of fields and format - of them, and the choice of acceptable values? - - Yes. However, modifying some fields, notably those related to bug - progression states, also require adjusting the program logic to - compensate for the change. - - There is no GUI for adding fields to Bugzilla at this time. You can - follow development of this feature in bug 91037 - - A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, - etc? You know, the type of stuff that management likes to see. :) - - Yes. Look at http://bugzilla.mozilla.org/report.cgi for samples of - what Bugzilla can do in reporting and graphing. - - If you can not get the reports you want from the included reporting - scripts, it is possible to hook up a professional reporting package - such as Crystal Reports using ODBC. If you choose to do this, beware - that giving direct access to the database does contain some security - implications. Even if you give read-only access to the bugs database - it will bypass the secure bugs features of Bugzilla. - - A.2.8. Is there email notification and if so, what do you see when you - get an email? - - Email notification is user-configurable. By default, the bug id and - Summary of the bug report accompany each email notification, along - with a list of the changes made. - - A.2.9. Can email notification be set up to send to multiple people, - some on the To List, CC List, BCC List etc? - - Yes. - - A.2.10. Do users have to have any particular type of email - application? - - Bugzilla email is sent in plain text, the most compatible mail format - on the planet. + Don't directly edit the compiled templates in data/template/* - your + changes will be lost when Template Toolkit recompiles them. Note - If you decide to use the bugzilla_email integration features to allow - Bugzilla to record responses to mail with the associated bug, you may - need to caution your users to set their mailer to "respond to messages - in the format in which they were sent". For security reasons Bugzilla - ignores HTML tags in comments, and if a user sends HTML-based email - into Bugzilla the resulting comment looks downright awful. + It is recommended that you run ./checksetup.pl after any template + edits, especially if you've created a new file in the custom + directory. + _________________________________________________________________ - A.2.11. Does Bugzilla allow data to be imported and exported? If I had - outsiders write up a bug report using a MS Word bug template, could - that template be imported into "matching" fields? If I wanted to take - the results of a query and export that data to MS Excel, could I do - that? +6.1.2. How To Edit Templates - Bugzilla can output buglists as HTML (the default), CSV or RDF. The - link for CSV can be found at the bottom of the buglist in HTML format. - This CSV format can easily be imported into MS Excel or other - spread-sheet applications. + Note - To use the RDF format of the buglist it is necessary to append a - &ctype=rdf to the URL. RDF is meant to be machine readable and thus it - is assumed that the URL would be generated progmatically so there is - no user visible link to this format. + If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the Developers' Guide. - Currently the only script included with Bugzilla that can import data - is importxml.pl which is intended to be used for importing the data - generated by the XML ctype of show_bug.cgi in association with bug - moving. Any other use is left as an exercise for the user. + The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the Template + Toolkit home page. - There are also scripts included in the contrib/ directory for using - e-mail to import information into Bugzilla, but these scripts are not - currently supported and included for educational purposes. + One thing you should take particular care about is the need to + properly HTML filter data that has been passed into the template. This + means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie <. You use the 'html' filter in the + Template Toolkit to do this. If you forget, you may open up your + installation to cross-site scripting attacks. - A.2.12. Has anyone converted Bugzilla to another language to be used - in other countries? Is it localizable? + Also note that Bugzilla adds a few filters of its own, that are not in + standard Template Toolkit. In particular, the 'url_quote' filter can + convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. - Yes. For more information including available translated templates, - see http://www.bugzilla.org/download.html#localizations. The admin - interfaces are still not included in these translated templates and is - therefore still English only. Also, there may be issues with the - charset not being declared. See bug 126226 for more information. + Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + _________________________________________________________________ - A.2.13. Can a user create and save reports? Can they do this in Word - format? Excel format? +6.1.3. Template Formats - Yes. No. Yes (using the CSV format). + Some CGIs have the ability to use more than one template. For example, + buglist.cgi can output bug lists as RDF or two different forms of HTML + (complex and simple). (Try this out by appending &format=simple to a + buglist.cgi URL on your Bugzilla installation.) This mechanism, called + template 'formats', is extensible. - A.2.14. Does Bugzilla have the ability to search by word, phrase, - compound search? + To see if a CGI supports multiple output formats, grep the CGI for + "GetFormat". If it's not present, adding multiple format support isn't + too hard - see how it's done in other CGIs, e.g. config.cgi. - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. + To make a new format template for a CGI which supports this, open a + current template for that CGI and take note of the INTERFACE comment + (if present.) This comment defines what variables are passed into this + template. If there isn't one, I'm afraid you'll have to read the + template and the code to find out what information you get. - A.2.15. Does Bugzilla provide record locking when there is - simultaneous access to the same bug? Does the second person get a - notice that the bug is in use or how are they notified? + Write your template in whatever markup or text style is appropriate. - Bugzilla does not lock records. It provides mid-air collision - detection, and offers the offending user a choice of options to deal - with the conflict. + You now need to decide what content type you want your template served + as. Open up the localconfig file and find the $contenttypes variable. + If your content type is not there, add it. Remember the three- or + four-letter tag assigned to you content type. This tag will be part of + the template filename. - A.2.16. Are there any backup features provided? + Save the template as -..tmpl. + Try out the template by calling the CGI as + .cgi?format= . + _________________________________________________________________ - MySQL, the database back-end for Bugzilla, allows hot-backup of data. - You can find strategies for dealing with backup considerations at - http://www.mysql.com/doc/B/a/Backup.html. +6.1.4. Particular Templates - A.2.17. Can users be on the system while a backup is in progress? + There are a few templates you may be particularly interested in + customizing for your installation. - Yes. However, commits to the database must wait until the tables are - unlocked. Bugzilla databases are typically very small, and backups - routinely take less than a minute. + index.html.tmpl: This is the Bugzilla front page. - A.2.18. What type of human resources are needed to be on staff to - install and maintain Bugzilla? Specifically, what type of skills does - the person need to have? I need to find out if we were to go with - Bugzilla, what types of individuals would we need to hire and how much - would that cost vs buying an "Out-of-the-Box" solution. + global/header.html.tmpl: This defines the header that goes on all + Bugzilla pages. The header includes the banner, which is what appears + to users and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for example + add a stylesheet or META tag by editing the header. - If Bugzilla is set up correctly from the start, continuing maintenance - needs are minimal and can be done easily using the web interface. + global/banner.html.tmpl: This contains the "banner", the part of the + header that appears at the top of all Bugzilla pages. The default + banner is reasonably barren, so you'll probably want to customize this + to give your installation a distinctive look and feel. It is + recommended you preserve the Bugzilla version number in some form so + the version you are running can be determined, and users know what + docs to read. - Commercial Bug-tracking software typically costs somewhere upwards of - $20,000 or more for 5-10 floating licenses. Bugzilla consultation is - available from skilled members of the newsgroup. Simple questions are - answered there and then. + global/footer.html.tmpl: This defines the footer that goes on all + Bugzilla pages. Editing this is another way to quickly get a + distinctive look and feel for your Bugzilla installation. - A.2.19. What time frame are we looking at if we decide to hire people - to install and maintain the Bugzilla? Is this something that takes - hours or weeks to install and a couple of hours per week to maintain - and customize or is this a multi-week install process, plus a full - time job for 1 person, 2 people, etc? + bug/create/user-message.html.tmpl: This is a message that appears near + the top of the bug reporting page. By modifying this, you can tell + your users how they should report bugs. - It all depends on your level of commitment. Someone with much Bugzilla - experience can get you up and running in less than a day, and your - Bugzilla install can run untended for years. If your Bugzilla strategy - is critical to your business workflow, hire somebody with reasonable - UNIX or Perl skills to handle your process management and bug-tracking - maintenance & customization. + bug/create/create.html.tmpl and bug/create/comment.txt.tmpl: You may + wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and + widgets, and have their values appear formatted in the initial + Description, rather than in database fields. An example of this is the + mozilla.org guided bug submission form. - A.2.20. Is there any licensing fee or other fees for using Bugzilla? - Any out-of-pocket cost other than the bodies needed as identified - above? + To make this work, create a custom template for enter_bug.cgi (the + default template, on which you could base it, is create.html.tmpl), + and either call it create.html.tmpl or use a format and call it + create-.html.tmpl. Put it in the custom/bug/create + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. - No. MySQL asks, if you find their product valuable, that you purchase - a support contract from them that suits your needs. + Then, create a template like custom/bug/create/comment.txt.tmpl, also + named after your format if you are using one, which references the + form fields you have created. When a bug report is submitted, the + initial comment attached to the bug report will be formatted according + to the layout of this template. -3. Bugzilla Security + For example, if your enter_bug template had a field + - A.3.1. How do I completely disable MySQL security if it's giving me - problems (I've followed the instructions in the installation section - of this guide)? + and then your comment.txt.tmpl had + BuildID: [% form.buildid %] - Run MySQL like this: "mysqld --skip-grant-tables". Please remember - this makes MySQL as secure as taping a $100 to the floor of a football - stadium bathroom for safekeeping. + then + BuildID: 20020303 - A.3.2. Are there any security problems with Bugzilla? + would appear in the initial checkin comment. + _________________________________________________________________ - The Bugzilla code has undergone a reasonably complete security audit, - and user-facing CGIs run under Perl's taint mode. However, it is - recommended that you closely examine permissions on your Bugzilla - installation, and follow the recommended security guidelines found in - The Bugzilla Guide. +6.1.5. Configuring Bugzilla to Detect the User's Language - A.3.3. I've implemented the security fixes mentioned in Chris Yeh's - security advisory of 5/10/2000 advising not to run MySQL as root, and - am running into problems with MySQL no longer working correctly. + Bugzilla honours the user's Accept: HTTP header. You can install + templates in other languages, and Bugzilla will pick the most + appropriate according to a priority order defined by you. Many + language templates can be obtained from + http://www.bugzilla.org/download.html#localizations. Instructions for + submitting new languages are also available from that location. - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts mysqld. + After untarring the localizations (or creating your own) in the + $BUGZILLA_HOME/template directory, you must update the languages + parameter to contain any localizations you'd like to permit. You may + also wish to set the defaultlanguage parameter to something other than + "en" if you don't want Engish to be the default language. + _________________________________________________________________ -4. Bugzilla Email - - A.4.1. I have a user who doesn't want to receive any more email from - Bugzilla. How do I stop it entirely for this user? - - The user should be able to set this in user email preferences (uncheck - all boxes) or you can add their email address to the data/nomail file. - - A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send - email to anyone but me. How do I do it? - - Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: ". - - A.4.3. I want whineatnews.pl to whine at something more, or other - than, only new bugs. How do I do it? - - Try Klaas Freitag's excellent patch for "whineatassigned" - functionality. You can find it in bug 6679. This patch is against an - older version of Bugzilla, so you must apply the diffs manually. - - A.4.4. I don't like/want to use Procmail to hand mail off to - bug_email.pl. What alternatives do I have? - - You can call bug_email.pl directly from your aliases file, with an - entry like this: - - bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" - - However, this is fairly nasty and subject to problems; you also need - to set up your smrsh (sendmail restricted shell) to allow it. In a - pinch, though, it can work. - - A.4.5. How do I set up the email interface to submit/change bugs via - email? - - You can find an updated README.mailif file in the contrib/ directory - of your Bugzilla distribution that walks you through the setup. - - A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely - slow. What gives? - - If you are using an alternate MTA, make sure the options given in - Bugzilla/BugMail.pm and any other place where sendmail is called from - are correct for your MTA. You should also ensure that the sendmailnow - param is set to on. - - If you are using sendmail, try enabling sendmailnow in editparams.cgi. - - A.4.7. How come email from Bugzilla changes never reaches me? - - Double-check that you have not turned off email in your user - preferences. Confirm that Bugzilla is able to send email by visiting - the "Log In" link of your Bugzilla installation and clicking the - "Email me a password" button after entering your email address. - - If you never receive mail from Bugzilla, chances you do not have - sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is - symlinked to, "/usr/lib/sendmail". - -5. Bugzilla Database - - A.5.1. I've heard Bugzilla can be used with Oracle? - - Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. Red - Hat's newer version (based on 2.17.1 and soon to be merged into the - main distribution) runs on PostgreSQL. At this time we know of no - recent ports of Bugzilla to Oracle but do intend to support it in the - future (possibly the 2.20 time-frame). - - A.5.2. I think my database might be corrupted, or contain invalid - entries. What do I do? - - Run the "sanity check" utility (./sanitycheck.cgi in the Bugzilla_home - directory) from your web browser to see! If it finishes without - errors, you're probably OK. If it doesn't come back OK (i.e. any red - letters), there are certain things Bugzilla can recover from and - certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to - manage your database. Sanity Check, although it is a good basic check - on your database integrity, by no means is a substitute for competent - database administration and avoiding deletion of data. It is not - exhaustive, and was created to do a basic check for the most common - problems in Bugzilla databases. - - A.5.3. I want to manually edit some entries in my database. How? - - There is no facility in Bugzilla itself to do this. It's also - generally not a smart thing to do if you don't know exactly what - you're doing. However, if you understand SQL you can use the mysql - command line utility to manually insert, delete and modify table - information. There are also more intuitive GUI clients available. - Personal favorites of the Bugzilla team are phpMyAdmin and MySQL - Control Center. - - A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla - still can't connect. - - Try running MySQL from its binary: "mysqld --skip-grant-tables". This - will allow you to completely rule out grant tables as the cause of - your frustration. If this Bugzilla is able to connect at this point - then you need to check that you have granted proper permission to the - user password combo defined in localconfig. +6.2. Customizing Who Can Change What Warning - Running MySQL with this command line option is very insecure and - should only be done when not connected to the external network as a - troubleshooting step. + This feature should be considered experimental; the Bugzilla code you + will be changing is not stable, and could change or move between + versions. Be aware that if you make modifications as outlined here, + you may have to re-make them or port them if Bugzilla changes + internally between versions, and you upgrade. - A.5.5. How do I synchronize bug information among multiple different - Bugzilla databases? + Companies often have rules about which employees, or classes of + employees, are allowed to change certain things in the bug system. For + example, only the bug's designated QA Contact may be allowed to VERIFY + the bug. Bugzilla has been designed to make it easy for you to write + your own custom rules to define who is allowed to make what sorts of + value transition. - Well, you can synchronize or you can move bugs. Synchronization will - only work one way -- you can create a read-only copy of the database - at one site, and have it regularly updated at intervals from the main - database. + For maximum flexibility, customizing this means editing Bugzilla's + Perl code. This gives the administrator complete control over exactly + who is allowed to do what. The relevant function is called + CheckCanChangeField(), and is found in process_bug.cgi in your + Bugzilla directory. If you open that file and grep for "sub + CheckCanChangeField", you'll find it. - MySQL has some synchronization features builtin to the latest - releases. It would be great if someone looked into the possibilities - there and provided a report to the newsgroup on how to effectively - synchronize two Bugzilla installations. + This function has been carefully commented to allow you to see exactly + how it works, and give you an idea of how to make changes to it. + Certain marked sections should not be changed - these are the + "plumbing" which makes the rest of the function work. In between those + sections, you'll find snippets of code like: + # Allow the owner to change anything. + if ($ownerid eq $whoid) { + return 1; + } - If you simply need to transfer bugs from one Bugzilla to another, - checkout the "move.pl" script in the Bugzilla distribution. + It's fairly obvious what this piece of code does. -6. Bugzilla and Win32 + So, how does one go about changing this function? Well, simple changes + can be made just be removing pieces - for example, if you wanted to + prevent any user adding a comment to a bug, just remove the lines + marked "Allow anyone to change comments." And if you want the reporter + to have no special rights on bugs they have filed, just remove the + entire section which refers to him. - A.6.1. What is the easiest way to run Bugzilla on Win32 - (Win98+/NT/2K)? + More complex customizations are not much harder. Basically, you add a + check in the right place in the function, i.e. after all the variables + you are using have been set up. So, don't look at $ownerid before + $ownerid has been obtained from the database. You can either add a + positive check, which returns 1 (allow) if certain conditions are + true, or a negative check, which returns 0 (deny.) E.g.: + if ($field eq "qacontact") { + if (Bugzilla->user->groups("quality_assurance")) { + return 1; + } + else { + return 0; + } + } - Remove Windows. Install Linux. Install Bugzilla. The boss will never - know the difference. + This says that only users in the group "quality_assurance" can change + the QA Contact field of a bug. Getting more weird: + if (($field eq "priority") && + (Bugzilla->user->email =~ /.*\@example\.com$/)) + { + if ($oldvalue eq "P1") { + return 1; + } + else { + return 0; + } + } - A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + This says that if the user is trying to change the priority field, and + their email address is @example.com, they can only do so if the old + value of the field was "P1". Not very useful, but illustrative. - Not currently. Bundle::Bugzilla enormously simplifies Bugzilla - installation on UNIX systems. If someone can volunteer to create a - suitable PPM bundle for Win32, it would be appreciated. - - A.6.3. CGI's are failing with a "something.cgi is not a valid Windows - NT application" error. Why? - - Depending on what Web server you are using, you will have to configure - the Web server to treat *.cgi files as CGI scripts. In IIS, you do - this by adding *.cgi to the App Mappings with the \perl.exe %s - %s as the executable. - - Microsoft has some advice on this matter, as well: - - "Set application mappings. In the ISM, map the extension for the - script file(s) to the executable for the script interpreter. For - example, you might map the extension .py to Python.exe, the - executable for the Python script interpreter. Note For the - ActiveState Perl script interpreter, the extension .pl is - associated with PerlIS.dll by default. If you want to change the - association of .pl to perl.exe, you need to change the application - mapping. In the mapping, you must add two percent (%) characters to - the end of the pathname for perl.exe, as shown in this example: - c:\perl\bin\perl.exe %s %s" - - A.6.4. I'm having trouble with the perl modules for NT not being able - to talk to to the database. - - Your modules may be outdated or inaccurate. Try: - - 1. Hitting http://www.activestate.com/ActivePerl - 2. Download ActivePerl - 3. Go to your prompt - 4. Type 'ppm' - 5. PPM> install DBI DBD-mysql GD - - I reckon TimeDate and Data::Dumper come with the activeperl. You can - check the ActiveState site for packages for installation through PPM. - http://www.activestate.com/Packages/. - -7. Bugzilla Usage - - A.7.1. How do I change my user name (email address) in Bugzilla? - - New in 2.16 - go to the Account section of the Preferences. You will - be emailed at both addresses for confirmation. - - A.7.2. The query page is very confusing. Isn't there a simpler way to - query? - - The interface was simplified by a UI designer for 2.16. Further - suggestions for improvement are welcome, but we won't sacrifice power - for simplicity. - - A.7.3. I'm confused by the behavior of the "accept" button in the Show - Bug form. Why doesn't it assign the bug to me when I accept it? - - The current behavior is acceptable to bugzilla.mozilla.org and most - users. You have your choice of patches to change this behavior, - however. - - Add a "and accept bug" radio button - "Accept" button automatically assigns to you - - Note that these patches are somewhat dated. You will need to apply - them manually. - - A.7.4. I can't upload anything into the database via the "Create - Attachment" link. What am I doing wrong? - - The most likely cause is a very old browser or a browser that is - incompatible with file upload via POST. Download the latest Netscape, - Microsoft, or Mozilla browser to handle uploads correctly. - - A.7.5. How do I change a keyword in Bugzilla, once some bugs are using - it? - - In the Bugzilla administrator UI, edit the keyword and it will let you - replace the old keyword name with a new one. This will cause a problem - with the keyword cache. Run sanitycheck.cgi to fix it. - - A.7.6. Why can't I close bugs from the "Change Several Bugs at Once" - page? - - The logic flow currently used is RESOLVED, then VERIFIED, then CLOSED. - You can mass-CLOSE bugs from the change several bugs at once page. - but, every bug listed on the page has to be in VERIFIED state before - the control to do it will show up on the form. You can also - mass-VERIFY, but every bug listed has to be RESOLVED in order for the - control to show up on the form. The logic behind this is that if you - pick one of the bugs that's not VERIFIED and try to CLOSE it, the bug - change will fail miserably (thus killing any changes in the list after - it while doing the bulk change) so it doesn't even give you the - choice. - -8. Bugzilla Hacking - - A.8.1. What kind of style should I use for templatization? - - Gerv and Myk suggest a 2-space indent, with embedded code sections on - their own line, in line with outer tags. Like this: - - [% IF foo %] - - [% FOREACH x = barney %] - - - [% x %] - - - [% END %] - [% END %] - - - Myk also recommends you turn on PRE_CHOMP in the template - initialization to prevent bloating of HTML with unnecessary - whitespace. - - Please note that many have differing opinions on this subject, and the - existing templates in Bugzilla espouse both this and a 4-space style. - Either is acceptable; the above is preferred. - - A.8.2. What bugs are in Bugzilla right now? - - Try this link to view current bugs or requests for enhancement for - Bugzilla. - - You can view bugs marked for 2.18 release here. This list includes - bugs for the 2.18 release that have already been fixed and checked - into CVS. Please consult the Bugzilla Project Page for details on how - to check current sources out of CVS so you can have these bug fixes - early! - - A.8.3. How can I change the default priority to a null value? For - instance, have the default priority be "---" instead of "P2"? - - This is well-documented in bug 49862. Ultimately, it's as easy as - adding the "---" priority field to your localconfig file in the - appropriate area, re-running checksetup.pl, and then changing the - default priority in your browser using "editparams.cgi". - - A.8.4. What's the best way to submit patches? What guidelines should I - follow? - - 1. Enter a bug into bugzilla.mozilla.org for the "Bugzilla" product. - 2. Upload your patch as a unified diff (having used "diff -u" against - the current sources checked out of CVS), or new source file by - clicking "Create a new attachment" link on the bug page you've - just created, and include any descriptions of database changes you - may make, into the bug ID you submitted in step #1. Be sure and - click the "Patch" checkbox to indicate the text you are sending is - a patch! - 3. Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for - discussion in the newsgroup (netscape.public.mozilla.webtools). - You'll get a really good, fairly immediate reaction to the - implications of your patch, which will also give us an idea how - well-received the change would be. - 4. If it passes muster with minimal modification, the person to whom - the bug is assigned in Bugzilla is responsible for seeing the - patch is checked into CVS. - 5. Bask in the glory of the fact that you helped write the most - successful open-source bug-tracking software on the planet :) + For a list of possible field names, look in data/versioncache for the + list called @::log_columns. If you need help writing custom rules for + your organization, ask in the newsgroup. _________________________________________________________________ -Appendix B. The Bugzilla Database - - Note - - This document really needs to be updated with more fleshed out - information about primary keys, interrelationships, and maybe some - nifty tables to document dependencies. Any takers? - _________________________________________________________________ - -B.1. Modifying Your Running System +6.3. Modifying Your Running System Bugzilla optimizes database lookups by storing all relatively static information in the versioncache file, located in the data/ @@ -3863,7 +2781,7 @@ B.1. Modifying Your Running System things. _________________________________________________________________ -B.2. MySQL Bugzilla Database Introduction +6.4. MySQL Bugzilla Database Introduction This information comes straight from my life. I was forced to learn how Bugzilla organizes database because of nitpicky requests from @@ -3920,7 +2838,7 @@ B.2. MySQL Bugzilla Database Introduction tinyint definitions. The Adventure Awaits You! _________________________________________________________________ -B.2.1. Bugzilla Database Basics +6.4.1. Bugzilla Database Basics If you were like me, at this point you're totally clueless about the internals of MySQL, and if it weren't for this executive order from @@ -3944,7 +2862,7 @@ B.2.1. Bugzilla Database Basics mysql use bugs; _________________________________________________________________ -B.2.1.1. Bugzilla Database Tables +6.4.1.1. Bugzilla Database Tables Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command: @@ -3956,31 +2874,31 @@ B.2.1.1. Bugzilla Database Tables From the command issued above, ou should have some output that looks like this: - +-------------------+ - | Tables in bugs | - +-------------------+ - | attachments | - | bugs | - | bugs_activity | - | cc | - | components | - | dependencies | - | fielddefs | - | groups | - | keyworddefs | - | keywords | - | logincookies | - | longdescs | - | milestones | - | namedqueries | - | products | - | profiles | - | profiles_activity | - | tokens | - | versions | - | votes | - | watch | - +-------------------+ ++-------------------+ +| Tables in bugs | ++-------------------+ +| attachments | +| bugs | +| bugs_activity | +| cc | +| components | +| dependencies | +| fielddefs | +| groups | +| keyworddefs | +| keywords | +| logincookies | +| longdescs | +| milestones | +| namedqueries | +| products | +| profiles | +| profiles_activity | +| tokens | +| versions | +| votes | +| watch | ++-------------------+ Here's an overview of what each table does. Most columns in each tab le have @@ -4166,34 +3084,787 @@ B.2.1.1. Bugzilla Database Tables this. But you need to know this stuff anyway, right? _________________________________________________________________ -Appendix C. Useful Patches and Utilities for Bugzilla +6.5. Integrating Bugzilla with Third-Party Tools - Are you looking for a way to put your Bugzilla into overdrive? Catch - some of the niftiest tricks here in this section. +6.5.1. Bonsai + + Bonsai is a web-based tool for managing CVS, the Concurrent Versioning + System . Using Bonsai, administrators can control open/closed status + of trees, query a fast relational database back-end for change, + branch, and comment information, and view changes made since the last + time the tree was closed. Bonsai also integrates with Tinderbox, the + Mozilla automated build management system. _________________________________________________________________ -C.1. Apache mod_rewrite magic +6.5.2. CVS - Apache's mod_rewrite module lets you do some truly amazing things with - URL rewriting. Here are a couple of examples of what you can do. + CVS integration is best accomplished, at this point, using the + Bugzilla Email Gateway. - 1. Make it so if someone types http://www.foo.com/12345 , Bugzilla - spits back http://www.foo.com/show_bug.cgi?id=12345. Try setting - up your VirtualHost section for Bugzilla with a rule like this: + Follow the instructions in this Guide for enabling Bugzilla e-mail + integration. Ensure that your check-in script sends an email to your + Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can + have CVS check-in comments append to your Bugzilla bug. If you want to + have the bug be closed automatically, you'll have to modify the + contrib/bugzilla_email_append.pl script. - - RewriteEngine On - RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] - - - 2. There are many, many more things you can do with mod_rewrite. - Please refer to the mod_rewrite documentation at - http://www.apache.org. + There is also a CVSZilla project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to email. + Check it out at: http://homepages.kcbbs.gen.nz/~tonyg/. _________________________________________________________________ -C.2. Command-line Bugzilla Queries +6.5.3. Perforce SCM - There are a suite of Unix utilities for querying Bugzilla from the + You can find the project page for Bugzilla and Teamtrack Perforce + integration (p4dti) at: http://www.ravenbrook.com/project/p4dti/ . + "p4dti" is now an officially supported product from Perforce, and you + can find the "Perforce Public Depot" p4dti page at + http://public.perforce.com/public/perforce/p4dti/index.html . + + Integration of Perforce with Bugzilla, once patches are applied, is + seamless. Perforce replication information will appear below the + comments of each bug. Be certain you have a matching set of patches + for the Bugzilla version you are installing. p4dti is designed to + support multiple defect trackers, and maintains its own documentation + for it. Please consult the pages linked above for further information. + _________________________________________________________________ + +6.5.4. Tinderbox/Tinderbox2 + + Tinderbox is a continuous-build system which can integrate with + Bugzilla - see http://www.mozilla.org/projects/tinderbox for details + of Tinderbox, and http://tinderbox.mozilla.org/showbuilds.cgi to see + it in action. + _________________________________________________________________ + +Appendix A. The Bugzilla FAQ + + This FAQ includes questions not covered elsewhere in the Guide. + + 1. General Questions + + A.1.1. What license is Bugzilla distributed under? + A.1.2. How do I get commercial support for Bugzilla? + A.1.3. What major companies or projects are currently using + Bugzilla for bug-tracking? + + A.1.4. Who maintains Bugzilla? + A.1.5. How does Bugzilla stack up against other bug-tracking + databases? + + A.1.6. Why doesn't Bugzilla offer this or that feature or + compatibility with this other tracking software? + + A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on + Oracle/Sybase/Msql/PostgreSQL/MSSQL. + + A.1.8. What is /usr/bonsaitools/bin/perl? + A.1.9. My perl is not located at /usr/bin/perl, is there an easy + way to change it everywhere it needs to be changed? + + A.1.10. Is there an easy way to change the Bugzilla cookie name? + + 2. Managerial Questions + + A.2.1. Is Bugzilla web-based, or do you have to have specific + software or a specific operating system on your machine? + + A.2.2. Does Bugzilla allow us to define our own priorities and + levels? Do we have complete freedom to change the labels + of fields and format of them, and the choice of + acceptable values? + + A.2.3. Does Bugzilla provide any reporting features, metrics, + graphs, etc? You know, the type of stuff that management + likes to see. :) + + A.2.4. Is there email notification and if so, what do you see + when you get an email? + + A.2.5. Do users have to have any particular type of email + application? + + A.2.6. Does Bugzilla allow data to be imported and exported? If I + had outsiders write up a bug report using a MS Word bug + template, could that template be imported into "matching" + fields? If I wanted to take the results of a query and + export that data to MS Excel, could I do that? + + A.2.7. Has anyone converted Bugzilla to another language to be + used in other countries? Is it localizable? + + A.2.8. Can a user create and save reports? Can they do this in + Word format? Excel format? + + A.2.9. Does Bugzilla provide record locking when there is + simultaneous access to the same bug? Does the second + person get a notice that the bug is in use or how are + they notified? + + A.2.10. Are there any backup features provided? + A.2.11. Can users be on the system while a backup is in progress? + + A.2.12. What type of human resources are needed to be on staff to + install and maintain Bugzilla? Specifically, what type of + skills does the person need to have? I need to find out + if we were to go with Bugzilla, what types of individuals + would we need to hire and how much would that cost vs + buying an "out-of-the-box" solution? + + A.2.13. What time frame are we looking at if we decide to hire + people to install and maintain the Bugzilla? Is this + something that takes hours or weeks to install and a + couple of hours per week to maintain and customize or is + this a multi-week install process, plus a full time job + for 1 person, 2 people, etc? + + A.2.14. Is there any licensing fee or other fees for using + Bugzilla? Any out-of-pocket cost other than the bodies + needed as identified above? + + 3. Bugzilla Security + + A.3.1. How do I completely disable MySQL security if it's giving + me problems (I've followed the instructions in the + installation section of this guide)? + + A.3.2. Are there any security problems with Bugzilla? + + 4. Bugzilla Email + + A.4.1. I have a user who doesn't want to receive any more email + from Bugzilla. How do I stop it entirely for this user? + + A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send + email to anyone but me. How do I do it? + + A.4.3. I want whineatnews.pl to whine at something different to + only new bugs. How do I do it? + + A.4.4. How do I set up the email interface to submit/change bugs + via email? + + A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's + extremely slow. What gives? + + A.4.6. How come email from Bugzilla changes never reaches me? + + 5. Bugzilla Database + + A.5.1. I've heard Bugzilla can be used with Oracle? + A.5.2. I think my database might be corrupted, or contain invalid + entries. What do I do? + + A.5.3. I want to manually edit some entries in my database. How? + A.5.4. I think I've set up MySQL permissions correctly, but + Bugzilla still can't connect. + + A.5.5. How do I synchronize bug information among multiple + different Bugzilla databases? + + 6. Bugzilla and Win32 + + A.6.1. What is the easiest way to run Bugzilla on Win32 + (Win98+/NT/2K)? + + A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + A.6.3. CGI's are failing with a "something.cgi is not a valid + Windows NT application" error. Why? + + A.6.4. I'm having trouble with the perl modules for NT not being + able to talk to to the database. + + 7. Bugzilla Usage + + A.7.1. How do I change my user name (email address) in Bugzilla? + A.7.2. The query page is very confusing. Isn't there a simpler + way to query? + + A.7.3. I'm confused by the behavior of the "accept" button in the + Show Bug form. Why doesn't it assign the bug to me when I + accept it? + + A.7.4. I can't upload anything into the database via the "Create + Attachment" link. What am I doing wrong? + + A.7.5. How do I change a keyword in Bugzilla, once some bugs are + using it? + + A.7.6. Why can't I close bugs from the "Change Several Bugs at + Once" page? + + 8. Bugzilla Hacking + + A.8.1. What kind of style should I use for templatization? + A.8.2. What bugs are in Bugzilla right now? + A.8.3. How can I change the default priority to a null value? For + instance, have the default priority be "---" instead of + "P2"? + + A.8.4. What's the best way to submit patches? What guidelines + should I follow? + +1. General Questions + + A.1.1. What license is Bugzilla distributed under? + + Bugzilla is covered by the Mozilla Public License. See details at + http://www.mozilla.org/MPL/. + + A.1.2. How do I get commercial support for Bugzilla? + + http://bugzilla.org/consulting.html is a list of people and companies + who have asked us to list them as consultants for Bugzilla. + + There are several experienced Bugzilla hackers on the mailing + list/newsgroup who are willing to make themselves available for + generous compensation. Try sending a message to the mailing list + asking for a volunteer. + + A.1.3. What major companies or projects are currently using Bugzilla + for bug-tracking? + + There are dozens of major companies with public Bugzilla sites to + track bugs in their products. We have a fairly complete list available + on our website at http://bugzilla.org/installation-list/. If you have + an installation of Bugzilla and would like to be added to the list, + whether it's a public install or not, simply e-mail Gerv + . + + A.1.4. Who maintains Bugzilla? + + A core team, led by Dave Miller (justdave@bugzilla.org). + + A.1.5. How does Bugzilla stack up against other bug-tracking + databases? + + We can't find any head-to-head comparisons of Bugzilla against other + defect-tracking software. If you know of one, please get in touch. + However, from the author's personal experience with other + bug-trackers, Bugzilla offers superior performance on commodity + hardware, better price (free!), more developer- friendly features + (such as stored queries, email integration, and platform + independence), improved scalability, open source code, greater + flexibility, and superior ease-of-use. + + If you happen to be a commercial bug-tracker vendor, please step + forward with a list of advantages your product has over Bugzilla. We'd + be happy to include it in the "Competitors" section. + + A.1.6. Why doesn't Bugzilla offer this or that feature or + compatibility with this other tracking software? + + It may be that the support has not been built yet, or that you have + not yet found it. Bugzilla is making tremendous strides in usability, + customizability, scalability, and user interface. It is widely + considered the most complete and popular open-source bug-tracking + software in existence. + + That doesn't mean it can't use improvement! You can help the project + along by either hacking a patch yourself that supports the + functionality you require, or else submitting a "Request for + Enhancement" (RFE) using the bug submission interface at + bugzilla.mozilla.org. + + A.1.7. Why MySQL? I'm interested in seeing Bugzilla run on + Oracle/Sybase/Msql/PostgreSQL/MSSQL. + + MySQL was originally chosen because it is free, easy to install, and + was available for the hardware Netscape intended to run it on. + + There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track the + progress of these initiatives in bug 98304 and bug 173130 + respectively. + + Once both of these are done, adding support for additional database + servers should be trivial. + + A.1.8. What is /usr/bonsaitools/bin/perl? + + Bugzilla used to have the path to perl on the shebang line set to + /usr/bonsaitools/bin/perl because when Terry first started writing the + code for mozilla.org he needed a version of Perl and other tools that + were completely under his control. This location was abandoned for the + 2.18 release in favor of the more sensible /usr/bin/perl. If you + installed an older verion of Bugzilla and created the symlink we + suggested, you can remove it now (provided that you don't have + anything else, such as Bonsai, using it and you don't intend to + reinstall an older version of Bugzilla). + + A.1.9. My perl is not located at /usr/bin/perl, is there an easy way + to change it everywhere it needs to be changed? + + Yes, the following bit of perl magic will change all the shebang + lines. Be sure to change /usr/local/bin/perl to your path to the perl + binary. +perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl + + A.1.10. Is there an easy way to change the Bugzilla cookie name? + + At present, no. + +2. Managerial Questions + + A.2.1. Is Bugzilla web-based, or do you have to have specific software + or a specific operating system on your machine? + + It is web and e-mail based. + + A.2.2. Does Bugzilla allow us to define our own priorities and levels? + Do we have complete freedom to change the labels of fields and format + of them, and the choice of acceptable values? + + Yes. However, modifying some fields, notably those related to bug + progression states, also require adjusting the program logic to + compensate for the change. + + There is no GUI for adding fields to Bugzilla at this time. You can + follow development of this feature in bug 91037 + + A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, + etc? You know, the type of stuff that management likes to see. :) + + Yes. Look at http://bugzilla.mozilla.org/report.cgi for samples of + what Bugzilla can do in reporting and graphing. + + If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, beware + that giving direct access to the database does contain some security + implications. Even if you give read-only access to the bugs database + it will bypass the secure bugs features of Bugzilla. + + A.2.4. Is there email notification and if so, what do you see when you + get an email? + + Email notification is user-configurable. By default, the bug id and + summary of the bug report accompany each email notification, along + with a list of the changes made. + + A.2.5. Do users have to have any particular type of email application? + + Bugzilla email is sent in plain text, the most compatible mail format + on the planet. + + Note + + If you decide to use the bugzilla_email integration features to allow + Bugzilla to record responses to mail with the associated bug, you may + need to caution your users to set their mailer to "respond to messages + in the format in which they were sent". For security reasons Bugzilla + ignores HTML tags in comments, and if a user sends HTML-based email + into Bugzilla the resulting comment looks downright awful. + + A.2.6. Does Bugzilla allow data to be imported and exported? If I had + outsiders write up a bug report using a MS Word bug template, could + that template be imported into "matching" fields? If I wanted to take + the results of a query and export that data to MS Excel, could I do + that? + + Bugzilla can output buglists as HTML (the default), CSV or RDF. The + link for CSV can be found at the bottom of the buglist in HTML format. + This CSV format can easily be imported into MS Excel or other + spreadsheet applications. + + To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF is meant to be machine readable and thus it + is assumed that the URL would be generated programatically so there is + no user visible link to this format. + + Currently the only script included with Bugzilla that can import data + is importxml.pl which is intended to be used for importing the data + generated by the XML ctype of show_bug.cgi in association with bug + moving. Any other use is left as an exercise for the user. + + There are also scripts included in the contrib/ directory for using + e-mail to import information into Bugzilla, but these scripts are not + currently supported and included for educational purposes. + + A.2.7. Has anyone converted Bugzilla to another language to be used in + other countries? Is it localizable? + + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html#localizations. The admin + interfaces are still not included in these translated templates and is + therefore still English only. Also, there may be issues with the + charset not being declared. See bug 126226 for more information. + + A.2.8. Can a user create and save reports? Can they do this in Word + format? Excel format? + + Yes. No. Yes (using the CSV format). + + A.2.9. Does Bugzilla provide record locking when there is simultaneous + access to the same bug? Does the second person get a notice that the + bug is in use or how are they notified? + + Bugzilla does not lock records. It provides mid-air collision + detection, and offers the offending user a choice of options to deal + with the conflict. + + A.2.10. Are there any backup features provided? + + MySQL, the database back-end for Bugzilla, allows hot-backup of data. + You can find strategies for dealing with backup considerations at + http://www.mysql.com/doc/B/a/Backup.html. + + A.2.11. Can users be on the system while a backup is in progress? + + Yes. However, commits to the database must wait until the tables are + unlocked. Bugzilla databases are typically very small, and backups + routinely take less than a minute. + + A.2.12. What type of human resources are needed to be on staff to + install and maintain Bugzilla? Specifically, what type of skills does + the person need to have? I need to find out if we were to go with + Bugzilla, what types of individuals would we need to hire and how much + would that cost vs buying an "out-of-the-box" solution? + + If Bugzilla is set up correctly from the start, continuing maintenance + needs are minimal and can be done easily using the web interface. + + Commercial Bug-tracking software typically costs somewhere upwards of + $20,000 or more for 5-10 floating licenses. Bugzilla consultation is + available from skilled members of the newsgroup. Simple questions are + answered there and then. + + A.2.13. What time frame are we looking at if we decide to hire people + to install and maintain the Bugzilla? Is this something that takes + hours or weeks to install and a couple of hours per week to maintain + and customize or is this a multi-week install process, plus a full + time job for 1 person, 2 people, etc? + + It all depends on your level of commitment. Someone with much Bugzilla + experience can get you up and running in less than a day, and your + Bugzilla install can run untended for years. If your Bugzilla strategy + is critical to your business workflow, hire somebody with reasonable + UNIX or Perl skills to handle your process management and bug-tracking + maintenance & customization. + + A.2.14. Is there any licensing fee or other fees for using Bugzilla? + Any out-of-pocket cost other than the bodies needed as identified + above? + + No. MySQL asks, if you find their product valuable, that you purchase + a support contract from them that suits your needs. + +3. Bugzilla Security + + A.3.1. How do I completely disable MySQL security if it's giving me + problems (I've followed the instructions in the installation section + of this guide)? + + Run MySQL like this: "mysqld --skip-grant-tables". Please remember + this makes MySQL as secure as taping a $100 to the floor of a football + stadium bathroom for safekeeping. + + A.3.2. Are there any security problems with Bugzilla? + + The Bugzilla code has undergone a reasonably complete security audit, + and user-facing CGIs run under Perl's taint mode. However, it is + recommended that you closely examine permissions on your Bugzilla + installation, and follow the recommended security guidelines found in + The Bugzilla Guide. + +4. Bugzilla Email + + A.4.1. I have a user who doesn't want to receive any more email from + Bugzilla. How do I stop it entirely for this user? + + The user should be able to set this in user email preferences (uncheck + all boxes) or you can add their email address to the data/nomail file. + + A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send + email to anyone but me. How do I do it? + + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: ". + + A.4.3. I want whineatnews.pl to whine at something different to only + new bugs. How do I do it? + + Try Klaas Freitag's excellent patch for "whineatassigned" + functionality. You can find it in bug 6679. This patch is against an + older version of Bugzilla, so you must apply the diffs manually. + + A.4.4. How do I set up the email interface to submit/change bugs via + email? + + You can find an updated README.mailif file in the contrib/ directory + of your Bugzilla distribution that walks you through the setup. + + A.4.5. Email takes FOREVER to reach me from Bugzilla -- it's extremely + slow. What gives? + + If you are using sendmail, try enabling sendmailnow in editparams.cgi. + + If you are using an alternate MTA, make sure the options given in + Bugzilla/BugMail.pm and any other place where sendmail is called from + are correct for your MTA. You should also ensure that the sendmailnow + param is set to on. + + A.4.6. How come email from Bugzilla changes never reaches me? + + Double-check that you have not turned off email in your user + preferences. Confirm that Bugzilla is able to send email by visiting + the "Log In" link of your Bugzilla installation and clicking the + "Email me a password" button after entering your email address. + + If you never receive mail from Bugzilla, chances are you do not have + sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is + symlinked to, "/usr/lib/sendmail". + +5. Bugzilla Database + + A.5.1. I've heard Bugzilla can be used with Oracle? + + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle, but + it is now so old as to be obsolete, and is totally unsupported. Red + Hat's newer version (based on 2.17.1 and soon to be merged into the + main distribution) runs on PostgreSQL. At this time we know of no + recent ports of Bugzilla to Oracle; to be honest, Bugzilla doesn't + need what Oracle offers. + + A.5.2. I think my database might be corrupted, or contain invalid + entries. What do I do? + + Run the "sanity check" utility (sanitycheck.cgi) from your web browser + to see! If it finishes without errors, you're probably OK. If it + doesn't come back OK (i.e. any red letters), there are certain things + Bugzilla can recover from and certain things it can't. If it can't + auto-recover, I hope you're familiar with mysqladmin commands or have + installed another way to manage your database. Sanity Check, although + it is a good basic check on your database integrity, by no means is a + substitute for competent database administration and avoiding deletion + of data. It is not exhaustive, and was created to do a basic check for + the most common problems in Bugzilla databases. + + A.5.3. I want to manually edit some entries in my database. How? + + There is no facility in Bugzilla itself to do this. It's also + generally not a smart thing to do if you don't know exactly what + you're doing. However, if you understand SQL you can use the mysql + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL + Control Center. + + A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla + still can't connect. + + Try running MySQL from its binary: "mysqld --skip-grant-tables". This + will allow you to completely rule out grant tables as the cause of + your frustration. If this Bugzilla is able to connect at this point + then you need to check that you have granted proper permission to the + user password combo defined in localconfig. + + Warning + + Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network as a + troubleshooting step. + + A.5.5. How do I synchronize bug information among multiple different + Bugzilla databases? + + Well, you can synchronize or you can move bugs. Synchronization will + only work one way -- you can create a read-only copy of the database + at one site, and have it regularly updated at intervals from the main + database. + + MySQL has some synchronization features builtin to the latest + releases. It would be great if someone looked into the possibilities + there and provided a report to the newsgroup on how to effectively + synchronize two Bugzilla installations. + + If you simply need to transfer bugs from one Bugzilla to another, + checkout the "move.pl" script in the Bugzilla distribution. + +6. Bugzilla and Win32 + + A.6.1. What is the easiest way to run Bugzilla on Win32 + (Win98+/NT/2K)? + + Remove Windows. Install Linux. Install Bugzilla. The boss will never + know the difference. + + A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + + Not currently. Bundle::Bugzilla enormously simplifies Bugzilla + installation on UNIX systems. If someone can volunteer to create a + suitable PPM bundle for Win32, it would be appreciated. + + A.6.3. CGI's are failing with a "something.cgi is not a valid Windows + NT application" error. Why? + + Depending on what Web server you are using, you will have to configure + the Web server to treat *.cgi files as CGI scripts. In IIS, you do + this by adding *.cgi to the App Mappings with the \perl.exe %s + %s as the executable. + + Microsoft has some advice on this matter, as well: + + "Set application mappings. In the ISM, map the extension for the + script file(s) to the executable for the script interpreter. For + example, you might map the extension .py to Python.exe, the + executable for the Python script interpreter. Note For the + ActiveState Perl script interpreter, the extension .pl is + associated with PerlIS.dll by default. If you want to change the + association of .pl to perl.exe, you need to change the application + mapping. In the mapping, you must add two percent (%) characters to + the end of the pathname for perl.exe, as shown in this example: + c:\perl\bin\perl.exe %s %s" + + A.6.4. I'm having trouble with the perl modules for NT not being able + to talk to to the database. + + Your modules may be outdated or inaccurate. Try: + + 1. Hitting http://www.activestate.com/ActivePerl + 2. Download ActivePerl + 3. Go to your prompt + 4. Type 'ppm' + 5. PPM> install DBI DBD-mysql GD + + I reckon TimeDate and Data::Dumper come with the activeperl. You can + check the ActiveState site for packages for installation through PPM. + http://www.activestate.com/Packages/. + +7. Bugzilla Usage + + A.7.1. How do I change my user name (email address) in Bugzilla? + + New in 2.16 - go to the Account section of the Preferences. You will + be emailed at both addresses for confirmation. + + A.7.2. The query page is very confusing. Isn't there a simpler way to + query? + + The interface was simplified by a UI designer for 2.16. Further + suggestions for improvement are welcome, but we won't sacrifice power + for simplicity. + + A.7.3. I'm confused by the behavior of the "accept" button in the Show + Bug form. Why doesn't it assign the bug to me when I accept it? + + The current behavior is acceptable to bugzilla.mozilla.org and most + users. You have your choice of patches to change this behavior, + however. + + Add a "and accept bug" radio button + "Accept" button automatically assigns to you + + Note that these patches are somewhat dated. You will need to apply + them manually. + + A.7.4. I can't upload anything into the database via the "Create + Attachment" link. What am I doing wrong? + + The most likely cause is a very old browser or a browser that is + incompatible with file upload via POST. Download the latest Netscape, + Microsoft, or Mozilla browser to handle uploads correctly. + + A.7.5. How do I change a keyword in Bugzilla, once some bugs are using + it? + + In the Bugzilla administrator UI, edit the keyword and it will let you + replace the old keyword name with a new one. This will cause a problem + with the keyword cache. Run sanitycheck.cgi to fix it. + + A.7.6. Why can't I close bugs from the "Change Several Bugs at Once" + page? + + The logic flow currently used is RESOLVED, then VERIFIED, then CLOSED. + You can mass-CLOSE bugs from the change several bugs at once page. + but, every bug listed on the page has to be in VERIFIED state before + the control to do it will show up on the form. You can also + mass-VERIFY, but every bug listed has to be RESOLVED in order for the + control to show up on the form. The logic behind this is that if you + pick one of the bugs that's not VERIFIED and try to CLOSE it, the bug + change will fail miserably (thus killing any changes in the list after + it while doing the bulk change) so it doesn't even give you the + choice. + +8. Bugzilla Hacking + + A.8.1. What kind of style should I use for templatization? + + Gerv and Myk suggest a 2-space indent, with embedded code sections on + their own line, in line with outer tags. Like this: + +[% IF foo %] + + [% FOREACH x = barney %] + + + [% x %] + + + [% END %] +[% END %] + + + Myk also recommends you turn on PRE_CHOMP in the template + initialization to prevent bloating of HTML with unnecessary + whitespace. + + Please note that many have differing opinions on this subject, and the + existing templates in Bugzilla espouse both this and a 4-space style. + Either is acceptable; the above is preferred. + + A.8.2. What bugs are in Bugzilla right now? + + Try this link to view current bugs or requests for enhancement for + Bugzilla. + + You can view bugs marked for 2.18 release here. This list includes + bugs for the 2.18 release that have already been fixed and checked + into CVS. Please consult the Bugzilla Project Page for details on how + to check current sources out of CVS so you can have these bug fixes + early! + + A.8.3. How can I change the default priority to a null value? For + instance, have the default priority be "---" instead of "P2"? + + This is well-documented in bug 49862. Ultimately, it's as easy as + adding the "---" priority field to your localconfig file in the + appropriate area, re-running checksetup.pl, and then changing the + default priority in your browser using "editparams.cgi". + + A.8.4. What's the best way to submit patches? What guidelines should I + follow? + + 1. Enter a bug into bugzilla.mozilla.org for the "Bugzilla" product. + 2. Upload your patch as a unified diff (having used "diff -u" against + the current sources checked out of CVS), or new source file by + clicking "Create a new attachment" link on the bug page you've + just created, and include any descriptions of database changes you + may make, into the bug ID you submitted in step #1. Be sure and + click the "Patch" checkbox to indicate the text you are sending is + a patch! + 3. Announce your patch and the associated URL + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for + discussion in the newsgroup (netscape.public.mozilla.webtools). + You'll get a really good, fairly immediate reaction to the + implications of your patch, which will also give us an idea how + well-received the change would be. + 4. If it passes muster with minimal modification, the person to whom + the bug is assigned in Bugzilla is responsible for seeing the + patch is checked into CVS. + 5. Bask in the glory of the fact that you helped write the most + successful open-source bug-tracking software on the planet :) + _________________________________________________________________ + +Appendix B. Contrib + + There are a number of unofficial Bugzilla add-ons in the + $BUGZILLA_ROOT/contrib/ directory. This section documents them. + _________________________________________________________________ + +B.1. Command-line Search Interface + + There are a suite of Unix utilities for searching Bugzilla from the command line. They live in the contrib/cmdline directory. However, they have not yet been updated to work with 2.16 (post-templatisation.). There are three files - query.conf, buglist @@ -4226,82 +3897,7 @@ C.2. Command-line Bugzilla Queries w3m -T text/html -dump _________________________________________________________________ -Appendix D. Bugzilla Variants and Competitors - - I created this section to answer questions about Bugzilla competitors - and variants, then found a wonderful site which covers an awful lot of - what I wanted to discuss. Rather than quote it in its entirety, I'll - simply refer you here: http://linas.org/linux/pm.html. - _________________________________________________________________ - -D.1. Red Hat Bugzilla - - Red Hat's old fork of Bugzilla which was based on version 2.8 is now - obsolete. The newest version in use is based on version 2.17.1 and is - in the process of being integrated into the main Bugzilla source tree. - The back-end is modified to work with PostgreSQL instead of MySQL and - they have custom templates to get their desired look and feel, but - other than that it is Bugzilla 2.17.1. Dave Lawrence of Red Hat put - forth a great deal of effort to make sure that the changes he made - could be integrated back into the main tree. Bug 98304 exists to track - this integration. - - URL: http://bugzilla.redhat.com/bugzilla/ - - This section last updated 24 Dec 2002 - _________________________________________________________________ - -D.2. Loki Bugzilla (Fenris) - - Fenris was a fork from Bugzilla made by Loki Games; when Loki went - into receivership, it died. While Loki's other code lives on, its - custodians recommend Bugzilla for future bug-tracker deployments. - - This section last updated 27 Jul 2002 - _________________________________________________________________ - -D.3. Issuezilla - - Issuezilla was another fork from Bugzilla, made by collab.net and - hosted at tigris.org. It is also dead; the primary focus of - bug-tracking at tigris.org is their Java-based bug-tracker, Section - D.4. - - This section last updated 27 Jul 2002 - _________________________________________________________________ - -D.4. Scarab - - Scarab is a new open source bug-tracking system built using Java - Servlet technology. It is currently at version 1.0 beta 13. - - URL: http://scarab.tigris.org/ - - This section last updated 18 Jan 2003 - _________________________________________________________________ - -D.5. Perforce SCM - - Although Perforce isn't really a bug tracker, it can be used as such - through the "jobs" functionality. - - URL: http://www.perforce.com/perforce/technotes/note052.html - - This section last updated 27 Jul 2002 - _________________________________________________________________ - -D.6. SourceForge - - SourceForge is a way of coordinating geographically distributed free - software and open source projects over the Internet. It has a built-in - bug tracker, but it's not highly thought of. - - URL: http://www.sourceforge.net - - This section last updated 27 Jul 2002 - _________________________________________________________________ - -Appendix E. GNU Free Documentation License +Appendix C. GNU Free Documentation License Version 1.1, March 2000 @@ -4707,7 +4303,7 @@ A doesn't have to be changed in every Bugzilla script. For more information about how to configure Apache for - Bugzilla, see Section 4.4.1. + Bugzilla, see Section 4.2.1. B @@ -4754,10 +4350,10 @@ C perl, there may be additional modules or other requirements than those of the offical distribution. - Note + Note - Scripts in the contrib directory are not offically supported by the - Bugzilla team and may break in between versions. + Scripts in the contrib directory are not offically supported by the + Bugzilla team and may break in between versions. D @@ -4804,7 +4400,7 @@ M Privilege System Much more detailed information about the suggestions in - Section 5.6.2. + Section 4.5.2. P @@ -4848,7 +4444,7 @@ R S - SGML + SGML SGML stands for "Standard Generalized Markup Language". Created in the 1980's to provide an extensible means to maintain documentation based upon content instead of presentation, SGML @@ -4884,16 +4480,16 @@ Z - I've been asked to explain this ... way back when, when Netscape - released version 4.0 of its browser, we had a release party. - Naturally, there had been a big push to try and fix every known bug - before the release. Naturally, that hadn't actually happened. (This is - not unique to Netscape or to 4.0; the same thing has happened with - every software project I've ever seen.) Anyway, at the release party, - T-shirts were handed out that said something like "Netscape 4.0: Zarro - Boogs". Just like the software, the T-shirt had no known bugs. Uh-huh. - So, when you query for a list of bugs, and it gets no results, you can - think of this as a friendly reminder. Of *course* there are bugs - matching your query, they just aren't in the bugsystem yet... + I've been asked to explain this ... way back when, when Netscape + released version 4.0 of its browser, we had a release party. + Naturally, there had been a big push to try and fix every known bug + before the release. Naturally, that hadn't actually happened. (This is + not unique to Netscape or to 4.0; the same thing has happened with + every software project I've ever seen.) Anyway, at the release party, + T-shirts were handed out that said something like "Netscape 4.0: Zarro + Boogs". Just like the software, the T-shirt had no known bugs. Uh-huh. + So, when you query for a list of bugs, and it gets no results, you can + think of this as a friendly reminder. Of *course* there are bugs + matching your query, they just aren't in the bugsystem yet... - --Terry Weissman + --Terry Weissman diff --git a/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml b/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml index 5ff9555a434..8fb74a31a0f 100644 --- a/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml +++ b/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml @@ -13,7 +13,7 @@ - + @@ -34,11 +34,10 @@ - + - Bugzilla Documentation"> @@ -70,21 +69,23 @@ @@ -93,18 +94,10 @@ try to avoid clutter and feel free to waste space in the code to make it more re - The Bugzilla Guide - &bz-ver; <![%bz-devel;[Development ]]>Release + The Bugzilla Guide - &bz-ver; + <![%bz-devel;[Development ]]>Release - - Matthew - P. - Barnson - - - Jacob - Steenhagen - The Bugzilla Team @@ -112,28 +105,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re - This is the documentation for Bugzilla, the mozilla.org - bug-tracking system. + This is the documentation for Bugzilla, a + bug-tracking system from mozilla.org. Bugzilla is an enterprise-class piece of software - that powers issue-tracking for hundreds of - organizations around the world, tracking millions of bugs. + that tracks millions of bugs and issues for hundreds of + organizations around the world. - - This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the &bzg-bugs; component. - - This is a development version of this guide. Information in it - is subject to change before the &bz-nextver; release of this guide - (which will correspond with the &bz-nextver; release of Bugzilla). - - ]]> - The most current version of this document can always be found on the - Bugzilla Documentation Page. + Bugzilla + Documentation Page. @@ -166,18 +148,15 @@ try to avoid clutter and feel free to waste space in the code to make it more re &administration; + +&customization; + &faq; - -&database; - &patches; - -&variants; - &gfdl; diff --git a/webtools/bugzilla/docs/xml/about.xml b/webtools/bugzilla/docs/xml/about.xml index 3b0f18e0fe7..28cc9d8c73f 100644 --- a/webtools/bugzilla/docs/xml/about.xml +++ b/webtools/bugzilla/docs/xml/about.xml @@ -7,7 +7,7 @@ @@ -28,43 +28,28 @@ Disclaimer No liability for the contents of this document can be accepted. - Use the concepts, examples, and other content at your own risk. + Follow the instructions herein at your own risk. This document may contain errors and inaccuracies that may damage your system, cause your partner to leave you, your boss to fire you, your cats to pee on your furniture and clothing, and global thermonuclear war. Proceed with caution. - - All copyrights are held by their respective owners, unless - specifically noted otherwise. Use of a term in this document - should not be regarded as affecting the validity of any - trademark or service mark. - Naming of particular products or brands should not be seen as endorsements, with the exception of the term "GNU/Linux". We - wholeheartedly endorse the use of GNU/Linux in every situation - where it is appropriate. It is an extremely versatile, stable, + wholeheartedly endorse the use of GNU/Linux; it is an extremely + versatile, stable, and robust operating system that offers an ideal operating environment for Bugzilla. - - You are strongly recommended to make a backup of your system - before installing Bugzilla and at regular intervals thereafter. - If you implement any suggestion in this Guide, implement this one! - Although the Bugzilla development team has taken great care to - ensure that all easily-exploitable bugs or options are - documented or fixed in the code, security holes surely exist. - Great care should be taken both in the installation and usage of - this software. Carefully consider the implications of installing - other network services with Bugzilla. The Bugzilla development - team members, Netscape Communications, America Online Inc., and - any affiliated developers or sponsors assume no liability for - your use of this product. You have the source code to this - product, and are responsible for auditing it yourself to ensure + ensure that all exploitable bugs or options have been + fixed, security holes surely exist. 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 + the source code, and are responsible for auditing it yourself to ensure your security needs are met. @@ -77,24 +62,14 @@ This is the &bz-ver; version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. - If you are - reading this from any source other than those below, please - check one of these mirrors to make sure you are reading an - up-to-date version of the Guide. The newest version of this guide can always be found at ; including - documentation for past releases and the current development version. - - - The documentation for the most recent stable release of Bugzilla can also - be found at - The Linux Documentation Project. + url="http://www.bugzilla.org"/>; however, you should read the version + which came with the Bugzilla release you are using. The latest version of this document can always be checked out via CVS. @@ -118,87 +93,33 @@ contribution to the Bugzilla community: - - - - Matthew P. Barnson mbarnson@sisna.com - - for the Herculaean task of pulling together the Bugzilla Guide - and shepherding it to 2.14. - - - - - - Terry Weissman terry@mozilla.org - - for initially writing Bugzilla and creating the README upon - which the UNIX installation documentation is largely based. - - - - - - Tara Hernandez tara@tequilarists.org - - for keeping Bugzilla development going strong after Terry left - mozilla.org and for running landfill. - - - - - - Dave Lawrence dkl@redhat.com - - for providing insight into the key differences between Red - Hat's customized Bugzilla, and being largely responsible for - . - - - - - - Dawn Endico endico@mozilla.org - - for being a hacker extraordinaire and putting up with Matthew's - incessant questions and arguments on irc.mozilla.org in #mozwebtools - - - - - - Jacob Steenhagen jake@bugzilla.org - - for taking over documentation during the 2.17 development - period. - - - - - - - Last but not least, all the members of the - - newsgroup. Without your discussions, insight, suggestions, and patches, - this could never have happened. - - - Thanks also go to the following people for significant contributions - to this documentation (in alphabetical order): - Andrew Pearson + Matthew P. Barnson + Kevin Brannen + Dawn Endico Ben FrantzDale Eric Hanson + Tara Hernandez + Dave Lawrence + Zach Lipton Gervase Markham + Andrew Pearson Joe Robins - Kevin Brannen - Martin Wulffeld - Ron Teitelbaum Spencer Smith - Zach Liption - - . + Jacob Steenhagen + Ron Teitelbaum + Terry Weissman + Martin Wulffeld + . + + + + Last but not least, all the members of the + + netscape.public.mozilla.webtools + newsgroup. Without your discussions, insight, suggestions, and patches, + this could never have happened. diff --git a/webtools/bugzilla/docs/xml/administration.xml b/webtools/bugzilla/docs/xml/administration.xml index 8eb7769a433..b261f4ee2ff 100644 --- a/webtools/bugzilla/docs/xml/administration.xml +++ b/webtools/bugzilla/docs/xml/administration.xml @@ -71,7 +71,7 @@ standard type, and Bugzilla does not yet take advantage of features such as transactions which would justify this speed decrease. The Bugzilla team are, however, happy to hear about any experiences with - row level locking and Bugzilla + row level locking and Bugzilla. The shadowdb parameter was designed to get around this limitation. While only a @@ -82,7 +82,7 @@ high-traffic Bugzilla databases. - As a guide, mozilla.org began needing + As a guide, on reasonably old hardware, mozilla.org began needing shadowdb when they reached around 40,000 Bugzilla users with several hundred Bugzilla bug changes and comments per day. @@ -321,7 +321,7 @@ they attempt to perform these actions, and should explain why the account was disabled. - Don't disable the administrator account! + Don't disable all the administrator accounts! @@ -418,178 +418,167 @@ -
    - Product, Component, Milestone, and Version Administration +
    + Products -
    - Products + + + Products - - - Products + are the broadest category in Bugzilla, and tend to represent real-world + shipping products. E.g. if your company makes computer games, + you should have one product per game, perhaps a "Common" product for + units of technology used in multiple games, and maybe a few special + products (Website, Administration...) - are the broadest category in Bugzilla, and tend to represent real-world - shipping products. E.g. if your company makes computer games, - you should have one product per game, perhaps a "Common" product for - units of technology used in multiple games, and maybe a few special - products (Website, Administration...) + Many of Bugzilla's settings are configurable on a per-product + basis. The number of "votes" available to users is set per-product, + as is the number of votes + required to move a bug automatically from the UNCONFIRMED status to the + NEW status. - Many of Bugzilla's settings are configurable on a per-product - basis. The number of "votes" available to users is set per-product, - as is the number of votes - required to move a bug automatically from the UNCONFIRMED status to the - NEW status. + To create a new product: - To create a new product: + + + Select "products" from the footer - - - Select "products" from the footer + - + + Select the "Add" link in the bottom right + - - Select the "Add" link in the bottom right - + + Enter the name of the product and a description. The + Description field may contain HTML. + + - - Enter the name of the product and a description. The - Description field may contain HTML. - - + Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single bug", + "Number of votes a bug in this Product needs to automatically get out + of the UNCOMFIRMED state", and "Version" options yet. We'll cover + those in a few moments. + +
    - Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get out - of the UNCOMFIRMED state", and "Version" options yet. We'll cover - those in a few moments. - -
    +
    + Components -
    - Components + Components are subsections of a Product. E.g. the computer game + you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company. - Components are subsections of a Product. E.g. the computer game - you are designing may have a "UI" - component, an "API" component, a "Sound System" component, and a - "Plugins" component, each overseen by a different programmer. It - often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or - company. - - - Each component has a owner and (if you turned it on in the parameters), - a QA Contact. The owner should be the primary person who fixes bugs in - that component. The QA Contact should be the person who will ensure - these bugs are completely fixed. The Owner, QA Contact, and Reporter - will get email when new bugs are created in this Component and when - these bugs change. Default Owner and Default QA Contact fields only - dictate the - default assignments; - these can be changed on bug submission, or at any later point in - a bug's life. + + Each component has a owner and (if you turned it on in the parameters), + a QA Contact. The owner should be the primary person who fixes bugs in + that component. The QA Contact should be the person who will ensure + these bugs are completely fixed. The Owner, QA Contact, and Reporter + will get email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields only + dictate the + default assignments; + these can be changed on bug submission, or at any later point in + a bug's life. - To create a new Component: + To create a new Component: - - - Select the "Edit components" link from the "Edit product" - page - + + + Select the "Edit components" link from the "Edit product" + page + - - Select the "Add" link in the bottom right. - + + Select the "Add" link in the bottom right. + - - Fill out the "Component" field, a short "Description", - the "Initial Owner" and "Initial QA Contact" (if enabled.) - The Component and Description fields may contain HTML; - the "Initial Owner" field must be a login name - already existing in the database. - - - -
    - -
    - Versions - - Versions are the revisions of the product, such as "Flinders - 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select - field; the usual practice is to select the most recent version with - the bug. - - - To create and edit Versions: - - - - From the "Edit product" screen, select "Edit Versions" - - - - You will notice that the product already has the default - version "undefined". Click the "Add" link in the bottom right. - - - - Enter the name of the Version. This field takes text only. - Then click the "Add" button. - - - -
    - -
    - Milestones - - Milestones are "targets" that you plan to get a bug fixed by. For - example, you have a bug that you plan to fix for your 3.0 release, it - would be assigned the milestone of 3.0. - - - Milestone options will only appear for a Product if you turned - on the "usetargetmilestone" Param in the "Edit Parameters" screen. + + Fill out the "Component" field, a short "Description", + the "Initial Owner" and "Initial QA Contact" (if enabled.) + The Component and Description fields may contain HTML; + the "Initial Owner" field must be a login name + already existing in the database. - + + +
    - To create new Milestones, set Default Milestones, and set - Milestone URL: +
    + Versions - - - Select "Edit milestones" from the "Edit product" page. - + Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the earliest version known to have + the bug. + - - Select "Add" in the bottom right corner. - text - + To create and edit Versions: - - Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "sortkey", which is a positive or negative - number (-255 to 255) that defines where in the list this particular - milestone appears. This is because milestones often do not - occur in alphanumeric order For example, "Future" might be - after "Release 1.2". Select "Add". - + + + From the "Edit product" screen, select "Edit Versions" + - - From the Edit product screen, you can enter the URL of a - page which gives information about your milestones and what - they mean. + + You will notice that the product already has the default + version "undefined". Click the "Add" link in the bottom right. + - - If you want your milestone document to be restricted so - that it can only be viewed by people in a particular Bugzilla - group, the best way is to attach the document to a bug in that - group, and make the URL the URL of that attachment. - - - -
    + + Enter the name of the Version. This field takes text only. + Then click the "Add" button. + + + +
    + +
    + Milestones + + Milestones are "targets" that you plan to get a bug fixed by. For + example, you have a bug that you plan to fix for your 3.0 release, it + would be assigned the milestone of 3.0. + + + Milestone options will only appear for a Product if you turned + on the "usetargetmilestone" Param in the "Edit Parameters" screen. + + + + To create new Milestones, set Default Milestones, and set + Milestone URL: + + + + Select "Edit milestones" from the "Edit product" page. + + + + Select "Add" in the bottom right corner. + text + + + + Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this particular + milestone appears. This is because milestones often do not + occur in alphanumeric order For example, "Future" might be + after "Release 1.2". Select "Add". + + + + From the Edit product screen, you can enter the URL of a + page which gives information about your milestones and what + they mean. + +
    @@ -723,9 +712,10 @@ place all users who fulfill the Regular Expression into the new group. When you have finished, click Add. - The User Regexp is a perl regexp and, if not anchored, will match - any part of an address. So, if you do not want to grant access - into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use + If specifying a domain in the regexp, make sure you end + the regexp with a $. Otherwise, when granting access to + "@mycompany\.com", you will allow access to + 'badperson@mycompany.com.cracker.net'. You need to use '@mycompany\.com$' as the regexp. @@ -749,705 +739,6 @@
    - -
    - Bugzilla Security - - - 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. - - - - These instructions must, of necessity, be somewhat vague since - Bugzilla runs on so many different platforms. If you have refinements - of these directions, please submit a bug to &bzg-bugs;. - - - - - This is not meant to be a comprehensive list of every possible - security issue regarding the tools mentioned in this section. There is - no subsitute for reading the information written by the authors of any - software running on your system. - - - -
    - TCP/IP Ports - - - TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla - only needs 1... 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. - -
    - -
    - MySQL - - 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 not the same as - the system root). Also, many installations default to running - mysqld as the system root. - - - - - Consult the documentation that came with your system for - information on making mysqld run as an - unprivleged user. - - - - - 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: - - -bash$ mysql mysql -mysql> DELETE FROM user WHERE user = ''; -mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; -mysql> FLUSH PRIVILEGES; - - From this point forward you will need to use - mysql -u root -p and enter - new_password when prompted when using the - mysql client. - - - - - 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 /etc/my.conf: - - -[myslqd] -# Prevent network access to MySQL. -skip-networking - - - - - 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. - - - - - -
    - -
    - Daemon Accounts - - Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either root or nobody. Running - as root introduces obvious security problems, but the - problems introduced by running everything as nobody may - not be so obvious. Basically, if you're running every daemon as - nobody and one of them gets comprimised, they all get - comprimised. For this reason it is recommended that you create a user - account for each daemon. - - - - You will need to set the webservergroup to - the group you created for your webserver to run as in - localconfig. This will allow - ./checksetup.pl to better adjust the file - permissions on your Bugzilla install so as to not require making - anything world-writable. - - - -
    - -
    - Web Server Access Controls - - 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 layed out, the list of what should and should - not be accessible is rather complicated. A new installation method - is currently in the works which should solve this by allowing files - that shouldn't be accessible from the web to be placed in directory - outside the webroot. See - - bug 44659 for more information. - - - - - In the main Bugzilla directory, you should: - - - Block: - - *.pl - *localconfig* - runtests.sh - - - - - But allow: - - localconfig.js - localconfig.rdf - - - - - - - - In data: - - - Block everything - - - But allow: - - duplicates.rdf - - - - - - - - In data/webdot: - - - If you use a remote webdot server: - - - Block everything - - - But allow - - *.dot - - only for the remote webdot server - - - - - Otherwise, if you use a local GraphViz: - - - Block everything - - - But allow: - - *.png - *.gif - *.jpg - *.map - - - - - - - And if you don't use any dot: - - - Block everything - - - - - - - - In Bugzilla: - - - Block everything - - - - - - In template: - - - Block everything - - - - - - - Bugzilla ships with the ability to generate - .htaccess files instructing - Apache which files - should and should not be accessible. For more information, see - . - - - - You should test to make sure that the files mentioned above are - not accessible from the Internet, especially your - localconfig 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 - . You should - get a 403 Forbidden - error. - - - - Not following the instructions in this section, including - testing, may result in sensitive information being globally - accessible. - - - - - You should check 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. - - - -
    - -
    - -
    - Template Customization - - - One of the large changes for 2.16 was the templatization of the - entire user-facing UI, using the - Template Toolkit. - Administrators can now configure the look and feel of Bugzilla without - having to edit Perl files or face the nightmare of massive merge - conflicts when they upgrade to a newer version in the future. - - - - Templatization also makes localized versions of Bugzilla possible, - for the first time. As of version 2.18, it's possible to have Bugzilla's language determined by - the user's browser. More information is available in - . - - -
    - What to Edit - - There are two different ways of editing of Bugzilla's templates, - and which you use depends mainly on how you upgrade Bugzilla. The - template directory structure is that there's a top level directory, - template, which contains a directory for - each installed localization. The default English templates are - therefore in en. Underneath that, there - is the default directory and optionally the - custom directory. The default - directory contains all the templates shipped with Bugzilla, whereas - the custom directory does not exist at first and - must be created if you want to use it. - - - - The first method of making customizations is to directly edit the - templates in template/en/default. This is - probably the best method for small changes if you are going to use - the CVS method of upgrading, because if you then execute a - cvs update, any template fixes will get - automagically merged into your modified versions. - - - - If you use this method, your installation will break if CVS conflicts - occur. - - - - The other method is to copy the templates into a mirrored directory - structure under template/en/custom. The templates - in this directory automatically override those in default. - This is the technique you - need to use if you use the overwriting method of upgrade, because - otherwise your changes will be lost. This method is also better if - you are using the CVS method of upgrading and are going to make major - changes, because it is guaranteed that the contents of this directory - will not be touched during an upgrade, and you can then decide whether - to continue using your own templates, or make the effort to merge your - changes into the new versions by hand. - - - - If you use this method, your installation may break if incompatible - changes are made to the template interface. If such changes are made - they will be documented in the release notes, provided you are using a - stable release of Bugzilla. If you use using unstable code, you will - need to deal with this one yourself, although if possible the changes - will be mentioned before they occur in the deprecations section of the - previous stable release's release notes. - - - - - Don't directly edit the compiled templates in - data/template/* - your - changes will be lost when Template Toolkit recompiles them. - - - - - It is recommended that you run ./checksetup.pl - after any template edits, especially if you've created a new file in - the custom directory. - - -
    - -
    - How To Edit Templates - - - The syntax of the Template Toolkit language is beyond the scope of - this guide. It's reasonably easy to pick up by looking at the current - templates; or, you can read the manual, available on the - Template Toolkit home - page. However, you should particularly remember (for security - reasons) to always HTML filter things which come from the database or - user input, to prevent cross-site scripting attacks. - - - - However, one thing you should take particular care about is the need - to properly HTML filter data that has been passed into the template. - This means that if the data can possibly contain special HTML characters - such as <, and the data was not intended to be HTML, they need to be - converted to entity form, ie &lt;. You use the 'html' filter in the - Template Toolkit to do this. If you fail to do this, you may open up - your installation to cross-site scripting attacks. - - - - Also note that Bugzilla adds a few filters of its own, that are not - in standard Template Toolkit. In particular, the 'url_quote' filter - can convert characters that are illegal or have special meaning in URLs, - such as &, to the encoded form, ie %26. This actually encodes most - characters (but not the common ones such as letters and numbers and so - on), including the HTML-special characters, so there's never a need to - HTML filter afterwards. - - - - Editing templates is a good way of doing a "poor man's custom fields". - For example, if you don't use the Status Whiteboard, but want to have - a free-form text entry box for "Build Identifier", then you can just - edit the templates to change the field labels. It's still be called - status_whiteboard internally, but your users don't need to know that. - - - - - If you are making template changes that you intend on submitting back - for inclusion in standard Bugzilla, you should read the relevant - sections of the - Developers' - Guide. - - -
    - - -
    - Template Formats - - - Some CGIs have the ability to use more than one template. For - example, buglist.cgi can output bug lists as RDF or two - different forms of HTML (complex and simple). (Try this out - by appending &format=simple to a buglist.cgi - URL on your Bugzilla installation.) This - mechanism, called template 'formats', is extensible. - - - - To see if a CGI supports multiple output formats, grep the - CGI for "ValidateOutputFormat". If it's not present, adding - multiple format support isn't too hard - see how it's done in - other CGIs. - - - - To make a new format template for a CGI which supports this, - open a current template for - that CGI and take note of the INTERFACE comment (if present.) This - comment defines what variables are passed into this template. If - there isn't one, I'm afraid you'll have to read the template and - the code to find out what information you get. - - - - Write your template in whatever markup or text style is appropriate. - - - - You now need to decide what content type you want your template - served as. Open up the localconfig file and find the - $contenttypes - variable. If your content type is not there, add it. Remember - the three- or four-letter tag assigned to you content type. - This tag will be part of the template filename. - - - - Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. - Try out the template by calling the CGI as - <cginame>.cgi?format=<formatname> . - -
    - - -
    - Particular Templates - - - There are a few templates you may be particularly interested in - customizing for your installation. - - - - index.html.tmpl: - This is the Bugzilla front page. - - - - global/header.html.tmpl: - This defines the header that goes on all Bugzilla pages. - The header includes the banner, which is what appears to users - and is probably what you want to edit instead. However the - header also includes the HTML HEAD section, so you could for - example add a stylesheet or META tag by editing the header. - - - - global/banner.html.tmpl: - This contains the "banner", the part of the header that appears - at the top of all Bugzilla pages. The default banner is reasonably - barren, so you'll probably want to customize this to give your - installation a distinctive look and feel. It is recommended you - preserve the Bugzilla version number in some form so the version - you are running can be determined, and users know what docs to read. - - - - global/footer.html.tmpl: - This defines the footer that goes on all Bugzilla pages. Editing - this is another way to quickly get a distinctive look and feel for - your Bugzilla installation. - - - - bug/create/user-message.html.tmpl: - This is a message that appears near the top of the bug reporting page. - By modifying this, you can tell your users how they should report - bugs. - - - - bug/process/midair.html.tmpl: - This is the page used if two people submit simultaneous changes to the - same bug. The second person to submit their changes will get this page - to tell them what the first person did, and ask if they wish to - overwrite those changes or go back and revisit the bug. The default - title and header on this page read "Mid-air collision detected!" If - you work in the aviation industry, or other environment where this - might be found offensive (yes, we have true stories of this happening) - you'll want to change this to something more appropriate for your - environment. - - - - bug/create/create.html.tmpl and - bug/create/comment.txt.tmpl: - You may wish to get bug submitters to give certain bits of structured - information, each in a separate input widget, for which there is not a - field in the database. The bug entry system has been designed in an - extensible fashion to enable you to define arbitrary fields and widgets, - and have their values appear formatted in the initial - Description, rather than in database fields. An example of this - is the mozilla.org - guided - bug submission form. - - - - To make this work, create a custom template for - enter_bug.cgi (the default template, on which you - could base it, is create.html.tmpl), - and either call it create.html.tmpl or use a format and - call it create-<formatname>.html.tmpl. - Put it in the custom/bug/create - directory. In it, add widgets for each piece of information you'd like - collected - such as a build number, or set of steps to reproduce. - - - - Then, create a template like - custom/bug/create/comment.txt.tmpl, also named - after your format if you are using one, which - references the form fields you have created. When a bug report is - submitted, the initial comment attached to the bug report will be - formatted according to the layout of this template. - - - - For example, if your enter_bug template had a field - <input type="text" name="buildid" size="30"> - and then your comment.txt.tmpl had - BuildID: [% form.buildid %] - then - BuildID: 20020303 - would appear in the initial checkin comment. - -
    - - -
    - Configuring Bugzilla to Detect the User's Language - - Begining in version 2.18, it's now possible to have the users web browser tell Bugzilla - which language templates to use for each visitor (using the HTTP_ACCEPT - header). For this to work, Bugzilla needs to have the correct language - templates installed for the version of Bugzilla you are using. Many - language templates can be obtained from . Instructions - for submitting new languages are also available from that location. - - - After untarring the localizations (or creating your own) in the - [Bugzilla_Root]/template directory, - you must update the parameter to contain any - localizations you'd like to permit. You may also wish to set the - parameter to something other than - en if you don't want Engish to be the default language. - -
    - -
    - -
    - Change Permission Customization - - - - This feature should be considered experimental; the Bugzilla code you - will be changing is not stable, and could change or move between - versions. Be aware that if you make modifications to it, you may have - to re-make them or port them if Bugzilla changes internally between - versions. - - - - - Companies often have rules about which employees, or classes of employees, - are allowed to change certain things in the bug system. For example, - only the bug's designated QA Contact may be allowed to VERIFY the bug. - Bugzilla has been - designed to make it easy for you to write your own custom rules to define - who is allowed to make what sorts of value transition. - - - - For maximum flexibility, customizing this means editing Bugzilla's Perl - code. This gives the administrator complete control over exactly who is - allowed to do what. The relevant function is called - CheckCanChangeField(), - and is found in process_bug.cgi in your - Bugzilla directory. If you open that file and grep for - "sub CheckCanChangeField", you'll find it. - - - - This function has been carefully commented to allow you to see exactly - how it works, and give you an idea of how to make changes to it. Certain - marked sections should not be changed - these are the "plumbing" which - makes the rest of the function work. In between those sections, you'll - find snippets of code like: - # Allow the owner to change anything. - if ($ownerid eq $whoid) { - return 1; - } - It's fairly obvious what this piece of code does. - - - - So, how does one go about changing this function? Well, simple changes - can be made just be removing pieces - for example, if you wanted to - prevent any user adding a comment to a bug, just remove the lines marked - "Allow anyone to change comments." And if you want the reporter to have - no special rights on bugs they have filed, just remove the entire section - which refers to him. - - - - More complex customizations are not much harder. Basically, you add - a check in the right place in the function, i.e. after all the variables - you are using have been set up. So, don't look at $ownerid before - $ownerid has been obtained from the database. You can either add a - positive check, which returns 1 (allow) if certain conditions are true, - or a negative check, which returns 0 (deny.) E.g.: - if ($field eq "qacontact") { - if (Bugzilla->user->groups("quality_assurance")) { - return 1; - } - else { - return 0; - } - } - This says that only users in the group "quality_assurance" can change - the QA Contact field of a bug. Getting more weird: - if (($field eq "priority") && - (Bugzilla->user->email =~ /.*\@example\.com$/)) - { - if ($oldvalue eq "P1") { - return 1; - } - else { - return 0; - } - } - This says that if the user is trying to change the priority field, - and their email address is @example.com, they can only do so if the - old value of the field was "P1". Not very useful, but illustrative. - - - - For a list of possible field names, look in - data/versioncache for the list called - @::log_columns. If you need help writing custom - rules for your organization, ask in the newsgroup. - -
    -
    Upgrading to New Releases @@ -1619,8 +910,8 @@ bash$ ./checksetup.pl revisions to go from the most recent revision to the new one. You could also read the release notes and grab the patches attached to the mentioned bug, but it is safer to use the released patch file as - sometimes patches get changed before they get checked in (for minor - spelling fixes and the like). It is also theorectically possible to + sometimes patches get changed before they get checked in. + It is also theoretically possible to scour the fixed bug list and pick and choose which patches to apply from a point release, but this is not recommended either as what you'll end up with is a hodge podge Bugzilla that isn't really any version. @@ -1650,10 +941,6 @@ patching file globals.pl
    - - - &integration; - + + Customising Bugzilla + +
    + Template Customization + + + Administrators can configure the look and feel of Bugzilla without + having to edit Perl files or face the nightmare of massive merge + conflicts when they upgrade to a newer version in the future. + + + + Templatization also makes localized versions of Bugzilla possible, + for the first time. It's possible to have Bugzilla's UI language + determined by the user's browser. More information is available in + . + + +
    + What to Edit + + The template directory structure is that there's a top level directory, + template, which contains a directory for + each installed localization. The default English templates are + therefore in en. Underneath that, there + is the default directory and optionally the + custom directory. The default + directory contains all the templates shipped with Bugzilla, whereas + the custom directory does not exist at first and + must be created if you want to use it. + + + + There are two different ways of editing Bugzilla's templates, + and which you use depends mainly on the method you plan to use to + upgrade Bugzilla. + The first method of making customizations is to directly edit the + templates in template/en/default. This is + probably the best method for small changes if you are going to use + the CVS method of upgrading, because if you then execute a + cvs update, any template fixes will get + automagically merged into your modified versions. + + + + If you use this method, your installation will break if CVS conflicts + occur. + + + + The other method is to copy the templates to be modified into a + mirrored directory + structure under template/en/custom. The templates + in this directory automatically override those in default. + This is the technique you + need to use if you use the overwriting method of upgrade, because + otherwise your changes will be lost. This method is also better if + you are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory + will not be touched during an upgrade, and you can then decide whether + to continue using your own templates, or make the effort to merge your + changes into the new versions by hand. + + + + If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made + they will be documented in the release notes, provided you are using a + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes + will be mentioned before they occur in the deprecations section of the + previous stable release's release notes. + + + + + Don't directly edit the compiled templates in + data/template/* - your + changes will be lost when Template Toolkit recompiles them. + + + + + It is recommended that you run ./checksetup.pl + after any template edits, especially if you've created a new file in + the custom directory. + + +
    + +
    + How To Edit Templates + + + + If you are making template changes that you intend on submitting back + for inclusion in standard Bugzilla, you should read the relevant + sections of the + Developers' + Guide. + + + + + The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the + Template Toolkit home + page. + + + + One thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML characters + such as <, and the data was not intended to be HTML, they need to be + converted to entity form, ie &lt;. You use the 'html' filter in the + Template Toolkit to do this. If you forget, you may open up + your installation to cross-site scripting attacks. + + + + Also note that Bugzilla adds a few filters of its own, that are not + in standard Template Toolkit. In particular, the 'url_quote' filter + can convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most + characters (but not the common ones such as letters and numbers and so + on), including the HTML-special characters, so there's never a need to + HTML filter afterwards. + + + + Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. + + +
    + + +
    + Template Formats + + + Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending &format=simple to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. + + + + To see if a CGI supports multiple output formats, grep the + CGI for "GetFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs, e.g. config.cgi. + + + + To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. + + + + Write your template in whatever markup or text style is appropriate. + + + + You now need to decide what content type you want your template + served as. Open up the localconfig file and find the + $contenttypes + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. + + + + Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. + Try out the template by calling the CGI as + <cginame>.cgi?format=<formatname> . + +
    + + +
    + Particular Templates + + + There are a few templates you may be particularly interested in + customizing for your installation. + + + + index.html.tmpl: + This is the Bugzilla front page. + + + + global/header.html.tmpl: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + + + + global/banner.html.tmpl: + This contains the "banner", the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customize this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + + + + global/footer.html.tmpl: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + + + + bug/create/user-message.html.tmpl: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + + + + bug/create/create.html.tmpl and + bug/create/comment.txt.tmpl: + You may wish to get bug submitters to give certain bits of structured + information, each in a separate input widget, for which there is not a + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and widgets, + and have their values appear formatted in the initial + Description, rather than in database fields. An example of this + is the mozilla.org + guided + bug submission form. + + + + To make this work, create a custom template for + enter_bug.cgi (the default template, on which you + could base it, is create.html.tmpl), + and either call it create.html.tmpl or use a format and + call it create-<formatname>.html.tmpl. + Put it in the custom/bug/create + directory. In it, add widgets for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + + + + Then, create a template like + custom/bug/create/comment.txt.tmpl, also named + after your format if you are using one, which + references the form fields you have created. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + + + + For example, if your enter_bug template had a field + <input type="text" name="buildid" size="30"> + and then your comment.txt.tmpl had + BuildID: [% form.buildid %] + then + BuildID: 20020303 + would appear in the initial checkin comment. + +
    + + +
    + Configuring Bugzilla to Detect the User's Language + + Bugzilla honours the user's Accept: HTTP header. You can install + templates in other languages, and Bugzilla will pick the most appropriate + according to a priority order defined by you. Many + language templates can be obtained from . Instructions + for submitting new languages are also available from that location. + + + After untarring the localizations (or creating your own) in the + $BUGZILLA_HOME/template directory, + you must update the parameter to contain any + localizations you'd like to permit. You may also wish to set the + parameter to something other than + en if you don't want Engish to be the default language. + +
    + +
    + +
    + Customizing Who Can Change What + + + + This feature should be considered experimental; the Bugzilla code you + will be changing is not stable, and could change or move between + versions. Be aware that if you make modifications as outlined here, + you may have + to re-make them or port them if Bugzilla changes internally between + versions, and you upgrade. + + + + + Companies often have rules about which employees, or classes of employees, + are allowed to change certain things in the bug system. For example, + only the bug's designated QA Contact may be allowed to VERIFY the bug. + Bugzilla has been + designed to make it easy for you to write your own custom rules to define + who is allowed to make what sorts of value transition. + + + + For maximum flexibility, customizing this means editing Bugzilla's Perl + code. This gives the administrator complete control over exactly who is + allowed to do what. The relevant function is called + CheckCanChangeField(), + and is found in process_bug.cgi in your + Bugzilla directory. If you open that file and grep for + "sub CheckCanChangeField", you'll find it. + + + + This function has been carefully commented to allow you to see exactly + how it works, and give you an idea of how to make changes to it. Certain + marked sections should not be changed - these are the "plumbing" which + makes the rest of the function work. In between those sections, you'll + find snippets of code like: + # Allow the owner to change anything. + if ($ownerid eq $whoid) { + return 1; + } + It's fairly obvious what this piece of code does. + + + + So, how does one go about changing this function? Well, simple changes + can be made just be removing pieces - for example, if you wanted to + prevent any user adding a comment to a bug, just remove the lines marked + "Allow anyone to change comments." And if you want the reporter to have + no special rights on bugs they have filed, just remove the entire section + which refers to him. + + + + More complex customizations are not much harder. Basically, you add + a check in the right place in the function, i.e. after all the variables + you are using have been set up. So, don't look at $ownerid before + $ownerid has been obtained from the database. You can either add a + positive check, which returns 1 (allow) if certain conditions are true, + or a negative check, which returns 0 (deny.) E.g.: + if ($field eq "qacontact") { + if (Bugzilla->user->groups("quality_assurance")) { + return 1; + } + else { + return 0; + } + } + This says that only users in the group "quality_assurance" can change + the QA Contact field of a bug. Getting more weird: + if (($field eq "priority") && + (Bugzilla->user->email =~ /.*\@example\.com$/)) + { + if ($oldvalue eq "P1") { + return 1; + } + else { + return 0; + } + } + This says that if the user is trying to change the priority field, + and their email address is @example.com, they can only do so if the + old value of the field was "P1". Not very useful, but illustrative. + + + + For a list of possible field names, look in + data/versioncache for the list called + @::log_columns. If you need help writing custom + rules for your organization, ask in the newsgroup. + +
    + +
    + Modifying Your Running System + + Bugzilla optimizes database lookups by storing all relatively + static information in the + versioncache file, located in the + data/ + subdirectory under your installation directory. + + If you make a change to the structural data in your database (the + versions table for example), or to the + constants + + encoded in defparams.pl, you will need to remove + the cached content from the data directory (by doing a + rm data/versioncache + + ), or your changes won't show up. + + versioncache + gets automatically regenerated whenever it's more than + an hour old, so Bugzilla will eventually notice your changes by itself, + but generally you want it to notice right away, so that you can test + things. +
    + +
    + MySQL Bugzilla Database Introduction + + This information comes straight from my life. I was forced to learn + how Bugzilla organizes database because of nitpicky requests from users + for tiny changes in wording, rather than having people re-educate + themselves or figure out how to work our procedures around the tool. It + sucks, but it can and will happen to you, so learn how the schema works + and deal with it when it comes. + + So, here you are with your brand-new installation of Bugzilla. + You've got MySQL set up, Apache working right, Perl DBI and DBD talking + to the database flawlessly. Maybe you've even entered a few test bugs to + make sure email's working; people seem to be notified of new bugs and + changes, and you can enter and edit bugs to your heart's content. Perhaps + you've gone through the trouble of setting up a gateway for people to + submit bugs to your database via email, have had a few people test it, + and received rave reviews from your beta testers. + + What's the next thing you do? Outline a training strategy for your + development team, of course, and bring them up to speed on the new tool + you've labored over for hours. + + Your first training session starts off very well! You have a + captive audience which seems enraptured by the efficiency embodied in + this thing called "Bugzilla". You are caught up describing the nifty + features, how people can save favorite queries in the database, set them + up as headers and footers on their pages, customize their layouts, + generate reports, track status with greater efficiency than ever before, + leap tall buildings with a single bound and rescue Jane from the clutches + of Certain Death! + + But Certain Death speaks up -- a tiny voice, from the dark corners + of the conference room. "I have a concern," the voice hisses from the + darkness, "about the use of the word 'verified'." + + The room, previously filled with happy chatter, lapses into + reverential silence as Certain Death (better known as the Vice President + of Software Engineering) continues. "You see, for two years we've used + the word 'verified' to indicate that a developer or quality assurance + engineer has confirmed that, in fact, a bug is valid. I don't want to + lose two years of training to a new software product. You need to change + the bug status of 'verified' to 'approved' as soon as possible. To avoid + confusion, of course." + + Oh no! Terror strikes your heart, as you find yourself mumbling + "yes, yes, I don't think that would be a problem," You review the changes + with Certain Death, and continue to jabber on, "no, it's not too big a + change. I mean, we have the source code, right? You know, 'Use the + Source, Luke' and all that... no problem," All the while you quiver + inside like a beached jellyfish bubbling, burbling, and boiling on a hot + Jamaican sand dune... + + Thus begins your adventure into the heart of Bugzilla. You've been + forced to learn about non-portable enum() fields, varchar columns, and + tinyint definitions. The Adventure Awaits You! + +
    + Bugzilla Database Basics + + If you were like me, at this point you're totally clueless about + the internals of MySQL, and if it weren't for this executive order from + the Vice President you couldn't care less about the difference between + a + bigint + + and a + tinyint + + entry in MySQL. I recommend you refer to the + MySQL documentation + . Below are the basics you need to know about the Bugzilla database. + Check the chart above for more details. + + + + + To connect to your database: + + + bash# + + mysql + + -u root + + + If this works without asking you for a password, + shame on you + + ! You should have locked your security down like the installation + instructions told you to. You can find details on locking down + your database in the Bugzilla FAQ in this directory (under + "Security"), or more robust security generalities in the + MySQL + searchable documentation. + + + + + You should now be at a prompt that looks like this: + + + mysql> + + + At the prompt, if + bugs + + is the name you chose in the + localconfig + + file for your Bugzilla database, type: + + + mysql + + use bugs; + + + + + + +
    + Bugzilla Database Tables + + Imagine your MySQL database as a series of spreadsheets, and + you won't be too far off. If you use this command: + + + mysql> + show tables from bugs; + + + you'll be able to see the names of all the + spreadsheets + (tables) in your database. + + From the command issued above, ou should have some + output that looks like this: + ++-------------------+ +| Tables in bugs | ++-------------------+ +| attachments | +| bugs | +| bugs_activity | +| cc | +| components | +| dependencies | +| fielddefs | +| groups | +| keyworddefs | +| keywords | +| logincookies | +| longdescs | +| milestones | +| namedqueries | +| products | +| profiles | +| profiles_activity | +| tokens | +| versions | +| votes | +| watch | ++-------------------+ + + + + + Here's an overview of what each table does. Most columns in each table have +descriptive names that make it fairly trivial to figure out their jobs. + +attachments: This table stores all attachments to bugs. It tends to be your +largest table, yet also generally has the fewest entries because file +attachments are so (relatively) large. + +bugs: This is the core of your system. The bugs table stores most of the +current information about a bug, with the exception of the info stored in the +other tables. + +bugs_activity: This stores information regarding what changes are made to bugs +when -- a history file. + +cc: This tiny table simply stores all the CC information for any bug which has +any entries in the CC field of the bug. Note that, like most other tables in +Bugzilla, it does not refer to users by their user names, but by their unique +userid, stored as a primary key in the profiles table. + +components: This stores the programs and components (or products and +components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program" +(product) field is the full name of the product, rather than some other unique +identifier, like bug_id and user_id are elsewhere in the database. + +dependencies: Stores data about those cool dependency trees. + +fielddefs: A nifty table that defines other tables. For instance, when you +submit a form that changes the value of "AssignedTo" this table allows +translation to the actual field name "assigned_to" for entry into MySQL. + +groups: defines bitmasks for groups. A bitmask is a number that can uniquely +identify group memberships. For instance, say the group that is allowed to +tweak parameters is assigned a value of "1", the group that is allowed to edit +users is assigned a "2", and the group that is allowed to create new groups is +assigned the bitmask of "4". By uniquely combining the group bitmasks (much +like the chmod command in UNIX,) you can identify a user is allowed to tweak +parameters and create groups, but not edit users, by giving him a bitmask of +"5", or a user allowed to edit users and create groups, but not tweak +parameters, by giving him a bitmask of "6" Simple, huh? + If this makes no sense to you, try this at the mysql prompt: +mysql> select * from groups; + You'll see the list, it makes much more sense that way. + +keyworddefs: Definitions of keywords to be used + +keywords: Unlike what you'd think, this table holds which keywords are +associated with which bug id's. + +logincookies: This stores every login cookie ever assigned to you for every +machine you've ever logged into Bugzilla from. Curiously, it never does any +housecleaning -- I see cookies in this file I've not used for months. However, +since Bugzilla never expires your cookie (for convenience' sake), it makes +sense. + +longdescs: The meat of bugzilla -- here is where all user comments are stored! +You've only got 2^24 bytes per comment (it's a mediumtext field), so speak +sparingly -- that's only the amount of space the Old Testament from the Bible +would take (uncompressed, 16 megabytes). Each comment is keyed to the +bug_id to which it's attached, so the order is necessarily chronological, for +comments are played back in the order in which they are received. + +milestones: Interesting that milestones are associated with a specific product +in this table, but Bugzilla does not yet support differing milestones by +product through the standard configuration interfaces. + +namedqueries: This is where everybody stores their "custom queries". Very +cool feature; it beats the tar out of having to bookmark each cool query you +construct. + +products: What products you have, whether new bug entries are allowed for the +product, what milestone you're working toward on that product, votes, etc. It +will be nice when the components table supports these same features, so you +could close a particular component for bug entry without having to close an +entire product... + +profiles: Ahh, so you were wondering where your precious user information was +stored? Here it is! With the passwords in plain text for all to see! (but +sshh... don't tell your users!) + +profiles_activity: Need to know who did what when to who's profile? This'll +tell you, it's a pretty complete history. + +versions: Version information for every product + +votes: Who voted for what when + +watch: Who (according to userid) is watching who's bugs (according to their +userid). + + +=== +THE DETAILS +=== + + Ahh, so you're wondering just what to do with the information above? At the +mysql prompt, you can view any information about the columns in a table with +this command (where "table" is the name of the table you wish to view): + +mysql> show columns from table; + + You can also view all the data in a table with this command: + +mysql> select * from table; + + -- note: this is a very bad idea to do on, for instance, the "bugs" table if +you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or +50,000 bugs play across your screen. + + You can limit the display from above a little with the command, where +"column" is the name of the column for which you wish to restrict information: + +mysql> select * from table where (column = "some info"); + + -- or the reverse of this + +mysql> select * from table where (column != "some info"); + + Let's take our example from the introduction, and assume you need to change +the word "verified" to "approved" in the resolution field. We know from the +above information that the resolution is likely to be stored in the "bugs" +table. Note we'll need to change a little perl code as well as this database +change, but I won't plunge into that in this document. Let's verify the +information is stored in the "bugs" table: + +mysql> show columns from bugs + + (exceedingly long output truncated here) +| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED|| + + Sorry about that long line. We see from this that the "bug status" column is +an "enum field", which is a MySQL peculiarity where a string type field can +only have certain types of entries. While I think this is very cool, it's not +standard SQL. Anyway, we need to add the possible enum field entry +'APPROVED' by altering the "bugs" table. + +mysql> ALTER table bugs CHANGE bug_status bug_status + -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED", + -> "VERIFIED", "APPROVED", "CLOSED") not null; + + (note we can take three lines or more -- whatever you put in before the +semicolon is evaluated as a single expression) + +Now if you do this: + +mysql> show columns from bugs; + + you'll see that the bug_status field has an extra "APPROVED" enum that's +available! Cool thing, too, is that this is reflected on your query page as +well -- you can query by the new status. But how's it fit into the existing +scheme of things? + Looks like you need to go back and look for instances of the word "verified" +in the perl code for Bugzilla -- wherever you find "verified", change it to +"approved" and you're in business (make sure that's a case-insensitive search). +Although you can query by the enum field, you can't give something a status +of "APPROVED" until you make the perl changes. Note that this change I +mentioned can also be done by editing checksetup.pl, which automates a lot of +this. But you need to know this stuff anyway, right? + +
    +
    +
    + + + &integration; + +     + + + diff --git a/webtools/bugzilla/docs/xml/faq.xml b/webtools/bugzilla/docs/xml/faq.xml index e2cebd6471b..d00a8e8f326 100644 --- a/webtools/bugzilla/docs/xml/faq.xml +++ b/webtools/bugzilla/docs/xml/faq.xml @@ -13,19 +13,6 @@ General Questions - - - - Where can I find information about Bugzilla? - - - - You can stay up-to-date with the latest Bugzilla - information at . - - - - @@ -52,12 +39,6 @@ is a list of people and companies who have asked us to list them as consultants for Bugzilla. - - offers - Bugzilla as part of their standard offering to large projects. - They do have some minimum fees that are pretty hefty, and generally - aren't interested in small projects. - There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing @@ -79,11 +60,10 @@ There are dozens of major companies with public Bugzilla sites to track bugs in their products. We have a fairly complete list available on our website at - . If you + . If you have an installation of Bugzilla and would like to be added to the list, whether it's a public install or not, simply e-mail - Gerv gerv@mozilla.org. Keep in mind that it's kinda - difficult to get onto the high-profile list ;). + Gerv gerv@mozilla.org. @@ -241,13 +221,6 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl Managerial Questions - - - - Questions likely to be asked by managers. :-) - - - @@ -258,69 +231,7 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the web. - - - - - - - - Can Bugzilla integrate with - Perforce (SCM software)? - - - - - Yes! You can find more information elsewhere in "The Bugzilla - Guide" in the "Integration with Third-Party Products" section. - - - - - - - - Does Bugzilla allow the user to track multiple projects? - - - - - Absolutely! You can track any number of Products that can each be - composed of any number of Components. - - - - - - - - If I am on many projects, and search for all bugs assigned to me, will - Bugzilla list them for me and allow me to sort by project, severity etc? - - - - - Yes. - - - - - - - - Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, - are there any that are NOT allowed? - - - - - Yes - any sort of attachment is allowed, although administrators can - configure a maximum size. - Bugzilla gives the user the option of either using the MIME-type - supplied by the browser, choosing from a pre-defined list or - manually typing any arbitrary MIME-type. + It is web and e-mail based. @@ -380,26 +291,12 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl Email notification is user-configurable. By default, the bug id and - Summary of the bug report accompany each email notification, along with + summary of the bug report accompany each email notification, along with a list of the changes made. - - - - Can email notification be set up to send to multiple - people, some on the To List, CC List, BCC List etc? - - - - - Yes. - - - - @@ -439,13 +336,13 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl Bugzilla can output buglists as HTML (the default), CSV or RDF. The link for CSV can be found at the bottom of the buglist in HTML format. This CSV format can easily be imported into MS Excel or - other spread-sheet applications. + other spreadsheet applications. To use the RDF format of the buglist it is necessary to append a &ctype=rdf to the URL. RDF is meant to be machine readable and thus it is assumed that the - URL would be generated progmatically so there is no user visible + URL would be generated programatically so there is no user visible link to this format. @@ -499,21 +396,6 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - - - - Does Bugzilla have the ability to search by word, phrase, compound - search? - - - - - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. - - - - @@ -567,7 +449,7 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an - "Out-of-the-Box" solution. + "out-of-the-box" solution? @@ -657,24 +539,6 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - - - - - - I've implemented the security fixes mentioned in Chris Yeh's security - advisory of 5/10/2000 advising not to run MySQL as root, and am running into - problems with MySQL no longer working correctly. - - - - - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts - mysqld. - - - @@ -714,7 +578,7 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - I want whineatnews.pl to whine at something more, or other than, only new + I want whineatnews.pl to whine at something different to only new bugs. How do I do it? @@ -730,29 +594,6 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - - - - I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? - - - - - You can call bug_email.pl directly from your aliases file, with - an entry like this: -
    - - bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" - -
    - However, this is fairly nasty and subject to problems; you also - need to set up your smrsh (sendmail restricted shell) to allow - it. In a pinch, though, it can work. -     -     -     - @@ -775,6 +616,11 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl + + If you are using sendmail, try enabling + in editparams.cgi. + + If you are using an alternate MTA, make sure the options given in Bugzilla/BugMail.pm @@ -782,11 +628,6 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl are correct for your MTA. You should also ensure that the param is set to on. - - If you are using sendmail, try enabling - in editparams.cgi. - - @@ -804,7 +645,7 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl button after entering your email address. - If you never receive mail from Bugzilla, chances you do not have + If you never receive mail from Bugzilla, chances are you do not have sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked to, "/usr/lib/sendmail". @@ -823,11 +664,12 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl - Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle, + but it is now so old as to be obsolete, and is totally unsupported. Red Hat's newer version (based on 2.17.1 and soon to be merged into the main distribution) runs on PostgreSQL. At this time we know of - no recent ports of Bugzilla to Oracle but do intend to support it - in the future (possibly the 2.20 time-frame). + no recent ports of Bugzilla to Oracle; to be honest, Bugzilla + doesn't need what Oracle offers. @@ -842,9 +684,8 @@ perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl Run the sanity check utility - (./sanitycheck.cgi in the - Bugzilla_home directory) from your web browser to see! If - it finishes without errors, you're + (sanitycheck.cgi) from your web browser to see! + If it finishes without errors, you're probably OK. If it doesn't come back OK (i.e. any red letters), there are certain things Bugzilla can recover from and certain things it can't. If diff --git a/webtools/bugzilla/docs/xml/installation.xml b/webtools/bugzilla/docs/xml/installation.xml index e6b06527b5c..019a6a71d95 100644 --- a/webtools/bugzilla/docs/xml/installation.xml +++ b/webtools/bugzilla/docs/xml/installation.xml @@ -1,5 +1,5 @@ - + Installation @@ -40,24 +40,25 @@ with administrative access to install it for you. + + You are strongly recommended to make a backup of your system + before installing Bugzilla and at regular intervals thereafter. + + The listing below is a basic step-by-step list. More information can be found in the sections below. Minimum versions will be included in parenthesis where appropriate. - - Install MySQL - (&min-mysql-ver;) - - Install Perl (&min-perl-ver;) - Install Perl Modules + Install MySQL + (&min-mysql-ver;) @@ -68,12 +69,29 @@ Put Bugzilla in the Webspace + + Install Perl Modules + + Setup the MySQL Database +
    + Perl + + Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from . + There are also binary versions available for many platforms, most of which + are linked to from perl.com. + Although Bugzilla runs with perl &min-perl-ver;, + 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 &newest-perl-ver;. +
    +
    MySQL @@ -121,19 +139,106 @@ set-variable = max_allowed_packet=1M also wish to utilize the option as mentioned in for the added security. + +
    + Configuring MySQL + + This first thing you'll want to do is make sure you've given the + root user a password as suggested in + . For clarity, these instructions will + assume that your MySQL user for Bugzilla will be bugs_user, + the database will be called bugs_db and the password for + the bugs_user user is bugs_password. You + should, of course, substitute the values you intend to use for your site. + + + + Most people use bugs for both the user and + database name. + + + + Next, we use an SQL GRANT command to create a + bugs_user + user, and grant sufficient permissions for checksetup.pl, which we'll + use later, to work its magic. This also restricts the + bugs_user + user to operations within a database called + bugs_db, and only allows the account to connect from + localhost. + Modify it to reflect your setup if you will be connecting from + another machine or as a different user. + + + mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost + IDENTIFIED BY 'bugs_password'; + mysql> FLUSH PRIVILEGES; + + + + If you are using MySQL 4, the bugs user also needs to be granted + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions. + + +
    -
    - Perl +
    + HTTP Server - Any machine that doesn't have Perl on it is a sad machine indeed. - Perl can be got in source form from . - There are also binary versions available for many platforms, most of which - are linked to from perl.com. - Although Bugzilla runs with perl &min-perl-ver;, - 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 &newest-perl-ver;. + You have freedom of choice here, pretty much any web server that + is capable of running CGI + scripts will work. has more information about + configuring web servers to work with Bugzilla. + + + + We strongly recommend Apache as the web server to use. The + Bugzilla Guide installation instructions, in general, assume you are + using Apache. If you have got Bugzilla working using another webserver, + please share your experiences with us by filing a bug in &bzg-bugs;. + + + +
    + +
    + Bugzilla + + You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + nobody). + You may decide to put the files in the main web space for your + web server or perhaps in + /usr/local + with a symbolic link in the web space that points to the Bugzilla + directory. + + + If you symlink the bugzilla directory into your Apache's HTML + hierarchy, you may receive + Forbidden + errors unless you add the + FollowSymLinks + directive to the <Directory> entry for the HTML root + in httpd.conf. + + + Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install + checksetup.pl + script, which locks down your installation. + + + The default Bugzilla distribution is not designed to be placed + in a cgi-bin directory (this + includes any directory which is configured using the + directive of Apache). + +
    @@ -177,7 +282,7 @@ set-variable = max_allowed_packet=1M - The process of untaring the module as defined in + The process of untarring the module as defined in will create the <module> directory. @@ -660,122 +765,14 @@ ReadLine support enabled
    -
    - HTTP Server - - You have freedom of choice here, pretty much any web server that - is capable of running CGI - scripts will work. has more information about - configuring web servers to work with Bugzilla. - - - - We strongly recommend Apache as the web server to use. The - Bugzilla Guide installation instructions, in general, assume you are - using Apache. If you have got Bugzilla working using another webserver, - please share your experiences with us by filing a bug in &bzg-bugs;. - - - -
    - -
    - Bugzilla - - You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - nobody). - You may decide to put the files in the main web space for your - web server or perhaps in - /usr/local - with a symbolic link in the web space that points to the Bugzilla - directory. - - - If you symlink the bugzilla directory into your Apache's HTML - hierarchy, you may receive - Forbidden - errors unless you add the - FollowSymLinks - directive to the <Directory> entry for the HTML root - in httpd.conf. - - - Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install - checksetup.pl - script, which locks down your installation. - - - The default Bugzilla distribution is not designed to be placed - in a cgi-bin directory (this - includes any directory which is configured using the - directive of Apache). This will probably - change as part of - bug - 44659. - - -
    - -
    - Setting Up the MySQL Database - - After you've gotten all the software installed and working you're - ready to start preparing the database for its life as the back end to - a high quality bug tracker. - - This first thing you'll want to do is make sure you've given the - root user a password as suggested in - . For clarity, these instructions will - assume that your MySQL user for Bugzilla will be bugs_user, - the database will be called bugs_db and the password for - the bugs_user user is bugs_password. You - should, of course, substitute the values you intend to use for your site. - - - - Most people use bugs for both the user and - database name. - - - - Next, we use an SQL GRANT command to create a - bugs_user - user, and grant sufficient permissions for checksetup.pl, which we'll - use later, to work its magic. This also restricts the - bugs_user - user to operations within a database called - bugs_db, and only allows the account to connect from - localhost. - Modify it to reflect your setup if you will be connecting from - another machine or as a different user. - - -mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, - DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost - IDENTIFIED BY 'bugs_password'; -mysql> FLUSH PRIVILEGES; - - - - If you are using MySQL 4, the bugs user also needs to be granted - the LOCK TABLES and - CREATE TEMPORARY TABLES permissions. - - -
    <filename>checksetup.pl</filename> - Next, run the magic checksetup.pl script. (Many thanks to - Holger Schurig - for writing this script!) - This script is designed to make sure your perl modules are the correct + Next, run the magic checksetup.pl script. + This is designed to make sure your perl modules are the correct version and your MySQL database and other configuration options are consistent with the Bugzilla CGI files. It will make sure Bugzilla files and directories have reasonable @@ -849,6 +846,149 @@ ReadLine support enabled
    +
    + HTTP Server Configuration + + The Bugzilla Team recommends Apache when using Bugzilla, however, any web server + that can be configured to run CGI scripts + should be able to handle Bugzilla. No matter what web server you choose, but + especially if you choose something other than Apache, you should be sure to read + . + + + The plan for this section is to eventually document the specifics of how to lock + down permissions on individual web servers. + + +
    + Apache <productname>httpd</productname> + + You will have to make sure that Apache is properly + configured to run the Bugzilla CGI scripts. You also need to make sure + that the .htaccess files created by + ./checksetup.pl are allowed to override Apache's normal access + permissions or else important password information may be exposed to the + Internet. + + + You need to configure Apache to run .cgi files outside the + cgi-bin directory. + Open your + httpd.conf file and make sure the + following line exists and is uncommented: + +AddHandler cgi-script .cgi + + + To allow .htaccess files to override + permissions and .cgi files to run in the Bugzilla directory, make sure + the following two lines are in a Directory + directive that applies to the Bugzilla directory on your system + (either the Bugzilla directory or one of its parents). + + +Options +ExecCGI +AllowOverride Limit + + + You should modify the <DirectoryIndex> parameter for + the Apache virtual host running your Bugzilla installation to + allow index.cgi as the index page for a + directory, as well as the usual index.html, + index.htm, and so forth. + + + For more information on Apache and its directives, see the + glossary entry on . + + +
    + +
    + Microsoft <productname>Internet Information Services</productname> + + If you need, or for some reason even want, to use Microsoft's + Internet Information Services or + Personal Web Server you should be able + to. You will need to configure them to know how to run CGI scripts, + however. This is described in Microsoft Knowledge Base article + Q245225 + for Internet Information Services and + Q231998 + for Personal Web Server. + + + Also, and this can't be stressed enough, make sure that files such as + localconfig and your data + directory are secured as described in . + + +
    + +
    + AOL Server + + Ben FrantzDale reported success using AOL Server with Bugzilla. He + reported his experience and what appears below is based on that. + + + AOL Server will have to be configured to run + CGI scripts, please consult + the documentation that came with your server for more information on + how to do this. + + + Because AOL Server doesn't support .htaccess + files, you'll have to create a TCL + script. You should create an aolserver/modules/tcl/filter.tcl + file (the filename shouldn't matter) with the following contents (change + /bugzilla/ to the web-based path to + your Bugzilla installation): + + + +ns_register_filter preauth GET /bugzilla/localconfig filter_deny +ns_register_filter preauth GET /bugzilla/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" +} + + + + This probably doesn't account for all possible editor backup + files so you may wish to add some additional variations of + localconfig. For more information, see + + bug 186383 or Bugtraq ID 6501. + + + + + If you are using webdot from research.att.com (the default + configuration for the paramater), you + will need to allow access to data/webdot/*.dot + for the reasearch.att.com machine. + + If you are using a local installation of GraphViz, you will need to allow + everybody to access *.png, + *.gif, *.jpg, and + *.map in the + data/webdot directory. + + +
    +
    +
    Optional Additional Configuration @@ -961,20 +1101,9 @@ man 5 crontab
    LDAP Authentication - - LDAP authentication has been rewritten for the 2.18 release of - Bugzilla. It no longer requires the Mozilla::LDAP module and now uses - Net::LDAP instead. This rewrite was part of a larger landing that - allowed for additional authentication schemes to be easily added - (bug - 180642). - - This patch originally landed in 21-Mar-2003 and was included - in the 2.17.4 development release. - - ]]> - + LDAP authentication is a module for Bugzilla's plugin + authentication architecture. + The existing authentication @@ -1093,56 +1222,31 @@ man 5 crontab Preventing untrusted Bugzilla content from executing malicious Javascript code - It is possible for a Bugzilla to execute malicious Javascript - code. Due to internationalization concerns, we are unable to - incorporate the code changes necessary to fulfill the CERT advisory - requirements mentioned in + 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. + Due to internationalization concerns, we are unable to + incorporate by default the code changes necessary to fulfill the CERT + advisory requirements mentioned in . - Making the change below will fix the problem if your installation is for - an English speaking audience. + If your installation is for an English speaking audience only, making the + change below will prevent this problem. - Telling Bugzilla to output a charset as part of the HTTP header is - much easier in version 2.18 and higher than it was - in previous versions. Simply locate the following line in + Simply locate the following line in Bugzilla/CGI.pm: - # Make sure that we don't send any charset headers $self->charset(''); and change it to: - # Send all data using the ISO-8859-1 charset $self->charset('ISO-8859-1'); - - - Using <meta> tags to set the charset is not - recommended, as there's a bug in Netscape 4.x which causes pages - marked up in this way to load twice. See - bug 126266 - for more information including progress toward making - bugzilla charset aware by default. - -
    -
    - - <filename>directoryindex</filename> for the Bugzilla default page. - - - You should modify the <DirectoryIndex> parameter for - the Apache virtual host running your Bugzilla installation to - allow index.cgi as the index page for a - directory, as well as the usual index.html, - index.htm, and so forth. -
    -
    Bugzilla and <filename>mod_perl</filename> @@ -1199,7 +1303,7 @@ man 5 crontab <section id="os-win32"> <title>Microsoft Windows - Making Bugzilla work on windows is still a very 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 @@ -1259,12 +1363,9 @@ C:\perl> ppm <module name>
    Code changes required to run on win32 - Unfortunately, Bugzilla still doesn't run "out of the box" on - Windows. There is work in progress to make this easier, but until that - happens code will have to be modified. This section is an attempt to - list the required changes. It is an attempt to be all inclusive, but - there may be other changes required. If you find something is missing, - please file a bug in &bzg-bugs;. + 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.
    @@ -1297,8 +1398,8 @@ my $webservergid = '8' To make bug e-mail work on Win32 (until bug 84876 lands), the - simplest way is to have Net::SMTP installed and change this (in - Bugzilla/BugMail.pm): + simplest way is to have the Net::SMTP Perl module installed and + change this: open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") || @@ -1452,217 +1553,270 @@ $smtp->quit;
    -
    - HTTP Server Configuration +
    + Bugzilla Security - The Bugzilla Team recommends Apache when using Bugzilla, however, any web server - that can be configured to run CGI scripts - should be able to handle Bugzilla. No matter what web server you choose, but - especially if you choose something other than Apache, you should be sure to read - . - + + 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. + + 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. + + - The plan for this section is to eventually document the specifics of how to lock - down permissions on individual web servers. - +
    + TCP/IP Ports -
    - Apache <productname>httpd</productname> + + 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. + +
    - As mentioned above, the Bugzilla Team recommends Apache for use - with Bugzilla. You will have to make sure that Apache is properly - configured to run the Bugzilla CGI scripts. You also need to make sure - that the .htaccess files created by - ./checksetup.pl (shown in - for the curious) are allowed to override Apache's normal access - permissions or else important password information may be exposed to the - Internet. +
    + MySQL + + 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 not the same as + the system root). Also, many installations default to running + mysqld as the system root. - Many Apache installations are not configured to run scripts - anywhere but in the cgi-bin - directory; however, we recommend that Bugzilla not be installed in the - cgi-bin, otherwise the static - files such as images and - will not work correctly. To allow scripts to run in the normal - web space, the following changes should be made to your - httpd.conf file. - - - To allow files with a .cgi extension to be run, make sure the - following line exists and is uncommented: - -AddHandler cgi-script .cgi - - - To allow .htaccess files to override - permissions and .cgi files to run in the Bugzilla directory, make sure - the following two lines are in a Directory - directive that applies to the Bugzilla directory on your system - (either the Bugzilla directory or one of its parents). - - -Options +ExecCGI -AllowOverride Limit - - - - For more information on Apache and its directives, see the - glossary entry on . + + + Consult the documentation that came with your system for + information on making mysqld run as an + unprivleged user. - + - - <filename>.htaccess</filename> files for Apache - - $BUGZILLA_HOME/.htaccess - - deny from all - - - allow from all - - ]]> + + 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: - - $BUGZILLA_HOME/data/.htaccess - - allow from all - - ]]> - - - $BUGZILLA_HOME/data/webdot - - Allow from 192.20.225.10 - Deny from all - - -# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and -# .map files - - Allow from all - - -# And no directory listings, either. -Deny from all - ]]> - - - $BUGZILLA_HOME/Bugzilla/.htaccess -# nothing in this directory is retrievable unless overriden by an .htaccess -# in a subdirectory -deny from all +bash$ mysql mysql +mysql> DELETE FROM user WHERE user = ''; +mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; +mysql> FLUSH PRIVILEGES; + From this point forward you will need to use + mysql -u root -p and enter + new_password when prompted when using the + mysql client. + - $BUGZILLA_HOME/template/.htaccess + + 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 /etc/my.conf: + -# nothing in this directory is retrievable unless overriden by an .htaccess -# in a subdirectory -deny from all +[myslqd] +# Prevent network access to MySQL. +skip-networking - + - + + 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. + + + +
    -
    - Microsoft <productname>Internet Information Services</productname> +
    + Daemon Accounts - If you need, or for some reason even want, to use Microsoft's - Internet Information Services or - Personal Web Server you should be able - to. You will need to configure them to know how to run CGI scripts, - however. This is described in Microsoft Knowledge Base article - Q245225 - for Internet Information Services and - Q231998 - for Personal Web Server. + Many daemons, such as Apache's httpd and MySQL's mysqld default to + running as either root or nobody. Running + as root introduces obvious security problems, but the + problems introduced by running everything as nobody may + not be so obvious. Basically, if you're running every daemon as + nobody 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. - Also, and this can't be stressed enough, make sure that files such as - localconfig and your data - directory are secured as described in . - - -
    - -
    - AOL Server - - Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. - - - AOL Server will have to be configured to run - CGI scripts, please consult - the documentation that came with your server for more information on - how to do this. - - - Because AOL Server doesn't support .htaccess - files, you'll have to create a TCL - script. You should create an aolserver/modules/tcl/filter.tcl - file (the filename shouldn't matter) with the following contents (change - /bugzilla/ to the web-based path to - your Bugzilla installation): - - - -ns_register_filter preauth GET /bugzilla/localconfig filter_deny -ns_register_filter preauth GET /bugzilla/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" -} - - - - This probably doesn't account for all possible editor backup - files so you may wish to add some additional variations of - localconfig. For more information, see - - bug 186383 or Bugtraq ID 6501. - - - - If you are using webdot from research.att.com (the default - configuration for the paramater), you - will need to allow access to data/webdot/*.dot - for the reasearch.att.com machine. - - If you are using a local installation of GraphViz, you will need to allow - everybody to access *.png, - *.gif, *.jpg, and - *.map in the - data/webdot directory. + You will need to set the webservergroup to + the group you created for your webserver to run as in + localconfig. This will allow + ./checksetup.pl to better adjust the file + permissions on your Bugzilla install so as to not require making + anything world-writable. +
    + +
    + Web Server Access Controls + + 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. + + + 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. + + + + + In the main Bugzilla directory, you should: + + + Block: + + *.pl + *localconfig* + runtests.sh + + + + + But allow: + + localconfig.js + localconfig.rdf + + + + + + + + In data: + + + Block everything + + + But allow: + + duplicates.rdf + + + + + + + + In data/webdot: + + + If you use a remote webdot server: + + + Block everything + + + But allow + + *.dot + + only for the remote webdot server + + + + + Otherwise, if you use a local GraphViz: + + + Block everything + + + But allow: + + *.png + *.gif + *.jpg + *.map + + + + + + + And if you don't use any dot: + + + Block everything + + + + + + + + In Bugzilla: + + + Block everything + + + + + + In template: + + + Block everything + + + + + + You should test to make sure that the files mentioned above are + not accessible from the Internet, especially your + localconfig 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 + . You should + get a 403 Forbidden + error. + + + + Not following the instructions in this section, including + testing, may result in sensitive information being globally + accessible. + + + + + You should check 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. + + + +
    +
    diff --git a/webtools/bugzilla/docs/xml/integration.xml b/webtools/bugzilla/docs/xml/integration.xml index 65451dc7559..598baffca4e 100644 --- a/webtools/bugzilla/docs/xml/integration.xml +++ b/webtools/bugzilla/docs/xml/integration.xml @@ -70,7 +70,12 @@ xreflabel="Tinderbox, the Mozilla automated build management system"> Tinderbox/Tinderbox2 - We need Tinderbox integration information. + Tinderbox is a continuous-build system which can integrate with + Bugzilla - see + for details + of Tinderbox, and + to see it + in action.
    diff --git a/webtools/bugzilla/docs/xml/introduction.xml b/webtools/bugzilla/docs/xml/introduction.xml index 8b09fe2b537..d01e399798e 100644 --- a/webtools/bugzilla/docs/xml/introduction.xml +++ b/webtools/bugzilla/docs/xml/introduction.xml @@ -1,23 +1,44 @@ Introduction -
    +
    What is Bugzilla? Bugzilla is a bug- or issue-tracking system. Bug-tracking systems allow individual or groups of developers effectively to keep track - of outstanding problems with their product. - Bugzilla was originally - written by Terry Weissman in a programming language called TCL, to - replace a rudimentary bug-tracking database used internally by Netscape - Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl - it remains to this day. Most commercial defect-tracking software vendors - at the time charged enormous licensing fees, and Bugzilla quickly became - a favorite of the open-source crowd (with its genesis in the open-source - browser project, Mozilla). It is now the de-facto standard - defect-tracking system against which all others are measured. + of outstanding problems with their products. + + Do we need more here? + +
    + +
    + Why use a bug-tracking system? + + For many years, defect-tracking software was principally + the domain of large software development houses. Most smaller shops + simply relied on + shared lists and email to monitor the status of defects. This procedure + was error-prone and tended to cause those bugs judged least significant by + developers to be dropped or ignored. + + Integrated + defect-tracking systems reduce downtime, increase productivity, and raise + customer satisfaction with their systems. Along with full disclosure, an + open bug-tracker allows you to keep in touch with your clients + and resellers, to communicate about problems effectively throughout the + data management chain. Many corporations have also discovered that + defect-tracking helps reduce costs by providing IT support + accountability, telephone support knowledge bases, and a common, + well-understood method for accounting for unusual system or software + issues. + +
    + +
    + Why use Bugzilla? Bugzilla boasts many advanced features. These include: @@ -71,34 +92,7 @@ -
    - -
    - Why Should We Use Bugzilla? - - For many years, defect-tracking software has remained principally - the domain of large software development houses. Even then, most shops - never bothered with bug-tracking software, and instead simply relied on - shared lists and email to monitor the status of defects. This procedure - is error-prone and tends to cause those bugs judged least significant by - developers to be dropped or ignored. - - These days, many companies are finding that integrated - defect-tracking systems reduce downtime, increase productivity, and raise - customer satisfaction with their systems. Along with full disclosure, an - open bug-tracker allows manufacturers to keep in touch with their clients - and resellers, to communicate about problems effectively throughout the - data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood system for accounting for unusual system or software - issues. - - But why should - you - - use Bugzilla? - + Bugzilla is very adaptable to various situations. Known uses currently include IT support queues, Systems Administration deployment management, chip design and development problem tracking (both @@ -110,20 +104,6 @@ Perforce SCM, Bugzilla provides a powerful, easy-to-use solution to configuration management and replication problems. - - Bugzilla can dramatically increase the productivity and - accountability of individual employees by providing a documented workflow - and positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do - something - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and follow the discussion trail - that led to critical decisions. - - Ultimately, Bugzilla puts the power in your hands to improve your - value to your employer or business while providing a usable framework for - your natural attention to detail and knowledge store to flourish.
    diff --git a/webtools/bugzilla/docs/xml/patches.xml b/webtools/bugzilla/docs/xml/patches.xml index b8c068fac51..6b755cbce3b 100644 --- a/webtools/bugzilla/docs/xml/patches.xml +++ b/webtools/bugzilla/docs/xml/patches.xml @@ -1,52 +1,15 @@ - Useful Patches and Utilities for Bugzilla + Contrib - Are you looking for a way to put your Bugzilla into overdrive? Catch - some of the niftiest tricks here in this section. - -
    - Apache - <filename>mod_rewrite</filename> - - magic - - Apache's - mod_rewrite - - module lets you do some truly amazing things with URL rewriting. Here are - a couple of examples of what you can do. - - - - Make it so if someone types - http://www.foo.com/12345 - - , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try - setting up your VirtualHost section for Bugzilla with a rule like - this: - - -RewriteEngine On -RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] - -]]> - - - - There are many, many more things you can do with mod_rewrite. - Please refer to the mod_rewrite documentation at - . - - - -
    + There are a number of unofficial Bugzilla add-ons in the + $BUGZILLA_ROOT/contrib/ + directory. This section documents them.
    - Command-line Bugzilla Queries + Command-line Search Interface - There are a suite of Unix utilities for querying Bugzilla from the + There are a suite of Unix utilities for searching Bugzilla from the command line. They live in the contrib/cmdline directory. However, they diff --git a/webtools/bugzilla/docs/xml/using.xml b/webtools/bugzilla/docs/xml/using.xml index f06969f570b..21614e740b1 100644 --- a/webtools/bugzilla/docs/xml/using.xml +++ b/webtools/bugzilla/docs/xml/using.xml @@ -3,468 +3,461 @@ Using Bugzilla -
    - How do I use Bugzilla? + This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + Landfill, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and runs an up-to-the-minute version, + so some things may not quite work as this document describes. + +
    + Create a Bugzilla Account - This section contains information for end-users of Bugzilla. - There is a Bugzilla test installation, called - Landfill, - which you are welcome to play with (if it's up.) - However, it does not necessarily - have all Bugzilla features enabled, and often runs cutting-edge versions - of Bugzilla for testing, so some things may work slightly differently - than mentioned here. + 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: + . + -
    - Create a Bugzilla Account + + + Click the + Open a new Bugzilla account - 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: - . - + link, enter your email address and, optionally, your name in the + spaces provided, then click + Create Account - - - Click the - Open a new Bugzilla account + . + - link, enter your email address and, optionally, your name in the - spaces provided, then click - Create Account + + 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. + - . - + + Click the + Log In + 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 + Login. + - - Within moments, you should receive an email to the address - you provided above, which contains your login name (generally the - same as the email address), and a password you can use to access - your account. This password is randomly generated, and can be - changed to something more memorable. - + + - - Click the - Log In - link in the yellow area at the bottom of the page in your browser, - enter your email address and password into the spaces provided, and - click - Login. - - - - + You are now logged in. Bugzilla uses cookies 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. +
    - You are now logged in. Bugzilla uses cookies for authentication - so, unless your IP address changes, you should not have to log in - again. -
    +
    + Anatomy of a Bug -
    - Anatomy of a Bug + The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + + Bug 1 on Landfill - The core of Bugzilla is the screen which displays a particular - bug. It's a good place to explain some Bugzilla concepts. - - Bug 1 on Landfill + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla. - 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. - - - - - Product and Component: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: - - - Administration: - Administration of a Bugzilla installation. - - - Bugzilla-General: - Anything that doesn't fit in the other components, or spans - multiple components. - - - Creating/Changing Bugs: - Creating, changing, and viewing bugs. - - - Documentation: - The Bugzilla documentation, including The Bugzilla Guide. - - - Email: - Anything to do with email sent by Bugzilla. - - - Installation: - The installation process of Bugzilla. - - - Query/Buglist: - Anything to do with searching for bugs and viewing the - buglists. - - - Reporting/Charting: - Getting reports from Bugzilla. - - - User Accounts: - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc. - - - User Interface: - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc. - - - - - - - Status and Resolution: - - These define exactly what state the bug is in - from not even - being confirmed as a bug, through to being fixed and the fix - confirmed by Quality Assurance. The different possible values for - Status and Resolution on your installation should be documented in the - context-sensitive help for those items. - - - - - Assigned To: - The person responsible for fixing the bug. - - - - - *URL: - A URL associated with the bug, if any. - - - - - Summary: - A one-sentence summary of the problem. - - - - - *Status Whiteboard: - (a.k.a. Whiteboard) A free-form text area for adding short notes - and tags to a bug. - - - - - *Keywords: - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression. - - - - - Platform and OS: - These indicate the computing environment where the bug was - found. - - - - - Version: - The "Version" field is usually used for versions of a product which - have been released, and is set to indicate which versions of a - Component have the particular problem the bug report is - about. - - - - - Priority: - The bug assignee uses this field to prioritise his or her bugs. - It's a good idea not to change this on other people's bugs. - - - - - Severity: - This indicates how severe the problem is - from blocker - ("application unusable") to trivial ("minor cosmetic issue"). You - can also use this field to indicate whether a bug is an enhancement - request. - - - - - *Target: - (a.k.a. Target Milestone) A future version by which the bug is to - be fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not - restricted to numbers, thought - you can use any text strings, such - as dates. - - - - - Reporter: - The person who filed the bug. - - - - - CC list: - A list of people who get mail when the bug changes. - - - - - Attachments: - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section. - - - - - *Dependencies: - If this bug cannot be fixed unless other bugs are fixed (depends - on), or this bug stops other bugs being fixed (blocks), their - numbers are recorded here. - - - - - *Votes: - Whether this bug has any votes. - - - - - Additional Comments: - You can add your two cents to the bug discussion here, if you have - something worthwhile to say. - - -
    - -
    - Searching for Bugs - - The Bugzilla Search page is is the interface where you can find - any bug report, comment, or patch currently in the Bugzilla system. You - can play with it here: - . - - 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 one of the selected - values. If none is selected, then the field can take any value. - - Once you've defined a search, you can either run it, or save it - as a Remembered Query, which can optionally appear in the footer of - your pages. - - Highly advanced querying is done using Boolean Charts. -
    - -
    - Bug Lists - - If you run a search, a list of matching bugs will be returned. - The default search is to return all open bugs on the system - don't try - running this search on a Bugzilla installation with a lot of - bugs! - - 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: - + + + + Product and Component: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + Components: + - Long Format: - - this gives you a large page with a non-editable summary of the fields - of each bug. + Administration: + Administration of a Bugzilla installation. - Change Columns: - - change the bug attributes which appear in the list. + Bugzilla-General: + Anything that doesn't fit in the other components, or spans + multiple components. - Change several bugs at once: - - If your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner. + Creating/Changing Bugs: + Creating, changing, and viewing bugs. - Send mail to bug owners: - - Sends mail to the owners of all bugs on the list. + Documentation: + The Bugzilla documentation, including The Bugzilla Guide. - Edit this query: + Email: + Anything to do with email sent by Bugzilla. - 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. - - + + Installation: + The installation process of Bugzilla. + + + Query/Buglist: + Anything to do with searching for bugs and viewing the + buglists. + + + Reporting/Charting: + Getting reports from Bugzilla. + + + User Accounts: + Anything about managing a user account from the user's perspective. + Saved queries, creating accounts, changing passwords, logging in, + etc. + + + User Interface: + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, + etc. + + + + + + + Status and Resolution: + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items. + + + + + Assigned To: + The person responsible for fixing the bug. + + + + + *URL: + A URL associated with the bug, if any. + + + + + Summary: + A one-sentence summary of the problem. + + + + + *Status Whiteboard: + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug. + + + + + *Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression. + + + + + Platform and OS: + These indicate the computing environment where the bug was + found. + + + + + Version: + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about. + + + + + Priority: + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs. + + + + + Severity: + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request. + + + + + *Target: + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates. + + + + + Reporter: + The person who filed the bug. + + + + + CC list: + A list of people who get mail when the bug changes. + + + + + Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section. + + + + + *Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here. + + + + + *Votes: + Whether this bug has any votes. + + + + + Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say. + + +
    + +
    + Searching for Bugs + + The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + . + + 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. + + Once you've run a search, you can save it as a Saved Search, which + appears in the page footer. + + Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information. +
    + +
    + Bug Lists + + If you run a search, a list of matching bugs will be returned. + + + The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features can be + accessed using the links at the bottom of the list: + + + Long Format: + + this gives you a large page with a non-editable summary of the fields + of each bug. + + + Change Columns: + + change the bug attributes which appear in the list. + + + Change several bugs at once: + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner. + + + Send mail to bug owners: + + Sends mail to the owners of all bugs on the list. + + + Edit this query: + + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results. + + +
    + +
    + Filing Bugs + + Years of bug writing experience has been distilled for your + reading pleasure into the + + Bug Writing Guidelines. + While some of the advice is Mozilla-specific, the basic principles of + reporting Reproducible, Specific bugs, isolating the Product you are + using, the Version of the Product, the Component which failed, the + Hardware Platform, and Operating System you were using at the time of + the failure go a long way toward ensuring accurate, responsible fixes + for the bug that bit you. + + The procedure for filing a test bug is as follows: + + + + Go to + + Landfill + in your browser and click + + Enter a new bug report. + + + + + Select a product - any one will do. + + + + 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. + + + + Select "Commit" and send in your bug report. + + +
    + +
    + Patch Viewer + + 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. + + Patch viewer allows you to: + + + View patches in color, with side-by-side view rather than trying + to interpret the contents of the patch. + See the difference between two patches. + Get more context in a patch. + Collapse and expand sections of a patch for easy + reading. + Link to a particular section of a patch for discussion or + review + Go to Bonsai or LXR to see more context, blame, and + cross-references for the part of the patch you are looking at + Create a rawtext unified format diff out of any patch, no + matter what format it came from + + +
    + Viewing Patches in Patch Viewer + 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.
    -
    - Filing Bugs - - Years of bug writing experience has been distilled for your - reading pleasure into the - - Bug Writing Guidelines. - While some of the advice is Mozilla-specific, the basic principles of - reporting Reproducible, Specific bugs, isolating the Product you are - using, the Version of the Product, the Component which failed, the - Hardware Platform, and Operating System you were using at the time of - the failure go a long way toward ensuring accurate, responsible fixes - for the bug that bit you. - - The procedure for filing a test bug is as follows: - - - - Go to - - Landfill - in your browser and click - - Enter a new bug report. - - - - - Select a product - any one will do. - - - - 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. - - - - Select "Commit" and send in your bug report. - - +
    + Seeing the Difference Between Two Patches + 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.
    -
    - Patch Viewer - - 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. - - Patch viewer allows you to: - - - View patches in color, with side-by-side view rather than trying - to interpret the contents of the patch. - See the difference between two patches. - Get more context in a patch. - Collapse and expand sections of a patch for easy - reading. - Link to a particular section of a patch for discussion or - review - Go to Bonsai or LXR to see more context, blame, and - cross-references for the part of the patch you are looking at - Create a rawtext unified format diff out of any patch, no - matter what format it came from - - -
    - Viewing Patches in Patch Viewer - 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. -
    - -
    - Seeing the Difference Between Two Patches - 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. -
    - -
    - Getting More Context in a Patch - 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". -
    - -
    - Collapsing and Expanding Sections of a Patch - 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. -
    - - - -
    - Going to Bonsai and LXR - 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. - - 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). -
    - -
    - Creating a Unified Diff - 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. -
    - +
    + Getting More Context in a Patch + 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".
    + +
    + Collapsing and Expanding Sections of a Patch + 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. +
    + + + +
    + Going to Bonsai and LXR + 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. + + 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). +
    + +
    + Creating a Unified Diff + 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. +
    +
    @@ -475,15 +468,16 @@
    Autolinkification - Bugzilla comments are plain text - so posting HTML will result - in literal HTML tags rather than being interpreted by a browser. + 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 + "http://www.bugzilla.org" will be turned into a link: . Other strings which get linkified in the obvious manner are: bug 12345 + comment 7 bug 23456, comment 53 attachment 4321 mailto:george@example.com @@ -532,7 +526,7 @@ Don't use sigs in comments. Signing your name ("Bill") is acceptable, - particularly if you do it out of habit, but full mail/news-style + if you do it out of habit, but full mail/news-style four line ASCII art creations are not.
    @@ -586,7 +580,7 @@ Once you have logged in, you can customise various aspects of Bugzilla via the "Edit prefs" link in the page footer. - The preferences are split into four tabs: + The preferences are split into three tabs:
    Account Settings @@ -608,9 +602,16 @@ On this tab you can reduce or increase the amount of email sent you from Bugzilla, opting in our out depending on your relationship to - the bug and the change that was made to it. (Note that you can also do - client-side filtering using the X-Bugzilla-Reason header which Bugzilla - adds to all bugmail.) + the bug and the change that was made to it. + + + + 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. By entering user email names, delineated by commas, into the "Users to watch" text entry box you can receive a copy of all the @@ -625,15 +626,6 @@
    -
    - Page Footer - - On the Search page, you can store queries in Bugzilla, so if you - regularly run a particular query it is just a drop-down menu away. - Once you have a stored query, you can come - here to request that it also be displayed in your page footer. -
    -
    Permissions @@ -643,6 +635,11 @@ functions.
    +
    + Reports + To be written +
    +