diff options
Diffstat (limited to 'docs/txt')
| -rw-r--r-- | docs/txt/Bugzilla-Guide.txt | 3260 |
1 files changed, 1428 insertions, 1832 deletions
diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt index 39b249eba..d7cf3974c 100644 --- a/docs/txt/Bugzilla-Guide.txt +++ b/docs/txt/Bugzilla-Guide.txt @@ -1,25 +1,14 @@ -The 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 - - 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. + 2004-01-15 - 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 - - A. The Bugzilla FAQ - B. The Bugzilla Database - B.1. Modifying Your Running System - B.2. MySQL Bugzilla Database Introduction + 6. Customising Bugzilla - C. Useful Patches and Utilities for 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 - C.1. Apache mod_rewrite magic - C.2. Command-line Bugzilla Queries - - D. Bugzilla Variants and Competitors + A. The Bugzilla FAQ + B. Contrib - D.1. Red Hat Bugzilla - D.2. Loki Bugzilla (Fenris) - D.3. Issuezilla - D.4. Scarab - D.5. Perforce SCM - D.6. SourceForge + B.1. Command-line Search Interface - 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 <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 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 - <para> - Beginning and end of paragraph - </para> + Code example +<para> +Beginning and end of paragraph +</para> + + This documentation is maintained in DocBook 4.1.2 XML format. Changes + are best submitted as plain text or XML diffs, attached to a bug filed + in the 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 <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. 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. - _________________________________________________________________ - -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. + 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.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. 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.3. Perl Modules +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 <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. + + 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 "<modulename>"' +bash# perl -MCPAN -e 'install "<modulename>"' Or the hard way: - bash# tar xzvf <module>.tar.gz (1) - bash# cd <module> (2) - bash# perl Makefile.PL - bash# make - bash# make test - bash# make install - - (1) +bash# tar xzvf <module>.tar.gz (1) +bash# cd <module> (2) +bash# perl Makefile.PL +bash# make +bash# make test +bash# make install + + (1) This assumes that you've already downloaded the <module>.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 <module> 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 - - 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 <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. - - 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 +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 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 + + 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. + + 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.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'. 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 <your-bugzilla-directory> ; ./whineatnews.pl - Tip - - Depending on your system, crontab may have several manpages. The - following command should lead you to the most useful page for this - purpose: + Tip - 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 - - 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). +4.3.4. LDAP Authentication - 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. - - 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(''); + 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. - and change it to: - # Send all data using the ISO-8859-1 charset - $self->charset('ISO-8859-1'); + Simply locate the following line in Bugzilla/CGI.pm: + $self->charset(''); - Note - - 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. + and change it to: + $self->charset('ISO-8859-1'); _________________________________________________________________ -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 <module name> + 4.1.5. The main difference is that windows uses PPM instead of CPAN. +C:\perl> ppm <module name> 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: - Note +bash$ mysql mysql +mysql> DELETE FROM user WHERE user = ''; +mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; +mysql> FLUSH PRIVILEGES; - 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. + 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: - 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. +[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.4.3. AOL Server +4.5.3. Daemon Accounts - Ben FrantzDale reported success using AOL Server with Bugzilla. He - reported his experience and what appears below is based on that. + 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. - 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. + Note - 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 + 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.5.4. Web Server Access Controls - proc filter_deny { why } { - ns_log Notice "filter_deny" - return "filter_return" - } + 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. - Warning + 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. - 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. + * 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 - Note + 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. - 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. + Tip - 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 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.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 <path-to-perl>/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. * <groupname>: 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,194 +2325,197 @@ 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. + 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. - Warning + 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 + it is to update depends on a few factors. - 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. - _________________________________________________________________ + * If the new version is a revision or a new point release + * How many, if any, local changes have been made -5.6.1. TCP/IP Ports + There are also three different methods to upgrade your installation. - 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. - _________________________________________________________________ + 1. Using CVS (Example 5-1) + 2. Downloading a new tarball (Example 5-2) + 3. Applying the relevant patches (Example 5-3) -5.6.2. MySQL + Which options are available to you may depend on how large a jump you + are making and/or your network configuration. - 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. + Revisions are normally released to fix security vulnerabilities and + are distinguished by an increase in the third number. For example, + when 2.16.2 was released, it was a revision to 2.16.1. - 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: + Point releases are normally released when the Bugzilla team feels that + there has been a significant amount of progress made between the last + point release and the current time. These are often proceeded by a + stabilization period and release candidates, however the use of + development versions or release candidates is beyond the scope of this + document. Point releases can be distinguished by an increase in the + second number, or minor version. For example, 2.16.2 is a newer point + release than 2.14.5. -bash$ mysql mysql -mysql> DELETE FROM user WHERE user = ''; -mysql> UPDATE user SET password = password('new_password') WHERE user = 'root'; -mysql> FLUSH PRIVILEGES; + The examples in this section are written as if you were updating to + version 2.16.2. The procedures are the same regardless if you are + updating to a new point release or a new revision. However, the chance + of running into trouble increases when upgrading to a new point + release, escpecially if you've made local changes. + These examples also assume that your Bugzilla installation is at + /var/www/html/bugzilla. If that is not the case, simply substitute the + proper paths where appropriate. - 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: + Example 5-1. Upgrading using CVS - [myslqd] - # Prevent network access to MySQL. - skip-networking + Every release of Bugzilla, whether it is a revision or a point + release, is tagged in CVS. Also, every tarball we have distributed + since version 2.12 has been primed for using CVS. This does, however, + require that you are able to access cvs-mirror.mozilla.org on port + 2401. + Tip - 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. - _________________________________________________________________ + 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 -5.6.3. Daemon Accounts + Caution - 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. + 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 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. - _________________________________________________________________ + You also need to run ./checksetup.pl before your Bugzilla upgrade will + be complete. -5.6.4. Web Server Access Controls + Example 5-2. Upgrading using the tarball - 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. + 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 - * 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 + Warning - Tip + 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. - 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. + Note - 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. + You will now have to reapply any changes you have made to your local + installation manually. - Caution + Example 5-3. Upgrading using patches - Not following the instructions in this section, including testing, may - result in sensitive information being globally accessible. + The Bugzilla team will normally make a patch file available for + 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. 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 +bash$ gunzip bugzilla-2.16.1-to-2.16.2.diff.gz +bash$ patch -p1 < bugzilla-2.16.1-to-2.16.2.diff +patching file checksetup.pl +patching file collectstats.pl +patching file globals.pl - Tip + Caution - 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. + 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.7. Template Customization +Chapter 6. Customising Bugzilla + +6.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 having to edit Perl - files or face the nightmare of massive merge conflicts when they - upgrade to a newer version in the future. + 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 Section 5.7.5. + 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.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, 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 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. + 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 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. + 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 @@ -2576,32 +2527,36 @@ mysql> FLUSH PRIVILEGES; Note - Don't directly edit the compiled templates in data/template/* - your - changes will be lost when Template Toolkit recompiles them. + 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. + 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 +6.1.2. How To Edit Templates + + 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. 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. + 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 <. 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 @@ -2616,15 +2571,9 @@ mysql> FLUSH PRIVILEGES; 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 +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 @@ -2633,8 +2582,8 @@ mysql> FLUSH PRIVILEGES; 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. + "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 @@ -2655,7 +2604,7 @@ mysql> FLUSH PRIVILEGES; <cginame>.cgi?format=<formatname> . _________________________________________________________________ -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. @@ -2684,16 +2633,6 @@ mysql> FLUSH PRIVILEGES; 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 @@ -2728,33 +2667,31 @@ mysql> FLUSH PRIVILEGES; would appear in the initial checkin comment. _________________________________________________________________ -5.7.5. Configuring Bugzilla to Detect the User's Language +6.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 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 + $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. _________________________________________________________________ -5.8. Change Permission Customization +6.2. Customizing Who Can Change What - Warning + 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. + 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 @@ -2775,10 +2712,10 @@ mysql> FLUSH PRIVILEGES; 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; - } + # Allow the owner to change anything. + if ($ownerid eq $whoid) { + return 1; + } It's fairly obvious what this piece of code does. @@ -2795,27 +2732,27 @@ mysql> FLUSH PRIVILEGES; $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; - } - } + 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; - } - } + 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 @@ -2826,156 +2763,330 @@ mysql> FLUSH PRIVILEGES; 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. +6.3. Modifying Your Running System - 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 - it is to update depends on a few factors. - - * If the new version is a revision or a new point release - * How many, if any, local changes have been made - - There are also three different methods to upgrade your installation. - - 1. Using CVS (Example 5-1) - 2. Downloading a new tarball (Example 5-2) - 3. Applying the relevant patches (Example 5-3) - - Which options are available to you may depend on how large a jump you - are making and/or your network configuration. - - Revisions are normally released to fix security vulnerabilities and - are distinguished by an increase in the third number. For example, - when 2.16.2 was released, it was a revision to 2.16.1. - - Point releases are normally released when the Bugzilla team feels that - there has been a significant amount of progress made between the last - point release and the current time. These are often proceeded by a - stabilization period and release candidates, however the use of - development versions or release candidates is beyond the scope of this - document. Point releases can be distinguished by an increase in the - second number, or minor version. For example, 2.16.2 is a newer point - release than 2.14.5. + Bugzilla optimizes database lookups by storing all relatively static + information in the versioncache file, located in the data/ + subdirectory under your installation directory. - The examples in this section are written as if you were updating to - version 2.16.2. The procedures are the same regardless if you are - updating to a new point release or a new revision. However, the chance - of running into trouble increases when upgrading to a new point - release, escpecially if you've made local changes. + 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. - These examples also assume that your Bugzilla installation is at - /var/www/html/bugzilla. If that is not the case, simply substitute the - proper paths where appropriate. + 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. + _________________________________________________________________ - Example 5-1. Upgrading using CVS +6.4. MySQL Bugzilla Database Introduction - Every release of Bugzilla, whether it is a revision or a point - release, is tagged in CVS. Also, every tarball we have distributed - since version 2.12 has been primed for using CVS. This does, however, - require that you are able to access cvs-mirror.mozilla.org on port - 2401. + 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. - Tip + 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. - 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 + 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. - Caution + 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! - 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. + 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'." - Note + 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." - You also need to run ./checksetup.pl before your Bugzilla upgrade will - be complete. + 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... - Example 5-2. Upgrading using the tarball + 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! + _________________________________________________________________ - 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 +6.4.1. Bugzilla Database Basics - Warning + 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. - 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. + 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; + _________________________________________________________________ - Note +6.4.1.1. Bugzilla Database Tables - You will now have to reapply any changes you have made to your local - installation manually. + Imagine your MySQL database as a series of spreadsheets, and you won't + be too far off. If you use this command: - Example 5-3. Upgrading using patches + mysql> show tables from bugs; - The Bugzilla team will normally make a patch file available for - 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. -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 -bash$ gunzip bugzilla-2.16.1-to-2.16.2.diff.gz -bash$ patch -p1 < bugzilla-2.16.1-to-2.16.2.diff -patching file checksetup.pl -patching file collectstats.pl -patching file globals.pl + you'll be able to see the names of all the "spreadsheets" (tables) in + your database. - Caution + 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 | ++-------------------+ - 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. + Here's an overview of what each table does. Most columns in each tab + le 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 mad + e 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 tab + les 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 othe + r 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, whe + n you + submit a form that changes the value of "AssignedTo" this table allows + translation to the actual field name "assigned_to" for entry into MySQ + L. + groups: defines bitmasks for groups. A bitmask is a number that can u + niquely + identify group memberships. For instance, say the group that is allowe + d 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 g + roups 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 bitm + ask 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 doe + s 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 m + akes + sense. + longdescs: The meat of bugzilla -- here is where all user comments ar + e stored! + You've only got 2^24 bytes per comment (it's a mediumtext field), so s + peak + sparingly -- that's only the amount of space the Old Testament from th + e Bible + would take (uncompressed, 16 megabytes). Each comment is keyed to the + bug_id to which it's attached, so the order is necessarily chronologic + al, for + comments are played back in the order in which they are received. + milestones: Interesting that milestones are associated with a specifi + c 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 que + ry 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, s + o you + could close a particular component for bug entry without having to clo + se an + entire product... + profiles: Ahh, so you were wondering where your precious user informa + tion 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 tabl + e 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, wher + e + "column" is the name of the column for which you wish to restrict info + rmation: + 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 fro + m the + above information that the resolution is likely to be stored in the "b + ugs" + table. Note we'll need to change a little perl code as well as this da + tabase + change, but I won't plunge into that in this document. Let's verify th + e + 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" c + olumn is + an "enum field", which is a MySQL peculiarity where a string type fiel + d can + only have certain types of entries. While I think this is very cool, i + t'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 befor + e 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 th + at's + available! Cool thing, too, is that this is reflected on your query p + age as + well -- you can query by the new status. But how's it fit into the exi + sting + scheme of things? + Looks like you need to go back and look for instances of the word "v + erified" + 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 s + tatus + 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 CVS, the Concurrent Versioning System . Using Bonsai, administrators can control open/closed status @@ -2985,7 +3096,7 @@ patching file globals.pl Mozilla automated build management system. _________________________________________________________________ -5.10.2. CVS +6.5.2. CVS CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway. @@ -3002,7 +3113,7 @@ patching file globals.pl Check it out at: http://homepages.kcbbs.gen.nz/~tonyg/. _________________________________________________________________ -5.10.3. Perforce SCM +6.5.3. Perforce SCM You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: http://www.ravenbrook.com/project/p4dti/ . @@ -3018,9 +3129,12 @@ patching file globals.pl for it. Please consult the pages linked above for further information. _________________________________________________________________ -5.10.4. Tinderbox/Tinderbox2 +6.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. _________________________________________________________________ Appendix A. The Bugzilla FAQ @@ -3029,232 +3143,199 @@ Appendix A. The Bugzilla FAQ 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.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.5. Who maintains Bugzilla? - A.1.6. How does Bugzilla stack up against other bug-tracking - databases? + A.1.4. Who maintains Bugzilla? + A.1.5. 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.6. 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.7. 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.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.11. Is there an easy way to change the Bugzilla cookie name? + 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. 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? + software or a specific operating system on your machine? - A.2.6. Does Bugzilla allow us to define our own priorities and + 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? + acceptable values? - A.2.7. Does Bugzilla provide any reporting features, metrics, + A.2.3. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management - likes to see. :) + likes to see. :) - A.2.8. Is there email notification and if so, what do you see - when you get an email? + 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.5. Do users have to have any particular type of email + application? - 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 + 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.12. Has anyone converted Bugzilla to another language to be - used in other countries? Is it localizable? + export that data to MS Excel, could I do that? - A.2.13. Can a user create and save reports? Can they do this in - Word format? Excel format? + A.2.7. Has anyone converted Bugzilla to another language to be + used in other countries? Is it localizable? - A.2.14. Does Bugzilla have the ability to search by word, phrase, - compound search? + A.2.8. Can a user create and save reports? Can they do this in + Word format? Excel format? - A.2.15. Does Bugzilla provide record locking when there is + 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? + 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 + 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. + buying an "out-of-the-box" solution? - A.2.19. What time frame are we looking at if we decide to hire + 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? + for 1 person, 2 people, etc? - A.2.20. Is there any licensing fee or other fees for using + 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? + 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)? + 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. + 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? + 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? + email to anyone but me. 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.3. I want whineatnews.pl to whine at something different to + only new bugs. How do I do it? - A.4.5. How do I set up the email interface to submit/change bugs - via email? + A.4.4. 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.5. 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? + 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.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? + entries. What do I do? - A.5.3. I want to manually edit some entries in my database. How? + 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. + Bugzilla still can't connect. A.5.5. How do I synchronize bug information among multiple - different Bugzilla databases? + different Bugzilla databases? 6. Bugzilla and Win32 A.6.1. What is the easiest way to run Bugzilla on Win32 - (Win98+/NT/2K)? + (Win98+/NT/2K)? - A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? + 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? + 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. + 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.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? + 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? + accept it? A.7.4. I can't upload anything into the database via the "Create - Attachment" link. What am I doing wrong? + Attachment" link. What am I doing wrong? A.7.5. How do I change a keyword in Bugzilla, once some bugs are - using it? + using it? A.7.6. Why can't I close bugs from the "Change Several Bugs at - Once" page? + 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.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"? + "P2"? A.8.4. What's the best way to submit patches? What guidelines - should I follow? + 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? + 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.3. How do I get commercial support for Bugzilla? + 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. - 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 + 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.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 - <gerv@mozilla.org>. Keep in mind that it's kinda difficult to get onto - the "high-profile" list ;). + 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 + <gerv@mozilla.org>. - A.1.5. Who maintains Bugzilla? + A.1.4. 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 + 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 @@ -3270,7 +3351,7 @@ Appendix A. The Bugzilla FAQ 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 + 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 @@ -3285,7 +3366,7 @@ Appendix A. The Bugzilla FAQ Enhancement" (RFE) using the bug submission interface at bugzilla.mozilla.org. - A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on + 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 @@ -3299,7 +3380,7 @@ Appendix A. The Bugzilla FAQ Once both of these are done, adding support for additional database servers should be trivial. - A.1.9. What is /usr/bonsaitools/bin/perl? + 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 @@ -3311,56 +3392,26 @@ Appendix A. The Bugzilla FAQ 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 + 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 +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? + A.1.10. Is there an easy way to change the Bugzilla cookie name? At present, no. 2. Managerial Questions - 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)? + It is web and e-mail based. - 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? + 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? @@ -3371,7 +3422,7 @@ Appendix A. The Bugzilla FAQ 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, + 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 @@ -3384,34 +3435,28 @@ Appendix A. The Bugzilla FAQ 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 + 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 + 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? + 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. + 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.11. Does Bugzilla allow data to be imported and exported? If I had + 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 @@ -3420,11 +3465,11 @@ Appendix A. The Bugzilla FAQ 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. + 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 + 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 @@ -3436,8 +3481,8 @@ Appendix A. The Bugzilla FAQ e-mail to import information into Bugzilla, but these scripts are not currently supported and included for educational purposes. - A.2.12. Has anyone converted Bugzilla to another language to be used - in other countries? Is it localizable? + 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 @@ -3445,42 +3490,36 @@ Appendix A. The Bugzilla FAQ therefore still English only. Also, there may be issues with the charset not being declared. See bug 126226 for more information. - A.2.13. Can a user create and save reports? Can they do this in Word + 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.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. 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.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.16. Are there any backup features provided? + 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.17. Can users be on the system while a backup is in progress? + 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.18. What type of human resources are needed to be on staff to + 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. + 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. @@ -3490,7 +3529,7 @@ Appendix A. The Bugzilla FAQ available from skilled members of the newsgroup. Simple questions are answered there and then. - A.2.19. What time frame are we looking at if we decide to hire people + 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 @@ -3503,7 +3542,7 @@ Appendix A. The Bugzilla FAQ UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. - A.2.20. Is there any licensing fee or other fees for using Bugzilla? + 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? @@ -3528,13 +3567,6 @@ Appendix A. The Bugzilla FAQ installation, and follow the recommended security guidelines found in The Bugzilla Guide. - 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. - 4. Bugzilla Email A.4.1. I have a user who doesn't want to receive any more email from @@ -3549,49 +3581,37 @@ Appendix A. The Bugzilla FAQ Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". - 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.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. 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 + 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.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely + 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. - If you are using sendmail, try enabling sendmailnow in editparams.cgi. - - A.4.7. How come email from Bugzilla changes never reaches me? + 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 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". @@ -3599,26 +3619,26 @@ Appendix A. The Bugzilla FAQ 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 + 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). + 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 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. + 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? @@ -3641,9 +3661,9 @@ Appendix A. The Bugzilla FAQ 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. + 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? @@ -3772,18 +3792,18 @@ Appendix A. The Bugzilla FAQ Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this: - <fred> - [% IF foo %] - <bar> - [% FOREACH x = barney %] - <tr> - <td> - [% x %] - </td> - <tr> - [% END %] - [% END %] - </fred> +<fred> +[% IF foo %] + <bar> + [% FOREACH x = barney %] + <tr> + <td> + [% x %] + </td> + <tr> + [% END %] +[% END %] +</fred> Myk also recommends you turn on PRE_CHOMP in the template initialization to prevent bloating of HTML with unnecessary @@ -3836,364 +3856,15 @@ Appendix A. The Bugzilla FAQ successful open-source bug-tracking software on the planet :) _________________________________________________________________ -Appendix B. The Bugzilla Database +Appendix B. Contrib - 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? + There are a number of unofficial Bugzilla add-ons in the + $BUGZILLA_ROOT/contrib/ directory. This section documents them. _________________________________________________________________ -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. +B.1. Command-line Search Interface - 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 tab - le 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 mad - e 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 tab - les 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 othe - r 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, whe - n you - submit a form that changes the value of "AssignedTo" this table allows - translation to the actual field name "assigned_to" for entry into MySQ - L. - groups: defines bitmasks for groups. A bitmask is a number that can u - niquely - identify group memberships. For instance, say the group that is allowe - d 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 g - roups 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 bitm - ask 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 doe - s 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 m - akes - sense. - longdescs: The meat of bugzilla -- here is where all user comments ar - e stored! - You've only got 2^24 bytes per comment (it's a mediumtext field), so s - peak - sparingly -- that's only the amount of space the Old Testament from th - e Bible - would take (uncompressed, 16 megabytes). Each comment is keyed to the - bug_id to which it's attached, so the order is necessarily chronologic - al, for - comments are played back in the order in which they are received. - milestones: Interesting that milestones are associated with a specifi - c 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 que - ry 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, s - o you - could close a particular component for bug entry without having to clo - se an - entire product... - profiles: Ahh, so you were wondering where your precious user informa - tion 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 tabl - e 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, wher - e - "column" is the name of the column for which you wish to restrict info - rmation: - 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 fro - m the - above information that the resolution is likely to be stored in the "b - ugs" - table. Note we'll need to change a little perl code as well as this da - tabase - change, but I won't plunge into that in this document. Let's verify th - e - 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" c - olumn is - an "enum field", which is a MySQL peculiarity where a string type fiel - d can - only have certain types of entries. While I think this is very cool, i - t'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 befor - e 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 th - at's - available! Cool thing, too, is that this is reflected on your query p - age as - well -- you can query by the new status. But how's it fit into the exi - sting - scheme of things? - Looks like you need to go back and look for instances of the word "v - erified" - 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 s - tatus - 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 - - 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 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. - _________________________________________________________________ - -C.2. Command-line Bugzilla Queries - - 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 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 |