diff options
| author | barnboy%trilobyte.net <> | 2001-08-11 07:26:38 +0200 |
|---|---|---|
| committer | barnboy%trilobyte.net <> | 2001-08-11 07:26:38 +0200 |
| commit | 20811e277e61cd29ae1edc97a6c62bc1a03f442b (patch) | |
| tree | 4e98392a7b8690a2e9826ed9ae0c2c14a453bfcc /docs/txt | |
| parent | 5bef49c26c5d3c49da84aeddee3217a2fa917e8c (diff) | |
| download | bugzilla-20811e277e61cd29ae1edc97a6c62bc1a03f442b.tar.gz bugzilla-20811e277e61cd29ae1edc97a6c62bc1a03f442b.tar.xz | |
Compiled HTML/TXT check-in. For some reason, it keeps thinking my darn
dbschema.jpg file is changing, though.
Diffstat (limited to 'docs/txt')
| -rw-r--r-- | docs/txt/Bugzilla-Guide.txt | 3754 |
1 files changed, 1868 insertions, 1886 deletions
diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt index 2c2ed648e..a5fd79fcb 100644 --- a/docs/txt/Bugzilla-Guide.txt +++ b/docs/txt/Bugzilla-Guide.txt @@ -3,7 +3,15 @@ The Bugzilla Guide Matthew P. Barnson - barnboy@trilobyte.net + barnboy@NOSPAM.trilobyte.net + Zach Lipton + + zach@NOSPAM.zachlipton.com + +Edited by + +I. P. Freely + Revision History Revision v2.11 20 December 2000 Revised by: MPB Converted the README, FAQ, and DATABASE information into SGML docbook @@ -24,9 +32,26 @@ Matthew P. Barnson deprecated status. Things I know need work: Used "simplelist" a lot, where I should have used "procedure" to tag things. Need to lowercase all tags to be XML compliant. + Revision 2.14.0 07 August 2001 Revised by: MPB + Attempted to integrate relevant portions of the UNIX and Windows + installation instructions, moved some data from FAQ to Install, + removed references to README from text, added Mac OS X install + instructions, fixed a bunch of tpyos (Mark Harig), linked text that + referenced other parts of the Guide, and nuked the old MySQL + permissions section. This is the documentation for Bugzilla, the Mozilla bug-tracking system. + + Bugzilla is an enterprise-class set of software utilities that, when + used together, power issue-tracking for hundreds of organizations + around the world, tracking millions of bugs. While it is easy to use + and quite flexible, it is very difficult for a novice to install and + maintain. Although we have provided step-by-step directions, Bugzilla + is not always easy to get working. Please be sure the person + responsible for installing and maintaining this software is a + qualified professional on operating system upon which you install + Bugzilla. _________________________________________________________________ Table of Contents @@ -42,89 +67,95 @@ Matthew P. Barnson 1.8. Translations 1.9. Document Conventions - 2. Installing Bugzilla + 2. Using Bugzilla + + 2.1. What is Bugzilla? + 2.2. Why Should We Use Bugzilla? + 2.3. How do I use Bugzilla? - 2.1. UNIX Installation + 2.3.1. Create a Bugzilla Account + 2.3.2. The Bugzilla Query Page + 2.3.3. Creating and Managing Bug Reports - 2.1.1. ERRATA - 2.1.2. Step-by-step Install + 2.3.3.1. Writing a Great Bug Report + 2.3.3.2. Managing your Bug Reports - 2.1.2.1. Introduction - 2.1.2.2. Installing the Prerequisites - 2.1.2.3. Installing MySQL Database - 2.1.2.4. Perl (5.004 or greater) - 2.1.2.5. DBI Perl Module - 2.1.2.6. Data::Dumper Perl Module - 2.1.2.7. MySQL related Perl Module Collection - 2.1.2.8. TimeDate Perl Module Collection - 2.1.2.9. GD Perl Module (1.8.3) - 2.1.2.10. Chart::Base Perl Module (0.99c) - 2.1.2.11. DB_File Perl Module - 2.1.2.12. HTTP Server - 2.1.2.13. Installing the Bugzilla Files - 2.1.2.14. Setting Up the MySQL Database - 2.1.2.15. Tweaking "localconfig" - 2.1.2.16. Setting Up Maintainers Manually (Optional) - 2.1.2.17. The Whining Cron (Optional) - 2.1.2.18. Bug Graphs (Optional) - 2.1.2.19. Securing MySQL - 2.1.2.20. Installation General Notes + 2.4. What's in it for me? - 2.2. Win32 (Win98+/NT/2K) Installation + 2.4.1. Account Settings + 2.4.2. Email Settings - 2.2.1. Win32 Installation: Step-by-step - 2.2.2. Additional Windows Tips + 2.4.2.1. Email Notification + 2.4.2.2. New Email Technology + 2.4.2.3. "Watching" Users - 3. Administering Bugzilla + 2.4.3. Page Footer + 2.4.4. Permissions - 3.1. Post-Installation Checklist - 3.2. User Administration + 2.5. Using Bugzilla-Conclusion - 3.2.1. Creating the Default User - 3.2.2. Managing Other Users + 3. Installation - 3.2.2.1. Logging In - 3.2.2.2. Creating new users - 3.2.2.3. Disabling Users - 3.2.2.4. Modifying Users + 3.1. ERRATA + 3.2. Step-by-step Install - 3.3. Product, Component, Milestone, and Version Administration + 3.2.1. Introduction + 3.2.2. Installing the Prerequisites + 3.2.3. Installing MySQL Database + 3.2.4. Perl (5.004 or greater) + 3.2.5. DBI Perl Module + 3.2.6. Data::Dumper Perl Module + 3.2.7. MySQL related Perl Module Collection + 3.2.8. TimeDate Perl Module Collection + 3.2.9. GD Perl Module (1.8.3) + 3.2.10. Chart::Base Perl Module (0.99c) + 3.2.11. DB_File Perl Module + 3.2.12. HTTP Server + 3.2.13. Installing the Bugzilla Files + 3.2.14. Setting Up the MySQL Database + 3.2.15. Tweaking "localconfig" + 3.2.16. Setting Up Maintainers Manually (Optional) + 3.2.17. The Whining Cron (Optional) + 3.2.18. Bug Graphs (Optional) + 3.2.19. Securing MySQL - 3.3.1. Products - 3.3.2. Components - 3.3.3. Versions - 3.3.4. Milestones - 3.3.5. Voting - 3.3.6. Groups and Group Security + 3.3. Mac OS X Installation Notes + 3.4. BSD Installation Notes + 3.5. Installation General Notes - 3.4. Bugzilla Security + 3.5.1. Modifying Your Running System + 3.5.2. Upgrading From Previous Versions + 3.5.3. .htaccess files and security + 3.5.4. UNIX Installation Instructions History - 4. Using Bugzilla + 3.6. Win32 Installation Notes - 4.1. What is Bugzilla? - 4.2. Why Should We Use Bugzilla? - 4.3. How do I use Bugzilla? + 3.6.1. Win32 Installation: Step-by-step + 3.6.2. Additional Windows Tips - 4.3.1. Create a Bugzilla Account - 4.3.2. The Bugzilla Query Page - 4.3.3. Creating and Managing Bug Reports + 4. Administering Bugzilla - 4.3.3.1. Writing a Great Bug Report - 4.3.3.2. Managing your Bug Reports + 4.1. Post-Installation Checklist + 4.2. User Administration - 4.4. What's in it for me? + 4.2.1. Creating the Default User + 4.2.2. Managing Other Users - 4.4.1. Account Settings - 4.4.2. Email Settings + 4.2.2.1. Logging In + 4.2.2.2. Creating new users + 4.2.2.3. Disabling Users + 4.2.2.4. Modifying Users - 4.4.2.1. Email Notification - 4.4.2.2. New Email Technology - 4.4.2.3. "Watching" Users + 4.3. Product, Component, Milestone, and Version Administration - 4.4.3. Page Footer - 4.4.4. Permissions + 4.3.1. Products + 4.3.2. Components + 4.3.3. Versions + 4.3.4. Milestones + 4.3.5. Voting + 4.3.6. Groups and Group Security - 4.5. Using Bugzilla-Conclusion + 4.4. Bugzilla Security 5. Integrating Bugzilla with Third-Party Tools @@ -134,22 +165,18 @@ Matthew P. Barnson 5.4. Tinderbox 6. The Future of Bugzilla - - 6.1. Reducing Spam - 6.2. Better Searching - 6.3. Description Flags and Tracking Bugs - 6.4. Bug Issues - 6.5. Database Integrity - 6.6. Bugzilla 3.0 - A. The Bugzilla FAQ B. Software Download Links C. The Bugzilla Database C.1. Database Schema Chart C.2. MySQL Bugzilla Database Introduction + + C.2.1. Bugzilla Database Basics + + C.2.1.1. Bugzilla Database Tables + C.3. MySQL Permissions & Grant Tables - C.4. Cleaning up after mucking with Bugzilla 7. Bugzilla Variants @@ -179,21 +206,20 @@ Matthew P. Barnson Glossary List of Examples - 2-1. Setting up bonsaitools symlink - 2-2. Running checksetup.pl as the web user - 2-3. Removing encrypt() for Windows NT installations - 3-1. Creating some Components - 3-2. Common Use of Versions - 3-3. A Different Use of Versions - 3-4. Using SortKey with Target Milestone - 3-5. When to Use Group Security - 3-6. Creating a New Group - 4-1. Some Famous Software Versions - 4-2. Mozilla Webtools Components + 2-1. Some Famous Software Versions + 2-2. Mozilla Webtools Components + 3-1. Setting up bonsaitools symlink + 3-2. Running checksetup.pl as the web user + 3-3. Installing ActivePerl ppd Modules on Microsoft Windows + 3-4. Removing encrypt() for Windows NT installations + 4-1. Creating some Components + 4-2. Common Use of Versions + 4-3. A Different Use of Versions + 4-4. Using SortKey with Target Milestone + 4-5. When to Use Group Security + 4-6. Creating a New Group D-1. Using Setperl to set your perl path 1. A Sample Product - - ] > _________________________________________________________________ Chapter 1. About This Guide @@ -211,8 +237,8 @@ Chapter 1. About This Guide administration, maintenance, and use of the Bugzilla bug-tracking system. - This release of the Bugzilla Guide is the 2.11 release. It is so named - that it may match the current version of Bugzilla. The numbering + This release of the Bugzilla Guide is the 2.14.0 release. It is so + named that it may match the current version of Bugzilla. The numbering tradition stems from that used for many free software projects, in which even-numbered point releases (1.2, 1.14, etc.) are considered "stable releases", intended for public consumption; on the other hand, @@ -220,20 +246,21 @@ Chapter 1. About This Guide development releases intended for advanced users, systems administrators, developers, and those who enjoy a lot of pain. - Newer revisions of the Bugzilla Guide will follow the numbering - conventions of the main-tree Bugzilla releases, available at - Mozilla.org, with the exception that intermediate releases will have a - minor revision number following a period. For instance, if the current - version of Bugzilla is 4.2, the current "stable" version of the - Bugzilla guide, in, say, it's fifth revision, would be numbered - "4.2.5". Got it? Good. + Newer revisions of the Bugzilla Guide follow the numbering conventions + of the main-tree Bugzilla releases, available at + http://www.mozilla.org/projects/bugzilla. Intermediate releases will + have a minor revision number following a period. The current version + of Bugzilla, as of this writing (August 10, 2001) is 2.14; if + something were seriously wrong with that edition of the Guide, + subsequent releases would receive an additional dotted-decimal digit + to indicate the update (2.14.0.1, 2.14.0.2, etc.). Got it? Good. I wrote this in response to the enormous demand for decent Bugzilla documentation. I have incorporated instructions from the Bugzilla README, Frequently Asked Questions, Database Schema Document, and various mailing lists to create it. Chances are, there are glaring - errors in this documentation; please contact <barnboy@trilobyte.net> - to correct them. + errors in this documentation; please contact + <barnboy@NOSPAM.trilobyte.net> to correct them. _________________________________________________________________ 1.2. Copyright Information @@ -241,7 +268,7 @@ Chapter 1. About This Guide Permission is granted to copy, distribute and/or modify this document - under thei terms of the GNU Free Documentation License, Version 1.1 or + 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 the section entitled "GNU @@ -249,9 +276,9 @@ Chapter 1. About This Guide --Copyright (c) 2000-2001 Matthew P. Barnson - If you have any questions regarding this document, its' copyright, or + If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, please contact - <barnboy@trilobyte.net> + Matthew P. Barnson. Remove "NOSPAM" from email address to send. _________________________________________________________________ 1.3. Disclaimer @@ -267,27 +294,38 @@ Chapter 1. About This Guide 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. In particular, I like to put down Microsoft(tm). Live with it. + mark. Naming of particular products or brands should not be seen as - endorsements, with the exception of the term "GNU/Linux". Use - GNU/Linux. Love it. Bathe with it. It is life and happiness. I endorse - it wholeheartedly and encourage you to do the same. + endorsements, with the exception of the term "GNU/Linux". I + 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. Heaven knows it's saved my bacon time after time; if you implement any suggestion in this Guide, implement this one! - Bugzilla has not undergone a complete security review. Security holes - probably exist in the code. 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. + 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 insure + your security needs are met. _________________________________________________________________ 1.4. New Versions - This is the initial release of the Bugzilla Guide. + This is the 2.14.0 version of The Bugzilla Guide. 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. This document can be found in the following places: @@ -330,8 +368,8 @@ Chapter 1. About This Guide Thanks go to these people for significant contributions to this documentation (in no particular order): - Zach Lipton (significant textual contributions), Andrew Pearson, - Spencer Smith, Eric Hanson, Kevin Brannen, + Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron + Teitelbaum _________________________________________________________________ 1.7. Feedback @@ -347,9 +385,8 @@ Chapter 1. About This Guide The Bugzilla Guide needs translators! Please volunteer your translation into the language of your choice. If you will translate this Guide, please notify the members of the mozilla-webtools mailing - list at <mozilla-webtools@mozilla.org>. Since The Bugzilla Guide is - also hosted on the Linux Documentation Project, you would also do well - to notify + list at <mozilla-webtools@mozilla.org>, and arrange with Matt Barnson + to check it into CVS. _________________________________________________________________ 1.9. Document Conventions @@ -364,12 +401,14 @@ Chapter 1. About This Guide Warnings. Hint - Tip: Hint. + Tip + Hint. Notes - Note: Note. + Note + Note. Information requiring special attention Warning @@ -388,26 +427,627 @@ Chapter 1. About This Guide <para>Beginning and end of paragraph</para> _________________________________________________________________ -Chapter 2. Installing Bugzilla +Chapter 2. Using Bugzilla + + + + What, Why, How, & What's in it for me? + _________________________________________________________________ + +2.1. What is Bugzilla? + + Bugzilla is one example of a class of programs called "Defect Tracking + Systems", or, more commonly, "Bug-Tracking Systems". Defect Tracking + Systems allow individual or groups of developers to keep track of + outstanding bugs in their product effectively. Bugzilla was originally + written by Terry Weissman in a programming language called "TCL", to + replace a crappy bug-tracking database used internally for Netscape + Communications. Terry later ported Bugzilla to Perl from TCL, and in + Perl it remains to this day. Most commercial defect-tracking software + vendors at the time charged enormous licensing fees, and Bugzilla + quickly became a favorite of the open-source crowd (with its genesis + in the open-source browser project, Mozilla). It is now the de-facto + standard defect-tracking system against which all others are measured. + + Bugzilla has matured immensely, and now boasts many advanced features. + These include: + + * integrated, product-based granular security schema + * inter-bug dependencies and dependency graphing + * advanced reporting capabilities + * a robust, stable RDBMS back-end + * extensive configurability + * a very well-understood and well-thought-out natural bug resolution + protocol + * email, XML, console, and HTTP APIs + * available integration with automated software configuration + management systems, including Perforce and CVS + * too many more features to list + + Despite its current robustness and popularity, however, Bugzilla faces + some near-term challenges, such as reliance on a single database, a + lack of abstraction of the user interface and program logic, verbose + email bug notifications, a powerful but daunting query interface, + little reporting configurability, problems with extremely large + queries, some unsupportable bug resolution options, no + internationalization, and dependence on some nonstandard libraries. + + Some recent headway has been made on the query front, however. If you + are using the latest version of Bugzilla, you should see a "simple + search" form on the default front page of your Bugzilla install. Type + in two or three search terms and you should pull up some relevant + information. This is also available as "queryhelp.cgi". + + Despite these small problems, Bugzilla is very hard to beat. It is + under very active development to address the current issues, and a + long-awaited overhaul in the form of Bugzilla 3.0 is expected sometime + later this year. + _________________________________________________________________ + +2.2. Why Should We Use Bugzilla? + + + + No, Who's on first... + + For many years, defect-tracking software has remained principally the + domain of large software development houses. Even then, most shops + never bothered with bug-tracking software, and instead simply relied + on shared lists and email to monitor the status of defects. This + procedure is error-prone and tends to cause those bugs judged least + significant by developers to be dropped or ignored. + + These days, many companies are finding that integrated defect-tracking + systems reduce downtime, increase productivity, and raise customer + satisfaction with their systems. Along with full disclosure, an open + bug-tracker allows manufacturers to keep in touch with their clients + and resellers, to communicate about problems effectively throughout + the data management chain. Many corporations have also discovered that + defect-tracking helps reduce costs by providing IT support + accountability, telephone support knowledge bases, and a common, + well-understood system for accounting for unusual system or software + issues. + + But why should you use Bugzilla? + + Bugzilla is very adaptable to various situations. Known uses currently + include IT support queues, Systems Administration deployment + management, chip design and development problem tracking (both + pre-and-post fabrication), and software and hardware bug tracking for + luminaries such as Redhat, Loki software, Linux-Mandrake, and VA + Systems. Combined with systems such as CVS, Bonsai, or Perforce SCM, + Bugzilla provides a powerful, easy-to-use solution to configuration + management and replication problems + + Bugzilla can dramatically increase the productivity and accountability + of individual employees by providing a documented workflow and + positive feedback for good performance. How many times do you wake up + in the morning, remembering that you were supposed to do *something* + today, but you just can't quite remember? Put it in Bugzilla, and you + have a record of it from which you can extrapolate milestones, predict + product versions for integration, and by using Bugzilla's e-mail + integration features be able to 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. + _________________________________________________________________ + +2.3. How do I use Bugzilla? + + + + Hey! I'm Woody! Howdy, Howdy, Howdy! + + Bugzilla is a large, complex system. Describing how to use it requires + some time. If you are only interested in installing or administering a + Bugzilla installation, please consult the Installing and Administering + Bugzilla portions of this Guide. This section is principally aimed + towards developing end-user mastery of Bugzilla, so you may fully + enjoy the benefits afforded by using this reliable open-source + bug-tracking software. + + Throughout this portion of the Guide, we will refer to user account + options available at the Bugzilla test installation, + landfill.tequilarista.org. + + Note + + Some people have run into difficulties completing this tutorial. If + you run into problems, please check the updated, online documentation + available at http://www.trilobyte.net/barnsons. If you're still + stumped, please subscribe to the newsgroup and provide details of + exactly what's stumping you! If enough people complain, I'll have to + fix it in the next version of this Guide. You can subscribe to the + newsgroup at news://news.mozilla.org/netscape.public.mozilla.webtools + Although Landfill serves as a great introduction to Bugzilla, it does + not offer all the options you would have as a user on your own + installation of Bugzilla, nor can it do more than serve as a general + introduction to Bugzilla. Additionally, Landfill often runs + cutting-edge versions of Bugzilla for testing, so some things may work + slightly differently than mentioned here. + _________________________________________________________________ + +2.3.1. Create a Bugzilla Account + + First things first! If you want to use Bugzilla, first you need to + create an account. Consult with the administrator responsible for your + installation of Bugzilla for the URL you should use to access it. If + you're test-driving the end-user Bugzilla experience, use this URL: + http://landfill.tequilarista.org/bugzilla-tip/ + + 1. Click the "Open a new Bugzilla account" link. + 2. Enter your "E-mail address" and "Real Name" (or whatever name you + want to call yourself) in the spaces provided, then select the + "Create Account" button. + 3. Within 5-10 minutes, 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 should be + changed at your nearest opportunity (we'll go into how to do it + later). + 4. Click the "Log In" link in the yellow area at the bottom of the + page in your browser, then enter your "E-mail address" and + "Password" you just received into the spaces provided, and select + "Login". + + Note + + If you ever forget your password, you can come back to this page, + enter your "E-mail address", then select the "E-mail me a password" + button to have your password mailed to you again so that you can + login. + + Caution + + Many modern browsers include an "Auto-Complete" or "Form Fill" feature + to remember the user names and passwords you type in at many sites. + Unfortunately, sometimes they attempt to "guess" what you will put in + as your password, and guess wrong. If you notice a text box is already + filled out, please overwrite the contents of the text box so you can + be sure to input the correct information. + + Congratulations! If you followed these directions, you now are the + proud owner of a user account on landfill.tequilarista.org (Landfill) + or your local Bugzilla install. You should now see in your browser a + page called the "Bugzilla Query Page". It may look daunting, but with + this Guide to walk you through it, you will master it in no time. + _________________________________________________________________ + +2.3.2. The Bugzilla Query Page + + The Bugzilla Query Page is the heart and soul of Bugzilla. It is the + master interface where you can find any bug report, comment, or patch + currently in the Bugzilla system. We'll go into how to create your own + bug report later on. + + There are efforts underway to simplify query usage. If you have a + local installation of Bugzilla 2.12 or higher, you should have + "quicksearch.html" available to use and simplify your searches. There + is also, or shortly will be, a helper for the query interface, called + "queryhelp.cgi". Landfill tends to run the latest code, so these two + utilities should be available there for your perusal. + + At this point, please visit the main Bugzilla site, + bugzilla.mozilla.org, to see a more fleshed-out query page. + + The first thing you need to notice about the Bugzilla Query Page is + that nearly every box you see on your screen has a hyperlink nearby, + explaining what it is or what it does. Near the upper-left-hand corner + of your browser window you should see the word "Status" underlined. + Select it. + + Notice the page that popped up? Every underlined word you see on your + screen is a hyperlink that will take you to context-sensitive help. + Click around for a while, and learn what everything here does. To + return to the query interface after pulling up a help page, use the + "Back" button in your browser. + + I'm sure that after checking out the online help, you are now an + Expert on the Bugzilla Query Page. If, however, you feel you haven't + mastered it yet, let me walk you through making a few successful + queries to find out what there are in the Bugzilla bug-tracking system + itself. + + 1. Ensure you are back on the "Bugzilla Query Page" Do nothing in the + boxes marked "Status", "Resolution", "Platform", "OpSys", + "Priority", or "Severity". The default query for "Status" is to + find all bugs that are NEW, ASSIGNED, or REOPENED, which is what + we want. If you don't select anything in the other 5 scrollboxes + there, then you are saying that "any of these are OK"; we're not + locking ourselves into only finding bugs on the "DEC" Platform, or + "Windows 95" OpSys (Operating System). You're smart, I think you + have it figured out. + Basically, selecting anything on the query page narrows your + search down. Leaving stuff unselected, or text boxes unfilled, + broadens your search! + 2. You see the box immediately below the top six boxes that contains + an "Email" text box, with the words "matching as", a drop-down + selection box, then some checkboxes with "Assigned To" checked by + default? This allows you to filter your search down based upon + email address. Let's put my email address in there, and see what + happens. + Type "barnboy@trilobyte.net" in the top Email text box. + 3. Let's narrow the search some more. Scroll down until you find the + box with the word "Program" over the top of it. This is where we + can narrow our search down to only specific products (software + programs or product lines) in our Bugzilla database. Please notice + the box is a scrollbox. Using the down arrow on the scrollbox, + scroll down until you can see an entry called "Webtools". Select + this entry. + 4. Did you notice that some of the boxes to the right changed when + you selected "Webtools"? Every Program (or Product) has different + Versions, Components, and Target Milestones associated with it. A + "Version" is the number of a software program. + Example 2-1. Some Famous Software Versions + Do you remember the hype in 1995 when Microsoft Windows 95(r) was + released? It may have been several years ago, but Microsoft(tm) + spent over $300 Million advertising this new Version of their + software. Three years later, they released Microsoft Windows + 98(r), another new version, to great fanfare, and then in 2000 + quietly released Microsoft Windows ME(Millenium Edition)(r). + Software "Versions" help a manufacturer differentiate their + current product from their previous products. Most do not identify + their products by the year they were released. Instead, the + "original" version of their software will often be numbered "1.0", + with small bug-fix releases on subsequent tenths of a digit. In + most cases, it's not a decimal number; for instance, often 1.9 is + an older version of the software than 1.11, but is a newer version + than 1.1.1. + In general, a "Version" in Bugzilla should refer to released + products, not products that have not yet been released to the + public. Forthcoming products are what the Target Milestone field + is for. + A "Component" is a piece of a Product. It may be a standalone + program, or some other logical division of a Product or Program. + Normally, a Component has a single Owner, who is responsible for + overseeing efforts to improve that Component. + Example 2-2. Mozilla Webtools Components + Mozilla's "Webtools" Product is composed of several pieces + (Components): + + Bonsai, a tool to show recent changes to Mozilla + Bugzilla, a defect-tracking tool + Build, a tool to automatically compile source code into + machine-readable form + Despot, a program that controls access to the other Webtools + LXR, a utility that automatically marks up text files to make them + more readable + MozBot, a "robot" that announces changes to Mozilla in Chat + TestManager, a tool to help find bugs in Mozilla + Tinderbox, which displays reports from Build + A different person is responsible for each of these Components. + Tara Hernandez keeps the "Bugzilla" component up-to-date. + A "Milestone", or "Target Milestone" is a often a planned future + "Version" of a product. In many cases, though, Milestones simply + represent significant dates for a developer. Having certain + features in your Product is frequently tied to revenue (money) the + developer will receive if the features work by the time she + reaches the Target Milestone. Target Milestones are a great tool + to organize your time. If someone will pay you $100,000 for + incorporating certain features by a certain date, those features + by that Milestone date become a very high priority. Milestones + tend to be highly malleable creatures, though, that appear to be + in reach but are out of reach by the time the important day + arrives. + The Bugzilla Project has set up Milestones for future Bugzilla + versions 2.14, 2.16, 2.18, 3.0, etc. However, a Target Milestone + can just as easily be a specific date, code name, or weird + alphanumeric combination, like "M19". + 5. OK, now let's select the "Bugzilla" component from its scrollbox. + 6. Skip down the page a bit -- do you see the "submit query" button? + Select it, and let's run this query! + 7. Congratulations! You've completed your first Query, and have + before you the Bug List of the author of this Guide, Matthew P. + Barnson (barnboy@trilobyte.net). If I'm doing well, you'll have a + cryptic "Zarro Boogs Found" message on your screen. It is just a + happy hacker's way of saying "Zero Bugs Found". However, I am + fairly certain I will always have some bugs assigned to me that + aren't done yet, so you won't often see that message! + + I encourage you to click the bug numbers in the left-hand column and + examine my bugs. Also notice that if you click the underlined links + near the top of this page, they do not take you to context-sensitive + help here, but instead sort the columns of bugs on the screen! When + you need to sort your bugs by priority, severity, or the people they + are assigned to, this is a tremendous timesaver. + + A couple more interesting things about the Bug List page: + + Change Columns: by selecting this link, you can show all kinds of + information in the Bug List + Change several bugs at once: If you have sufficient rights to change + all the bugs shown in the Bug List, you can mass-modify them. This is + a big time-saver. + Send mail to bug owners: If you have many related bugs, you can + request an update from every person who owns the bugs in the Bug List + asking them the status. + Edit this query: If you didn't get exactly the results you were + looking for, you can return to the Query page through this link and + make small revisions to the query you just made so you get more + accurate results. + + Note + + There are many more options to the Bugzilla Query Page and the Bug + List than I have shown you. But this should be enough for you to learn + to get around. I encourage you to check out the Bugzilla Home Page to + learn about the Anatomy and Life Cycle of a Bug before continuing. + _________________________________________________________________ + +2.3.3. Creating and Managing Bug Reports + + + + And all this time, I thought we were taking bugs out... + _________________________________________________________________ + +2.3.3.1. Writing a Great Bug Report + + Before we plunge into writing your first bug report, I encourage you + to read Mozilla.org's Bug Writing Guidelines. While some of the advice + is Mozilla-specific, the basic principles of reporting Reproducible, + Specific bugs, isolating the Product you are using, the Version of the + Product, the Component which failed, the Hardware Platform, and + Operating System you were using at the time of the failure go a long + way toward ensuring accurate, responsible fixes for the bug that bit + you. + + While you are at it, why not learn how to find previously reported + bugs? Mozilla.org has published a great tutorial on finding duplicate + bugs, available at + http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. + + I realize this was a lot to read. However, understanding the mentality + of writing great bug reports will help us on the next part! + + 1. Go back to http://landfill.tequilarista.org/bugzilla-tip/ in your + browser. + 2. Select the Enter a new bug report link. + 3. Select a product. + 4. Now you should be at the "Enter Bug" form. The "reporter" should + have been automatically filled out for you (or else Bugzilla + prompted you to Log In again -- you did keep the email with your + username and password, didn't you?). + 5. Select a Component in the scrollbox. + 6. Bugzilla should have made reasonable guesses, based upon your + browser, for the "Platform" and "OS" drop-down boxes. If those are + wrong, change them -- if you're on an SGI box running IRIX, we + want to know! + 7. Fill in the "Assigned To" box with the email address you provided + earlier. This way you don't end up sending copies of your bug to + lots of other people, since it's just a test bug. + 8. Leave the "CC" text box blank. Fill in the "URL" box with + "http://www.mozilla.org". + 9. Enter "The Bugzilla Guide" in the Summary text box, and place any + comments you have on this tutorial, or the Guide in general, into + the Description box. + + Voila! Select "Commit" and send in your bug report! Next we'll look at + resolving bugs. + _________________________________________________________________ + +2.3.3.2. Managing your Bug Reports + + OK, you should have a link to the bug you just created near the top of + your page. It should say "Bug XXXX posted", with a link to the right + saying "Back to BUG# XXXX". Select this link. + + 1. Scroll down a bit on the subsequent page, until you see the + "Resolve bug, changing resolution to (dropdown box). Normally, you + would "Accept bug (change status to ASSIGNED)", fix it, and then + resolve. But in this case, we're going to short-circuit the + process because this wasn't a real bug. Change the dropdown next + to "Resolve Bug" to "INVALID", make sure the radio button is + marked next to "Resolve Bug", then click "Commit". + 2. Hey! It said it couldn't take the change in a big red box! That's + right, you must specify a Comment in order to make this change. + Select the "Back" button in your browser, add a Comment, then try + Resolving the bug with INVALID status again. This time it should + work. + + You have now learned the basics of Bugzilla navigation, entering a + bug, and bug maintenance. I encourage you to explore these features, + and see what you can do with them! We'll spend no more time on + individual Bugs or Queries from this point on, so you are on your own + there. + + But I'll give a few last hints! + + There is a CLUE on the Query page that will teach you more how to use + the form. + + If you click the hyperlink on the Component box of the Query page, you + will be presented a form that will describe what all the components + are. + + Possibly the most powerful feature of the Query page is the Boolean + Chart section. It's a bit confusing to use the first time, but can + provide unparalleled flexibility in your queries, allowing you to + build extremely powerful requests. + + Finally, you can build some nifty Reports using the "Bug Reports" link + near the bottom of the query page, and also available via the + "Reports" link at the footer of each page. + _________________________________________________________________ + +2.4. What's in it for me? + + + + Indiana, it feels like we walking on fortune cookies! + + These ain't fortune cookies, kid... + + Customized User Preferences offer tremendous versatility to your + individual Bugzilla experience. Let's plunge into what you can do! The + first step is to click the "Edit prefs" link at the footer of each + page once you have logged in to Landfill. + _________________________________________________________________ + +2.4.1. Account Settings + + On this page, you can change your basic Account Settings, including + your password and full name. For security reasons, in order to change + anything on this page you must type your current password into the + "Old Password" field. If you wish to change your password, type the + new password you want into the "New Password" field and again into the + "Re-enter new password" field to ensure you typed your new password + correctly. Select the "Submit" button and you're done! + _________________________________________________________________ + +2.4.2. Email Settings + +2.4.2.1. Email Notification + + Note + + The email notification settings described below have been obsoleted in + Bugzilla 2.12, and this section will be replaced with a comprehensive + description of the amazing array of new options at your disposal. + However, in the meantime, throw this chunk out the window and go crazy + with goofing around with different notification options. + + Ahh, here you can reduce or increase the amount of email sent you from + Bugzilla! In the drop-down "Notify me of changes to", select one of + + All qualifying bugs: sends you every change to every bug where your + name is somewhere on it, regardless of who changed it. + Only those bugs which I am listed in the CC line: prevents you from + receiving mail for which you are the reporter,' owner, or QA contact. + If you are on the CC list, presumably someone had a good reason for + you to get the email. + All qulifying bugs except those which I change: This is the default, + and a sensible setting. If someone else changes your bugs, you will + get emailed, but if you change bugs yourself you will receive no + notification of the change. + _________________________________________________________________ + +2.4.2.2. New Email Technology -2.1. UNIX Installation + Note -2.1.1. ERRATA + This option may not be available in all Bugzilla installations, + depending upon the preferences of the systems administrator + responsible for the setup of your Bugzilla. However, if you really + want this functionality, ask her to "enable newemailtech in Params" + and "make it the default for all new users", referring her to the + Administration section of this Guide. - Note: If you are installing Bugzilla on S.u.S.e. Linux, or some - other distributions with "paranoid" security options, it is - possible that the checksetup.pl script may fail with the error: - cannot chdir(/var/spool/mqueue): Permission denied This is because - your /var/spool/mqueue directory has a mode of "drwx------". Type - chmod 755 /var/spool/mqueue as root to fix this problem. + Disregard the warnings about "experimental and bleeding edge"; the + code to handle email in a cleaner manner than that historically used + for Bugzilla is quite robust and well-tested now. - Note: Release Notes for Bugzilla 2.12 are available at - docs/rel_notes.txt + I recommend you enable the option, "Click here to sign up (and risk + any bugs)". Your email-box will thank you for it. The fundamental + shift in "newemailtech" is away from standard UNIX "diff" output, + which is quite ugly, to a prettier, better laid-out email. + _________________________________________________________________ - Note: The preferred documentation for Bugzilla is available in - docs/, with a variety of document types available. Please refer to - these documents when installing, configuring, and maintaining your - Bugzilla installation. +2.4.2.3. "Watching" Users + + Note + + This option may not be available in all Bugzilla installations, + depending upon the preferences of the systems administrator + responsible for the setup of your Bugzilla. However, if you really + want this functionality, ask her to "enable watchers in Params". + + By entering user email names into the "Users to watch" text entry box, + delineated by commas, you can watch bugs of other users. This powerful + functionality enables seamless transitions as developers change + projects, managers wish to get in touch with the issues faced by their + direct reports, or users go on vacation. If any of these three + situations apply to you, you will undoubtedly find this feature quite + convenient. + _________________________________________________________________ + +2.4.3. Page Footer + + Note + + By default, this page is quite barren. However, go explore the Query + Page some more; you will find that you can store numerous queries on + the server, so if you regularly run a particular query it is just a + drop-down menu away. On this page of Preferences, if you have many + stored queries you can elect to have them always one-click away! + + If you have many stored queries on the server, here you will find + individual drop-downs for each stored query. Each drop-down gives you + the option of that query appearing on the footer of every page in + Bugzilla! This gives you powerful one-click access to any complex + searches you may set up, and is an excellent way to impress your + boss... + + Tip + + By default, the "My Bugs" link appears at the bottom of each page. + However, this query gives you both the bugs you have reported, as well + as those you are assigned. One of the most common uses for this page + is to remove the "My Bugs" link, replacing it with two other queries, + commonly called "My Bug Reports" and "My Bugs" (but only referencing + bugs assigned to you). This allows you to distinguish those bugs you + have reported from those you are assigned. I commonly set up complex + Boolean queries in the Query page and link them to my footer in this + page. When they are significantly complex, a one-click reference can + save hours of work. + _________________________________________________________________ + +2.4.4. Permissions + + This is a purely informative page which outlines your current + permissions on this installation of Bugzilla. If you have permissions + to grant certain permissions to other users, the "other users" link + appears on this page as well as the footer. For more information + regarding user administration, please consult the Administration + section of this Guide. + _________________________________________________________________ + +2.5. Using Bugzilla-Conclusion + + Thank you for reading through this portion of the Bugzilla Guide. I + anticipate it may not yet meet the needs of all readers. If you have + additional comments or corrections to make, please submit your + contributions to the mozilla-webtools mailing list/newsgroup. The + mailing list is mirrored to the netscape.public.mozilla.webtools + newsgroup, and the newsgroup is mirrored to + mozilla-webtools@mozilla.org + _________________________________________________________________ + +Chapter 3. Installation + + These installation instructions are presented assuming you are + installing on a UNIX or completely POSIX-compliant system. If you are + installing on Microsoft Windows or another oddball operating system, + please consult the appropriate sections in this installation guide for + notes on how to be successful. + _________________________________________________________________ + +3.1. ERRATA + + Here are some miscellaneous notes about possible issues you main run + into when you begin your Bugzilla installation. Reference platforms + for Bugzilla installation are Redhat Linux 7.2, Linux-Mandrake 8.0, + and Solaris 8. + + If you are installing Bugzilla on S.u.S.e. Linux, or some other + distributions with "paranoid" security options, it is possible that + the checksetup.pl script may fail with the error: cannot + chdir(/var/spool/mqueue): Permission denied This is because your + /var/spool/mqueue directory has a mode of "drwx------". Type chmod 755 + /var/spool/mqueue as root to fix this problem. + Bugzilla may be installed on Macintosh OS X (10), which is a + unix-based (BSD) operating system. Everything required for Bugzilla on + OS X will install cleanly, but the optional GD perl module which is + used for bug charting requires some additional setup for installation. + Please see the Mac OS X installation section below for details + Release Notes for Bugzilla 2.14 are available at docs/rel_notes.txt in + your Bugzilla source distribution. + The preferred documentation for Bugzilla is available in docs/, with a + variety of document types available. Please refer to these documents + when installing, configuring, and maintaining your Bugzilla + installation. Warning @@ -428,9 +1068,9 @@ Chapter 2. Installing Bugzilla implications of installing other network services with Bugzilla. _________________________________________________________________ -2.1.2. Step-by-step Install +3.2. Step-by-step Install -2.1.2.1. Introduction +3.2.1. Introduction Installation of bugzilla is pretty straightforward, particularly if your machine already has MySQL and the MySQL-related perl packages @@ -440,26 +1080,35 @@ Chapter 2. Installing Bugzilla required, it is recommended. Bugzilla has been successfully installed under Solaris, Linux, and - Win32. The peculiarities of installing on Win32 (Win98+/NT/2K) are not - included in this section of the Guide; please check out the "Win32 - Installation Instructions" for further advice on getting Bugzilla to + Win32. The peculiarities of installing on Win32 (Microsoft Windows) + are not included in this section of the Guide; please check out the + Win32 Installation Notes for further advice on getting Bugzilla to work on Microsoft Windows. - The Bugzilla Guide is contained in the "docs/" folder. It is available - in plain text (docs/txt), HTML (docs/html), or SGML source - (docs/sgml). + The Bugzilla Guide is contained in the "docs/" folder in your Bugzilla + distribution. It is available in plain text (docs/txt), HTML + (docs/html), or SGML source (docs/sgml). _________________________________________________________________ -2.1.2.2. Installing the Prerequisites +3.2.2. Installing the Prerequisites + + Note + + If you want to skip these manual installation steps for the CPAN + dependencies listed below, and are running the very most recent + version of Perl and MySQL (both the executables and development + libraries) on your system, check out Bundle::Bugzilla in Using + Bundle::Bugzilla instead of manually installing Perl modules The software packages necessary for the proper running of bugzilla are: 1. MySQL database server and the mysql client (3.22.5 or greater) - 2. Perl (5.004 or greater) + 2. Perl (5.004 or greater, 5.6.1 is recommended if you wish to use + Bundle::Bugzilla) 3. DBI Perl module 4. Data::Dumper Perl module - 5. DBD::mySQL + 5. Bundle::Mysql Perl module collection 6. TimeDate Perl module collection 7. GD perl module (1.8.3) (optional, for bug charting) 8. Chart::Base Perl module (0.99c) (optional, for bug charting) @@ -468,10 +1117,6 @@ Chapter 2. Installing Bugzilla 11. MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - Note: You must run Bugzilla on a filesystem that supports file - locking via flock(). This is necessary for Bugzilla to operate - safely with multiple instances. - Warning It is a good idea, while installing Bugzilla, to ensure it is not @@ -483,9 +1128,9 @@ Chapter 2. Installing Bugzilla point is your machine vulnerable to an attack. _________________________________________________________________ -2.1.2.3. Installing MySQL Database +3.2.3. Installing MySQL Database - Visit MySQL homepage at http://www.mysql.org/ and grab the latest + Visit MySQL homepage at http://www.mysql.com/ and grab the latest stable release of the server. Both binaries and source are available and which you get shouldn't matter. Be aware that many of the binary versions of MySQL store their data files in /var which on many @@ -503,41 +1148,60 @@ Chapter 2. Installing Bugzilla the command that starts mysqld (or safe_mysqld), then you will be able to have attachments up to about 1 megabyte. - Note: If you plan on running Bugzilla and MySQL on the same - machine, consider using the "--skip-networking" option in the init - script. This enhances security by preventing network access to - MySQL. + Note + + If you plan on running Bugzilla and MySQL on the same machine, + consider using the "--skip-networking" option in the init script. This + enhances security by preventing network access to MySQL. _________________________________________________________________ -2.1.2.4. Perl (5.004 or greater) +3.2.4. Perl (5.004 or greater) Any machine that doesn't have perl on it is a sad machine indeed. Perl for *nix systems can be gotten in source form from - http://www.perl.com. + http://www.perl.com. Although Bugzilla runs with most post-5.004 + versions of Perl, 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.6.1. Perl is now a far cry from the the single compiler/interpreter binary - it once was. It now includes a great many required modules and quite a - few other support files. If you're not up to or not inclined to build - perl from source, you'll want to install it on your machine using some - sort of packaging system (be it RPM, deb, or what have you) to ensure - a sane install. In the subsequent sections you'll be installing quite - a few perl modules; this can be quite ornery if your perl installation + it once was. It includes a great many required modules and quite a few + other support files. If you're not up to or not inclined to build perl + from source, you'll want to install it on your machine using some sort + of packaging system (be it RPM, deb, or what have you) to ensure a + sane install. In the subsequent sections you'll be installing quite a + few perl modules; this can be quite ornery if your perl installation isn't up to snuff. - Tip: You can skip the following Perl module installation steps by - installing "Bundle::Bugzilla" from CPAN, which includes them. All - Perl module installation steps require you have an active Internet - connection. - - bash# perl -MCPAN -e 'install "Bundle::Bugzilla"' + Warning - Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser, - which are not essential to a basic Bugzilla install. If installing - this bundle fails, you should install each module individually to - isolate the problem. + 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 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. + + Tip + + You can skip the following Perl module installation steps by + installing "Bundle::Bugzilla" from CPAN, which includes them. All Perl + module installation steps require you have an active Internet + connection. If you wish to use Bundle::Bugzilla, however, you must be + using the latest version of Perl (at this writing, version 5.6.1) + + bash# perl -MCPAN -e 'install "Bundle::Bugzilla"' + + Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser, + which are not essential to a basic Bugzilla install. If installing + this bundle fails, you should install each module individually to + isolate the problem. _________________________________________________________________ -2.1.2.5. DBI Perl Module +3.2.5. DBI Perl Module The DBI module is a generic Perl module used by other database related Perl modules. For our purposes it's required by the MySQL-related @@ -559,8 +1223,10 @@ Chapter 2. Installing Bugzilla bash# perl -MCPAN -e 'install "DBI"' - Note: Replace "DBI" with the name of whichever module you wish to - install, such as Data::Dumper, TimeDate, GD, etc. + Note + + Replace "DBI" with the name of whichever module you wish to install, + such as Data::Dumper, TimeDate, GD, etc. To do it the hard way: @@ -577,19 +1243,19 @@ Chapter 2. Installing Bugzilla majority of perl modules this is all that's required. _________________________________________________________________ -2.1.2.6. Data::Dumper Perl Module +3.2.6. Data::Dumper Perl Module The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later sub-releases of Perl 5.004, but a re-installation just to be sure it's available won't hurt anything. - Data::Dumper is used by the MySQL related Perl modules. It can be + Data::Dumper is used by the MySQL-related Perl modules. It can be found on CPAN (link in Appendix A) and can be installed by following the same four step make sequence used for the DBI module. _________________________________________________________________ -2.1.2.7. MySQL related Perl Module Collection +3.2.7. MySQL related Perl Module Collection The Perl/MySQL interface requires a few mutually-dependent perl modules. These modules are grouped together into the the @@ -603,11 +1269,10 @@ Chapter 2. Installing Bugzilla compilation target and your MySQL installation. For many of the questions the provided default will be adequate. - When asked if your desired target is the MySQL or mSQL packages - selected the MySQL related ones. Later you will be asked if you wish - to provide backwards compatibility with the older MySQL packages; you - must answer YES to this question. The default will be no, and if you - select it things won't work later. + When asked if your desired target is the MySQL or mSQL packages, + select the MySQL related ones. Later you will be asked if you wish to + provide backwards compatibility with the older MySQL packages; you + should answer YES to this question. The default is NO. A host of 'localhost' should be fine and a testing user of 'test' and a null password should find itself with sufficient access to run tests @@ -616,19 +1281,19 @@ Chapter 2. Installing Bugzilla to go as far as database connectivity is concerned. _________________________________________________________________ -2.1.2.8. TimeDate Perl Module Collection +3.2.8. TimeDate Perl Module Collection Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This - bundle is stored on the CPAN under the name TimeDate. A (hopefully - current) link can be found in Appendix A. The component module we're - most interested in is the Date::Format module, but installing all of - them is probably a good idea anyway. The standard Perl module + bundle is stored on the CPAN under the name TimeDate. A link link may + be found in Appendix B, Software Download Links. The component module + we're most interested in is the Date::Format module, but installing + all of them is probably a good idea anyway. The standard Perl module installation instructions should work perfectly for this simple package. _________________________________________________________________ -2.1.2.9. GD Perl Module (1.8.3) +3.2.9. GD Perl Module (1.8.3) The GD library was written by Thomas Boutell a long while ago to programatically generate images in C. Since then it's become almost a @@ -639,27 +1304,29 @@ Chapter 2. Installing Bugzilla Actually bugzilla uses the Graph module which relies on GD itself, but isn't that always the way with OOP. At any rate, you can find the GD - library on CPAN (link in Appendix "Required Software"). + library on CPAN (link in Appendix B, Software Download Links). - 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. Just realize that if compiling GD fails, it's probably - because you're missing a required library. + 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. Just realize + that if compiling GD fails, it's probably because you're missing a + required library. _________________________________________________________________ -2.1.2.10. Chart::Base Perl Module (0.99c) +3.2.10. Chart::Base Perl Module (0.99c) The Chart module provides bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched from CPAN where it is found as the Chart-x.x... tarball in a directory - to be listed in Appendix "Required Software". Note that as with the GD - perl module, only the specific versions listed above (or newer) will + to be listed in Appendix B, "Software Download Links". Note that as + with the GD perl module, only the version listed above, or newer, will work. Earlier versions used GIF's, which are no longer supported by the latest versions of GD. _________________________________________________________________ -2.1.2.11. DB_File Perl Module +3.2.11. DB_File Perl Module DB_File is a module which allows Perl programs to make use of the facilities provided by Berkeley DB version 1.x. This module is @@ -667,7 +1334,7 @@ Chapter 2. Installing Bugzilla plan to make use of bug charting, you must install this module. _________________________________________________________________ -2.1.2.12. HTTP Server +3.2.12. HTTP Server You have a freedom of choice here - Apache, Netscape or any other server on UNIX would do. You can easily run the web server on a @@ -690,20 +1357,18 @@ Chapter 2. Installing Bugzilla Warning There are two critical directories and a file that should not be a - served by the HTTP server. These are the 'data' and 'shadow' - directories and the 'localconfig' file. You should configure your HTTP + served by the HTTP server. These are the "data" and "shadow" + directories and the "localconfig" file. You should configure your HTTP server to not serve content from these files. Failure to do so will - expose critical passwords and other data. Please see your HTTP server - configuration manual on how to do this. If you use quips (at the top - of the buglist pages) you will want the 'data/comments' file to still - be served. This file contains those quips. + expose critical passwords and other data. Please see .htaccess files + and security for details. _________________________________________________________________ -2.1.2.13. Installing the Bugzilla Files +3.2.13. Installing the Bugzilla Files 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 off of the main web space + "nobody"). You may decide to put the files off of the main web space for your web server or perhaps off of /usr/local with a symbolic link in the web space that points to the bugzilla directory. At any rate, just dump all the files in the same place (optionally omitting the CVS @@ -711,10 +1376,11 @@ Chapter 2. Installing Bugzilla Bugzilla) and make sure you can access the files in that directory through your web server. - Tip: If you symlink the bugzilla directory into your Apache's HTML - heirarchy, you may receive "Forbidden" errors unless you add the - "FollowSymLinks" directive to the <Directory> entry for the HTML - root. + Tip + + If you symlink the bugzilla directory into your Apache's HTML + heirarchy, you may receive "Forbidden" errors unless you add the + "FollowSymLinks" directive to the <Directory> entry for the HTML root. Once all the files are in a web accessible directory, make that directory writable by your webserver's user (which may require just @@ -728,7 +1394,7 @@ Chapter 2. Installing Bugzilla .cgi files to change where they look for perl. To make future upgrades easier, you should use the symlink approach. - Example 2-1. Setting up bonsaitools symlink + Example 3-1. Setting up bonsaitools symlink Here's how you set up the Perl symlink on Linux to make Bugzilla work. Your mileage may vary; if you are running on Solaris, you probably @@ -739,13 +1405,15 @@ bash# mkdir /usr/bonsaitools bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl - Tip: If you don't have root access to set this symlink up, check - out the "setperl.csh" utility, listed in the Patches section of - this Guide. It will change the path to perl in all your Bugzilla - files for you. + Tip + + If you don't have root access to set this symlink up, check out the + The setperl.csh Utility, listed in Useful Patches and Utilities for + Bugzilla. It will change the path to perl in all your Bugzilla files + for you. _________________________________________________________________ -2.1.2.14. Setting Up the MySQL Database +3.2.14. 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 a the back end @@ -753,10 +1421,13 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl First, you'll want to fix MySQL permissions to allow access from Bugzilla. For the purpose of this Installation section, the Bugzilla - username will be "bugs", and will have minimal permissions. Bugzilla - has not undergone a thorough security audit. It may be possible for a - system cracker to somehow trick Bugzilla into executing a command such - as "; DROP DATABASE mysql". + username will be "bugs", and will have minimal permissions. + + Warning + + Bugzilla has not undergone a thorough security audit. It may be + possible for a system cracker to somehow trick Bugzilla into executing + a command such as DROP DATABASE mysql. That would be bad. @@ -797,7 +1468,7 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl The first time you run it, it will create a file called "localconfig". _________________________________________________________________ -2.1.2.15. Tweaking "localconfig" +3.2.15. Tweaking "localconfig" This file contains a variety of settings you may need to tweak including how Bugzilla should connect to the MySQL database. @@ -809,6 +1480,10 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl 3. MySQL username: "bugs" if you're following these directions 4. Password for the "bugs" MySQL account above + You may also install .htaccess files that the Apache webserver will + use to restrict access to Bugzilla data files. See .htaccess files and + security. + Once you are happy with the settings, re-run checksetup.pl. On this second run, it will create the database and an administrator account for which you will be prompted to provide information. @@ -826,14 +1501,16 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl with multiple instances. If flock() is not fully supported, it will stall at: Now regenerating the shadow database for all bugs. - Note: The second time you run checksetup.pl, you should become the - user your web server runs as, and that you ensure you have set the - "webservergroup" parameter in localconfig to match the web server's - group name, if any. I believe, for the next release of Bugzilla, - this will be fixed so that Bugzilla supports a "webserveruser" - parameter in localconfig as well. + Note - Example 2-2. Running checksetup.pl as the web user + The second time you run checksetup.pl, you should become the user your + web server runs as, and that you ensure that you set the + "webservergroup" parameter in localconfig to match the web server's + group name, if any. I believe, for the next release of Bugzilla, this + will be fixed so that Bugzilla supports a "webserveruser" parameter in + localconfig as well. + + Example 3-2. Running checksetup.pl as the web user Assuming your web server runs as user "apache", and Bugzilla is installed in "/usr/local/bugzilla", here's one way to run @@ -844,17 +1521,19 @@ bash# su - apache bash# cd /usr/local/bugzilla bash# ./checksetup.pl - 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. + 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. _________________________________________________________________ -2.1.2.16. Setting Up Maintainers Manually (Optional) +3.2.16. Setting Up Maintainers Manually (Optional) If you want to add someone else to every group by hand, you can do it by typing the appropriate MySQL commands. Run ' mysql -u root -p bugs' - (you may need different parameters, depending on your security - settings according to section 3, above). Then: + You may need different parameters, depending on your security + settings. Then: mysql> update profiles set groupset=0x7fffffffffffffff where login_name = 'XXX'; @@ -862,18 +1541,25 @@ bash# ./checksetup.pl replacing XXX with the Bugzilla email address. _________________________________________________________________ -2.1.2.17. The Whining Cron (Optional) +3.2.17. The Whining Cron (Optional) - By now you've got a fully functional bugzilla, but what good are bugs - if they're not annoying? To help make those bugs more annoying you can + 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 set up bugzilla's automatic whining system. This can be done by adding the following command as a daily crontab entry (for help on that see that crontab man page): 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: + man 5 crontab _________________________________________________________________ -2.1.2.18. Bug Graphs (Optional) +3.2.18. Bug Graphs (Optional) As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty bugzilla bug reporting graphs. @@ -888,12 +1574,12 @@ bash# ./checksetup.pl Bug Reports page. _________________________________________________________________ -2.1.2.19. Securing MySQL +3.2.19. Securing MySQL - If you followed the README for setting up your "bugs" and "root" user - in MySQL, much of this should not apply to you. If you are upgrading - an existing installation of Bugzilla, you should pay close attention - to this section. + If you followed the installation instructions for setting up your + "bugs" and "root" user in MySQL, much of this should not apply to you. + If you are upgrading an existing installation of Bugzilla, you should + pay close attention to this section. Most MySQL installs have "interesting" default security parameters: @@ -937,6 +1623,9 @@ bash# ./checksetup.pl REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com; FLUSH PRIVILEGES; + Use .htaccess files with the Apache webserver to secure your bugzilla + install. See .htaccess files and security + Consider also: 1. Turning off external networking with "--skip-networking", unless @@ -952,20 +1641,99 @@ bash# ./checksetup.pl 7. making backups ;-) _________________________________________________________________ -2.1.2.20. Installation General Notes +3.3. Mac OS X Installation Notes + + There are a lot of common libraries and utilities out there that Apple + did not include with Mac OS X, but which run perfectly well on it. The + GD library, which Bugzilla needs to do bug graphs, is one of these. + + The easiest way to get a lot of these is with a program called Fink, + which is similar in nature to the CPAN installer, but installs common + GNU utilities. Fink is available from + <http://sourceforge.net/projects/fink/>. + + Follow the instructions for setting up Fink. Once it's installed, + you'll want to run the following as root: fink install gd + + It will prompt you for a number of dependencies, type 'y' and hit + enter to install all of the dependencies. Then watch it work. + + 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 for libgd will be at /sw/lib and /sw/include instead of + /usr/lib and /usr/local/include. Because of these changed locations + for the libraries, the Perl GD module will not install directly via + CPAN (it looks for the specific paths instead of getting them from + your environment). But there's a way around that :-) + + Instead of typing "install GD" at the cpan> prompt, type look GD. This + should go through the motions of downloading the latest version of the + GD module, then it will open a shell and drop you into the build + directory. Apply the following patch to the Makefile.PL file (save the + patch into a file and use the command patch < patchfile: + + +--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000 ++++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001 +@@ -3,8 +3,8 @@ + warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library versi +on 4.X).\n"; + + # =====> PATHS: CHECK AND ADJUST <===== +-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd); +-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/l +ib ); ++my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/lo +cal/include/gd); ++my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/u +sr/local/lib); + my @LIBS = qw(-lgd -lpng -lz); + + # FEATURE FLAGS +@@ -23,7 +23,7 @@ + + push @LIBS,'-lttf' if $TTF; + push @LIBS,'-ljpeg' if $JPEG; +-push @LIBS, '-lm' unless $^O eq 'MSWin32'; ++push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/); + + # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified + if ($^O ne 'freebsd' && $^O ne 'MSWin32') { + + + + Then, run these commands to finish the installation of the perl + module: + + perl Makefile.PL + make + make test + make install + And don't forget to run exit to get back to cpan. + + Happy Hacking! + _________________________________________________________________ + +3.4. BSD Installation Notes + + For instructions on how to set up Bugzilla on FreeBSD, NetBSD, + OpenBSD, BSDi, etc. please consult Section 3.3. + _________________________________________________________________ + +3.5. Installation General Notes -2.1.2.20.1. Modifying Your Running System +3.5.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 (we said before it - needs to be writable, right?!) + 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! + show up. That file gets automatically regenerated whenever it's more than an hour old, so Bugzilla will eventually notice your changes by itself, @@ -973,7 +1741,7 @@ bash# ./checksetup.pl things. _________________________________________________________________ -2.1.2.20.2. Upgrading From Previous Versions +3.5.2. Upgrading From Previous Versions The developers of Bugzilla are constantly adding new tables, columns and fields. You'll get SQL errors if you just update the code. The @@ -981,17 +1749,40 @@ bash# ./checksetup.pl whenever you upgrade your installation of Bugzilla. If you want to see what has changed, you can read the comments in that file, starting from the end. + + If you are running Bugzilla version 2.8 or lower, and wish to upgrade + to the latest version, please consult the file, "UPGRADING-pre-2.8" in + the Bugzilla root directory after untarring the archive. _________________________________________________________________ -2.1.2.20.3. UNIX Installation Instructions History +3.5.3. .htaccess files and security + + To enhance the security of your Bugzilla installation, Bugzilla will + generate .htaccess files which the Apache webserver can use to + restrict access to the bugzilla data files. The checksetup script will + generate the .htaccess files. + + Note + + If you are using an alternate provider of webdot services for graphing + (as described when viewing editparams.cgi in your web browser), you + will need to change the ip address in data/webdot/.htaccess to the ip + address of the webdot server that you are using. + + If you are using Internet Information Server or other web server which + does not observe .htaccess conventions, you can disable their creation + by editing localconfig and setting the $create_htaccess variable to 0. + _________________________________________________________________ + +3.5.4. UNIX Installation Instructions History This document was originally adapted from the Bonsai installation instructions by Terry Weissman <terry@mozilla.org>. The February 25, 1999 re-write of this page was done by Ry4an Brase <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, - Martin Pool, & Dan Mosedale (But don't send bug reports to them! - Report them using bugzilla, at + Martin Pool, & Dan Mosedale (But don't send bug reports to them; + report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, component Bugzilla). @@ -1001,116 +1792,253 @@ bash# ./checksetup.pl for Bugzilla installations. Finally, the README in its entirety was marked up in SGML and included - into the Guide on April 24, 2001. + into the Guide on April 24, 2001 by Matt Barnson. Since that time, + it's undergone extensive modification as Bugzilla grew. Comments from people using this Guide for the first time are particularly welcome. _________________________________________________________________ -2.2. Win32 (Win98+/NT/2K) Installation - - These directions have not been extensively tested. We need testers! - Please try these out and post any changes to the newsgroup. +3.6. Win32 Installation Notes + + This section covers installation on Microsoft Windows 95, 98, ME, NT, + and 2000. Bugzilla works fine on Win32 platforms, but please remember + that the Bugzilla team and the author of the Guide neither endorse nor + support installation on Microsoft Windows. Bugzilla installs and runs + best and easiest on UNIX-like operating systems, and that is the way + it will stay for the foreseeable future. The Bugzilla team is + considering supporting Win32 for the 2.16 release and later. + + The easiest way to install Bugzilla on Intel-archiecture machines is + to install some variant of GNU/Linux, then follow the UNIX + installation instructions in this Guide. If you have any influence in + the platform choice for running this system, please choose GNU/Linux + instead of Microsoft Windows. _________________________________________________________________ -2.2.1. Win32 Installation: Step-by-step +3.6.1. Win32 Installation: Step-by-step - Note: You should be familiar with, and cross-reference, the UNIX - README while performing your Win32 installation. Unfortunately, - Win32 directions are not yet as detailed as those for UNIX. + Note - The most critical difference for Win32 users is the lack of support - for a crypt() function in MySQL for Windows. It does not have it! - All ENCRYPT statements must be modified. + You should be familiar with, and cross-reference, the rest of the + Chapter 3 section while performing your Win32 installation. + Making Bugzilla work on Microsoft Windows is no picnic. Support for + Win32 has improved dramatically in the last few releases, but, if you + choose to proceed, you should be a very skilled Windows Systems + Administrator with both strong troubleshooting abilities and a high + tolerance for pain. Bugzilla on NT requires hacking source code and + implementing some advanced utilities. What follows is the recommended + installation procedure for Win32; additional suggestions are provided + in The Bugzilla FAQ. 1. Install Apache Web Server for Windows. - Note: You may also use Internet Information Server or Personal Web - Server for this purpose. However, setup is slightly more difficult. - If ActivePerl doesn't seem to handle your file associations - correctly (for .cgi and .pl files), please consult the FAQ, in the - "Win32" section. - If you are going to use IIS, if on Windows NT you must be updated - to at least Service Pack 4. - 2. Install ActivePerl + Note + + You may also use Internet Information Server or Personal Web Server + for this purpose. However, setup is slightly more difficult. If + ActivePerl doesn't seem to handle your file associations correctly + (for .cgi and .pl files), please consult The Bugzilla FAQ. + If you are going to use IIS, if on Windows NT you must be updated to + at least Service Pack 4. Windows 2000 ships with a sufficient version + of IIS. + 2. Install ActivePerl for Windows. Check + http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a + current compiled binary. Please also check the following links to fully understand the - status of ActivePerl on Win32: Perl Porting, and Hixie Click Here + status of ActivePerl on Win32: Perl Porting, and Perl on Win32 FAQ 3. Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need to extract them from .zip format using Winzip or other unzip program first. These additional ppm modules can be downloaded from ActiveState. - The syntax for ppm is: C:> ppm install <module>.ppd + + Note + + You can find a list of modules at + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ + The syntax for ppm is: C:> ppm <modulename> + Example 3-3. Installing ActivePerl ppd Modules on Microsoft + Windows + C:>ppm DBD-Mysql + Watch your capitalization! You can find ActiveState ppm modules at http://www.activestate.com/PPMPackages/5.6plus - 4. Download and install the Windows GNU tools from www.cygwin.com. - Make sure the GNU utilities are in your $PATH. - 5. Install MySQL for NT. + 4. Install MySQL for NT. + + Note - Note: Your configuration file for MySQL must be named C:\MY.CNF. - 6. Setup MySQL + You can download MySQL for Windows NT from MySQL.com. Some find it + helpful to use the WinMySqlAdmin utility, included with the download, + to set up the database. + 5. Setup MySQL a. C:> C:\mysql\bin\mysql -u root mysql b. mysql> DELETE FROM user WHERE Host='localhost' AND User=''; c. mysql> UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; + "new_password", above, indicates whatever password you wish + to use for your "root" user. d. mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost IDENTIFIED BY 'bugs_password'; + "bugs_password", above, indicates whatever password you wish + to use for your "bugs" user. e. mysql> FLUSH PRIVILEGES; f. mysql> create database bugs; - g. mysql> exit + g. mysql> exit; h. C:> C:\mysql\bin\mysqladmin -u root -p reload - 7. Configure Bugzilla. For Win32, this involves editing - "defparams.pl" and "localconfig" to taste. Running "checksetup.pl" - should create localconfig for you. Note that getgrnam() doesn't - work, and should be deleted. Change this line: "my $webservergid = - getgrnam($my_webservergroup); " to "my $webservergid = - $my_webservergroup; " - 8. - - Note: There are several alternatives to Sendmail that will work on - Win32. The one mentioned here is a suggestion, not a requirement. - Some other mail packages that can work include BLAT, Windmail, - Mercury Sendmail, and the CPAN Net::SMTP Perl module (available in - .ppm). Every option requires some hacking of the Perl scripts for - Bugzilla to make it work. The option here simply requires the - least. - Download NTsendmail, available from www.ntsendmail.com. In order - for it to work, you must set up some new environment variables - (detailed on the ntsendmail home page). Figuring out where to put - those variables is left as an exercise for the reader. You must - have a "real" mail server which allows you to relay off it in your - $ENV{"NTsendmail"} (which you should probably place in globals.pl) - Once downloaded and installed, modify all open(SENDMAIL) calls to - open "| c:\ntsendmail\ntsendmail -t" instead of - "|/usr/lib/sendmail -t". - - Note: We need someone to test this and make sure this works as - advertised. - 9. Modify globals.pl and CGI.pl to remove the word "encrypt". - - Note: I'm not sure this is all that is involved to remove crypt. - Any NT Bugzilla hackers want to pipe up? - 10. Change all references to "processmail" to "processmail.pl" in all - files, and rename "processmail" to "processmail.pl" - - Note: I really think this may be a change we want to make for - main-tree Bugzilla. It's painless for the UNIX folks, and will make - the Win32 people happier. - 11. Modify the path to perl on the first line (#!) of all files to + 6. Edit checksetup.pl in your Bugzilla directory. Change this line: + "my $webservergid = getgrnam($my_webservergroup); " + to + "my $webservergid = $my_webservergroup; " + 7. Run checksetup.pl from the Bugzilla directory. + 8. Edit localconfig to suit your requirements. Set $db_pass to your + "bugs_password" from step 5.d, and $webservergroup to "8". + + Note + + Not sure on the "8" for $webservergroup above. If it's wrong, please + send corrections. + 9. Edit defparams.pl to suit your requirements. Particularly, set + DefParam("maintainer") and DefParam("urlbase") to match your + install. + + Note + + This is yet another step I'm not sure of, since the maintainer of this + documentation does not maintain Bugzilla on NT. If you can confirm or + deny that this step is required, please let me know. + 10. + + Note + + There are several alternatives to Sendmail that will work on Win32. + The one mentioned here is a suggestion, not a requirement. Some other + mail packages that can work include BLAT, Windmail, Mercury Sendmail, + and the CPAN Net::SMTP Perl module (available in .ppm). Every option + requires some hacking of the Perl scripts for Bugzilla to make it + work. The option here simply requires the least. + 1. Download NTsendmail, available from www.ntsendmail.com. You + must have a "real" mail server which allows you to relay off + it in your $ENV{"NTsendmail"} (which you should probably + place in globals.pl) + 2. Put ntsendmail.pm into your .\perl\lib directory. + 3. Add to globals.pl: + +# these settings configure the NTsendmail process +use NTsendmail; +$ENV{"NTsendmail"}="your.smtpserver.box"; +$ENV{"NTsendmail_debug"}=1; +$ENV{"NTsendmail_max_tries"}=5; + + + Note + + Some mention to also edit $db_pass in globals.pl to be your + "bugs_password". Although this may get you around some problem + authenticating to your database, since globals.pl is not normally + restricted by .htaccess, your database password is exposed to whoever + uses your web server. + 4. Find and comment out all occurences of "open(SENDMAIL" in + your Bugzilla directory. Then replace them with: + +# new sendmail functionality +my $mail=new NTsendmail; +my $from="bugzilla\@your.machine.name.tld"; +my $to=$login; +my $subject=$urlbase; +$mail->send($from,$to,$subject,$msg); + + Note + + The code above needs testing as well to make sure it is correct. + 11. Change all references in all files from processmail to + processmail.pl, and rename processmail to processmail.pl. + + Note + + Many think this may be a change we want to make for main-tree + Bugzilla. It's painless for the UNIX folks, and will make the Win32 + people happier. + + Note + + Some people have suggested using the Net::SMTP Perl module instead of + NTsendmail or the other options listed here. You can change + processmail.pl to make this work. +my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP ser +ver +$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here +$smtp->to($tolist); # recipient's address +$smtp->data(); # Start the mail +$smtp->datasend($msg); +$smtp->dataend(); # Finish sending the mail +$smtp->quit; # Close the SMTP connection +$logstr = "$logstr; mail sent to $tolist $cclist"; +} + + here is a test mail program for Net::SMTP: +use Net::SMTP; + my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug +=> 1, ); # connect to SMTP server + $smtp->auth; + $smtp->mail('you@yourcompany.com');# use the sender's adress +here + $smtp->to('someotherAddress@someotherdomain.com'); # +recipient's address + $smtp->data(); # Start the mail + $smtp->datasend('test'); + $smtp->dataend(); # Finish sending the mail + $smtp->quit; # Close the SMTP connection +exit; + + 12. + + Note + + This step is completely optional if you are using IIS or another web + server which only decides on an interpreter based upon the file + extension (.pl), rather than the "shebang" line + (#/usr/bonsaitools/bin/perl) + Modify the path to perl on the first line (#!) of all files to point to your Perl installation, and add "perl" to the beginning of all Perl system calls that use a perl script as an argument. - This may take you a while. There is a "setperl.pl" utility to - speed part of this procedure, available in the "Patches and - Utilities" section of The Bugzilla Guide. - 12. In processmail.pl, add "binmode(HANDLE)" before all read() calls. - This may not be necessary, but in some cases the read() under - Win32 doesn't count the EOL's without using a binary read(). + This may take you a while. There is a "setperl.csh" utility to + speed part of this procedure, available in the Useful Patches and + Utilities for Bugzilla section of The Bugzilla Guide. However, it + requires the Cygwin GNU-compatible environment for Win32 be set up + in order to work. See http://www.cygwin.com/ for details on + obtaining Cygwin. + 13. Modify the invocation of all system() calls in all perl scripts in + your Bugzilla directory. For instance, change this line in + processmail: + +system ("./processmail.pl",@ARGLIST); + + + to + +system ("perl processmail.pl",@ARGLIST); + + + Tip + + If you are using IIS 5.0 or higher, you must add cgi relationships to + Properties -> Home directory (tab) -> Application Settings (section) + -> Configuration (button), such as: + +.cgi to: <perl install directory>\perl.exe %s %s +.pl to: <perl install directory>\perl.exe %s %s +GET,HEAD,POST + + Change the path to Perl to match your install, of course. _________________________________________________________________ -2.2.2. Additional Windows Tips +3.6.2. Additional Windows Tips - Tip: From Andrew Pearson: + Tip + + From Andrew Pearson: "You can make Bugzilla work with Personal Web Server for Windows 98 and higher, as well as for IIS 4.0. Microsoft has information @@ -1129,8 +2057,10 @@ bash# ./checksetup.pl The KB article only talks about .pl, but it goes into more detail and provides a perl test script. - Tip: "Brian" had this to add, about upgrading to Bugzilla 2.12 from - previous versions: + Tip + + "Brian" had this to add, about upgrading to Bugzilla 2.12 from + previous versions: Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I deleted the current dir and copied the files in). @@ -1149,7 +2079,7 @@ my $webservergid = 'Administrators' 2. I then ran checksetup.pl 3. I removed all the encrypt() - Example 2-3. Removing encrypt() for Windows NT installations + Example 3-4. Removing encrypt() for Windows NT installations Replace this: SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . @@ -1173,77 +2103,77 @@ log"; The quotes around the dir is for the spaces. mail.log is for the output - Tip: This was some late breaking information from Jan Evert. Sorry - for the lack of formatting. - - I'm busy installing bugzilla on a WinNT machine and I thought I'd n - otify you - at this moment of the commments I have to section 2.2.1 of the bugz - illa - guide (at http://www.trilobyte.net/barnsons/html/). - Step 1: - I've used apache, installation is really straightforward. - After reading the Unix installation instructions, I found that it i - s - necessary to add the ExecCGI option to the bugzilla directory. Also - the - 'AddHandler' line for .cgi is by default commented out. - Step 3: although just a detail, 'ppm install <module%gt;' will also - work - (wihtout .ppd). And, it can also download these automatically from - ActiveState. - Step 4: although I have cygwin installed, it seems that it is not n - ecessary. - On my machine cygwin is not in the PATH and everything seems to wor - k as - expected. - However, I've not used everything yet. - Step 6: the 'bugs_password' given in SQL command d needs to be edit - ed into - localconfig later on (Step 7) if the password is not empty. I've al - so edited - it into globals.pl, but I'm not sure that is needed. In both places - , the - variable is named db_pass. - Step 8: all the sendmail replacements mentioned are not as simple a - s - described there. Since I am not familiar (yet) with perl, I don't h - ave any - mail working yet. - Step 9: in globals.pl the encrypt() call can be replaced by just th - e - unencrypted password. In CGI.pl, the complete SQL command can be re - moved. - Step 11: I've only changed the #! lines in *.cgi. I haven't noticed - problems - with the system() call yet. - There seem to be only four system() called programs: processmail.pl - (handled - by step 10), syncshadowdb (which should probably get the same treat - ment as - processmail.pl), diff and mysqldump. The last one is only needed wi - th the - shadowdb feature (which I don't use). - There seems to be one step missing: copying the bugzilla files some - hwere - that apache can serve them. - Just noticed the updated guide... Brian's comment is new. His first - comment - will work, but opens up a huge security hole. + Tip + + This was some late breaking information from Jan Evert. Sorry for the + lack of formatting. + + I'm busy installing bugzilla on a WinNT machine and I thought I'd noti + fy you + at this moment of the commments I have to section 2.2.1 of the bugzill + a + guide (at http://www.trilobyte.net/barnsons/html/). + Step 1: + I've used apache, installation is really straightforward. + After reading the Unix installation instructions, I found that it is + necessary to add the ExecCGI option to the bugzilla directory. Also th + e + 'AddHandler' line for .cgi is by default commented out. + Step 3: although just a detail, 'ppm install <module%gt;' will also wo + rk + (without .ppd). And, it can also download these automatically from + ActiveState. + Step 4: although I have cygwin installed, it seems that it is not nece + ssary. + On my machine cygwin is not in the PATH and everything seems to work a + s + expected. + However, I've not used everything yet. + Step 6: the 'bugs_password' given in SQL command d needs to be edited + into + localconfig later on (Step 7) if the password is not empty. I've also + edited + it into globals.pl, but I'm not sure that is needed. In both places, t + he + variable is named db_pass. + Step 8: all the sendmail replacements mentioned are not as simple as + described there. Since I am not familiar (yet) with perl, I don't have + any + mail working yet. + Step 9: in globals.pl the encrypt() call can be replaced by just the + unencrypted password. In CGI.pl, the complete SQL command can be remov + ed. + Step 11: I've only changed the #! lines in *.cgi. I haven't noticed pr + oblems + with the system() call yet. + There seem to be only four system() called programs: processmail.pl (h + andled + by step 10), syncshadowdb (which should probably get the same treatmen + t as + processmail.pl), diff and mysqldump. The last one is only needed with + the + shadowdb feature (which I don't use). + There seems to be one step missing: copying the bugzilla files somehwe + re + that apache can serve them. + Just noticed the updated guide... Brian's comment is new. His first co + mment + will work, but opens up a huge security hole. _________________________________________________________________ -Chapter 3. Administering Bugzilla +Chapter 4. Administering Bugzilla Or, I just got this cool thing installed. Now what the heck do I do with it? - So you followed the README isntructions to the letter, and just logged - into bugzilla with your super-duper god account and you are sitting at - the query screen. Yet, you have nothing to query. Your first act of - business needs to be to setup the operating parameters for bugzilla. + So you followed the installation instructions to the letter, and just + logged into bugzilla with your super-duper god account and you are + sitting at the query screen. Yet, you have nothing to query. Your + first act of business needs to be to setup the operating parameters + for bugzilla. _________________________________________________________________ -3.1. Post-Installation Checklist +4.1. Post-Installation Checklist After installation, follow the checklist below to ensure that you have a successful installation. If you do not see a recommended setting for @@ -1260,10 +2190,10 @@ Chapter 3. Administering Bugzilla If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi, your url base is http://www.foo.com/bugzilla/ - 4. Set "usebuggroups" to "1" only if you need to restrict access to + 4. Set "usebuggroups" to "on" only if you need to restrict access to products. I suggest leaving this parameter off while initially testing your Bugzilla. - 5. Set "usebuggroupsentry" to "1" if you want to restrict access to + 5. Set "usebuggroupsentry" to "on" if you want to restrict access to products. Once again, if you are simply testing your installation, I suggest against turning this parameter on; the strict security checking may stop you from being able to modify your new entries. @@ -1272,9 +2202,11 @@ Chapter 3. Administering Bugzilla simultaneous users to read and write to the database without interfering with one another. - Note: Enabling "shadowdb" can adversely affect the stability of - your installation of Bugzilla. You may frequently need to manually - synchronize your databases, or schedule nightly syncs via "cron" + Note + + Enabling "shadowdb" can adversely affect the stability of your + installation of Bugzilla. You may frequently need to manually + synchronize your databases, or schedule nightly syncs via "cron" Once again, in testing you should avoid this option -- use it if or when you need to use it, and have repeatedly run into the problem it was designed to solve -- very long wait times while @@ -1288,17 +2220,19 @@ Chapter 3. Administering Bugzilla "headerhtml", "footerhtml", "errorhtml", "bannerhtml", or "blurbhtml" text boxes. - Note: The "headerhtml" text box is the HTML printed out before any - other code on the page. If you have a special banner, put the code - for it in "bannerhtml". You may want to leave these settings at the - defaults initially. + Note + + The "headerhtml" text box is the HTML printed out before any other + code on the page. If you have a special banner, put the code for it in + "bannerhtml". You may want to leave these settings at the defaults + initially. 8. Add any text you wish to the "passwordmail" parameter box. For instance, many people choose to use this box to give a quick training blurb about how to use Bugzilla at your site. 9. Ensure "newemailtech" is "on". Your users will thank you. This is the default in the post-2.12 world, and is only an issue if you are upgrading. - 10. Do you want to use the qa contact ("useqacontact") and status + 10. Do you want to use the QA Contact ("useqacontact") and status whiteboard ("usestatuswhiteboard") fields? These fields are useful because they allow for more flexibility, particularly when you have an existing Quality Assurance and/or Release Engineering @@ -1306,17 +2240,18 @@ Chapter 3. Administering Bugzilla 11. Set "whinedays" to the amount of days you want to let bugs go in the "New" or "Reopened" state before notifying people they have untouched new bugs. If you do not plan to use this feature, simply - do not set up the whining cron job described in the README, or set - this value to "0". + do not set up the whining cron job described in the installation + instructions, or set this value to "0". 12. Set the "commenton" options according to your site policy. It is a wise idea to require comments when users resolve, reassign, or reopen bugs. - 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!) + 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!) 13. Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their respective areas, and can offer many other benefits, such as allowing a developer to pick up a @@ -1324,13 +2259,13 @@ Chapter 3. Administering Bugzilla information in the bug. _________________________________________________________________ -3.2. User Administration +4.2. User Administration User administration is one of the easiest parts of Bugzilla. Keeping it from getting out of hand, however, can become a challenge. _________________________________________________________________ -3.2.1. Creating the Default User +4.2.1. Creating the Default User When you first run checksetup.pl after installing Bugzilla, it will prompt you for the administrative username (email address) and @@ -1338,17 +2273,18 @@ Chapter 3. Administering Bugzilla the "super user" account, re-running checksetup.pl will again prompt you for this username and password. - Tip: If you wish to add more administrative users, you must use the - MySQL interface. Run "mysql" from the command line, and use these - commands ("mysql>" denotes the mysql prompt, not something you - should type in): mysql> use bugs; mysql> update profiles set - groupset=0x7ffffffffffffff where login_name = "(user's login - name)"; + Tip + + If you wish to add more administrative users, you must use the MySQL + interface. Run "mysql" from the command line, and use these commands + ("mysql>" denotes the mysql prompt, not something you should type in): + mysql> use bugs; mysql> update profiles set groupset=0x7ffffffffffffff + where login_name = "(user's login name)"; _________________________________________________________________ -3.2.2. Managing Other Users +4.2.2. Managing Other Users -3.2.2.1. Logging In +4.2.2.1. Logging In 1. Open the index.html page for your Bugzilla installation in your browser window. @@ -1360,7 +2296,7 @@ Chapter 3. Administering Bugzilla Congratulations, you are logged in! _________________________________________________________________ -3.2.2.2. Creating new users +4.2.2.2. Creating new users Your users can create their own user accounts by clicking the "New Account" link at the bottom of each page. However, should you desire @@ -1373,25 +2309,29 @@ Chapter 3. Administering Bugzilla the "submit" button. You must click "submit" here to be able to add a new user. - Tip: More functionality is available via the list on the right-hand - side of the text entry box. You can match what you type as a - case-insensitive substring (the default) of all users on your - system, a case-sensitive regular expression (please see the "man - regexp" manual page for details on regular expression syntax), or a - reverse regular expression match, where every user name which does - NOT match the regular expression is selected. + Tip + + More functionality is available via the list on the right-hand side of + the text entry box. You can match what you type as a case-insensitive + substring (the default) of all users on your system, a case-sensitive + regular expression (please see the "man regexp" manual page for + details on regular expression syntax), or a reverse regular expression + match, where every user name which does NOT match the regular + expression is selected. 3. Click the "Add New User" link at the bottom of the user list 4. Fill out the form presented. This page is self-explanatory. When done, click "submit". - Note: Adding a user this way will not send an email informing them - of their username and password. 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. + Note + + Adding a user this way will not send an email informing them of their + username and password. 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. _________________________________________________________________ -3.2.2.3. Disabling Users +4.2.2.3. Disabling Users I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen, when you edit an account? By entering any @@ -1405,17 +2345,19 @@ Chapter 3. Administering Bugzilla Don't disable your own administrative account, or you will hate life! _________________________________________________________________ -3.2.2.4. Modifying Users +4.2.2.4. Modifying Users Here I will attempt to describe the function of each option on the - user edit screen. + Edit User screen. * Login Name: This is generally the user's email address. However, if you have edited your system parameters, this may just be the user's login name or some other identifier. - Tip: For compatability reasons, you should probably stick with - email addresses as user login names. It will make your life easier. + Tip + + For compatability reasons, you should probably stick with email + addresses as user login names. It will make your life easier. * Real Name: Duh! * Password: You will only see asterisks in versions of Bugzilla newer than 2.10 or early 2.11. You can change the user password @@ -1423,34 +2365,38 @@ Chapter 3. Administering Bugzilla * Email Notification: You may choose from one of three options: 1. All qualifying bugs except those which I change: The user will be notified of any change to any bug for which she is - the reporter, assignee, Q/A contact, CC recipient, or + the reporter, assignee, QA Contact, CC recipient, or "watcher". 2. Only those bugs which I am listed on the CC line: The user will not be notified of changes to bugs where she is the - assignee, reporter, or Q/A contact, but will receive them if + assignee, reporter, or QA Contact, but will receive them if she is on the CC list. - Note: She will still receive whining cron emails if you set up the - "whinemail" feature. + Note + + She will still receive whining cron emails if you set up the + "whinemail" feature. 3. All Qualifying Bugs: This user is a glutton for punishment. - If her name is in the reporter, Q/A contact, CC, assignee, or + If her name is in the reporter, QA Contact, CC, assignee, or is a "watcher", she will get email updates regarding the bug. Disable Text: If you type anything in this box, including just a space, the user account is disabled from making any changes to bugs via the web interface, and what you type in this box is presented as the reason. - Warning - Don't disable the administrator account! + Warning + + Don't disable the administrator account! - Note: As of this writing, the user can still submit bugs via the - e-mail gateway, if you set it up, despite the disabled text field. - The e-mail gateway should not be enabled for secure installations - of Bugzilla. + Note + + As of this writing, the user can still submit bugs via the e-mail + gateway, if you set it up, despite the disabled text field. The e-mail + gateway should not be enabled for secure installations of Bugzilla. * CanConfirm: This field is only used if you have enabled "unconfirmed" status in your parameters screen. If you enable this for a user, that user can then move bugs from "Unconfirmed" to - "Confirmed" status (ergo: "New" status). Be judicious about + "Confirmed" status (e.g.: "New" status). Be judicious about allowing users to turn this bit on for other users. * Creategroups: This option will allow a user to create and destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry @@ -1459,9 +2405,11 @@ Chapter 3. Administering Bugzilla * Editbugs: Unless a user has this bit set, they can only edit those bugs for which they are the assignee or the reporter. - Note: Leaving this option unchecked does not prevent users from - adding comments to a bug! They simply cannot change a bug priority, - severity, etc. unless they are the assignee or reporter. + Note + + Leaving this option unchecked does not prevent users from adding + comments to a bug! They simply cannot change a bug priority, severity, + etc. unless they are the assignee or reporter. * Editcomponents: This flag allows a user to create new products and components, as well as modify and destroy those that have no bugs associated with them. If a product or component has bugs @@ -1492,14 +2440,14 @@ Chapter 3. Administering Bugzilla are using bug groups, this option has no effect. _________________________________________________________________ -3.3. Product, Component, Milestone, and Version Administration +4.3. Product, Component, Milestone, and Version Administration Dear Lord, we have to get our users to do WHAT? _________________________________________________________________ -3.3.1. Products +4.3.1. Products Formerly, and in some spots still, called "Programs" @@ -1514,61 +2462,66 @@ Chapter 3. Administering Bugzilla most important bugs is set per-product, as is the number of votes required to move a bug automatically from the UNCONFIRMED status to the NEW status. One can close a Product for further bug entry and - define various Versions available from the Edit Product screen. + define various Versions available from the Edit product screen. To create a new product: 1. Select "components" from the yellow footer - Tip: It may seem counterintuitive to click "components" when you - want to edit the properties associated with Products. This is one - of a long list of things we want in Bugzilla 3.0... + Tip + + It may seem counterintuitive to click "components" when you want to + edit the properties associated with Products. This is one of a long + list of things we want in Bugzilla 3.0... 2. Select the "Add" link to the right of "Add a new product". 3. Enter the name of the product and a description. The Description field is free-form. - Tip: Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single bug", - "Number of votes a bug in this Product needs to automatically get - out of the UNCOMFIRMED state", and "Version" options yet. We'll - cover those in a few moments. + Tip + + Don't worry about the "Closed for bug entry", "Maximum Votes per + person", "Maximum votes a person can put on a single bug", "Number of + votes a bug in this Product needs to automatically get out of the + UNCOMFIRMED state", and "Version" options yet. We'll cover those in a + few moments. _________________________________________________________________ -3.3.2. Components +4.3.2. Components Components are subsections of a Product. - Example 3-1. Creating some Components + Example 4-1. Creating some Components - The computer game you are designing may a "UI" component, an "API" - component, a "Sound System" component, and a "Plugins" component, each - overseen by a different programmer. It often makes sense to divide - Components in Bugzilla according to the natural divisions of - responsibility within your Product or company. + The computer game you are designing may have a "UI" component, an + "API" component, a "Sound System" component, and a "Plugins" + component, each overseen by a different programmer. It often makes + sense to divide Components in Bugzilla according to the natural + divisions of responsibility within your Product or company. Each component has a owner and (if you turned it on in the - parameters), a qa contact. The owner should be the primary person who + parameters), a QA Contact. The owner should be the primary person who fixes bugs in that component. The QA Contact should be the person who will ensure these bugs are completely fixed. The Owner, QA Contact, and Reporter will get email when new bugs are created in this Component and when these bugs change. Default Owner and Default QA - Contact fields only dictate the default assignments; the Owner and Q/A + Contact fields only dictate the default assignments; the Owner and QA Contact fields in a bug are otherwise unrelated to the Component. To create a new Component: - 1. Select the "Edit components" link from the "Edit Product" page + 1. Select the "Edit components" link from the "Edit product" page 2. Select the "Add" link to the right of the "Add a new component" text on the "Select Component" page. 3. Fill out the "Component" field, a short "Description", and the - "Initial Owner". The "Component" field should not contain a space. - The "Description" field is free-form. The "Initial Owner" field - must be that of a valid user already existing in the database. If - the initial owner does not exist, Bugzilla will refuse to create - the component. - - Tip: Is your "Default Owner" a user who is not yet in the database? - No problem. + "Initial Owner". The Component and Description fields are + free-form; the "Initial Owner" field must be that of a user ID + already existing in the database. If the initial owner does not + exist, Bugzilla will refuse to create the component. + + Tip + + Is your "Default Owner" a user who is not yet in the database? No + problem. a. Select the "Log out" link on the footer of the page. b. Select the "New Account" link on the footer of the "Relogin" page @@ -1579,18 +2532,18 @@ Chapter 3. Administering Bugzilla and you can modify the product to use the Default Owner information you require. - 4. Either "edit" more components or return to the "query" page on the - ensuing "Addming new component" page. To return to the Product you - were editing, you must select the "components" link as before. + 4. Either Edit more components or return to the Bugzilla Query Page. + To return to the Product you were editing, you must select the + Components link as before. _________________________________________________________________ -3.3.3. Versions +4.3.3. Versions Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", and "Flinders 2000". Using Versions helps you isolate code changes and are an aid in reporting. - Example 3-2. Common Use of Versions + Example 4-2. Common Use of Versions A user reports a bug against Version "Beta 2.0" of your product. The current Version of your software is "Release Candidate 1", and no @@ -1600,7 +2553,7 @@ Chapter 3. Administering Bugzilla versions of the software. This can help isolate code changes that caused the bug - Example 3-3. A Different Use of Versions + Example 4-3. A Different Use of Versions This field has been used to good effect by an online service provider in a slightly different way. They had three versions of the product: @@ -1613,7 +2566,7 @@ Chapter 3. Administering Bugzilla To create and edit Versions: - 1. From the "Edit Product" screen, select "Edit Versions" + 1. From the "Edit product" screen, select "Edit Versions" 2. You will notice that the product already has the default version "undefined". If your product doesn't use version numbers, you may want to leave this as it is or edit it so that it is "---". You @@ -1629,16 +2582,17 @@ Chapter 3. Administering Bugzilla page. _________________________________________________________________ -3.3.4. Milestones +4.3.4. Milestones Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a bug that you plan to fix for 2.8, this would have a milestone of 2.8. - Note: Milestone options will only appear for a Product if you - turned the "usetargetmilestone" field in the "Edit Parameters" - screen "On". + Note + + Milestone options will only appear for a Product if you turned the + "usetargetmilestone" field in the "Edit Parameters" screen "On". To create new Milestones, set Default Milestones, and set Milestone URL: @@ -1649,7 +2603,7 @@ Chapter 3. Administering Bugzilla optionally set the "Sortkey", which is a positive or negative number (-255 to 255) that defines where in the list this particular milestone appears. Select "Add". - Example 3-4. Using SortKey with Target Milestone + Example 4-4. Using SortKey with Target Milestone Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". Later, you realize that you will have a public beta, called "Beta1". You can create a Milestone called "Beta1", @@ -1660,13 +2614,14 @@ Chapter 3. Administering Bugzilla select "components" again, and make your way back to the Product you were editing. - Note: This is another in the list of unusual user interface - decisions that we'd like to get cleaned up. Shouldn't there be a - link to the effect of "edit the Product I was editing when I ended - up here"? In any case, clicking "components" in the footer takes - you back to the "Select product" screen, from which you can begin - editing your product again. - 5. From the Edit Product screen again (once you've made your way + Note + + This is another in the list of unusual user interface decisions that + we'd like to get cleaned up. Shouldn't there be a link to the effect + of "edit the Product I was editing when I ended up here"? In any case, + clicking "components" in the footer takes you back to the "Select + product" screen, from which you can begin editing your product again. + 5. From the Edit product screen again (once you've made your way back), enter the URL for a description of what your milestones are for this product in the "Milestone URL" field. It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" @@ -1680,10 +2635,9 @@ Chapter 3. Administering Bugzilla Milestone field is a powerful tool when reporting the status of projects. Select the "Update" button when you are done. - 7. _________________________________________________________________ -3.3.5. Voting +4.3.5. Voting The concept of "voting" is a poorly understood, yet powerful feature for the management of open-source projects. Each user is assigned so @@ -1704,7 +2658,7 @@ Chapter 3. Administering Bugzilla To modify Voting settings: - 1. Navigate to the "Edit Product" screen for the Product you wish to + 1. Navigate to the "Edit product" screen for the Product you wish to modify 2. Set "Maximum Votes per person" to your calculated value. Setting this field to "0" disables voting. @@ -1720,22 +2674,24 @@ Chapter 3. Administering Bugzilla of what use are Votes if your Bugzilla user base is unable to affect which bugs appear on Development radar? - Tip: You should probably set this number to higher than a small - coalition of Bugzilla users can influence it. Most sites use this - as a "referendum" mechanism -- if users are able to vote a bug out - of UNCONFIRMED, it is a really bad bug! + Tip + + You should probably set this number to higher than a small coalition + of Bugzilla users can influence it. Most sites use this as a + "referendum" mechanism -- if users are able to vote a bug out of + UNCONFIRMED, it is a really bad bug! 5. Once you have adjusted the values to your preference, select the "Update" button. _________________________________________________________________ -3.3.6. Groups and Group Security +4.3.6. Groups and Group Security Groups can be very useful in bugzilla, because they allow users to isolate bugs or products that should only be seen by certain people. Groups can also be a complicated minefield of interdependencies and weirdness if mismanaged. - Example 3-5. When to Use Group Security + Example 4-5. When to Use Group Security Many Bugzilla sites isolate "Security-related" bugs from all other bugs. This way, they can have a fix ready before the security @@ -1754,30 +2710,31 @@ Chapter 3. Administering Bugzilla security in Bugzilla can be divided into two categories: Generic and Product-Based. - Note: Groups in Bugzilla are a complicated beast that evolved out - of very simple user permission bitmasks, apparently itself derived - from common concepts in UNIX access controls. A "bitmask" is a - fixed-length number whose value can describe one, and only one, set - of states. For instance, UNIX file permissions are assigned bitmask - values: "execute" has a value of 1, "write" has a value of 2, and - "read" has a value of 4. Add them together, and a file can be read, - written to, and executed if it has a bitmask of "7". (This is a - simplified example -- anybody who knows UNIX security knows there - is much more to it than this. Please bear with me for the purpose - of this note.) The only way a bitmask scheme can work is by - doubling the bit count for each value. Thus if UNIX wanted to offer - another file permission, the next would have to be a value of 8, - then the next 16, the next 32, etc. - - Similarly, Bugzilla offers a bitmask to define group permissions, - with an internal limit of 64. Several are already occupied by - built-in permissions. The way around this limitation is to avoid - assigning groups to products if you have many products, avoid - bloating of group lists, and religiously prune irrelevant groups. - In reality, most installations of Bugzilla support far fewer than - 64 groups, so this limitation has not hit for most sites, but it is - on the table to be revised for Bugzilla 3.0 because it interferes - with the security schemes of some administrators. + Note + + Groups in Bugzilla are a complicated beast that evolved out of very + simple user permission bitmasks, apparently itself derived from common + concepts in UNIX access controls. A "bitmask" is a fixed-length number + whose value can describe one, and only one, set of states. For + instance, UNIX file permissions are assigned bitmask values: "execute" + has a value of 1, "write" has a value of 2, and "read" has a value of + 4. Add them together, and a file can be read, written to, and executed + if it has a bitmask of "7". (This is a simplified example -- anybody + who knows UNIX security knows there is much more to it than this. + Please bear with me for the purpose of this note.) The only way a + bitmask scheme can work is by doubling the bit count for each value. + Thus if UNIX wanted to offer another file permission, the next would + have to be a value of 8, then the next 16, the next 32, etc. + + Similarly, Bugzilla offers a bitmask to define group permissions, with + an internal limit of 64. Several are already occupied by built-in + permissions. The way around this limitation is to avoid assigning + groups to products if you have many products, avoid bloating of group + lists, and religiously prune irrelevant groups. In reality, most + installations of Bugzilla support far fewer than 64 groups, so this + limitation has not hit for most sites, but it is on the table to be + revised for Bugzilla 3.0 because it interferes with the security + schemes of some administrators. To enable Generic Group Security ("usebuggroups"): @@ -1791,15 +2748,15 @@ Chapter 3. Administering Bugzilla and "New User RegExp" fields. "New User RegExp" allows you to automatically place all users who fulfill the Regular Expression into the new group. - Example 3-6. Creating a New Group - I created a group called "DefaultGroup" with a description of - "This is simply a group to play with", and a "New User RegExp" of - "*@velio.com". This new group automatically includes all Bugzilla - users with "@velio.com" at the end of their user id. When I - finished, my new group was assigned bit #128. - When you have finished, select the "Add" button. + Example 4-6. Creating a New Group + I created a group called DefaultGroup with a description of "This + is simply a group to play with", and a New User RegExp of + ".*@mydomain.tld". This new group automatically includes all + Bugzilla users with "@mydomain.tld" at the end of their user id. + When I finished, my new group was assigned bit #128. + When you have finished, select the Add button. - To enable Product-Based Group Security ("usebuggroupsentry"): + To enable Product-Based Group Security (usebuggroupsentry): Warning @@ -1813,7 +2770,8 @@ Chapter 3. Administering Bugzilla 1. Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. - Warning + Warning + "usebuggroupsentry" has the capacity to prevent the administrative user from directly altering bugs because of conflicting group permissions. If you plan on using "usebuggroupsentry", you should plan @@ -1830,7 +2788,7 @@ Chapter 3. Administering Bugzilla to add them to the group available under the "Edit User" screens. _________________________________________________________________ -3.4. Bugzilla Security +4.4. Bugzilla Security @@ -1838,24 +2796,28 @@ Chapter 3. Administering Bugzilla on the fact that no one knows that you hide your money in a mayonnaise jar in your fridge. - Note: Poorly-configured MySQL, Bugzilla, and FTP 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 + + Poorly-configured MySQL, Bugzilla, and FTP 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. - First thing's first: Secure your installation. + Secure your installation. - Note: These instructions must, of necessity, be somewhat vague - since Bugzilla runs on so many different platforms. If you have - refinements of these directions for specific platforms, please - submit them to mozilla-webtools@mozilla.org + Note + + These instructions must, of necessity, be somewhat vague since + Bugzilla runs on so many different platforms. If you have refinements + of these directions for specific platforms, please submit them to + mozilla-webtools@mozilla.org 1. Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had notable security holes and poorly secured default configuration choices. 2. There is no substitute for understanding the tools on your system! - Read The MySQL Privelege System until you can recite it from + Read The MySQL Privilege System until you can recite it from memory! At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant table rights (consult the @@ -1869,6 +2831,15 @@ Chapter 3. Administering Bugzilla 4. Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories. Run it, instead, as a user with a name, set via your httpd.conf file. + + Note + + "nobody" is a real user on UNIX systems. Having a process run as user + id "nobody" is absolutely no protection against system crackers versus + using any other user account. As a general security measure, I + recommend you create unique user ID's for each daemon running on your + system and, if possible, use "chroot" to jail that process away from + the rest of your system. 5. Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig and @@ -1882,22 +2853,23 @@ Chapter 3. Administering Bugzilla directories and this file, you will expose bug information to those who may not be allowed to see it. - Note: Bugzilla provides default .htaccess files to protect the most - common Apache installations. However, you should verify these are - adequate according to the site-wide security policy of your web - server, and ensure that the .htaccess files are allowed to - "override" default permissions set in your Apache configuration - files. Covering Apache security is beyond the scope of this Guide; - please consult the Apache documentation for details. - If you are using a web server that does not support the .htaccess - control method, you are at risk! After installing, check to see if - you can view the file "localconfig" in your web browser (ergo: - http://bugzilla.mozilla.org/localconfig. If you can read the - contents of this file, your web server has not secured your - bugzilla directory properly and you must fix this problem before - deploying Bugzilla. If, however, it gives you a "Forbidden" error, - then it probably respects the .htaccess conventions and you are - good to go. + Note + + Bugzilla provides default .htaccess files to protect the most common + Apache installations. However, you should verify these are adequate + according to the site-wide security policy of your web server, and + ensure that the .htaccess files are allowed to "override" default + permissions set in your Apache configuration files. Covering Apache + security is beyond the scope of this Guide; please consult the Apache + documentation for details. + If you are using a web server that does not support the .htaccess + control method, you are at risk! After installing, check to see if you + can view the file "localconfig" in your web browser (e.g.: + http://bugzilla.mozilla.org/localconfig). If you can read the contents + of this file, your web server has not secured your bugzilla directory + properly and you must fix this problem before deploying Bugzilla. If, + however, it gives you a "Forbidden" error, then it probably respects + the .htaccess conventions and you are good to go. On Apache, you can use .htaccess files to protect access to these directories, as outlined in Bug 57161 for the localconfig file, and Bug 65572 for adequate protection in your data/ and shadow/ @@ -1908,599 +2880,15 @@ Chapter 3. Administering Bugzilla transmitted to curious users. Place the following text into a file named ".htaccess", readable by your web server, in your $BUGZILLA_HOME/data directory. - <Files comments> - allow from all - </Files> - deny from all - + <Files comments> allow + from all </Files> deny from all Place the following text into a file named ".htaccess", readable by your web server, in your $BUGZILLA_HOME/ directory. - <Files localconfig> - deny from all - </Files> - allow from all - + <Files localconfig> deny + from all </Files> allow from all Place the following text into a file named ".htaccess", readable by your web server, in your $BUGZILLA_HOME/shadow directory. - deny from all - _________________________________________________________________ - -Chapter 4. Using Bugzilla - - - - What, Why, How, & What's in it for me? - _________________________________________________________________ - -4.1. What is Bugzilla? - - Bugzilla is one example of a class of programs called "Defect Tracking - Systems", or, more commonly, "Bug-Tracking Systems". Defect Tracking - Systems allow individual or groups of developers to keep track of - outstanding bugs in their product effectively. Bugzilla was originally - written by Terry Weissman in a programming language called "TCL", to - replace a crappy bug-tracking database used internally for Netscape - Communications. Terry later ported Bugzilla to Perl from TCL, and in - Perl it remains to this day. Most commercial defect-tracking software - vendors at the time charged enormous licensing fees, and Bugzilla - quickly became a favorite of the open-source crowd (with its genesis - in the open-source browser project, Mozilla). It is now the de-facto - standard defect-tracking system against which all others are measured. - - Bugzilla has matured immensely, and now boasts many advanced features. - These include: - - * integrated, product-based granular security schema - * inter-bug dependencies and dependency graphing - * advanced reporting capabilities - * a robust, stable RDBMS back-end - * extensive configurability - * a very well-understood and well-thought-out natural bug resolution - protocol - * email, XML, and HTTP APIs - * available integration with automated software configuration - management systems, including Perforce and CVS. - * too many more features to list - - Despite its current robustness and popularity, however, Bugzilla faces - some near-term challenges, such as reliance on a single database, a - lack of abstraction of the user interface and program logic, verbose - email bug notifications, a powerful but daunting query interface, - little reporting configurability, problems with extremely large - queries, some unsupportable bug resolution options, no - internationalization, and dependence on some nonstandard libraries. - - Some recent headway has been made on the query front, however. If you - are using the latest version of Bugzilla, you should see a "simple - search" form on the default front page of your Bugzilla install. Type - in two or three search terms and you should pull up some relevant - information. This is also available as "queryhelp.cgi". - - Despite these small problems, Bugzilla is very hard to beat. It is - under very active development to address the current issues, and a - long-awaited overhaul in the form of Bugzilla 3.0 is expected sometime - later this year. - _________________________________________________________________ - -4.2. Why Should We Use Bugzilla? - - - - No, Who's on first... - - For many years, defect-tracking software has remained principally the - domain of large software development houses. Even then, most shops - never bothered with bug-tracking software, and instead simply relied - on shared lists and email to monitor the status of defects. This - procedure is error-prone and tends to cause those bugs judged least - significant by developers to be dropped or ignored - - These days, many companies are finding that integrated defect-tracking - systems reduce downtime, increase productivity, and raise customer - satisfaction with their systems. Along with full disclosure, an open - bug-tracker allows manufacturers to keep in touch with their clients - and resellers, to communicate about problems effectively throughout - the data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood system for accounting for unusual system or software - issues. - - But why should you use Bugzilla? - - Bugzilla is very adaptable to various situations. Known uses currently - include IT support queues, Systems Administration deployment - management, chip design and development problem tracking (both - pre-and-post fabrication), and software and hardware bug tracking for - luminaries such as Redhat, Loki software, Linux-Mandrake, and VA - Systems. Combined with systems such as CVS, Bonsai, or Perforce SCM, - Bugzilla provides a powerful, easy-to-use solution to configuration - management and replication problems - - Bugzilla can dramatically increase the productivity and accountability - of individual employees by providing a documented workflow and - positive feedback for good performance. How many times do you wake up - in the morning, remembering that you were supposed to do *something* - today, but you just can't quite remember? Put it in Bugzilla, and you - have a record of it from which you can extrapolate milestones, predict - product versions for integration, and by using Bugzilla's e-mail - integration features be able to 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. - _________________________________________________________________ - -4.3. How do I use Bugzilla? - - - - Hey! I'm Woody! Howdy, Howdy, Howdy! - - Bugzilla is a large, complex system. Describing how to use it requires - some time. If you are only interested in installing or administering a - Bugzilla installation, please consult the Installing and Administering - Bugzilla portions of this Guide. This section is principally aimed - towards developing end-user mastery of Bugzilla, so you may fully - enjoy the benefits afforded by using this reliable open-source - bug-tracking software. - - Throughout this portion of the Guide, we will refer to user account - options available at the Bugzilla test installation, - landfill.tequilarista.org. - - Note: Some people have run into difficulties completing this - tutorial. If you run into problems, please check the updated, - online documentation available at - http://www.trilobyte.net/barnsons. If you're still stumped, please - subscribe to the newsgroup and provide details of exactly what's - stumping you! If enough people complain, I'll have to fix it in the - next version of this Guide. You can subscribe to the newsgroup at - news://news.mozilla.org/netscape.public.mozilla.webtools - - Although Landfill serves as a great introduction to Bugzilla, it does - not offer all the options you would have as a user on your own - installation of Bugzilla, nor can it do more than serve as a general - introduction to Bugzilla. Additionally, Landfill often runs - cutting-edge versions of Bugzilla for testing, so some things may work - slightly differently than mentioned here. - _________________________________________________________________ - -4.3.1. Create a Bugzilla Account - - First thing's first! If you want to use Bugzilla, first you need to - create an account. Consult with the administrator responsible for your - installation of Bugzilla for the URL you should use to access it. If - you're test-driving the end-user Bugzilla experience, use this URL: - http://landfill.tequilarista.org/mozilla/bugzilla/ - - 1. Click the "Open a new Bugzilla account" link. - 2. Enter your "E-mail address" and "Real Name" (or whatever name you - want to call yourself) in the spaces provided, then select the - "Create Account" button. - 3. Within 5-10 minutes, 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 should be - changed at your nearest opportunity (we'll go into how to do it - later). - 4. Click the "Log In" link in the yellow area at the bottom of the - page in your browser, then enter your "E-mail address" and - "Password" you just received into the spaces provided, and select - "Login". - - Note: If you ever forget your password, you can come back to this - page, enter your "E-mail address", then select the "E-mail me a - password" button to have your password mailed to you again so that - you can login. - - Caution - Many modern browsers include an "Auto-Complete" or "Form Fill" feature - to remember the user names and passwords you type in at many sites. - Unfortunately, sometimes they attempt to "guess" what you will put in - as your password, and guess wrong. If you notice a text box is already - filled out, please overwrite the contents of the text box so you can - be sure to input the correct information. - - Congratulations! If you followed these directions, you now are the - proud owner of a user account on landfill.tequilarista.org (Landfill) - or your local Bugzilla install. You should now see in your browser a - page called the "Bugzilla Query Page". It may look daunting, but with - this Guide to walk you through it, you will master it in no time. - _________________________________________________________________ - -4.3.2. The Bugzilla Query Page - - The Bugzilla Query Page is the heart and soul of Bugzilla. It is the - master interface where you can find any bug report, comment, or patch - currently in the Bugzilla system. We'll go into how to create your own - bug report later on. - - There are efforts underway to simplify query usage. If you have a - local installation of Bugzilla 2.12 or higher, you should have - "quicksearch.html" available to use and simplify your searches. There - is also, or shortly will be, a helper for the query interface, called - "queryhelp.cgi". Landfill tends to run the latest code, so these two - utilities should be available there for your perusal. - - At this point, please visit the main Bugzilla site, - bugzilla.mozilla.org, to see a more fleshed-out query page. - - The first thing you need to notice about the Bugzilla Query Page is - that nearly every box you see on your screen has a hyperlink nearby, - explaining what it is or what it does. Near the upper-left-hand corner - of your browser window you should see the word "Status" underlined. - Select it. - - Notice the page that popped up? Every underlined word you see on your - screen is a hyperlink that will take you to context-sensitive help. - Click around for a while, and learn what everything here does. To - return to the query interface after pulling up a help page, use the - "Back" button in your browser. - - I'm sure that after checking out the online help, you are now an - Expert on the Bugzilla Query Page. If, however, you feel you haven't - mastered it yet, let me walk you through making a few successful - queries to find out what there are in the Bugzilla bug-tracking system - itself. - - 1. Ensure you are back on the "Bugzilla Query Page" Do nothing in the - boxes marked "Status", "Resolution", "Platform", "OpSys", - "Priority", or "Severity". The default query for "Status" is to - find all bugs that are NEW, ASSIGNED, or REOPENED, which is what - we want. If you don't select anything in the other 5 scrollboxes - there, then you are saying that "any of these are OK"; we're not - locking ourselves into only finding bugs on the "DEC" Platform, or - "Windows 95" OpSys (Operating System). You're smart, I think you - have it figured out. - Basically, selecting anything on the query page narrows your - search down. Leaving stuff unselected, or text boxes unfilled, - broadens your search! - 2. You see the box immediately below the top six boxes that contains - an "Email" text box, with the words "matching as", a drop-down - selection box, then some checkboxes with "Assigned To" checked by - default? This allows you to filter your search down based upon - email address. Let's put my email address in there, and see what - happens. - Type "barnboy@trilobyte.net" in the top Email text box. - 3. Let's narrow the search some more. Scroll down until you find the - box with the word "Program" over the top of it. This is where we - can narrow our search down to only specific products (software - programs or product lines) in our Bugzilla database. Please notice - the box is a scrollbox. Using the down arrow on the scrollbox, - scroll down until you can see an entry called "Webtools". Select - this entry. - 4. Did you notice that some of the boxes to the right changed when - you selected "Webtools"? Every Program (or Product) has different - Versions, Components, and Target Milestones associated with it. A - "Version" is the number of a software program. - Example 4-1. Some Famous Software Versions - Do you remember the hype in 1995 when Microsoft Windows 95(r) was - released? It may have been several years ago, but Microsoft(tm) - spent over $300 Million advertising this new Version of their - software. Three years later, they released Microsoft Windows - 98(r), another new version, to great fanfare, and then in 2000 - quietly released Microsoft Windows ME(Millenium Edition)(r). - Software "Versions" help a manufacturer differentiate their - current product from their previous products. Most do not identify - their products by the year they were released. Instead, the - "original" version of their software will often be numbered "1.0", - with small bug-fix releases on subsequent tenths of a digit. In - most cases, it's not a decimal number; for instance, often 1.9 is - an older version of the software than 1.11, but is a newer version - than 1.1.1. - In general, a "Version" in Bugzilla should refer to released - products, not products that have not yet been released to the - public. Forthcoming products are what the Target Milestone field - is for. - A "Component" is a piece of a Product. It may be a standalone - program, or some other logical division of a Product or Program. - Normally, a Component has a single Owner, who is responsible for - overseeing efforts to improve that Component. - Example 4-2. Mozilla Webtools Components - Mozilla's "Webtools" Product is composed of several pieces - (Components): - - Bonsai, a tool to show recent changes to Mozilla - Bugzilla, a defect-tracking tool - Build, a tool to automatically compile source code into - machine-readable form - Despot, a program that controls access to the other Webtools - LXR, a utility that automatically marks up text files to make them - more readable - MozBot, a "robot" that announces changes to Mozilla in Chat - TestManager, a tool to help find bugs in Mozilla - Tinderbox, which displays reports from Build - A different person is responsible for each of these Components. - Tara Hernandez keeps the "Bugzilla" component up-to-date. - A "Milestone", or "Target Milestone" is a often a planned future - "Version" of a product. In many cases, though, Milestones simply - represent significant dates for a developer. Having certain - features in your Product is frequently tied to revenue (money) the - developer will receive if the features work by the time she - reaches the Target Milestone. Target Milestones are a great tool - to organize your time. If someone will pay you $100,000 for - incorporating certain features by a certain date, those features - by that Milestone date become a very high priority. Milestones - tend to be highly malleable creatures, though, that appear to be - in reach but are out of reach by the time the important day - arrives. - The Bugzilla Project has set up Milestones for future Bugzilla - versions 2.14, 2.16, 2.18, 3.0, etc. However, a Target Milestone - can just as easily be a specific date, code name, or weird - alphanumeric combination, like "M19". - 5. OK, now let's select the "Bugzilla" component from its scrollbox. - 6. Skip down the page a bit -- do you see the "submit query" button? - Select it, and let's run this query! - 7. Congratulations! You've completed your first Query, and have - before you the Bug List of the author of this Guide, Matthew P. - Barnson (barnboy@trilobyte.net). If I'm doing well, you'll have a - cryptic "Zarro Boogs Found" message on your screen. It is just a - happy hacker's way of saying "Zero Bugs Found". However, I am - fairly certain I will always have some bugs assigned to me that - aren't done yet, so you won't often see that message! - - I encourage you to click the bug numbers in the left-hand column and - examine my bugs. Also notice that if you click the underlined links - near the top of this page, they do not take you to context-sensitive - help here, but instead sort the columns of bugs on the screen! When - you need to sort your bugs by priority, severity, or the people they - are assigned to, this is a tremendous timesaver. - - A couple more interesting things about the Bug List page: - - Change Columns: by selecting this link, you can show all kinds of - information in the Bug List - Change several bugs at once: If you have sufficient rights to change - all the bugs shown in the Bug List, you can mass-modify them. This is - a big time-saver. - Send mail to bug owners: If you have many related bugs, you can - request an update from every person who owns the bugs in the Bug List - asking them the status. - Edit this query: If you didn't get exactly the results you were - looking for, you can return to the Query page through this link and - make small revisions to the query you just made so you get more - accurate results. - - Note: There are many more options to the Bugzilla Query Page and - the Bug List than I have shown you. But this should be enough for - you to learn to get around. I encourage you to check out the - Bugzilla Home Page to learn about the Anatomy and Life Cycle of a - Bug before continuing. - _________________________________________________________________ - -4.3.3. Creating and Managing Bug Reports - - - - And all this time, I thought we were taking bugs out... - _________________________________________________________________ - -4.3.3.1. Writing a Great Bug Report - - Before we plunge into writing your first bug report, I encourage you - to read Mozilla.org's Bug Writing Guidelines. While some of the advice - is Mozilla-specific, the basic principles of reporting Reproducible, - Specific bugs, isolating the Product you are using, the Version of the - Product, the Component which failed, the Hardware Platform, and - Operating System you were using at the time of the failure go a long - way toward ensuring accurate, responsible fixes for the bug that bit - you. - - While you are at it, why not learn how to find previously reported - bugs? Mozilla.org has published a great tutorial on finding duplicate - bugs, available at - http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. - - I realize this was a lot to read. However, understanding the mentality - of writing great bug reports will help us on the next part! - - 1. Go back to http://landfill.tequilarista.org/mozilla/bugzilla/ in - your browser. - 2. Select the Enter a new bug report link. - 3. Select a product. - 4. Now you should be at the "Enter Bug" form. The "reporter" should - have been automatically filled out for you (or else Bugzilla - prompted you to Log In again -- you did keep the email with your - username and password, didn't you?). - 5. Select a Component in the scrollbox. - 6. Bugzilla should have made reasonable guesses, based upon your - browser, for the "Platform" and "OS" drop-down boxes. If those are - wrong, change them -- if you're on an SGI box running IRIX, we - want to know! - 7. Fill in the "Assigned To" box with the email address you provided - earlier. This way you don't end up sending copies of your bug to - lots of other people, since it's just a test bug. - 8. Leave the "CC" text box blank. Fill in the "URL" box with - "http://www.mozilla.org". - 9. Enter "The Bugzilla Guide" in the Summary text box, and place any - comments you have on this tutorial, or the Guide in general, into - the Description box. - - Voila! Select "Commit" and send in your bug report! Next we'll look at - resolving bugs. - _________________________________________________________________ - -4.3.3.2. Managing your Bug Reports - - OK, you should have a link to the bug you just created near the top of - your page. It should say "Bug XXXX posted", with a link to the right - saying "Back to BUG# XXXX". Select this link. - - 1. Scroll down a bit on the subsequent page, until you see the - "Resolve bug, changing resolution to (dropdown box). Normally, you - would "Accept bug (change status to ASSIGNED)", fix it, and then - resolve. But in this case, we're going to short-circuit the - process because this wasn't a real bug. Change the dropdown next - to "Resolve Bug" to "INVALID", make sure the radio button is - marked next to "Resolve Bug", then click "Commit". - 2. Hey! It said it couldn't take the change in a big red box! That's - right, you must specify a Comment in order to make this change. - Select the "Back" button in your browser, add a Comment, then try - Resolving the bug with INVALID status again. This time it should - work. - - You have now learned the basics of Bugzilla navigation, entering a - bug, and bug maintenance. I encourage you to explore these features, - and see what you can do with them! We'll spend no more time on - individual Bugs or Queries from this point on, so you are on your own - there. - - But I'll give a few last hints! - - There is a CLUE on the Query page that will teach you more how to use - the form. - - If you click the hyperlink on the Component box of the Query page, you - will be presented a form that will describe what all the components - are. - - Possibly the most powerful feature of the Query page is the Boolean - Chart section. It's a bit confusing to use the first time, but can - provide unparalleled flexibility in your queries, allowing you to - build extremely powerful requests. - - Finally, you can build some nifty Reports using the "Bug Reports" link - near the bottom of the query page, and also available via the - "Reports" link at the footer of each page. - _________________________________________________________________ - -4.4. What's in it for me? - - - - Indiana, it feels like we walking on fortune cookies! - - These ain't fortune cookies, kid... - - Customized User Preferences offer tremendous versatility to your - individual Bugzilla experience. Let's plunge into what you can do! The - first step is to click the "Edit prefs" link at the footer of each - page once you have logged in to Landfill. - _________________________________________________________________ - -4.4.1. Account Settings - - On this page, you can change your basic Account Settings, including - your password and full name. For security reasons, in order to change - anything on this page you must type your current password into the - "Old Password" field. If you wish to change your password, type the - new password you want into the "New Password" field and again into the - "Re-enter new password" field to ensure you typed your new password - correctly. Select the "Submit" button and you're done! - _________________________________________________________________ - -4.4.2. Email Settings - -4.4.2.1. Email Notification - - Note: The email notification settings described below have been - obsoleted in Bugzilla 2.12, and this section will be replaced with - a comprehensive description of the amazing array of new options at - your disposal. However, in the meantime, throw this chunk out the - window and go crazy with goofing around with different notification - options. - - Ahh, here you can reduce or increase the amount of email sent you from - Bugzilla! In the drop-down "Notify me of changes to", select one of - - All qualifying bugs: sends you every change to every bug where your - name is somewhere on it, regardless of who changed it. - Only those bugs which I am listed in the CC line: prevents you from - receiving mail for which you are the reporter,' owner, or QA contact. - If you are on the CC list, presumably someone had a good reason for - you to get the email. - All qulifying bugs except those which I change: This is the default, - and a sensible setting. If someone else changes your bugs, you will - get emailed, but if you change bugs yourself you will receive no - notification of the change. - _________________________________________________________________ - -4.4.2.2. New Email Technology - - Note: This option may not be available in all Bugzilla - installations, depending upon the preferences of the systems - administrator responsible for the setup of your Bugzilla. However, - if you really want this functionality, ask her to "enable - newemailtech in Params" and "make it the default for all new - users", referring her to the Administration section of this Guide. - - Disregard the warnings about "experimental and bleeding edge"; the - code to handle email in a cleaner manner than that historically used - for Bugzilla is quite robust and well-tested now. - - I recommend you enable the option, "Click here to sign up (and risk - any bugs)". Your email-box will thank you for it. The fundamental - shift in "newemailtech" is away from standard UNIX "diff" output, - which is quite ugly, to a prettier, better laid-out email. - _________________________________________________________________ - -4.4.2.3. "Watching" Users - - Note: This option may not be available in all Bugzilla - installations, depending upon the preferences of the systems - administrator responsible for the setup of your Bugzilla. However, - if you really want this functionality, ask her to "enable watchers - in Params". - - By entering user email names into the "Users to watch" text entry box, - delineated by commas, you can watch bugs of other users. This powerful - functionality enables seamless transitions as developers change - projects, managers wish to get in touch with the issues faced by their - direct reports, or users go on vacation. If any of these three - situations apply to you, you will undoubtedly find this feature quite - convenient. - _________________________________________________________________ - -4.4.3. Page Footer - - Note: By default, this page is quite barren. However, go explore - the Query Page some more; you will find that you can store numerous - queries on the server, so if you regularly run a particular query - it is just a drop-down menu away. On this page of Preferences, if - you have many stored queries you can elect to have them always - one-click away! - - If you have many stored queries on the server, here you will find - individual drop-downs for each stored query. Each drop-down gives you - the option of that query appearing on the footer of every page in - Bugzilla! This gives you powerful one-click access to any complex - searches you may set up, and is an excellent way to impress your - boss... - - Tip: By default, the "My Bugs" link appears at the bottom of each - page. However, this query gives you both the bugs you have - reported, as well as those you are assigned. One of the most common - uses for this page is to remove the "My Bugs" link, replacing it - with two other queries, commonly called "My Bug Reports" and "My - Bugs" (but only referencing bugs assigned to you). This allows you - to distinguish those bugs you have reported from those you are - assigned. I commonly set up complex Boolean queries in the Query - page and link them to my footer in this page. When they are - significantly complex, a one-click reference can save hours of - work. - _________________________________________________________________ - -4.4.4. Permissions - - This is a purely informative page which outlines your current - permissions on this installation of Bugzilla. If you have permissions - to grant certain permissions to other users, the "other users" link - appears on this page as well as the footer. For more information - regarding user administration, please consult the Administration - section of this Guide. - _________________________________________________________________ - -4.5. Using Bugzilla-Conclusion - - Thank you for reading through this portion of the Bugzilla Guide. I - anticipate it may not yet meet the needs of all readers. If you have - additional comments or corrections to make, please submit your - contributions to the mozilla-webtools mailing list/newsgroup. The - mailing list is mirrored to the netscape.public.mozilla.webtools - newsgroup, and the newsgroup is mirrored to - mozilla-webtools@mozilla.org + deny from all _________________________________________________________________ Chapter 5. Integrating Bugzilla with Third-Party Tools @@ -2512,16 +2900,16 @@ Chapter 5. Integrating Bugzilla with Third-Party Tools 5.2. CVS - We need CVS integration information + CVS integration is best accomplished, at this point, using the + Bugzilla Email Gateway. _________________________________________________________________ 5.3. Perforce SCM - Richard Brooksby created a Perforce integration tool for Bugzilla and - TeamTrack. You can find the main project page at - http://www.ravenbrook.com/project/p4dti. "p4dti" is now an officially - supported product from Perforce, and you can find the "Perforce Public - Depot" p4dti page at + You can find the project page for Bugzilla and Teamtrack Perforce + integration at: http://www.ravenbrook.com/project/p4dti. "p4dti" is + now an officially supported product from Perforce, and you can find + the "Perforce Public Depot" p4dti page at http://public.perforce.com/public/perforce/p4dti/index.html. Integration of Perforce with Bugzilla, once patches are applied, is @@ -2551,287 +2939,11 @@ Chapter 5. Integrating Bugzilla with Third-Party Tools Chapter 6. The Future of Bugzilla Bugzilla's Future. Much of this is the present, now. - _________________________________________________________________ -6.1. Reducing Spam - - Those who use Bugzilla frequently are probably used to notification sp - am - - unwanted or unnecessary notifications. A number of proposals have - been put forward to attempt to reduce this. - 1. Reduce CC Spam - Some of you probably know me as that guy who CCs on heaps and heaps of - bugs. Just as you get a lot of CC changes from me, so do I get a lot - from others. Why should CC changes send out email notifications? - It's not necessarily the best idea to just remove the CC spam, there a - re - other issues too, like the difficulty of adding to large CC fields. - For these reasons and more, an RFE for a per user "BCC" facility exist - s - that people could use to silently and privately track bugs, in a simil - ar - way to voting today, but applying to an unlimited number of bugs. See - "http://bugzilla.mozilla.org/show_bug.cgi?id=7345". - 2. Bulk Changes - You know the drill - a large milestone change, a component movement, - whatever, and lots of notifications are generated. If there's enough - maybe you'll just go delete, delete, delete, whoops, there goes anothe - r - notification that wasn't from the bulk change you missed. - Shouldn't bulk changes send out one notification? A proposal for this - is at "http://bugzilla.mozilla.org/show_bug.cgi?id=26943". - 3. Configurable Notification Criteria - It would be good if you could choose what you want to receive. There - are two parts to this. - (a) Choose a selection of bugs you're interested in. This would be - similar to CC except you let the set be computed from selection criter - ia - rather than limited to the bugs your name is on. There is currently a - limited version of this in the bugzilla preferences, ie "all qualifyin - g - bugs"/"all qualifying bugs except the ones I change"/"only those bugs - which I am listed on the cc line". - (b) Choose what changes will trigger a notification for the bugs you a - re - watching. With this, you could choose whether you want to receive cc, - dependency and keyword changes, for example. - Both of these proposals live at - "http://bugzilla.mozilla.org/show_bug.cgi?id=14137". - Note that they also live at - "http://bugzilla.mozilla.org/show_bug.cgi?id=17464", and the change - has been checked in. This is fixed with Bugzilla 2.12 and is no longe - r - an issue. Woo-Hoo! - _________________________________________________________________ - -6.2. Better Searching - - Current searching tools in Bugzilla include the querying mechanism, - special summary reports and dependency trees. This message is about n - ew - facilities. - 1. General Summary Reports - For some time now it has been apparent to me that the query bug list - leaves a little to be desired in its linear nature. There is a need t - o - have categorised subsets, and counts of each category. If you don't - believe me, how about these facilities already in place or which peopl - e - have asked for: - Most Doomed Reports - Categorised On Assignee, Shows and Counts Number - of Bugs For Each Assignee - Bug #15806 (Most Voted For Bugs) - Categorised On Product, Shows Bugs - Voters Most Want Fixed - Bug #9789 (BugAThon Tracking Page) - Categorised On Developer (Subset) - , - Counts Number of Bugs - Bug #9409 and #9411 - The desire to be able to report on more subsets. - Hopefully you can see the gist of what is desired here. It's a genera - l - reporting mechanism. - This mechanism lets you choose the subset of bugs to operate on (like - query), let's you categorise them, possibly along with subcategories a - nd - counts the number of bugs within each category. It might or might not - show the actual bugs themselves, and it might limit the number of bugs - within a category, or categories to report on. - I'm further sure that many applications of this mechanism would only b - e - recognised once it was implemented. - The general summary reports bug is at - "http://bugzilla.mozilla.org/show_bug.cgi?id=12282". - 2. Related Bugs - It would be nice to have a field where you could enter other bugs - related to the current bug - it would be handy for navigation and - possibly even finding duplicates. See - "http://bugzilla.mozilla.org/show_bug.cgi?id=12286". - 3. Column Specification Support - Currently query seems to get what columns to report on from whatever t - he - user last used. This doesn't work well for "prepackaged queries", whe - re - you followed a link. You can probably add a column by specifying a so - rt - column, but this is difficult and suboptimal. - Furthermore, I find that when I want to add a column to a query, it's - usually a one off and I would prefer it to go away for the next query. - - Hence, it would be nice to specify the columns that appear on the quer - y - (and general summary report) pages. The default query mechanism shoul - d - be able to let you specify your default columns. - This proposal lives at - "http://bugzilla.mozilla.org/show_bug.cgi?id=12284". - _________________________________________________________________ - -6.3. Description Flags and Tracking Bugs - - Since I last posted on this issue, we now have "keywords" that solve - many of the issues of description and status whiteboard keywords. We - have seen a migration towards keywords, but there is still further to - go. - Description ( + Status Whiteboard ) Keywords - -------------------------------------------- - Some description keywords remain. I'd like to hear what reasons, othe - r - than time, there are for these staying as they are. I'm suspecting ma - ny - are not really being used. Hopefully we can totally remove these - eventually. - Tracking Bugs - ------------- - When I suggested keywords, I did so to get rid of tracking bugs too, - though we've had less success on that front. - There are many disadvantages to tracking bugs. - - They can pollute bugs counts, and you must make sure you exclude - them. I believe the meta keyword might be used for this purpose. - - They have an assignee but there is nothing to fix, and that person c - an - get whined at by Bugzilla. - - It would be better to craft your own "dependency tree" rather than - rely on a fixed hierachy in the bug system. - - In creating a nice little hierachy, many bugs duplicate information - that should be available in other ways, eg - "http://bugzilla.mozilla.org/show_bug.cgi?id=12833" which is - about beta 1 networking issues. These could fall behind the actual - data. What tracking bugs are good for, ad hoc lists, is what keywords - are better for. - - An automatically generated dependency structure between one "trackin - g - bug" and another would be better than a manual one, since it gives exa - ct - rather than manually set up classifications. - Probably the only feature preventing tracking bugs being replaced is t - he - dependency tree. The quintessential tracking bug seems to be bug #722 - 9 - "chofmann's watch list", which probably has about a couple of hundred - bugs at various levels, which allows a nice visualisation. - Before keywords can replace tracking bugs better visualisation is goin - g - to be required. General summary reports and dependency forests of a b - ug - list ("http://bugzilla.mozilla.org/show_bug.cgi?id=12992") could both - help, but neither solves the problem totally. Perhaps keywords within - keywords would help here. In any case, I'm still thinking about this - one. - Some tracking bugs could definitely be turned into keywords immediatel - y - though, and I'll point the finger at - "http://bugzilla.mozilla.org/show_bug.cgi?id=7954" here since that's - what came to mind first. - _________________________________________________________________ - -6.4. Bug Issues - - 1. Inline Bug Changes - Why do I see so many "moving to M5" and "reassigning to blahblah" - messages, and in other circumstances none are entered? Why aren't the - se - automatically generated? A comment should be only necessary when ther - e - is something to add, and if I'm not interested in this sort of - information, I should be able to hide it. - At the moment we're in a hybrid world where we don't get everything, b - ut - we can't get rid of the bug change "messages" either. Furthermore, - "View Bug Activity" requires me to manually cross reference events on - another page, rather than being able to visually see the chronological - order. Shouldn't I be able to see all the information on one page? - A proposal to allow bugs to be shown either way is at - "http://bugzilla.mozilla.org/show_bug.cgi?id=11368". - 2. Hard Wrapping Comments - One thing that annoys me is the fact that comments are "hard wrapped" - to - a certain column width. This is a mistake Internet Mail and News has - made, unlike every word processor in existence, and as a consequence, - Usenet suffers to this day from bad software. Why has Bugzilla repeat - ed - the problem? - Hard wrapping to a certain column width is open to abuse (see old - Mozilla browsers that didn't wrap properly, resulting in many ugly bug - reports we have to read to this day), and furthermore doesn't expand t - o - fill greater screen sizes. I'm also under the impression the current - hard wrap uses a non-standard HTML facility. See - "http://bugzilla.mozilla.org/show_bug.cgi?id=11901". - 3. REMIND and LATER Are Evil - I really hate REMIND and LATER. Not because they mean something - won't be implemented, but because they aren't the best solutions. - Why are they bad? Well, basically because they are not resolved, yet - they are marked as such. Hence queries have to be well crafted to - include them. - LATER, according to Bugzilla, means it won't be done this release. - There is a better mechanism of doing this, that is assigning to - nobody@mozilla.org and making the milestone blank. It's more likely t - o - appear in a casual query, and it doesn't resolve the bug. - REMIND, according to Bugzilla, means it might still be implemented thi - s - release. Well, why not just move it to a later milestone then? You'r - e - a lot less likely to forget it. If it's really needed, a keyword woul - d - be better. - Some people can't use blank milestones to mean an untargetted mileston - e, - since they use this to assess new bugs that have no target. Hence, it - would be nice to distinguish between bugs that have not yet been - considered, and those that really are not assigned to any milestone in - the future (assumedly beyond). - All this is covered at - "http://bugzilla.mozilla.org/show_bug.cgi?id=13534". - 4. Create An Enhancement Field - Currently enhancement is an option in severity. This means that - important enhancements (like for example, POP3 support) are not proper - ly - distinguished as such, because they need a proper severity. This - dilutes the meaning of enhancement. - If enhancement was separated, we could properly see what was an - enhancement. See "http://bugzilla.mozilla.org/show_bug.cgi?id=9412". - I - see keywords like [RFE] and [FEATURE] that seem to be compensating for - this problem. - _________________________________________________________________ - -6.5. Database Integrity - - Bugzilla could be more proactive in detecting suboptimal situations an - d - prevent them or whine about them. - 1. Bugzilla Crime #1: Marking A Bug Fixed With Unresolved Dependencies - It can't be marked fixed with unresolved dependencies. Either mark it - INVALID (tracking bugs), fix the dependencies at the same time, or - resolve the blockers. - See "http://bugzilla.mozilla.org/show_bug.cgi?id=24496". - 2. Keyword Restrictions - Some keywords should only apply in certain circumstances, eg beta1 => - Milestone < - M14, css1 => Component = Style System are possibilities. See - "http://bugzilla.mozilla.org/show_bug.cgi?id=26940". - 3. Whine About Old Votes - Old votes can just sit on resolved bugs. This is problematic with - duplicates especially. Automatic transferral/removal is not - appropriate since bugs can be reopened, but a whining solution might - work. See "http://bugzilla.mozilla.org/show_bug.cgi?id=27553". - 4. Whine And Warn About Milestone Mismatches - Here's a fun one. Bug X (M17) depends on Bug Y (M15). Bug Y gets mov - ed - out to M19. The notification to the assignee of Bug X gets ignored (o - f - course) and Bug X is now due to be fixed before one of its blockers. - Warnings about this when it is detected as well as whining about it in - email would help bring these issues to the attention of people sooner. - Note that this would be less of a problem if we didn't have so many - tracking bugs since they aren't updated that often and often have this - problem. - See "http://bugzilla.mozilla.org/show_bug.cgi?id=16743". - _________________________________________________________________ - -6.6. Bugzilla 3.0 - - One day, Bugzilla 3.0 will have lots of cool stuff. + The future of Bugzilla is Bugzilla 3.0. Unfortunately, I do not have + more information about it right now, and most of what went into the + "future" section is now present. That stuff was blue-sky a year ago; + MattyT should have me a new document sometime... _________________________________________________________________ Appendix A. The Bugzilla FAQ @@ -2979,7 +3091,7 @@ Appendix A. The Bugzilla FAQ A.6.1. How do I completely disable MySQL security if it's giving me problems (I've followed the instructions in the - README!)? + installation section of this guide!)? A.6.2. Are there any security problems with Bugzilla? A.6.3. I've implemented the security fixes mentioned in Chris @@ -3217,19 +3329,23 @@ Appendix A. The Bugzilla FAQ for the various webtools, and not subject to anyone else. Edit it to point to whatever you like. - Note: We always recommend that, if possible, you keep the path as - /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools and - /usr/bonsaitools/bin directory, then symlink your version of perl - to /usr/bonsaitools/bin/perl. This will make upgrading your - Bugzilla much easier in the future. + Note - Obviously, if you do not have root access to your Bugzilla box, our - suggestion is irrelevant. + We always recommend that, if possible, you keep the path as + /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools and + /usr/bonsaitools/bin directory, then symlink your version of perl to + /usr/bonsaitools/bin/perl. This will make upgrading your Bugzilla much + easier in the future. + + Obviously, if you do not have root access to your Bugzilla box, our + suggestion is irrelevant. 2. Red Hat Bugzilla - Note: This section is no longer up-to-date. Please see the section - on "Red Hat Bugzilla" under "Variants" in The Bugzilla Guide. + Note + + This section is no longer up-to-date. Please see the section on "Red + Hat Bugzilla" under "Variants" in The Bugzilla Guide. A.2.1. What about Red Hat Bugzilla? @@ -3323,10 +3439,11 @@ Appendix A. The Bugzilla FAQ A.2.3. What's the current status of Red Hat Bugzilla? - Note: This information is somewhat dated; I last updated it 7 June - 2000. Please see the "Variants" section of "The Bugzilla Guide" for - more up-to-date information regarding Red Hat Bugzilla. + Note + This information is somewhat dated; I last updated it 7 June 2000. + Please see the "Variants" section of "The Bugzilla Guide" for more + up-to-date information regarding Red Hat Bugzilla. Dave Lawrence: I suppose the current thread warrants an update on the status of @@ -3375,14 +3492,16 @@ Appendix A. The Bugzilla FAQ 3. Loki Bugzilla (AKA Fenris) - Note: Loki's "Fenris" Bugzilla is based upon the (now ancient) - Bugzilla 2.8 tree, and is no longer actively maintained. It works - well enough for Loki. Additionally, the major differences in Fenris - have now been integrated into the main source tree of Bugzilla, so - there's not much reason to go grab the source. I leave this section - of the FAQ principally for historical interest, but unless Loki has - further input into Bugzilla's future, it will be deprecated in - future versions of the Guide. + Note + + Loki's "Fenris" Bugzilla is based upon the (now ancient) Bugzilla 2.8 + tree, and is no longer actively maintained. It works well enough for + Loki. Additionally, the major differences in Fenris have now been + integrated into the main source tree of Bugzilla, so there's not much + reason to go grab the source. I leave this section of the FAQ + principally for historical interest, but unless Loki has further input + into Bugzilla's future, it will be deprecated in future versions of + the Guide. A.3.1. What about Loki Bugzilla? @@ -3412,8 +3531,10 @@ Appendix A. The Bugzilla FAQ 4. Pointy-Haired-Boss Questions - Note: The title of this section doesn't mean you're a PHB -- it - just means you probably HAVE a PHB who wants to know this :) + Note + + The title of this section doesn't mean you're a PHB -- it just means + you probably HAVE a PHB who wants to know this :) A.4.1. Is Bugzilla web-based or do you have to have specific software or specific operating system on your machine? @@ -3469,44 +3590,27 @@ Appendix A. The Bugzilla FAQ This was a late-breaking question for the Guide, so I just have to quote the relevant newsgroup thread on it. - > AFAIK, most sites (even if they have SSI enabled) won't have #exec c - md - > enabled. Perhaps what would be better is a #include virtual and a - > footer.cgi the basically has the "require 'CGI.pl' and PutFooter com - mand. - > - > Please note that under most configurations, this also requires namin - g - > the file from index.html to index.shtml (and making sure that it wil - l - > still be reconized as an index). Personally, I think this is better - on - > a per-installation basis (perhaps add something to the FAQ that says - how - > to do this). - Good point. Yeah, easy enough to do, that it shouldn't be a big deal - for - someone to take it on if they want it. FAQ is a good place for it. - > Dave Miller wrote: - > - >> I did a little experimenting with getting the command menu and foot - er on - >> the end of the index page while leaving it as an HTML file... - >> - >> I was successful. :) - >> - >> I added this line: - >> - >> - >> - >> Just before the </BODY> </HTML> at the end of the file. And it wor - ked. - >> - >> Thought I'd toss that out there. Should I check this in? For thos - e that - >> have SSI disabled, it'll act like a comment, so I wouldn't think it - would - >> break anything. + > AFAIK, most sites (even if they have SSI enabled) won't have #exec + cmd > enabled. Perhaps what would be better is a #include + virtual and a > footer.cgi the basically has the "require + 'CGI.pl' and PutFooter command. > > Please note that under + most configurations, this also requires naming > the file + from index.html to index.shtml (and making sure that it + will > still be reconized as an index). Personally, I + think this is better on > a per-installation basis + (perhaps add something to the FAQ that says how > to do + this). Good point. Yeah, easy enough to do, that it + shouldn't be a big deal for someone to take it on if they + want it. FAQ is a good place for it. > Dave Miller wrote: + > >> I did a little experimenting with getting the command + menu and footer on >> the end of the index page while + leaving it as an HTML file... >> >> I was successful. :) + >> >> I added this line: >> >> >> >> Just before the + </BODY> </HTML> at the end of the file. And + it worked. >> >> Thought I'd toss that out there. Should + I check this in? For those that >> have SSI disabled, + it'll act like a comment, so I wouldn't think it would >> + break anything. A.4.8. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -3542,13 +3646,14 @@ Appendix A. The Bugzilla FAQ 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. + Note + + If you decide to use the bugzilla_email integration features to allow + Bugzilla to record responses to mail with the associated bug, you may + need to caution your users to set their mailer to "respond to messages + in the format in which they were sent". For security reasons Bugzilla + ignores HTML tags in comments, and if a user sends HTML-based email + into Bugzilla the resulting comment looks downright awful. A.4.12. If I just wanted to track certain bugs, as they go through life, can I set it up to alert me via email whenever that bug changes, @@ -3684,7 +3789,7 @@ Appendix A. The Bugzilla FAQ A.5.1. How do I download and install Bugzilla? Check http://www.mozilla.org/projects/bugzilla/ for details. Once you - download it, untar it, read the README and the Bugzilla Guide. + download it, untar it, read the Bugzilla Guide. A.5.2. How do I install Bugzilla on Windows NT? @@ -3698,7 +3803,8 @@ Appendix A. The Bugzilla FAQ 6. Bugzilla Security A.6.1. How do I completely disable MySQL security if it's giving me - problems (I've followed the instructions in the README!)? + problems (I've followed the instructions in the installation section + of this guide!)? Run mysql like this: "mysqld --skip-grant-tables". Please remember this makes mysql as secure as taping a $100 to the floor of a football @@ -3710,7 +3816,7 @@ Appendix A. The Bugzilla FAQ The Bugzilla code has not undergone a complete security audit. It is recommended that you closely examine permissions on your Bugzilla installation, and follow the recommended security guidelines found in - the README and in The Bugzilla Guide. + The Bugzilla Guide. A.6.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 @@ -3928,104 +4034,68 @@ Appendix A. The Bugzilla FAQ "The Bugzilla Guide". However, they are provided here for historical interest and insight. - 1. #!C:/perl/bin/perl had to be added to every perl file. - 2. Converted to Net::SMTP to handle mail messages instead of - /usr/bin/sendmail. - 3. The crypt function isn't available on Windows NT (at least none t - hat I - am aware), so I made encrypted passwords = plaintext passwords. - 4. The system call to diff had to be changed to the Cygwin diff. - 5. This was just to get a demo running under NT, it seems to be work - ing - good, and I have inserted almost 100 bugs from another bug tracki - ng - system. Since this work was done just to get an in-house demo, I - am NOT - planning on making a patch for submission to Bugzilla. If you wou - ld - like a zip file, let me know. - Q: Hmm, couldn't figure it out from the general instructions above. H - ow - about step-by-step? - A: Sure! Here ya go! - 1. Install IIS 4.0 from the NT Option Pack #4. - 2. Download and install Active Perl. - 3. Install the Windows GNU tools from Cygwin. Make sure to add the b - in - directory to your system path. (Everyone should have these, wheth - er - they decide to use Bugzilla or not. :-) ) - 4. Download relevant packages from ActiveState at - http://www.activestate.com/packages/zips/. + DBD-Mysql.zip - 5. Extract each zip file with WinZip, and install each ppd file usin - g the - notation: ppm install <module>.ppd - 6. Install Mysql. *Note: If you move the default install from c:\my - sql, - you must add the appropriate startup parameters to the NT service - . (ex. - -b e:\\programs\\mysql) - 7. Download any Mysql client. http://www.mysql.com/download_win.html - 8. Setup MySql. (These are the commands that I used.) - I. Cleanup default database settings. - C:\mysql\bin\mysql -u root mysql - mysql> DELETE FROM user WHERE Host='localhost' AND User=''; - mysql> quit - C:\mysql\bin\mysqladmin reload - II. Set password for root. - C:\mysql\bin\mysql -u root mysql - mysql> UPDATE user SET Password=PASSWORD('new_password') - WHERE user='root'; - mysql> FLUSH PRIVILEGES; - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - III. Create bugs user. - C:\mysql\bin\mysql -u root -p - mysql> insert into user (host,user,password) - values('localhost','bugs',''); - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - IV. Create the bugs database. - C:\mysql\bin\mysql -u root -p - mysql> create database bugs; - V. Give the bugs user access to the bugs database. - mysql> insert into db - (host,db,user,select_priv,insert_priv,update_priv,delete_pri - v,create_priv,drop_priv) - values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - 9. Run the table scripts to setup the bugs database. - 10. Change CGI.pm to use the following regular expression because of - differing backslashes in NT versus UNIX. - o $0 =~ m:[^\\]*$:; - 11. Had to make the crypt password = plain text password in the datab - ase. - (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one. - ) The - files that I changed were: - o globals.pl - o CGI.pl - o alternately, you can try commenting all references to 'crypt - ' - string and replace them with similar lines but without encry - pt() - or crypr() functions insida all files. - 12. Replaced sendmail with Windmail. Basically, you have to come up w - ith a - sendmail substitute for NT. Someone said that they used a Perl mo - dule - (Net::SMTP), but I was trying to save time and do as little Perl - coding - as possible. - 13. Added "perl" to the beginning of all Perl system calls that use a - perl - script as an argument and renamed processmail to processmail.pl. - 14. In processmail.pl, I added binmode(HANDLE) before all read() call - s. I'm - not sure about this one, but the read() under NT wasn't counting - the - EOLs without the binary read." + 1. #!C:/perl/bin/perl had to be + added to every perl file. 2. Converted to Net::SMTP to + handle mail messages instead of /usr/bin/sendmail. 3. + The crypt function isn't available on Windows NT (at + least none that I am aware), so I made encrypted + passwords = plaintext passwords. 4. The system call to + diff had to be changed to the Cygwin diff. 5. This was + just to get a demo running under NT, it seems to be + working good, and I have inserted almost 100 bugs from + another bug tracking system. Since this work was done + just to get an in-house demo, I am NOT planning on + making a patch for submission to Bugzilla. If you would + like a zip file, let me know. Q: Hmm, couldn't figure it + out from the general instructions above. How about + step-by-step? A: Sure! Here ya go! 1. Install IIS 4.0 + from the NT Option Pack #4. 2. Download and install + Active Perl. 3. Install the Windows GNU tools from + Cygwin. Make sure to add the bin directory to your + system path. (Everyone should have these, whether they + decide to use Bugzilla or not. :-) ) 4. Download + relevant packages from ActiveState at + http://www.activestate.com/packages/zips/. + + DBD-Mysql.zip 5. Extract each zip file with WinZip, and + install each ppd file using the notation: ppm install + <module>.ppd 6. Install Mysql. *Note: If you move + the default install from c:\mysql, you must add the + appropriate startup parameters to the NT service. (ex. + -b e:\\programs\\mysql) 7. Download any Mysql client. + http://www.mysql.com/download_win.html 8. Setup MySql. + (These are the commands that I used.) I. Cleanup default + database settings. C:\mysql\bin\mysql -u root mysql + mysql> DELETE FROM user WHERE Host='localhost' AND + User=''; mysql> quit C:\mysql\bin\mysqladmin reload II. + Set password for root. C:\mysql\bin\mysql -u root mysql + mysql> UPDATE user SET Password=PASSWORD('new_password') + WHERE user='root'; mysql> FLUSH PRIVILEGES; mysql> quit + C:\mysql\bin\mysqladmin -u root reload III. Create bugs + user. C:\mysql\bin\mysql -u root -p mysql> insert into + user (host,user,password) values('localhost','bugs',''); + mysql> quit C:\mysql\bin\mysqladmin -u root reload IV. + Create the bugs database. C:\mysql\bin\mysql -u root -p + mysql> create database bugs; V. Give the bugs user + access to the bugs database. mysql> insert into db + (host,db,user,select_priv,insert_priv,update_priv,delete_priv,cr + eate_priv,drop_priv) values('localhost','bugs','bugs','Y','Y','Y','Y', + 'Y','N') mysql> quit C:\mysql\bin\mysqladmin -u root reload 9. Run the + table scripts to setup the bugs database. 10. Change CGI.pm to use th + e following regular expression because of differing backslashes in NT + versus UNIX. o $0 =~ m:[^\\]*$:; 11. Had to make the crypt password = + plain text password in the database. (Thanks to Andrew Lahser" <andrew + _lahser@merck.com>" on this one.) The files that I changed were: o glo + bals.pl o CGI.pl o alternately, you can try commenting all references + to 'crypt' string and replace them with similar lines but without encr + ypt() or crypr() functions insida all files. 12. Replaced sendmail wit + h Windmail. Basically, you have to come up with a sendmail substitute + for NT. Someone said that they used a Perl module (Net::SMTP), but I w + as trying to save time and do as little Perl coding as possible. 13. A + dded "perl" to the beginning of all Perl system calls that use a perl + script as an argument and renamed processmail to processmail.pl. 14. I + n processmail.pl, I added binmode(HANDLE) before all read() calls. I'm + not sure about this one, but the read() under NT wasn't counting the + EOLs without the binary read." A.9.5. I'm having trouble with the perl modules for NT not being able to talk to to the database. @@ -4147,7 +4217,7 @@ Appendix B. Software Download Links Bugzilla: http://www.mozilla.org/projects/bugzilla/ - MySQL: http://www.mysql.org/ + MySQL: http://www.mysql.com/ Perl: http://www.perl.org/ @@ -4178,9 +4248,11 @@ Appendix B. Software Download Links Appendix C. The Bugzilla Database - Note: This document really needs to be updated with more fleshed - out information about primary keys, interrelationships, and maybe - some nifty tables to document dependencies. Any takers? + 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? _________________________________________________________________ C.1. Database Schema Chart @@ -4192,212 +4264,132 @@ C.1. Database Schema Chart C.2. MySQL Bugzilla Database Introduction - Contributor(s): Matthew P. Barnson (mbarnson@excitehome.net) - Last update: May 16, 2000 - Changes: - Version 1.0: Initial public release (May 16, 2000) - Maintainer: Matthew P. Barnson (mbarnson@excitehome.net) - === - Table Of Contents - === - FOREWORD - INTRODUCTION - THE BASICS - THE TABLES - THE DETAILS - === - FOREWORD - === - This information comes straight from my life. I was forced to learn - how - Bugzilla organizes database because of nitpicky requests from users fo - r 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. - I'm sorry this version is plain text. I can whip this info out a lo - t faster - if I'm not concerned about complex formatting. I'll get it into sgml - for easy - portability as time permits. - The Bugzilla Database Schema has a home! In addition to availabilit - y via CVS - and released versions 2.12 and higher of Bugzilla, you can find the la - test & - greatest version of the Bugzilla Database Schema at - http://www.trilobyte.net/barnsons/. This is a living document; please - be sure - you are up-to-date with the latest version before mirroring. - The Bugzilla Database Schema is designed to provide vital informatio - n - regarding the structure of the MySQL database. Where appropriate, thi - s - document will refer to URLs rather than including documents in their e - ntirety - to ensure completeness even should this paper become out of date. - This document is not maintained by Netscape or Netscape employees, s - o please - do not contact them regarding errors or omissions contained herein. Pl - ease - direct all questions, comments, updates, flames, etc. to Matthew P. Ba - rnson - mbarnson@excitehome.net) (barnboy or barnhome on irc.mozilla.org in - #mozwebtools). - I'm sure I've made some glaring errors or omissions in this paper -- - please - email me corrections or post corrections to the - netscape.public.mozilla.webtools newsgroup. - === - INTRODUCTION - === - 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 da - tabase - flawlessly. Maybe you've even entered a few test bugs to make sure em - ail's - working; people seem to be notified of new bugs and changes, and you c - an - enter and edit bugs to your heart's content. Perhaps you've gone thro - ugh the - trouble of setting up a gateway for people to submit bugs to your data - base via - email, have had a few people test it, and received rave reviews from y - our beta - testers. - What's the next thing you do? Outline a training strategy for your - development team, of course, and bring them up to speed on the new too - l you've - labored over for hours. - Your first training session starts off very well! You have a captiv - e - audience which seems enraptured by the efficiency embodied in this thi - ng called - "Bugzilla". You are caught up describing the nifty features, how peop - le can - save favorite queries in the database, set them up as headers and foot - ers on - their pages, customize their layouts, generate reports, track status w - ith - 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 o - f the - conference room. "I have a concern," the voice hisses from the darkne - ss, - "about the use of the word 'verified'. - The room, previously filled with happy chatter, lapses into reverent - ial - silence as Certain Death (better known as the Vice President of Softwa - re - Engineering) continues. "You see, for two years we've used the word ' - verified' - to indicate that a developer or quality assurance engineer has confirm - ed 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 "ye - s, yes, I - don't think that would be a problem," You review the changes with Cert - ain - Death, and continue to jabber on, "no, it's not too big a change. I me - an, 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 tinyin - t - definitions. The Adventure Awaits You! - === - The 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 th - e Vice - President you couldn't care less about the difference between a "bigin - t" and a - "tinyint" entry in MySQL. I'd refer you first to the MySQL documentat - ion, - available at http://www.mysql.com/doc.html, but that's mostly a confus - ing - morass of high-level database jargon. Here are the basics you need to - know - about the database to proceed: - 1. To connect to your database, type "mysql -u root" at the command p - rompt as - any user. If this works without asking you for a password, SHAME ON YO - U! You - should have locked your security down like the README told you to. Yo - u 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 at - http://www.mysql.com/php/manual.php3?section=Privilege_system . - 2. You should now be at a prompt that looks like this: - mysql> - At the prompt, if "bugs" is the name of your Bugzilla database, type: - mysql> use bugs; - (don't forget the ";" at the end of each line, or you'll be kicking yo - urself - all the way through this documentation) - Young Grasshopper, you are now ready for the unveiling of the Bugzil - la - database, in the next section... - === - THE 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 all the "spreadsheets" (tables) in your database - . Cool, - huh? It's kinda' like a filesystem, only much faster and more robust. - Come - on, I'll show you more! - From the command issued above, you should now have some output that - looks + This information comes straight from my life. I was forced to learn + how Bugzilla organizes database because of nitpicky requests from + users for tiny changes in wording, rather than having people + re-educate themselves or figure out how to work our procedures around + the tool. It sucks, but it can and will happen to you, so learn how + the schema works and deal with it when it comes. + + So, here you are with your brand-new installation of Bugzilla. You've + got MySQL set up, Apache working right, Perl DBI and DBD talking to + the database flawlessly. Maybe you've even entered a few test bugs to + make sure email's working; people seem to be notified of new bugs and + changes, and you can enter and edit bugs to your heart's content. + Perhaps you've gone through the trouble of setting up a gateway for + people to submit bugs to your database via email, have had a few + people test it, and received rave reviews from your beta testers. + + What's the next thing you do? Outline a training strategy for your + development team, of course, and bring them up to speed on the new + tool you've labored over for hours. + + Your first training session starts off very well! You have a captive + audience which seems enraptured by the efficiency embodied in this + thing called "Bugzilla". You are caught up describing the nifty + features, how people can save favorite queries in the database, set + them up as headers and footers on their pages, customize their + layouts, generate reports, track status with greater efficiency than + ever before, leap tall buildings with a single bound and rescue Jane + from the clutches of Certain Death! + + But Certain Death speaks up -- a tiny voice, from the dark corners of + the conference room. "I have a concern," the voice hisses from the + darkness, "about the use of the word 'verified'. + + The room, previously filled with happy chatter, lapses into + reverential silence as Certain Death (better known as the Vice + President of Software Engineering) continues. "You see, for two years + we've used the word 'verified' to indicate that a developer or quality + assurance engineer has confirmed that, in fact, a bug is valid. I + don't want to lose two years of training to a new software product. + You need to change the bug status of 'verified' to 'approved' as soon + as possible. To avoid confusion, of course." + + Oh no! Terror strikes your heart, as you find yourself mumbling "yes, + yes, I don't think that would be a problem," You review the changes + with Certain Death, and continue to jabber on, "no, it's not too big a + change. I mean, we have the source code, right? You know, 'Use the + Source, Luke' and all that... no problem," All the while you quiver + inside like a beached jellyfish bubbling, burbling, and boiling on a + hot Jamaican sand dune... + + Thus begins your adventure into the heart of Bugzilla. You've been + forced to learn about non-portable enum() fields, varchar columns, and + tinyint definitions. The Adventure Awaits You! + _________________________________________________________________ + +C.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, available at MySQL.com. 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 at + http://www.mysql.com/php/manual.php3?section=Privilege_system . + 2. You should now be at a prompt that looks like this: + mysql> + At the prompt, if "bugs" is the name you chose in thelocalconfig + file for your Bugzilla database, type: + mysqluse bugs; + + Note + + Don't forget the ";" at the end of each line, or you'll be kicking + yourself later. + _________________________________________________________________ + +C.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 all the "spreadsheets" (tables) in your + database. It is similar to a file system, only faster and more robust + for certain types of operations. + + 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 | - | shadowlog | - | versions | - | votes | - | watch | - +-------------------+ - If it doesn't look quite the same, that probably means it's - time to - update this documentation :) ++-------------------+ +| Tables in bugs | ++-------------------+ +| attachments | +| bugs | +| bugs_activity | +| cc | +| components | +| dependencies | +| fielddefs | +| groups | +| keyworddefs | +| keywords | +| logincookies | +| longdescs | +| milestones | +| namedqueries | +| products | +| profiles | +| profiles_activity | +| shadowlog | +| tokens | +| versions | +| votes | +| watch | ++-------------------+ + Here's an overview of what each table does. Most columns in each ta ble have descriptive names that make it fairly trivial to figure out their jobs @@ -4602,16 +4594,23 @@ C.2. MySQL Bugzilla Database Introduction C.3. MySQL Permissions & Grant Tables - Note: The following portion of documentation comes from my answer - to an old discussion of Keystone, a cool product that does - trouble-ticket tracking for IT departments. I wrote this post to - the Keystone support group regarding MySQL grant table permissions, - and how to use them effectively. It is badly in need of updating, - as I believe MySQL has added a field or two to the grant tables - since this time, but it serves as a decent introduction and - troubleshooting document for grant table issues. I used Keynote to - track my troubles until I discovered Bugzilla, which gave me a - whole new set of troubles to work on : ) + Note + + The following portion of documentation comes from my answer to an old + discussion of Keystone, a cool product that does trouble-ticket + tracking for IT departments. I wrote this post to the Keystone support + group regarding MySQL grant table permissions, and how to use them + effectively. It is badly in need of updating, as I believe MySQL has + added a field or two to the grant tables since this time, but it + serves as a decent introduction and troubleshooting document for grant + table issues. I used Keynote to track my troubles until I discovered + Bugzilla, which gave me a whole new set of troubles to work on : ) + Although it is of limited use, it still has SOME use, thus it's still + included. + + Please note, however, that I was a relatively new user to MySQL at the + time. Some of my suggestions, particularly in how to set up security, + showed a terrible lack of security-related database experience. From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 Date: Mon, 1 Mar 1999 21:37:04 -0700 @@ -4788,48 +4787,16 @@ C.3. MySQL Permissions & Grant Tables l. It is more detailed than I! http://www.mysql.com/Manual/manual.html. - ---------------------------------------------------------------------- - ------ - 10/12/2000 - Matthew sent in some mail with updated contact information: - NEW CONTACT INFORMATION: - ------------------------ - Matthew P. Barnson - Manager, Systems Administration - Excite@Home Business Applications - mbarnson@excitehome.net - (801)234-8300 - _________________________________________________________________ - -C.4. Cleaning up after mucking with Bugzilla - - Contributed by Eric Hanson: - There are several things, and one trick. There is a small tiny piece - of - documentation I saw once that said something very important. - 1) After pretty much any manual working of the Mysql db, you must - delete a file in the bugzilla directory: data/versioncache - Versioncache basically is a way to speed up bugzilla (from what I - understand). It stores a lot of commonly used information. However, - this file is refreshed every so often (I can't remember the time - interval though). So eventually all changes do propogate out, so you - may see stuff suddenly working. - 2) Assuming that failed, you will also have to check something with t - he - checksetup.pl file. It actually is run twice. The first time it - creates the file: localconfig. You can modify localconfig, (or not if - you are doing bug_status stuff) or you should delete localconfig and - rerun your modified checksetup.pl. Since I don't actually see anythin - g - in localconfig pertaining to bug_status, this point is mainly a FYI. _________________________________________________________________ Chapter 7. Bugzilla Variants - Note: I know there are more variants than just RedHat Bugzilla out - there. Please help me get information about them, their project - status, and benefits there might be in using them or in using their - code in main-tree Bugzilla. + Note + + I know there are more variants than just RedHat Bugzilla out there. + Please help me get information about them, their project status, and + benefits there might be in using them or in using their code in + main-tree Bugzilla. _________________________________________________________________ 7.1. Red Hat Bugzilla @@ -5360,6 +5327,19 @@ How to use this License for your documents Glossary +0-9, high ascii + + .htaccess + Apache web server, and other NCSA-compliant web servers, + observe the convention of using files in directories called + .htaccess files. These restrict parameters of the web server. + In Bugzilla, they are used to restrict access to certain files + which would otherwise compromise your installation. For + instance, the localconfig file contains the password to your + database. If this information were generally available, and + remote access to your database turned on, you risk corruption + of your database by computer criminals or the curious. + A There are no entries for A @@ -5369,8 +5349,8 @@ B Bug A "Bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, - etc. Many also refer to a "Ticket" or "Issue"; in this context, - they are synonymous. + etc. Some also refer to a "tickets" or "issues"; in the context + of Bugzilla, they are synonymous. Bug Number Each Bugzilla Bug is assigned a number that uniquely identifies @@ -5387,7 +5367,7 @@ B I Infinite Loop - See: Recursion + A loop of information that never ends; see recursion. P @@ -5402,26 +5382,28 @@ P A company sells a software product called "X". They also maintain some older software called "Y", and have a secret project "Z". An effective use of Products might be to create - Products "X", "Y", and "Z", each with Components "User - Interface", "Database", and "Business Logic". They might also - change group permissions so that only those people who are - members of Group "Z" can see components and bugs under Product - "Z". + Products "X", "Y", "Z", each with Components of User Interface, + Database, and Business Logic. They might also change group + permissions so that only those people who are members of Group + "Z" can see components and bugs under Product "Z". Q - Q/A - "Q/A" is short for "Quality Assurance". In most large software - development organizations, there is a team devoted to ensuring - the product meets minimum standards before shipping. This team - will also generally want to track the progress of bugs over - their life cycle, thus the need for the "Q/A Contact" field in - a Bug. + QA + "QA", "Q/A", and "Q.A." are short for "Quality Assurance". In + most large software development organizations, there is a team + devoted to ensuring the product meets minimum standards before + shipping. This team will also generally want to track the + progress of bugs over their life cycle, thus the need for the + "QA Contact" field in a Bug. R Recursion - See: Infinite Loop + The property of a function looking back at itself for + something. "GNU", for instance, stands for "GNU's Not UNIX", + thus recursing upon itself for definition. For further clarity, + see Infinite Loop. Z |