The Bugzilla Guide - 4.4.2+ Release

The Bugzilla Team

2014-01-27

Abstract

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.


Table of Contents

1. About This Guide
1.1. Copyright Information
1.2. Disclaimer
1.3. New Versions
1.4. Credits
1.5. Document Conventions
2. Installing Bugzilla
2.1. Installation
2.1.1. Perl
2.1.2. Database Engine
2.1.3. Web Server
2.1.4. Bugzilla
2.1.5. Perl Modules
2.1.6. Mail Transfer Agent (MTA)
2.1.7. Installing Bugzilla on mod_perl
2.2. Configuration
2.2.1. localconfig
2.2.2. Database Server
2.2.3. checksetup.pl
2.2.4. Web server
2.2.5. Bugzilla
2.3. Optional Additional Configuration
2.3.1. Bug Graphs
2.3.2. The Whining Cron
2.3.3. Whining
2.3.4. Serving Alternate Formats with the right MIME type
2.4. Multiple Bugzilla databases with a single installation
2.5. OS-Specific Installation Notes
2.5.1. Microsoft Windows
2.5.2. Mac OS X
2.5.3. Linux/BSD Distributions
2.6. UNIX (non-root) Installation Notes
2.6.1. Introduction
2.6.2. MySQL
2.6.3. Perl
2.6.4. Perl Modules
2.6.5. HTTP Server
2.6.6. Bugzilla
2.7. Upgrading to New Releases
2.7.1. Before You Upgrade
2.7.2. Getting The New Bugzilla
2.7.3. Completing Your Upgrade
2.7.4. Automatic Notifications of New Releases
3. Administering Bugzilla
3.1. Bugzilla Configuration
3.1.1. Required Settings
3.1.2. Administrative Policies
3.1.3. User Authentication
3.1.4. Attachments
3.1.5. Bug Change Policies
3.1.6. Bug Fields
3.1.7. Bug Moving
3.1.8. Dependency Graphs
3.1.9. Group Security
3.1.10. LDAP Authentication
3.1.11. RADIUS Authentication
3.1.12. Email
3.1.13. Patch Viewer
3.1.14. Query Defaults
3.1.15. Shadow Database
3.1.16. User Matching
3.2. User Administration
3.2.1. Creating the Default User
3.2.2. Managing Other Users
3.3. Classifications
3.4. Products
3.4.1. Creating New Products
3.4.2. Editing Products
3.4.3. Adding or Editing Components, Versions and Target Milestones
3.4.4. Assigning Group Controls to Products
3.5. Components
3.6. Versions
3.7. Milestones
3.8. Flags
3.8.1. A Simple Example
3.8.2. About Flags
3.8.3. Using flag requests
3.8.4. Two Types of Flags
3.8.5. Administering Flags
3.9. Keywords
3.10. Custom Fields
3.10.1. Adding Custom Fields
3.10.2. Editing Custom Fields
3.10.3. Deleting Custom Fields
3.11. Legal Values
3.11.1. Viewing/Editing legal values
3.11.2. Deleting legal values
3.12. Bug Status Workflow
3.13. Voting
3.14. Quips
3.15. Groups and Group Security
3.15.1. Creating Groups
3.15.2. Editing Groups and Assigning Group Permissions
3.15.3. Assigning Users to Groups
3.15.4. Assigning Group Controls to Products
3.16. Checking and Maintaining Database Integrity
4. Bugzilla Security
4.1. Operating System
4.1.1. TCP/IP Ports
4.1.2. System User Accounts
4.1.3. The chroot Jail
4.2. Web server
4.2.1. Disabling Remote Access to Bugzilla Configuration Files
4.3. Bugzilla
4.3.1. Prevent users injecting malicious Javascript
5. Using Bugzilla
5.1. Introduction
5.2. Create a Bugzilla Account
5.3. Anatomy of a Bug
5.4. Life Cycle of a Bug
5.5. Searching for Bugs
5.5.1. Boolean Charts
5.5.2. Quicksearch
5.5.3. Case Sensitivity in Searches
5.5.4. Bug Lists
5.5.5. Adding/removing tags to/from bugs
5.6. Filing Bugs
5.6.1. Reporting a New Bug
5.6.2. Clone an Existing Bug
5.7. Attachments
5.7.1. Patch Viewer
5.8. Hints and Tips
5.8.1. Autolinkification
5.8.2. Comments
5.8.3. Server-Side Comment Wrapping
5.8.4. Dependency Tree
5.9. Time Tracking Information
5.10. User Preferences
5.10.1. General Preferences
5.10.2. Email Preferences
5.10.3. Saved Searches
5.10.4. Name and Password
5.10.5. Permissions
5.11. Reports and Charts
5.11.1. Reports
5.11.2. Charts
5.12. Flags
5.13. Whining
5.13.1. The Event
5.13.2. Whining Schedule
5.13.3. Whining Searches
5.13.4. Saving Your Changes
6. Customizing Bugzilla
6.1. Bugzilla Extensions
6.2. Custom Skins
6.3. Template Customization
6.3.1. Template Directory Structure
6.3.2. Choosing a Customization Method
6.3.3. How To Edit Templates
6.3.4. Template Formats and Types
6.3.5. Particular Templates
6.3.6. Configuring Bugzilla to Detect the User's Language
6.4. Customizing Who Can Change What
6.5. Integrating Bugzilla with Third-Party Tools
A. Troubleshooting
A.1. General Advice
A.2. The Apache web server is not serving Bugzilla pages
A.3. I installed a Perl module, but checksetup.pl claims it's not installed!
A.4. DBD::Sponge::db prepare failed
A.5. cannot chdir(/var/spool/mqueue)
A.6. Everybody is constantly being forced to relogin
A.7. index.cgi doesn't show up unless specified in the URL
A.8. checksetup.pl reports "Client does not support authentication protocol requested by server..."
B. Contrib
B.1. Command-line Search Interface
B.2. Command-line 'Send Unsent Bug-mail' tool
C. Manual Installation of Perl Modules
C.1. Instructions
C.2. Download Locations
C.3. Optional Modules
D. GNU Free Documentation License
D.0. Preamble
D.1. Applicability and Definition
D.2. Verbatim Copying
D.3. Copying in Quantity
D.4. Modifications
D.5. Combining Documents
D.6. Collections of Documents
D.7. Aggregation with Independent Works
D.8. Translation
D.9. Termination
D.10. Future Revisions of this License
D.. How to use this License for your documents
Glossary

List of Figures

5.1. Lifecycle of a Bugzilla Bug

List of Examples

A.1. Examples of urlbase/cookiepath pairs for sharing login cookies
A.2. Examples of urlbase/cookiepath pairs to restrict the login cookie