The Bugzilla Guide - 4.0.2 Release
The Bugzilla Team
The Bugzilla Guide - 4.0.2 Release
by The Bugzilla Team
Published 2011-08-04
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
(http://www.bugzilla.org/docs/).
Table of Contents
1. About This Guide......................................................................................................................................................1
1.1. Copyright Information....................................................................................................................................1
1.2. Disclaimer ......................................................................................................................................................1
1.3. New Versions..................................................................................................................................................1
1.4. Credits ............................................................................................................................................................1
1.5. Document Conventions ..................................................................................................................................2
2. Installing Bugzilla .....................................................................................................................................................4
2.1. Installation......................................................................................................................................................4
2.1.1. Perl.....................................................................................................................................................4
2.1.2. Database Engine ................................................................................................................................5
2.1.2.1. MySQL..................................................................................................................................5
2.1.2.2. PostgreSQL ...........................................................................................................................5
2.1.2.3. Oracle ....................................................................................................................................5
2.1.3. Web Server.........................................................................................................................................6
2.1.4. Bugzilla..............................................................................................................................................6
2.1.5. Perl Modules......................................................................................................................................6
2.1.6. Mail Transfer Agent (MTA) ..............................................................................................................8
2.1.7. Installing Bugzilla on mod_perl ........................................................................................................9
2.2. Configuration..................................................................................................................................................9
2.2.1. localconfig..........................................................................................................................................9
2.2.2. Database Server ...............................................................................................................................10
2.2.2.1. Bugzilla Database Schema..................................................................................................10
2.2.2.2. MySQL................................................................................................................................10
2.2.2.3. PostgreSQL .........................................................................................................................12
2.2.2.4. Oracle ..................................................................................................................................12
2.2.3. checksetup.pl ...................................................................................................................................13
2.2.4. Web server .......................................................................................................................................14
2.2.4.1. Bugzilla using Apache ........................................................................................................14
2.2.4.2. Microsoft Internet Information Services.............................................................................16
2.2.5. Bugzilla............................................................................................................................................17
2.3. Optional Additional Configuration...............................................................................................................17
2.3.1. Bug Graphs ......................................................................................................................................17
2.3.2. The Whining Cron ...........................................................................................................................17
2.3.3. Whining ...........................................................................................................................................18
2.3.4. Serving Alternate Formats with the right MIME type.....................................................................18
2.4. Multiple Bugzilla databases with a single installation .................................................................................19
2.5. OS-Specific Installation Notes .....................................................................................................................19
2.5.1. Microsoft Windows .........................................................................................................................19
2.5.1.1. Win32 Perl...........................................................................................................................19
2.5.1.2. Perl Modules on Win32.......................................................................................................20
2.5.1.3. Serving the web pages.........................................................................................................21
2.5.1.4. Sending Email .....................................................................................................................21
2.5.2. Mac OS X ........................................................................................................................................21
2.5.2.1. Sendmail..............................................................................................................................21
2.5.2.2. Libraries & Perl Modules on Mac OS X.............................................................................21
iii
2.5.3. Linux Distributions..........................................................................................................................22
2.6. UNIX (non-root) Installation Notes .............................................................................................................22
2.6.1. Introduction......................................................................................................................................22
2.6.2. MySQL ............................................................................................................................................22
2.6.2.1. Running MySQL as Non-Root ...........................................................................................23
2.6.3. Perl...................................................................................................................................................24
2.6.4. Perl Modules....................................................................................................................................24
2.6.5. HTTP Server....................................................................................................................................25
2.6.5.1. Running Apache as Non-Root ............................................................................................25
2.6.6. Bugzilla............................................................................................................................................25
2.6.6.1. suexec or shared hosting .....................................................................................................25
2.7. Upgrading to New Releases .........................................................................................................................26
2.7.1. Before You Upgrade ........................................................................................................................26
2.7.2. Getting The New Bugzilla ...............................................................................................................27
2.7.2.1. If you have modified your Bugzilla.....................................................................................27
2.7.2.2. Upgrading using CVS .........................................................................................................27
2.7.2.3. Upgrading using the tarball.................................................................................................28
2.7.2.4. Upgrading using patches.....................................................................................................29
2.7.3. Completing Your Upgrade...............................................................................................................29
2.7.4. Automatic Notifications of New Releases .......................................................................................30
3. Administering Bugzilla...........................................................................................................................................31
3.1. Bugzilla Configuration .................................................................................................................................31
3.1.1. Required Settings.............................................................................................................................31
3.1.2. Administrative Policies....................................................................................................................33
3.1.3. User Authentication.........................................................................................................................33
3.1.4. Attachments .....................................................................................................................................33
3.1.5. Bug Change Policies........................................................................................................................33
3.1.6. Bug Fields........................................................................................................................................34
3.1.7. Bug Moving.....................................................................................................................................34
3.1.8. Dependency Graphs.........................................................................................................................34
3.1.9. Group Security.................................................................................................................................34
3.1.10. LDAP Authentication ....................................................................................................................35
3.1.11. RADIUS Authentication................................................................................................................36
3.1.12. Email..............................................................................................................................................37
3.1.13. Patch Viewer ..................................................................................................................................38
3.1.14. Query Defaults...............................................................................................................................38
3.1.15. Shadow Database...........................................................................................................................38
3.1.16. User Matching ...............................................................................................................................38
3.2. User Administration .....................................................................................................................................39
3.2.1. Creating the Default User ................................................................................................................39
3.2.2. Managing Other Users.....................................................................................................................39
3.2.2.1. Searching for existing users ................................................................................................39
3.2.2.2. Creating new users ..............................................................................................................39
3.2.2.3. Modifying Users .................................................................................................................40
3.2.2.4. Deleting Users.....................................................................................................................41
3.2.2.5. Impersonating Users ...........................................................................................................41
3.3. Classifications...............................................................................................................................................42
iv
3.4. Products........................................................................................................................................................42
3.4.1. Creating New Products ....................................................................................................................43
3.4.2. Editing Products...............................................................................................................................43
3.4.3. Adding or Editing Components, Versions and Target Milestones...................................................44
3.4.4. Assigning Group Controls to Products............................................................................................44
3.4.4.1. Common Applications of Group Controls ..........................................................................45
3.5. Components..................................................................................................................................................47
3.6. Versions ........................................................................................................................................................47
3.7. Milestones ....................................................................................................................................................47
3.8. Flags ...................................................................................................................... .......................................48
3.8.1. A Simple Example...........................................................................................................................48
3.8.2. About Flags......................................................................................................................................48
3.8.2.1. Values ..................................................................................................................................49
3.8.3. Using flag requests...........................................................................................................................49
3.8.4. Two Types of Flags..........................................................................................................................49
3.8.4.1. Attachment Flags ................................................................................................................49
3.8.4.2. Bug Flags ............................................................................................................................50
3.8.5. Administering Flags.........................................................................................................................50
3.8.5.1. Editing a Flag ......................................................................................................................50
3.8.5.2. Creating a Flag ....................................................................................................................50
3.8.5.3. Deleting a Flag ....................................................................................................................52
3.9. Keywords......................................................................................................................................................52
3.10. Custom Fields.............................................................................................................................................53
3.10.1. Adding Custom Fields ...................................................................................................................53
3.10.2. Editing Custom Fields ...................................................................................................................54
3.10.3. Deleting Custom Fields .................................................................................................................54
3.11. Legal Values ...............................................................................................................................................54
3.11.1. Viewing/Editing legal values .........................................................................................................54
3.11.2. Deleting legal values......................................................................................................................54
3.12. Bug Status Workflow..................................................................................................................................55
3.13. Voting .........................................................................................................................................................55
3.14. Quips ..........................................................................................................................................................55
3.15. Groups and Group Security........................................................................................................................56
3.15.1. Creating Groups.............................................................................................................................56
3.15.2. Editing Groups and Assigning Group Permissions .......................................................................57
3.15.3. Assigning Users to Groups ............................................................................................................58
3.15.4. Assigning Group Controls to Products..........................................................................................59
3.16. Checking and Maintaining Database Integrity...........................................................................................59
4. Bugzilla Security .....................................................................................................................................................60
4.1. Operating System .........................................................................................................................................60
4.1.1. TCP/IP Ports ....................................................................................................................................60
4.1.2. System User Accounts.....................................................................................................................60
4.1.3. The chroot Jail...............................................................................................................................60
4.2. Web server ....................................................................................................................................................60
4.2.1. Disabling Remote Access to Bugzilla Configuration Files .............................................................61
4.3. Bugzilla ........................................................................................................................................................62
4.3.1. Prevent users injecting malicious Javascript....................................................................................62
v
