From f0324c374c51b61a8615044631337a60eb9a37a8 Mon Sep 17 00:00:00 2001 From: "jake%bugzilla.org" <> Date: Fri, 3 Jan 2003 01:29:23 +0000 Subject: Recomiple the docs for the 2.17.3 release --- docs/html/Bugzilla-Guide.html | 1274 +++++++++----- docs/html/administration.html | 12 +- docs/html/cust-change-permissions.html | 306 ++++ docs/html/cust-templates.html | 30 +- docs/html/dbdoc.html | 4 +- docs/html/dbmodify.html | 184 ++ docs/html/extraconfig.html | 44 +- docs/html/faq.html | 538 +++--- docs/html/glossary.html | 2 +- docs/html/groups.html | 146 +- docs/html/index.html | 10 +- docs/html/installation.html | 22 +- docs/html/parameters.html | 37 +- docs/html/rhbugzilla.html | 23 +- docs/html/security.html | 334 +++- docs/html/stepbystep.html | 82 +- docs/html/troubleshooting.html | 4 +- docs/html/upgrading.html | 10 +- docs/html/variant-fenris.html | 2 + docs/html/variant-issuezilla.html | 2 + docs/html/variant-perforce.html | 2 + docs/html/variant-scarab.html | 2 + docs/html/variant-sourceforge.html | 2 + docs/html/win32.html | 8 +- docs/txt/Bugzilla-Guide.txt | 2956 ++++++++++++++++---------------- 25 files changed, 3713 insertions(+), 2323 deletions(-) create mode 100644 docs/html/cust-change-permissions.html create mode 100644 docs/html/dbmodify.html (limited to 'docs') diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index bc8f148cd..2e33a3c17 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -245,12 +245,12 @@ HREF="#security" >
5.7. Template CustomisationTemplate Customization
5.8. Change Permission CustomisationChange Permission Customization
5.9.
4-1. Installing ActivePerl ppd Modules on Microsoft Windows
4-2. Installing OpenInteract ppd Modules manually on Microsoft Windows
4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier
MySQL database server - (3.22.5 or greater) + (3.23.6 or greater)

  • Perl - (5.005 or greater, 5.6.1 is recommended if you wish to + (5.6, 5.6.1 is recommended if you wish to use Bundle::Bugzilla)

    • Template - (v2.07) + (v2.08)

  • File::Temp (v1.804) (Prerequisite for Template) +> + (1.804) (Prerequisite for Template)

  • AppConfig - (v1.52) + (1.52)

  • Text::Wrap - (v2001.0131) + (2001.0131)

  • File::Spec - (v0.8.2) + (0.82)

  • DBD::mysql - (v1.2209) + (1.2209)

  • DBI - (v1.13) + (1.13)

  • CGI::Carp - (any) +> CGI + + (2.88)

    • GD - (v1.19) for bug charting + (1.20) for bug charting +

  • GD::Chart + (any) for bug charting +

  • GD::Text::Align + (any) for bug charting

  • Chart::Base - (v0.99c) for bug charting + (0.99c) for bug charting

  • perl.com for the rare *nix systems which don't have it. - Although Bugzilla runs with all post-5.005 - versions of Perl, it's a good idea to be up to the very latest version + Although Bugzilla runs with perl 5.6, + it's a good idea to be up to the very latest version if you can when running Bugzilla. As of this writing, that is Perl - version 5.6.1.

    4.1.5.1. DBI

    4.1.5.2. Data::Dumper

    4.1.5.3. MySQL-related modules

    4.1.5.4. TimeDate modules

    4.1.5.5. GD (optional)

    4.1.5.6. Chart::Base (optional)

    4.1.5.7. Template Toolkit

    When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except that it is recommended you use the high speed XS Stash of the Template - Toolkit, in order to achieve best performance. However, there are - known problems with XS Stash and Perl 5.005_02 and lower. If you - wish to use these older versions of Perl, please use the regular - stash.

    4.1.6. HTTP Server

    4.1.7. Bugzilla

    4.1.8. Setting Up the MySQL Database

    4.1.9.

    4.1.10. Securing MySQL

    4.1.11. Configuring Bugzilla

    4.2.1. Dependency Charts

    4.2.2. Bug Graphs

    4.2.3. The Whining Cron

    "UTF-8".

    Note: using <meta> tags to set the charset is not - recommended, as there's a bug in Netscape 4.x which causes pages - marked up in this way to load twice.

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

    From Andrew Pearson:

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

    4.5.2. DBD::Sponge::db prepare failed

    usebuggroupsmakeproductgroups: - This dictates whether or not to implement group-based security for - Bugzilla. If set, Bugzilla bugs can have an associated 'group', - defining which users are allowed to see and edit the - bug.

    Set "usebuggroups" to "on" - only - if you may wish to restrict access to particular bugs to certain - groups of users. I suggest leaving - this parameter off - while initially testing your Bugzilla.

  • usebuggroupsentryuseentrygroupdefault: - Bugzilla Products can have a group associated with them, so that - certain users can only see bugs in certain products. When this parameter - is set to "on", this places all newly-created bugs in the - group for their product immediately.

    , this + causes the initial group controls on newly created products + to place all newly-created bugs in the group + having the same name as the product immediately. + After a product is initially created, the group controls + can be further adjusted without interference by + this mechanism.

  • Groups allow the administrator to isolate bugs or products that should only be seen by certain people. - There are two types of group - Generic Groups, and Product-Based Groups. + The association between products and groups is controlled from + the product edit page under "Edit Group Controls." +

    If the makeproductgroups param is on, a new group will be automatically + created for every new product.

    Product-Based Groups are matched with products, and allow you to restrict - access to bugs on a per-product basis. They are enabled using the - usebuggroups Param. Turning on the usebuggroupsentry - Param will mean bugs automatically get added to their product group when - filed. +> On the product edit page, there is a page to edit the + "Group Controls" + for a product and determine which groups are applicable, default, + and mandatory for each product as well as controlling entry + for each product and being able to set bugs in a product to be + totally read-only unless some group restrictions are met.

    Generic Groups have no special relationship to products; - you create them, and put bugs in them - as required. One example of the use of Generic Groups - is Mozilla's "Security" group, - into which security-sensitive bugs are placed until fixed. Only the - Mozilla Security Team are members of this group. +> For each group, it is possible to specify if membership in that + group is...

    To create Generic Groups:

    1. required for bug entry, +

    2. Not applicable to this product(NA), + a possible restriction for a member of the + group to place on a bug in this product(Shown), + a default restriction for a member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product(Mandatory). +

    3. Not applicable by non-members to this product(NA), + a possible restriction for a non-member of the + group to place on a bug in this product(Shown), + a default restriction for a non-member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product when entered by a non-member(Mandatory). +

    4. required in order to make any change + to bugs in this product including comments. +

    To create Groups:

    1. Select the "groups" +>Select the "groups" link in the footer.

    2. Take a moment to understand the instructions on the "Edit - Groups" screen, then select the "Add Group" link.

      Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.

    3. Fill out the "Group", "Description", and - "User RegExp" fields. "New User RegExp" allows you to automatically +>Fill out the "Group", "Description", + and "User RegExp" fields. + "User RegExp" allows you to automatically place all users who fulfill the Regular Expression into the new group. - When you have finished, click "Add".

      "Add".

    To use Product-Based Groups:

    1. Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen.

    2. In future, when you create a Product, a matching group will be - automatically created. If you need to add a Product Group to - a Product which was created before you turned on usebuggroups, - then simply create a new group, as outlined above, with the - same name as the Product.

    Note that group permissions are such that you need to be a member of all the groups a bug is in, for whatever - reason, to see that bug. + reason, to see that bug. Similarly, you must be a member + of all of the entry groups for a product + to add bugs to a product and you must be a member + of all of the canedit groups for a product + in order to make any change to bugs in that + product.

  • Ensure you are running at least MysQL version 3.22.32 or newer. - Earlier versions had notable security holes and (from a security - point of view) poor default configuration choices.

  • There is no substitute for understanding the tools on your system!

  • Lock down /etc/inetd.conf. Heck, disable inet entirely on this - box. It should only listen to port 25 for Sendmail and port 80 for - Apache.

    Lock down /etc/inetd.conf. Heck, disable + inet entirely on this box. It should only listen to port 25 for + Sendmail and port 80 for Apache.

  • Ensure you have adequate access controls for the - $BUGZILLA_HOME/data/ directory, as well as the - $BUGZILLA_HOME/localconfig file. + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. The localconfig file stores your "bugs" database account password. In addition, some - files under $BUGZILLA_HOME/data/ store sensitive information. + files under $BUGZILLA_HOME/data/ store sensitive + information. +

    Also, beware that some text editors create backup files in the + current working directory so you need to also secure files like + localconfig~.

    Simply blocking .*localconfig.* + won't work because the QuickSearch feature requires the web browser + to be able to retrieve localconfig.js and + others may be introduced in the future (see + bug + 186383 for more information. +

    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.

    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, + .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.: + localconfig in your web browser (e.g.:

  • When you run checksetup.pl, the script will attempt to modify various permissions on files which Bugzilla uses. If you do not have - a webservergroup set in the localconfig file, then Bugzilla will have - to make certain files world readable and/or writable. + a webservergroup set in the localconfig file, + then Bugzilla will have to make certain files world readable and/or + writable. THIS IS INSECURE! @@ -8298,16 +8485,26 @@ VALIGN="TOP" >

    On Apache, you can use .htaccess files to protect access to - these directories, as outlined in +>On Apache, you can use .htaccess files to + protect access to these directories, as outlined in Bugs Bug - 57161 57161 and + 186383 - for the localconfig file, and + for the localconfig file, and - for adequate protection in your data/ directory.

    data/ directory. + Also, don't forget about the template/ and + Bugzilla/ directories and to allow access to the + data/webdot directory for the + 192.20.225.10 IP address if you are + using webdot from research.att.com. The easiest way to + accomplish this is to set $create_htaccess to 1 + in localconfig. However, the information below + is provided for those that want to know exactly what is created. +

    Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other non-Apache web servers, please consult your system documentation for how to secure these files from being 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

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

    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

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

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

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

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

    • @@ -8351,9 +8706,9 @@ CLASS="section" >5.7. Template Customisation5.7. Template Customization

    One of the large changes for 2.16 was the templatisation of the +> One of the large changes for 2.16 was the templatization of the entire user-facing UI, using the

    Templatisation also makes localised versions of Bugzilla possible, +> Templatization also makes localized versions of Bugzilla possible, for the first time. In the future, a Bugzilla installation may - have templates installed for multiple localisations, and select + have templates installed for multiple localizations, and select which ones to use based on the user's browser language setting.

    5.7.1. What to Edit

    template, which contains a directory for - each installed localisation. The default English templates are + each installed localization. The default English templates are therefore in en

    The first method of making customisations is to directly edit the +> The first method of making customizations is to directly edit the templates in template/en/default

    5.7.2. How To Edit Templates

    5.7.3. Template Formats

    5.7.4. Particular Templates

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

    : This contains the "banner", the part of the header that appears at the top of all Bugzilla pages. The default banner is reasonably - barren, so you'll probably want to customise this to give your + barren, so you'll probably want to customize this to give your installation a distinctive look and feel. It is recommended you preserve the Bugzilla version number in some form so the version you are running can be determined, and users know what docs to read. @@ -8826,7 +9181,7 @@ CLASS="section" >5.8. Change Permission Customisation5.8. Change Permission Customization

    For maximum flexibility, customising this means editing Bugzilla's Perl +> For maximum flexibility, customizing this means editing Bugzilla's Perl code. This gives the administrator complete control over exactly who is allowed to do what. The relevant function is called

    More complex customisations are not much harder. Basically, you add +> More complex customizations are not much harder. Basically, you add a check in the right place in the function, i.e. after all the variables you are using have been set up. So, don't look at $ownerid before $ownerid has been obtained from the database. You can either add a @@ -8987,7 +9342,7 @@ CLASS="filename" CLASS="filename" >@::log_columns. If you need help writing custom - rules for your organisation, ask in the newsgroup. + rules for your organization, ask in the newsgroup.

    However, things get a bit more complicated if you've made changes to Bugzilla's code. In this case, you may have to re-make or - reapply those changes. One good method is to take a diff of your customised + reapply those changes. One good method is to take a diff of your customized version against the original, so you can survey all that you've changed. - Hopefully, templatisation will reduce the need for + Hopefully, templatization will reduce the need for this in the future.

    From version 2.8 onwards, Bugzilla databases can be automatically +>From version 2.8 onward, Bugzilla databases can be automatically carried forward during an upgrade. However, because the developers of Bugzilla are constantly adding new tables, columns and fields, you'll probably get SQL errors if you just @@ -9177,64 +9532,64 @@ HREF="#faq-general" >

    A.1.1. Where can I find information about Bugzilla?
    A.1.2. What license is Bugzilla distributed under?
    A.1.3. How do I get commercial support for Bugzilla?
    A.1.4. What major companies or projects are currently using Bugzilla for bug-tracking?
    A.1.5. Who maintains Bugzilla?
    A.1.6. How does Bugzilla stack up against other bug-tracking databases?
    A.1.7. Why doesn't Bugzilla offer this or that feature or compatability +HREF="#AEN1799" +> Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?
    A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL.
    A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else?
    A.1.10. Is there an easy way to change the Bugzilla cookie name?
    A.2.1. Is Bugzilla web-based, or do you have to have specific software or a specific operating system on your machine?
    A.2.2. Can Bugzilla integrate with Perforce (SCM software)?
    A.2.3. Does Bugzilla allow the user to track multiple projects?
    A.2.4. If I am on many projects, and search for all bugs assigned to me, will Bugzilla list them for me and allow me to sort by project, severity etc?
    A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed?
    A.2.6. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and the choice of acceptable values? @@ -9291,35 +9646,35 @@ HREF="#AEN1791" >
    A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :)
    A.2.8. Is there email notification and if so, what do you see when you get an email?
    A.2.9. Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc?
    A.2.10. Do users have to have any particular type of email application?
    A.2.11. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be imported into "matching" fields? If I wanted to take the results of a query @@ -9328,28 +9683,28 @@ HREF="#AEN1822" >
    A.2.12. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable?
    A.2.13. Can a user create and save reports? Can they do this in Word format? Excel format?
    A.2.14. Does Bugzilla have the ability to search by word, phrase, compound search?
    A.2.15. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? @@ -9357,19 +9712,19 @@ HREF="#AEN1845" >
    A.2.16. Are there any backup features provided?
    A.2.17. Can users be on the system while a backup is in progress?
    A.2.18. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -9379,7 +9734,7 @@ HREF="#AEN1861" >
    A.2.19. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -9389,7 +9744,7 @@ HREF="#AEN1867" >
    A.2.20. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above?
    A.3.1. How do I completely disable MySQL security if it's giving me problems (I've followed the instructions in the installation section of this guide)?
    A.3.2. Are there any security problems with Bugzilla?
    A.3.3. I've implemented the security fixes mentioned in Chris Yeh's security advisory of 5/10/2000 advising not to run MySQL as root, and am running into problems with MySQL no longer working correctly. @@ -9435,48 +9790,48 @@ HREF="#faq-email" >
    A.4.1. I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user?
    A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it?
    A.4.3. I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it?
    A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have?
    A.4.5. How do I set up the email interface to submit/change bugs via email?
    A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives?
    A.4.7. How come email from Bugzilla changes never reaches me?
    A.5.1. I've heard Bugzilla can be used with Oracle?
    A.5.2. I think my database might be corrupted, or contain invalid entries. What do I do?
    A.5.3. I want to manually edit some entries in my database. How?
    A.5.4. I try to add myself as a user, but Bugzilla always tells me my password is wrong. -
    A.5.5. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect.
    A.5.6. A.5.5. How do I synchronize bug information among multiple different Bugzilla databases?
    A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
    A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32?
    A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why?
    A.6.4. I'm having trouble with the perl modules for NT not being able to talk to to the database.
    A.7.1. How do I change my user name (email address) in Bugzilla?
    A.7.2. The query page is very confusing. Isn't there a simpler way to query?
    A.7.3. I'm confused by the behavior of the "accept" button in the Show Bug form. Why doesn't it assign the bug to me when I accept it?
    A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong?
    A.7.5. Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. -
    A.7.6. How do I change a keyword in Bugzilla, once some bugs are using it?
    A.8.1. What kind of style should I use for templatization?
    A.8.2. What bugs are in Bugzilla right now?
    A.8.3. How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"?
    A.8.4. What's the best way to submit patches? What guidelines should I follow?

    A.1.1.

    A.1.2.

    A.1.3. - http://bugzilla.org/consulting.html + is a list of people and companies who have asked us to list them + as consultants for Bugzilla. +

    www.collab.net

    A.1.4. There are dozens of major comapanies with public +> of major companies with public Bugzilla sites to track bugs in their products. A few include:

    AtHome CorporationRed Hat Software

    A.1.5. core team, - led by Dave Miller (justdave@syndicomm.com). + led by Dave Miller (justdave@netscape.com).

    A.1.6.

    A.1.7. - Why doesn't Bugzilla offer this or that feature or compatability + Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?

    A.1.8. - There is DB-independence work afoot. PostgreSQL support is planned - for 2.18, and full DB-independence can't be far further on. + MySQL was originally chosen because it is free, easy to install, + and was available for the hardware Netscape intended to run it on.

    There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track + the progress of these initiatives in bugs 98304 + and 173130 + respectively. +

    Once both of these are done, adding support for additional + database servers should be trivial. +

    A.1.9.

    A.1.10.

    A.2.1.

    A.2.2.

    A.2.3. - Absolutely! You can track any number of Products (although you - are limited to about 55 or so if - you are using Product-Based Groups), that can each be composed of any - number of Components. + Absolutely! You can track any number of Products that can each be + composed of any number of Components.

    A.2.4.

    A.2.5. Yes - any sort of attachment is allowed, although administrators can configure a maximum size. - There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. + Bugzilla gives the user the option of either using the MIME-type + supplied by the browser, choosing from a pre-defined list or + manually typing any arbitrary MIME-type.

    A.2.6.

    A.2.7. Yes. Look at http://bugzilla.mozilla.org/reports.cgi for basic reporting - and graphing facilities. +> http://bugzilla.mozilla.org/report.cgi for samples of what + Bugzilla can do in reporting and graphing.

    For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. +> If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, + beware that giving direct access to the database does contain some + security implications. Even if you give read-only access to the + bugs database it will bypass the secure bugs features of Bugzilla.

    A.2.8.

    A.2.9.

    A.2.10.

    A.2.11. - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. -

    If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. -

    To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF + is meant to be machine readable and thus it is assumed that the + URL would be generated progmatically so there is no user visible + link to this format. +

    As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - http://www.mozilla.org/quality/help/bugzilla-helper.html Currently the only script included with Bugzilla that can import + data is importxml.pl which is intended to be + used for importing the data generated by xml.cgi -

    There are also scripts included in the contrib/ + directory for using e-mail to import information into Bugzilla, + but these scripts are not currently supported and included for + educational purposes. +

    A.2.12. - To a certain extent, yes. 2.16's templates mean that you can localise - the user-facing UI (and several projects are doing exactly that.) However, - error messages and the admin interface are currently not localisable. - This should be achieved by 2.18. + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html. + The admin interfaces are still not included in these translated + templates and is therefore still English only. Also, there may be + issues with the charset not being declared. See bug 126226 + for more information.

    A.2.13. - Yes. No. No. + Yes. No. Yes (using the CSV format).

    A.2.14.

    A.2.15.

    A.2.16.

    A.2.17.

    A.2.18.

    A.2.19.

    A.2.20.

    A.3.1.

    A.3.2.

    A.3.3.

    A.4.1. The user should be able to set - this in user email preferences (uncheck all boxes.) + this in user email preferences (uncheck all boxes) or you can add + their email address to the data/nomail file.

    A.4.2. - Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>".

    A.4.3.

    A.4.4.

    A.4.5.

    A.4.6.

    A.4.7.

    A.5.1. - Red Hat Bugzilla works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's newer version (based on 2.17.1 and soon to be merged into + the main distribution) runs on PostgreSQL. At this time we know of + no recent ports of Bugzilla to Oracle but do intend to support it + in the future (possibly the 2.20 time-frame).

    A.5.2.

    A.5.3. There is no facility in Bugzilla itself to do this. It's also generally not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. -

    A.5.4. - I try to add myself as a user, but Bugzilla always tells me my password is wrong. -

    mysql - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL Control + Center.

    A.5.5. A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. @@ -11186,10 +11566,42 @@ CLASS="answer" > Try running MySQL from its binary: "mysqld --skip-grant-tables". This will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. -

    localconfig. +

    Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network + as a troubleshooting step. +

    A.5.6. A.5.5. How do I synchronize bug information among multiple different Bugzilla databases? @@ -11244,7 +11656,7 @@ CLASS="qandaentry" CLASS="question" >

    A.6.1.

    A.6.2.

    A.6.3.

    Microsoft has some advice on this matter, as well:

    A.6.4.

    A.7.1.

    A.7.2.

    A.7.3.

    A.7.4.

    A.7.5. - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. -

    - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime soon, because it would - cripple some other functionality. -

    A.7.6. How do I change a keyword in Bugzilla, once some bugs are using it?

    A.8.1. - Gerv and Myk suggest a 2-space endent, with embedded code sections on + Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this:

    A.8.2.

    A.8.3.

    A.8.4.

    B.2.1. Bugzilla Database Basics

    B.2.1.1. Bugzilla Database Tables

    D.1. Red Hat Bugzilla

    Red Hat Bugzilla is a fork of Bugzilla 2.8. - One of its major benefits is the ability - to work with Oracle, MySQL, and PostGreSQL databases serving as the - back-end, instead of just MySQL. Dave Lawrence of Red Hat is - active in the Bugzilla community, and we hope to see a reunification - of the fork before too long.

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

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

    This section last updated 24 Dec 2002

    This section last updated 27 Jul 2002

    Scarab.

    This section last updated 27 Jul 2002

    http://scarab.tigris.org

    This section last updated 27 Jul 2002

    This section last updated 27 Jul 2002

    http://www.sourceforge.net

    This section last updated 27 Jul 2002

    0-9, high ascii

    5.7. Template CustomisationTemplate Customization
    5.7.1. What to Edit
    5.7.2. How To Edit Templates
    5.7.3. Template Formats
    5.7.4. Particular Templates
    5.8. Change Permission CustomisationChange Permission Customization
    5.9. Change Permission Customization
    The Bugzilla Guide
    PrevChapter 5. Administering BugzillaNext

    5.8. Change Permission Customization

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

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

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

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

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

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

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

    PrevHomeNext
    Template CustomizationUpUpgrading to New Releases
    \ No newline at end of file diff --git a/docs/html/cust-templates.html b/docs/html/cust-templates.html index 7c8f17cc1..e0bfa2181 100644 --- a/docs/html/cust-templates.html +++ b/docs/html/cust-templates.html @@ -1,7 +1,7 @@ Template CustomisationTemplate Customization5.7. Template Customisation5.7. Template Customization

    One of the large changes for 2.16 was the templatisation of the +> One of the large changes for 2.16 was the templatization of the entire user-facing UI, using the

    Templatisation also makes localised versions of Bugzilla possible, +> Templatization also makes localized versions of Bugzilla possible, for the first time. In the future, a Bugzilla installation may - have templates installed for multiple localisations, and select + have templates installed for multiple localizations, and select which ones to use based on the user's browser language setting.

    5.7.1. What to Edit

    template, which contains a directory for - each installed localisation. The default English templates are + each installed localization. The default English templates are therefore in en

    The first method of making customisations is to directly edit the +> The first method of making customizations is to directly edit the templates in template/en/default

    5.7.2. How To Edit Templates

    5.7.3. Template Formats

    5.7.4. Particular Templates

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

    : This contains the "banner", the part of the header that appears at the top of all Bugzilla pages. The default banner is reasonably - barren, so you'll probably want to customise this to give your + barren, so you'll probably want to customize this to give your installation a distinctive look and feel. It is recommended you preserve the Bugzilla version number in some form so the version you are running can be determined, and users know what docs to read. @@ -601,7 +601,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Change Permission CustomisationChange Permission Customization

    B.2.1. Bugzilla Database Basics

    B.2.1.1. Bugzilla Database Tables

    Modifying Your Running System

    The Bugzilla Guide
    PrevAppendix B. The Bugzilla DatabaseNext

    B.1. Modifying Your Running System

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

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

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

    PrevHomeNext
    The Bugzilla DatabaseUpMySQL Bugzilla Database Introduction
    \ No newline at end of file diff --git a/docs/html/extraconfig.html b/docs/html/extraconfig.html index 064f1382f..24603c2a4 100644 --- a/docs/html/extraconfig.html +++ b/docs/html/extraconfig.html @@ -81,7 +81,7 @@ CLASS="section" >

    4.2.1. Dependency Charts

    4.2.2. Bug Graphs

    4.2.3. The Whining Cron

    "UTF-8".

    Note: using <meta> tags to set the charset is not - recommended, as there's a bug in Netscape 4.x which causes pages - marked up in this way to load twice.

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

    A.1.1. Where can I find information about Bugzilla?
    A.1.2. What license is Bugzilla distributed under?
    A.1.3. How do I get commercial support for Bugzilla?
    A.1.4. What major companies or projects are currently using Bugzilla for bug-tracking?
    A.1.5. Who maintains Bugzilla?
    A.1.6. How does Bugzilla stack up against other bug-tracking databases?
    A.1.7. Why doesn't Bugzilla offer this or that feature or compatability +HREF="faq.html#AEN1799" +> Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?
    A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL.
    A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else?
    A.1.10. Is there an easy way to change the Bugzilla cookie name?
    A.2.1. Is Bugzilla web-based, or do you have to have specific software or a specific operating system on your machine?
    A.2.2. Can Bugzilla integrate with Perforce (SCM software)?
    A.2.3. Does Bugzilla allow the user to track multiple projects?
    A.2.4. If I am on many projects, and search for all bugs assigned to me, will Bugzilla list them for me and allow me to sort by project, severity etc?
    A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed?
    A.2.6. Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and the choice of acceptable values? @@ -201,35 +201,35 @@ HREF="faq.html#AEN1791" >
    A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :)
    A.2.8. Is there email notification and if so, what do you see when you get an email?
    A.2.9. Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc?
    A.2.10. Do users have to have any particular type of email application?
    A.2.11. Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be imported into "matching" fields? If I wanted to take the results of a query @@ -238,28 +238,28 @@ HREF="faq.html#AEN1822" >
    A.2.12. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable?
    A.2.13. Can a user create and save reports? Can they do this in Word format? Excel format?
    A.2.14. Does Bugzilla have the ability to search by word, phrase, compound search?
    A.2.15. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? @@ -267,19 +267,19 @@ HREF="faq.html#AEN1845" >
    A.2.16. Are there any backup features provided?
    A.2.17. Can users be on the system while a backup is in progress?
    A.2.18. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -289,7 +289,7 @@ HREF="faq.html#AEN1861" >
    A.2.19. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -299,7 +299,7 @@ HREF="faq.html#AEN1867" >
    A.2.20. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above?
    A.3.1. How do I completely disable MySQL security if it's giving me problems (I've followed the instructions in the installation section of this guide)?
    A.3.2. Are there any security problems with Bugzilla?
    A.3.3. I've implemented the security fixes mentioned in Chris Yeh's security advisory of 5/10/2000 advising not to run MySQL as root, and am running into problems with MySQL no longer working correctly. @@ -345,48 +345,48 @@ HREF="faq.html#faq-email" >
    A.4.1. I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user?
    A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it?
    A.4.3. I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it?
    A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have?
    A.4.5. How do I set up the email interface to submit/change bugs via email?
    A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives?
    A.4.7. How come email from Bugzilla changes never reaches me?
    A.5.1. I've heard Bugzilla can be used with Oracle?
    A.5.2. I think my database might be corrupted, or contain invalid entries. What do I do?
    A.5.3. I want to manually edit some entries in my database. How?
    A.5.4. I try to add myself as a user, but Bugzilla always tells me my password is wrong. -
    A.5.5. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect.
    A.5.6. A.5.5. How do I synchronize bug information among multiple different Bugzilla databases?
    A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
    A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32?
    A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why?
    A.6.4. I'm having trouble with the perl modules for NT not being able to talk to to the database.
    A.7.1. How do I change my user name (email address) in Bugzilla?
    A.7.2. The query page is very confusing. Isn't there a simpler way to query?
    A.7.3. I'm confused by the behavior of the "accept" button in the Show Bug form. Why doesn't it assign the bug to me when I accept it?
    A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong?
    A.7.5. Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. -
    A.7.6. How do I change a keyword in Bugzilla, once some bugs are using it?
    A.8.1. What kind of style should I use for templatization?
    A.8.2. What bugs are in Bugzilla right now?
    A.8.3. How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"?
    A.8.4. What's the best way to submit patches? What guidelines should I follow?

    A.1.1.

    A.1.2.

    A.1.3. - http://bugzilla.org/consulting.html + is a list of people and companies who have asked us to list them + as consultants for Bugzilla. +

    www.collab.net

    A.1.4. There are dozens of major comapanies with public +> of major companies with public Bugzilla sites to track bugs in their products. A few include:

    AtHome CorporationRed Hat Software

    A.1.5. core team, - led by Dave Miller (justdave@syndicomm.com). + led by Dave Miller (justdave@netscape.com).

    A.1.6.

    A.1.7. - Why doesn't Bugzilla offer this or that feature or compatability + Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?

    A.1.8. - There is DB-independence work afoot. PostgreSQL support is planned - for 2.18, and full DB-independence can't be far further on. + MySQL was originally chosen because it is free, easy to install, + and was available for the hardware Netscape intended to run it on.

    There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track + the progress of these initiatives in bugs 98304 + and 173130 + respectively. +

    Once both of these are done, adding support for additional + database servers should be trivial. +

    A.1.9.

    A.1.10.

    A.2.1.

    A.2.2.

    A.2.3. - Absolutely! You can track any number of Products (although you - are limited to about 55 or so if - you are using Product-Based Groups), that can each be composed of any - number of Components. + Absolutely! You can track any number of Products that can each be + composed of any number of Components.

    A.2.4.

    A.2.5. Yes - any sort of attachment is allowed, although administrators can configure a maximum size. - There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. + Bugzilla gives the user the option of either using the MIME-type + supplied by the browser, choosing from a pre-defined list or + manually typing any arbitrary MIME-type.

    A.2.6.

    A.2.7. Yes. Look at http://bugzilla.mozilla.org/reports.cgi for basic reporting - and graphing facilities. +> http://bugzilla.mozilla.org/report.cgi for samples of what + Bugzilla can do in reporting and graphing.

    For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. +> If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, + beware that giving direct access to the database does contain some + security implications. Even if you give read-only access to the + bugs database it will bypass the secure bugs features of Bugzilla.

    A.2.8.

    A.2.9.

    A.2.10.

    A.2.11. - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. -

    If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. -

    To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF + is meant to be machine readable and thus it is assumed that the + URL would be generated progmatically so there is no user visible + link to this format. +

    Currently the only script included with Bugzilla that can import + data is importxml.pl which is intended to be + used for importing the data generated by xml.cgi + in association with bug moving. Any other use is left as an + exercise for the user. +

    As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - http://www.mozilla.org/quality/help/bugzilla-helper.html There are also scripts included in the contrib/ -

    A.2.12. - To a certain extent, yes. 2.16's templates mean that you can localise - the user-facing UI (and several projects are doing exactly that.) However, - error messages and the admin interface are currently not localisable. - This should be achieved by 2.18. + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html. + The admin interfaces are still not included in these translated + templates and is therefore still English only. Also, there may be + issues with the charset not being declared. See bug 126226 + for more information.

    A.2.13. - Yes. No. No. + Yes. No. Yes (using the CSV format).

    A.2.14.

    A.2.15.

    A.2.16.

    A.2.17.

    A.2.18.

    A.2.19.

    A.2.20.

    A.3.1.

    A.3.2.

    A.3.3.

    A.4.1. The user should be able to set - this in user email preferences (uncheck all boxes.) + this in user email preferences (uncheck all boxes) or you can add + their email address to the data/nomail file.

    A.4.2. - Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>".

    A.4.3.

    A.4.4.

    A.4.5.

    A.4.6.

    A.4.7.

    A.5.1. - Red Hat Bugzilla works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's newer version (based on 2.17.1 and soon to be merged into + the main distribution) runs on PostgreSQL. At this time we know of + no recent ports of Bugzilla to Oracle but do intend to support it + in the future (possibly the 2.20 time-frame).

    A.5.2.

    A.5.3. There is no facility in Bugzilla itself to do this. It's also generally not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. -

    A.5.4. - I try to add myself as a user, but Bugzilla always tells me my password is wrong. -

    mysql - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL Control + Center.

    A.5.5. A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. @@ -2096,10 +2121,42 @@ CLASS="answer" > Try running MySQL from its binary: "mysqld --skip-grant-tables". This will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. -

    localconfig. +

    Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network + as a troubleshooting step. +

    A.5.6. A.5.5. How do I synchronize bug information among multiple different Bugzilla databases? @@ -2154,7 +2211,7 @@ CLASS="qandaentry" CLASS="question" >

    A.6.1.

    A.6.2.

    A.6.3.

    Microsoft has some advice on this matter, as well:

    A.6.4.

    A.7.1.

    A.7.2.

    A.7.3.

    A.7.4.

    A.7.5. - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. -

    - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime soon, because it would - cripple some other functionality. -

    A.7.6. How do I change a keyword in Bugzilla, once some bugs are using it?

    A.8.1. - Gerv and Myk suggest a 2-space endent, with embedded code sections on + Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this:

    A.8.2.

    A.8.3.

    A.8.4.

    0-9, high ascii

    Groups allow the administrator to isolate bugs or products that should only be seen by certain people. - There are two types of group - Generic Groups, and Product-Based Groups. + The association between products and groups is controlled from + the product edit page under "Edit Group Controls."

    Product-Based Groups are matched with products, and allow you to restrict - access to bugs on a per-product basis. They are enabled using the - usebuggroups Param. Turning on the usebuggroupsentry - Param will mean bugs automatically get added to their product group when - filed. +> If the makeproductgroups param is on, a new group will be automatically + created for every new product.

    Generic Groups have no special relationship to products; - you create them, and put bugs in them - as required. One example of the use of Generic Groups - is Mozilla's "Security" group, - into which security-sensitive bugs are placed until fixed. Only the - Mozilla Security Team are members of this group. +> On the product edit page, there is a page to edit the + "Group Controls" + for a product and determine which groups are applicable, default, + and mandatory for each product as well as controlling entry + for each product and being able to set bugs in a product to be + totally read-only unless some group restrictions are met.

    To create Generic Groups:

    For each group, it is possible to specify if membership in that + group is... +

    1. Select the "groups" +> required for bug entry, +

    2. Not applicable to this product(NA), + a possible restriction for a member of the + group to place on a bug in this product(Shown), + a default restriction for a member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product(Mandatory). +

    3. Not applicable by non-members to this product(NA), + a possible restriction for a non-member of the + group to place on a bug in this product(Shown), + a default restriction for a non-member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product when entered by a non-member(Mandatory). +

    4. required in order to make any change + to bugs in this product including comments. +

    To create Groups:

    1. Select the "groups" link in the footer.

    2. Take a moment to understand the instructions on the "Edit - Groups" screen, then select the "Add Group" link.

      Take a moment to understand the instructions on the "Edit + Groups" screen, then select the "Add Group" link.

    3. Fill out the "Group", "Description", and - "User RegExp" fields. "New User RegExp" allows you to automatically +>Fill out the "Group", "Description", + and "User RegExp" fields. + "User RegExp" allows you to automatically place all users who fulfill the Regular Expression into the new group. - When you have finished, click "Add".

      "Add".

    To use Product-Based Groups:

    1. Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen.

    2. In future, when you create a Product, a matching group will be - automatically created. If you need to add a Product Group to - a Product which was created before you turned on usebuggroups, - then simply create a new group, as outlined above, with the - same name as the Product.

    Note that group permissions are such that you need to be a member of all the groups a bug is in, for whatever - reason, to see that bug. + reason, to see that bug. Similarly, you must be a member + of all of the entry groups for a product + to add bugs to a product and you must be a member + of all of the canedit groups for a product + in order to make any change to bugs in that + product.

    4.2.1. Dependency Charts
    4.2.2. Bug Graphs
    4.2.3. The Whining Cron
    4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1
    4.5.2. DBD::Sponge::db prepare failed

    usebuggroupsmakeproductgroups: - This dictates whether or not to implement group-based security for - Bugzilla. If set, Bugzilla bugs can have an associated 'group', - defining which users are allowed to see and edit the - bug.

    Set "usebuggroups" to "on" - only - if you may wish to restrict access to particular bugs to certain - groups of users. I suggest leaving - this parameter off - while initially testing your Bugzilla.

  • usebuggroupsentryuseentrygroupdefault: - Bugzilla Products can have a group associated with them, so that - certain users can only see bugs in certain products. When this parameter - is set to "on", this places all newly-created bugs in the - group for their product immediately.

    , this + causes the initial group controls on newly created products + to place all newly-created bugs in the group + having the same name as the product immediately. + After a product is initially created, the group controls + can be further adjusted without interference by + this mechanism.

  • D.1. Red Hat Bugzilla

    Red Hat Bugzilla is a fork of Bugzilla 2.8. - One of its major benefits is the ability - to work with Oracle, MySQL, and PostGreSQL databases serving as the - back-end, instead of just MySQL. Dave Lawrence of Red Hat is - active in the Bugzilla community, and we hope to see a reunification - of the fork before too long.

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

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

    This section last updated 24 Dec 2002

  • Ensure you are running at least MysQL version 3.22.32 or newer. - Earlier versions had notable security holes and (from a security - point of view) poor default configuration choices.

  • There is no substitute for understanding the tools on your system!

  • Lock down /etc/inetd.conf. Heck, disable inet entirely on this - box. It should only listen to port 25 for Sendmail and port 80 for - Apache.

    Lock down /etc/inetd.conf. Heck, disable + inet entirely on this box. It should only listen to port 25 for + Sendmail and port 80 for Apache.

  • Ensure you have adequate access controls for the - $BUGZILLA_HOME/data/ directory, as well as the - $BUGZILLA_HOME/localconfig file. + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. The localconfig file stores your "bugs" database account password. In addition, some - files under $BUGZILLA_HOME/data/ store sensitive information. + files under $BUGZILLA_HOME/data/ store sensitive + information.

    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.

    Also, beware that some text editors create backup files in the + current working directory so you need to also secure files like + localconfig~. +

    • Simply blocking .*localconfig.* + won't work because the QuickSearch feature requires the web browser + to be able to retrieve localconfig.js and + others may be introduced in the future (see + bug + 186383 for more information. +

    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, + .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.: + localconfig in your web browser (e.g.:

  • When you run checksetup.pl, the script will attempt to modify various permissions on files which Bugzilla uses. If you do not have - a webservergroup set in the localconfig file, then Bugzilla will have - to make certain files world readable and/or writable. + a webservergroup set in the localconfig file, + then Bugzilla will have to make certain files world readable and/or + writable. THIS IS INSECURE! @@ -307,16 +387,26 @@ VALIGN="TOP" >

    • On Apache, you can use .htaccess files to protect access to - these directories, as outlined in +>On Apache, you can use .htaccess files to + protect access to these directories, as outlined in Bugs Bug - 57161 57161 and + 186383 - for the localconfig file, and + for the localconfig file, and - for adequate protection in your data/ directory.

    data/ directory. + Also, don't forget about the template/ and + Bugzilla/ directories and to allow access to the + data/webdot directory for the + 192.20.225.10 IP address if you are + using webdot from research.att.com. The easiest way to + accomplish this is to set $create_htaccess to 1 + in localconfig. However, the information below + is provided for those that want to know exactly what is created. +

    Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other non-Apache web servers, please consult your system documentation for how to secure these files from being 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

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

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

    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

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

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

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

    @@ -411,7 +659,7 @@ ACCESSKEY="U" WIDTH="33%" ALIGN="right" VALIGN="top" ->Template CustomisationTemplate CustomizationMySQL database server     - (3.22.5 or greater) + (3.23.6 or greater)

  • Perl - (5.005 or greater, 5.6.1 is recommended if you wish to + (5.6, 5.6.1 is recommended if you wish to use Bundle::Bugzilla)

    • Template - (v2.07) + (v2.08)

  • File::Temp (v1.804) (Prerequisite for Template) +> + (1.804) (Prerequisite for Template)

  • AppConfig - (v1.52) + (1.52)

  • Text::Wrap - (v2001.0131) + (2001.0131)

  • File::Spec - (v0.8.2) + (0.82)

  • DBD::mysql - (v1.2209) + (1.2209)

  • DBI - (v1.13) + (1.13)

  • CGI::Carp - (any) +> CGI + + (2.88)

    • GD - (v1.19) for bug charting + (1.20) for bug charting +

  • GD::Chart + (any) for bug charting +

  • GD::Text::Align + (any) for bug charting

  • Chart::Base - (v0.99c) for bug charting + (0.99c) for bug charting

  • perl.com for the rare *nix systems which don't have it. - Although Bugzilla runs with all post-5.005 - versions of Perl, it's a good idea to be up to the very latest version + Although Bugzilla runs with perl 5.6, + it's a good idea to be up to the very latest version if you can when running Bugzilla. As of this writing, that is Perl - version 5.6.1.

    4.1.5.1. DBI

    4.1.5.2. Data::Dumper

    4.1.5.3. MySQL-related modules

    4.1.5.4. TimeDate modules

    4.1.5.5. GD (optional)

    4.1.5.6. Chart::Base (optional)

    4.1.5.7. Template Toolkit

    When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except that it is recommended you use the high speed XS Stash of the Template - Toolkit, in order to achieve best performance. However, there are - known problems with XS Stash and Perl 5.005_02 and lower. If you - wish to use these older versions of Perl, please use the regular - stash.

    4.1.6. HTTP Server

    4.1.7. Bugzilla

    4.1.8. Setting Up the MySQL Database

    4.1.9.

    4.1.10. Securing MySQL

    4.1.11. Configuring Bugzilla

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

    4.5.2. DBD::Sponge::db prepare failed

    However, things get a bit more complicated if you've made changes to Bugzilla's code. In this case, you may have to re-make or - reapply those changes. One good method is to take a diff of your customised + reapply those changes. One good method is to take a diff of your customized version against the original, so you can survey all that you've changed. - Hopefully, templatisation will reduce the need for + Hopefully, templatization will reduce the need for this in the future.

    From version 2.8 onwards, Bugzilla databases can be automatically +>From version 2.8 onward, Bugzilla databases can be automatically carried forward during an upgrade. However, because the developers of Bugzilla are constantly adding new tables, columns and fields, you'll probably get SQL errors if you just @@ -157,7 +157,7 @@ ACCESSKEY="N" WIDTH="33%" ALIGN="left" VALIGN="top" ->Change Permission CustomisationChange Permission Customization

    This section last updated 27 Jul 2002

    Scarab.

    This section last updated 27 Jul 2002

    This section last updated 27 Jul 2002

    http://scarab.tigris.org

    This section last updated 27 Jul 2002

    http://www.sourceforge.net

    This section last updated 27 Jul 2002

    From Andrew Pearson:

    "' @@ -1153,15 +1154,15 @@ Chapter 4. Installation 4.1.5.1. DBI - The DBI module is a generic Perl module used the MySQL-related - modules. As long as your Perl installation was done correctly the DBI - module should be a breeze. It's a mixed Perl/C module, but Perl's + The DBI module is a generic Perl module used the MySQL-related + modules. As long as your Perl installation was done correctly the DBI + module should be a breeze. It's a mixed Perl/C module, but Perl's MakeMaker system simplifies the C compilation greatly. _________________________________________________________________ 4.1.5.2. Data::Dumper - The Data::Dumper module provides data structure persistence for Perl + 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. @@ -1169,16 +1170,16 @@ Chapter 4. Installation 4.1.5.3. MySQL-related modules - The Perl/MySQL interface requires a few mutually-dependent Perl - modules. These modules are grouped together into the the + The Perl/MySQL interface requires a few mutually-dependent Perl + modules. These modules are grouped together into the the Msql-Mysql-modules package. - The MakeMaker process will ask you a few questions about the desired - compilation target and your MySQL installation. For most of the - questions the provided default will be adequate, but when asked if - your desired target is the MySQL or mSQL packages, you should select + The MakeMaker process will ask you a few questions about the desired + compilation target and your MySQL installation. For most of the + questions the provided default will be adequate, but when asked if + your desired target is the MySQL or mSQL packages, you should select the MySQL related ones. Later you will be asked if you wish to provide - backwards compatibility with the older MySQL packages; you should + 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' with @@ -1188,20 +1189,20 @@ Chapter 4. Installation 4.1.5.4. TimeDate modules - 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. The component - module we're most interested in is the Date::Format module, but + 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. The component + module we're most interested in is the Date::Format module, but installing all of them is probably a good idea anyway. _________________________________________________________________ 4.1.5.5. GD (optional) - The GD library was written by Thomas Boutell a long while ago to - programatically generate images in C. Since then it's become the + The GD library was written by Thomas Boutell a long while ago to + programatically generate images in C. Since then it's become the defacto standard for programatic image construction. The Perl bindings - to it found in the GD library are used on millions of web pages to - generate graphs on the fly. That's what Bugzilla will be using it for + to it found in the GD library are used on millions of web pages to + generate graphs on the fly. That's what Bugzilla will be using it for so you must install it if you want any of the graphing to work. Note @@ -1215,26 +1216,24 @@ Chapter 4. Installation 4.1.5.6. Chart::Base (optional) The Chart module provides Bugzilla with on-the-fly charting abilities. - It can be installed in the usual fashion after it has been fetched - from CPAN. Note that earlier versions that 0.99c used GIFs, which are + It can be installed in the usual fashion after it has been fetched + from CPAN. Note that earlier versions that 0.99c used GIFs, which are no longer supported by the latest versions of GD. _________________________________________________________________ 4.1.5.7. Template Toolkit - When you install Template Toolkit, you'll get asked various questions - about features to enable. The defaults are fine, except that it is - recommended you use the high speed XS Stash of the Template Toolkit, - in order to achieve best performance. However, there are known - problems with XS Stash and Perl 5.005_02 and lower. If you wish to use - these older versions of Perl, please use the regular stash. + When you install Template Toolkit, you'll get asked various questions + about features to enable. The defaults are fine, except that it is + recommended you use the high speed XS Stash of the Template Toolkit, + in order to achieve best performance. _________________________________________________________________ 4.1.6. HTTP Server - You have a freedom of choice here - Apache, Netscape or any other - server on UNIX would do. You can run the web server on a different - machine than MySQL, but need to adjust the MySQL "bugs" user + You have a freedom of choice here - Apache, Netscape or any other + server on UNIX would do. You can run the web server on a different + machine than MySQL, but need to adjust the MySQL "bugs" user permissions accordingly. Note @@ -1244,13 +1243,13 @@ Chapter 4. Installation Apache. If you have got Bugzilla working using another webserver, please share your experiences with us. - You'll want to make sure that your web server will run any file with - the .cgi extension as a CGI program and not simply display the source - code. If you're using Apache that means uncommenting the following + You'll want to make sure that your web server will run any file with + the .cgi extension as a CGI program and not simply display the source + code. If you're using Apache that means uncommenting the following line in the httpd.conf file: AddHandler cgi-script .cgi - With Apache you'll also want to make sure that within the httpd.conf + With Apache you'll also want to make sure that within the httpd.conf file these lines: Options +ExecCGI AllowOverride Limit @@ -1279,10 +1278,10 @@ AllowOverride Limit 4.1.7. Bugzilla - You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - "nobody"). You may decide to put the files in the main web space for - your web server or perhaps in /usr/local with a symbolic link in the + You should untar the Bugzilla files into a directory that you're + willing to make writable by the default web server user (probably + "nobody"). You may decide to put the files in the main web space for + your web server or perhaps in /usr/local with a symbolic link in the web space that points to the Bugzilla directory. Tip @@ -1292,15 +1291,15 @@ AllowOverride Limit "FollowSymLinks" directive to the entry for the HTML root in httpd.conf. - Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install checksetup.pl script, which locks down + Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install checksetup.pl script, which locks down your installation. - Lastly, you'll need to set up a symbolic link to - /usr/bonsaitools/bin/perl for the correct location of your Perl - executable (probably /usr/bin/perl). Otherwise you must hack all the - .cgi files to change where they look for Perl. This can be done using + Lastly, you'll need to set up a symbolic link to + /usr/bonsaitools/bin/perl for the correct location of your Perl + executable (probably /usr/bin/perl). Otherwise you must hack all the + .cgi files to change where they look for Perl. This can be done using the following Perl one-liner, but I suggest using the symlink approach to avoid upgrade hassles. @@ -1325,15 +1324,15 @@ processmail syncshadowdb 4.1.8. Setting Up the MySQL Database - After you've gotten all the software installed and working you're - ready to start preparing the database for its life as the back end to + After you've gotten all the software installed and working you're + ready to start preparing the database for its life as the back end to a high quality bug tracker. - First, you'll want to fix MySQL permissions to allow access from - Bugzilla. For the purpose of this Installation section, the Bugzilla + 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. - Begin by giving the MySQL root user a password. MySQL passwords are + Begin by giving the MySQL root user a password. MySQL passwords are limited to 16 characters. bash# mysql -u root mysql @@ -1341,16 +1340,16 @@ processmail syncshadowdb user='root'; mysql> FLUSH PRIVILEGES; - From this point on, if you need to access MySQL as the MySQL root - user, you will need to use mysql -u root -p and enter . + From this point on, if you need to access MySQL as the MySQL root + user, you will need to use mysql -u root -p and enter . Remember that MySQL user names have nothing to do with Unix user names (login names). - Next, we use an SQL GRANT command to create a "bugs" user, and grant - sufficient permissions for checksetup.pl, which we'll use later, to - work its magic. This also restricts the "bugs" user to operations - within a database called "bugs", and only allows the account to - connect from "localhost". Modify it to reflect your setup if you will + Next, we use an SQL GRANT command to create a "bugs" user, and grant + sufficient permissions for checksetup.pl, which we'll use later, to + work its magic. This also restricts the "bugs" user to operations + within a database called "bugs", and only allows the account to + connect from "localhost". Modify it to reflect your setup if you will be connecting from another machine or as a different user. Remember to set to some unique password. @@ -1363,18 +1362,18 @@ processmail syncshadowdb 4.1.9. checksetup.pl - Next, run the magic checksetup.pl script. (Many thanks to Holger + Next, run the magic checksetup.pl script. (Many thanks to Holger Schurig for writing this script!) This script is designed to make sure - your MySQL database and other configuration options are consistent - with the Bugzilla CGI files. It will make sure Bugzilla files and - directories have reasonable permissions, set up the data directory, + your MySQL database and other configuration options are consistent + with the Bugzilla CGI files. It will make sure Bugzilla files and + directories have reasonable permissions, set up the data directory, and create all the MySQL tables. bash# ./checksetup.pl The first time you run it, it will create a file called localconfig. - This file contains a variety of settings you may need to tweak + This file contains a variety of settings you may need to tweak including how Bugzilla should connect to the MySQL database. The connection settings include: @@ -1384,11 +1383,11 @@ processmail syncshadowdb 3. MySQL username: "bugs" if you're following these directions 4. Password for the "bugs" MySQL account; () above - Once you are happy with the settings, su to the user your web server - runs as, and re-run checksetup.pl. (Note: on some security-conscious - systems, you may need to change the login shell for the webserver - account before you can do this.) On this second run, it will create - the database and an administrator account for which you will be + Once you are happy with the settings, su to the user your web server + runs as, and re-run checksetup.pl. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) On this second run, it will create + the database and an administrator account for which you will be prompted to provide information. Note @@ -1400,9 +1399,9 @@ processmail syncshadowdb 4.1.10. Securing MySQL - If you followed the installation instructions for setting up your + 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 + 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: @@ -1413,8 +1412,8 @@ processmail syncshadowdb it defaults to no passwords whatsoever it defaults to allowing "File_Priv" - This means anyone from anywhere on the internet can not only drop the - database with one SQL command, and they can write as root to the + This means anyone from anywhere on the internet can not only drop the + database with one SQL command, and they can write as root to the system. To see your permissions do: @@ -1438,8 +1437,8 @@ processmail syncshadowdb REVOKE DROP ON bugs.* FROM bugs@localhost; FLUSH PRIVILEGES; - With "mit-pthreads" you'll need to modify the "globals.pl" - Mysql->Connect line to specify a specific host name instead of + With "mit-pthreads" you'll need to modify the "globals.pl" + Mysql->Connect line to specify a specific host name instead of "localhost", and accept external connections: GRANT USAGE ON *.* TO bugs@bounce.hop.com; @@ -1449,14 +1448,14 @@ processmail syncshadowdb Consider also: - 1. Turning off external networking with "--skip-networking", unless - you have "mit-pthreads", in which case you can't. Without + 1. Turning off external networking with "--skip-networking", unless + you have "mit-pthreads", in which case you can't. Without networking, MySQL connects with a Unix domain socket. - 2. using the --user= option to mysqld to run it as an unprivileged + 2. using the --user= option to mysqld to run it as an unprivileged user. 3. running MySQL in a chroot jail 4. running the httpd in a chroot jail - 5. making sure the MySQL passwords are different from the OS + 5. making sure the MySQL passwords are different from the OS passwords (MySQL "root" has nothing to do with system "root"). 6. running MySQL on a separate untrusted machine 7. making backups ;-) @@ -1464,8 +1463,8 @@ processmail syncshadowdb 4.1.11. Configuring Bugzilla - You should run through the parameters on the Edit Parameters page - (link in the footer) and set them all to appropriate values. They key + You should run through the parameters on the Edit Parameters page + (link in the footer) and set them all to appropriate values. They key parameters are documented in Section 5.1. _________________________________________________________________ @@ -1473,21 +1472,21 @@ processmail syncshadowdb 4.2.1. Dependency Charts - As well as the text-based dependency graphs, Bugzilla also supports - dependency graphing, using a package called 'dot'. Exactly how this - works is controlled by the 'webdotbase' parameter, which can have one + As well as the text-based dependency graphs, Bugzilla also supports + dependency graphing, using a package called 'dot'. Exactly how this + works is controlled by the 'webdotbase' parameter, which can have one of three values: - 1. A complete file path to the command 'dot' (part of GraphViz) will + 1. A complete file path to the command 'dot' (part of GraphViz) will generate the graphs locally - 2. A URL prefix pointing to an installation of the webdot package + 2. A URL prefix pointing to an installation of the webdot package will generate the graphs remotely 3. A blank value will disable dependency graphing. So, to get this working, install GraphViz. If you do that, you need to - enable server-side image maps in Apache. Alternatively, you could set - up a webdot server, or use the AT&T public webdot server (the default - for the webdotbase param). Note that AT&T's server won't work if + enable server-side image maps in Apache. Alternatively, you could set + up a webdot server, or use the AT&T public webdot server (the default + for the webdotbase param). Note that AT&T's server won't work if Bugzilla is only accessible using HTTPS. _________________________________________________________________ @@ -1496,24 +1495,24 @@ processmail syncshadowdb As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs. - Add a cron entry like this to run collectstats.pl daily at 5 after + Add a cron entry like this to run collectstats.pl daily at 5 after midnight: bash# crontab -e 5 0 * * * cd ; ./collectstats.pl - After two days have passed you'll be able to view bug graphs from the + After two days have passed you'll be able to view bug graphs from the Bug Reports page. _________________________________________________________________ 4.2.3. The Whining Cron By now you have a fully functional Bugzilla, but what good are bugs if - they're not annoying? To help make those bugs more annoying you can - set up Bugzilla's automatic whining system to complain at engineers + they're not annoying? To help make those bugs more annoying you can + set up Bugzilla's automatic whining system to complain at engineers which leave their bugs in the NEW state without triaging them. - This can be done by adding the following command as a daily crontab + This can be done by adding the following command as a daily crontab entry (for help on that see that crontab man page): cd ; ./whineatnews.pl @@ -1534,48 +1533,48 @@ processmail syncshadowdb Bugzilla is old, and the authors do not know of anyone who has tested it. Approach with caution. - The existing authentication scheme for Bugzilla uses email addresses - as the primary user ID, and a password to authenticate that user. All - places within Bugzilla where you need to deal with user ID (e.g + The existing authentication scheme for Bugzilla uses email addresses + as the primary user ID, and a password to authenticate that user. All + places within Bugzilla where you need to deal with user ID (e.g assigning a bug) use the email address. The LDAP authentication builds on top of this scheme, rather than replacing it. The initial log in is - done with a username and password for the LDAP directory. This then - fetches the email address from LDAP and authenticates seamlessly in - the standard Bugzilla authentication scheme using this email address. + done with a username and password for the LDAP directory. This then + fetches the email address from LDAP and authenticates seamlessly in + the standard Bugzilla authentication scheme using this email address. If an account for this address already exists in your Bugzilla system, - it will log in to that account. If no account for that email address - exists, one is created at the time of login. (In this case, Bugzilla - will attempt to use the "displayName" or "cn" attribute to determine - the user's full name.) After authentication, all other user-related + it will log in to that account. If no account for that email address + exists, one is created at the time of login. (In this case, Bugzilla + will attempt to use the "displayName" or "cn" attribute to determine + the user's full name.) After authentication, all other user-related tasks are still handled by email address, not LDAP username. You still assign bugs by email address, query on users by email address, etc. Using LDAP for Bugzilla authentication requires the Mozilla::LDAP (aka - PerLDAP) Perl module. The Mozilla::LDAP module in turn requires + PerLDAP) Perl module. The Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. After you have installed the SDK, then - install the PerLDAP module. Mozilla::LDAP and the Directory SDK for C + install the PerLDAP module. Mozilla::LDAP and the Directory SDK for C are both available for download from mozilla.org. - Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP - directory for authentication. Be very careful when setting up this - parameter; if you set LDAP authentication, but do not have a valid + Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP + directory for authentication. Be very careful when setting up this + parameter; if you set LDAP authentication, but do not have a valid LDAP directory set up, you will not be able to log back in to Bugzilla - once you log out. (If this happens, you can get back in by manually + once you log out. (If this happens, you can get back in by manually editing the data/params file, and setting useLDAP back to 0.) - If using LDAP, you must set the three additional parameters: Set - LDAPserver to the name (and optionally port) of your LDAP server. If - no port is specified, it defaults to the default port of 389. (e.g - "ldap.mycompany.com" or "ldap.mycompany.com:1234") Set LDAPBaseDN to - the base DN for searching for users in your LDAP directory. (e.g. - "ou=People,o=MyCompany") uids must be unique under the DN specified - here. Set LDAPmailattribute to the name of the attribute in your LDAP - directory which contains the primary email address. On most directory + If using LDAP, you must set the three additional parameters: Set + LDAPserver to the name (and optionally port) of your LDAP server. If + no port is specified, it defaults to the default port of 389. (e.g + "ldap.mycompany.com" or "ldap.mycompany.com:1234") Set LDAPBaseDN to + the base DN for searching for users in your LDAP directory. (e.g. + "ou=People,o=MyCompany") uids must be unique under the DN specified + here. Set LDAPmailattribute to the name of the attribute in your LDAP + directory which contains the primary email address. On most directory servers available, this is "mail", but you may need to change this. - You can also try using OpenLDAP with Bugzilla, using any of a number + You can also try using OpenLDAP with Bugzilla, using any of a number of administration tools. You should apply the patch attached this bug: - http://bugzilla.mozilla.org/show_bug.cgi?id=158630, then set the + http://bugzilla.mozilla.org/show_bug.cgi?id=158630, then set the following object classes for your users: 1. objectClass: person @@ -1585,46 +1584,49 @@ processmail syncshadowdb 5. objectClass: posixAccount 6. objectClass: shadowAccount - Please note that this patch has not yet been accepted by the Bugzilla - team, and so you may need to do some manual tweaking. That said, it + Please note that this patch has not yet been accepted by the Bugzilla + team, and so you may need to do some manual tweaking. That said, it looks like Net::LDAP is probably the way to go in the future. _________________________________________________________________ 4.2.5. Preventing untrusted Bugzilla content from executing malicious Javascript code - It is possible for a Bugzilla to execute malicious Javascript code. + It is possible for a Bugzilla to execute malicious Javascript code. Due to internationalization concerns, we are unable to incorporate the - code changes necessary to fulfill the CERT advisory requirements + code changes necessary to fulfill the CERT advisory requirements mentioned in http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. - Executing the following code snippet from a UNIX command shell will - rectify the problem if your Bugzilla installation is intended for an - English-speaking audience. As always, be sure your Bugzilla - installation has a good backup before making changes, and I recommend + Executing the following code snippet from a UNIX command shell will + rectify the problem if your Bugzilla installation is intended for an + English-speaking audience. As always, be sure your Bugzilla + installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it. bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; char set=ISO-8859-1/i" *.cgi *.pl - All this one-liner command does is search for all instances of - "Content-type: text/html" and replaces it with "Content-Type: - text/html; charset=ISO-8859-1" . This specification prevents possible - Javascript attacks on the browser, and is suggested for all - English-speaking sites. For non-English-speaking Bugzilla sites, I + All this one-liner command does is search for all instances of + "Content-type: text/html" and replaces it with "Content-Type: + text/html; charset=ISO-8859-1" . This specification prevents possible + Javascript attacks on the browser, and is suggested for all + English-speaking sites. For non-English-speaking Bugzilla sites, I suggest changing "ISO-8859-1", above, to "UTF-8". - Note: using tags to set the charset is not recommended, as - there's a bug in Netscape 4.x which causes pages marked up in this way - to load twice. + Note + + Using tags to set the charset is not recommended, as there's a + bug in Netscape 4.x which causes pages marked up in this way to load + twice. See bug 126266 for more information including progress toward + making bugzilla charset aware by default. _________________________________________________________________ 4.2.6. .htaccess files and security - To enhance the security of your Bugzilla installation, Bugzilla's - checksetup.pl script will generate .htaccess files which the Apache + To enhance the security of your Bugzilla installation, Bugzilla's + checksetup.pl script will generate .htaccess files which the Apache webserver can use to restrict access to the bugzilla data files. These - .htaccess files will not work with Apache 1.2.x - but this has + .htaccess files will not work with Apache 1.2.x - but this has security holes, so you shouldn't be using it anyway. Note @@ -1634,12 +1636,12 @@ set=ISO-8859-1/i" *.cgi *.pl will need to change the ip address in data/webdot/.htaccess to the ip address of the webdot server that you are using. - The default .htaccess file may not provide adequate access - restrictions, depending on your web server configuration. Be sure to - check the entries for your Bugzilla directory so that the - .htaccess file is allowed to override web server defaults. For - instance, let's assume your installation of Bugzilla is installed to - /usr/local/bugzilla . You should have this entry in your + The default .htaccess file may not provide adequate access + restrictions, depending on your web server configuration. Be sure to + check the entries for your Bugzilla directory so that the + .htaccess file is allowed to override web server defaults. For + instance, let's assume your installation of Bugzilla is installed to + /usr/local/bugzilla . You should have this entry in your httpd.conf file: @@ -1647,52 +1649,52 @@ set=ISO-8859-1/i" *.cgi *.pl AllowOverride All - The important part above is "AllowOverride All" . Without that, the - .htaccess file created by checksetup.pl will not have sufficient + The important part above is "AllowOverride All" . Without that, the + .htaccess file created by checksetup.pl will not have sufficient permissions to protect your Bugzilla installation. - If you are using Internet Information Server (IIS) or another web - server which does not observe .htaccess conventions, you can disable + If you are using Internet Information Server (IIS) or another web + server which does not observe .htaccess conventions, you can disable their creation by editing localconfig and setting the $create_htaccess variable to 0. _________________________________________________________________ 4.2.7. directoryindex for the Bugzilla default page. - You should modify the parameter for the Apache - virtual host running your Bugzilla installation to allow index.cgi as - the index page for a directory, as well as the usual index.html, + You should modify the parameter for the Apache + virtual host running your Bugzilla installation to allow index.cgi as + the index page for a directory, as well as the usual index.html, index.htm, and so forth. _________________________________________________________________ 4.2.8. Bugzilla and mod_perl - Bugzilla is unsupported under mod_perl. Effort is underway to make it + Bugzilla is unsupported under mod_perl. Effort is underway to make it work cleanly in a mod_perl environment, but it is slow going. _________________________________________________________________ 4.2.9. mod_throttle and Security - It is possible for a user, by mistake or on purpose, to access the - database many times in a row which can result in very slow access - speeds for other users. If your Bugzilla installation is experiencing - this problem , you may install the Apache module mod_throttle which - can limit connections by ip-address. You may download this module at - http://www.snert.com/Software/Throttle/. Follow the instructions to - install into your Apache install. This module only functions with the - Apache web server! You may use the ThrottleClientIP command provided - by this module to accomplish this goal. See the Module Instructions + It is possible for a user, by mistake or on purpose, to access the + database many times in a row which can result in very slow access + speeds for other users. If your Bugzilla installation is experiencing + this problem , you may install the Apache module mod_throttle which + can limit connections by ip-address. You may download this module at + http://www.snert.com/Software/Throttle/. Follow the instructions to + install into your Apache install. This module only functions with the + Apache web server! You may use the ThrottleClientIP command provided + by this module to accomplish this goal. See the Module Instructions for more information. _________________________________________________________________ 4.3. Win32 Installation Notes - This section covers installation on Microsoft Windows. Bugzilla has - been made to work on Win32 platforms, but the Bugzilla team wish to - emphasise that 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, + This section covers installation on Microsoft Windows. Bugzilla has + been made to work on Win32 platforms, but the Bugzilla team wish to + emphasise that 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. Warning @@ -1705,11 +1707,11 @@ set=ISO-8859-1/i" *.cgi *.pl pleasant than it is now. If you still want to try this, to have any hope of getting it to work, - you'll need to apply the mail patch from bug 124174. After that, - you'll need to read the (outdated) installation instructions below, - some (probably a lot better) more recent ones kindly provided by Toms + you'll need to apply the mail patch from bug 124174. After that, + you'll need to read the (outdated) installation instructions below, + some (probably a lot better) more recent ones kindly provided by Toms Baugis and Jean-Sebastien Guay, and also check the Bugzilla 2.16 Win32 - update page . If we get time, we'll write some better installation + update page . If we get time, we'll write some better installation instructions for 2.16 and put them up there. But no promises. _________________________________________________________________ @@ -1730,9 +1732,9 @@ set=ISO-8859-1/i" *.cgi *.pl the recommended installation procedure for Win32; additional suggestions are provided in Appendix A . 1. Install Apache Web Server for Windows, and copy the Bugzilla files - somewhere Apache can serve them. Please follow all the - instructions referenced in Bugzilla Installation regarding your - Apache configuration, particularly instructions regarding the + somewhere Apache can serve them. Please follow all the + instructions referenced in Bugzilla Installation regarding your + Apache configuration, particularly instructions regarding the "AddHandler" parameter and "ExecCGI" . Note @@ -1745,17 +1747,17 @@ set=ISO-8859-1/i" *.cgi *.pl 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 + 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 Perl on Win32 + Please also check the following links to fully understand the + status of ActivePerl on Win32: Perl Porting , and Perl on Win32 FAQ - 3. Use ppm from your perl\bin directory to install the following + 3. Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, - AppConfig, and Template. You may need to extract them from .zip - format using Winzip or other unzip program first. Most of these - additional ppm modules can be downloaded from ActiveState, but - AppConfig and Template should be obtained from OpenInteract using + AppConfig, and Template. You may need to extract them from .zip + format using Winzip or other unzip program first. Most of these + additional ppm modules can be downloaded from ActiveState, but + AppConfig and Template should be obtained from OpenInteract using the instructions on the Template Toolkit web site . Note @@ -1764,21 +1766,21 @@ set=ISO-8859-1/i" *.cgi *.pl http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ or http://www.activestate.com/PPMPackages/5.6plus The syntax for ppm is: C:> ppm - Example 4-1. Installing ActivePerl ppd Modules on Microsoft + Example 4-1. Installing ActivePerl ppd Modules on Microsoft Windows C:> ppm DBD-Mysql Watch your capitalization! ActiveState's 5.6Plus directory also contains an AppConfig ppm, so - you might see the following error when trying to install the + you might see the following error when trying to install the version at OpenInteract: - Error installing package 'AppConfig': Read a PPD for 'AppConfig', - but it is not intended for this build of Perl + Error installing package 'AppConfig': Read a PPD for 'AppConfig', + but it is not intended for this build of Perl (MSWin32-x86-multi-thread) - If so, download both the tarball and the ppd directly from + If so, download both the tarball and the ppd directly from OpenInteract, then run ppm from within the same directory to which - you downloaded those files and install the package by referencing + you downloaded those files and install the package by referencing the ppd file explicitly via in the install command, f.e.: - Example 4-2. Installing OpenInteract ppd Modules manually on + Example 4-2. Installing OpenInteract ppd Modules manually on Microsoft Windows install C:\AppConfig.ppd 4. Install MySQL for NT. @@ -1791,12 +1793,12 @@ set=ISO-8859-1/i" *.cgi *.pl 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') + c. mysql> UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; - "new_password" , above, indicates whatever password you wish + "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 + 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. @@ -1820,15 +1822,15 @@ my $webservergid = 'Administrators' 7. Run checksetup.pl from the Bugzilla directory. - 8. Edit localconfig to suit your requirements. Set $db_pass to your + 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 + 9. Edit defparams.pl to suit your requirements. Particularly, set + DefParam("maintainer") and DefParam("urlbase") to match your install. Note @@ -1846,9 +1848,9 @@ my $webservergid = , 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 + 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: @@ -1866,7 +1868,7 @@ my $webservergid = 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 + 4. Find and comment out all occurences of " open(SENDMAIL " in your Bugzilla directory. Then replace them with: # new sendmail functionality my $mail=new @@ -1883,7 +1885,7 @@ open SENDMAIL, mail.log"; or something to that effect. - 11. Change all references in all files from processmail to + 11. Change all references in all files from processmail to processmail.pl , and rename processmail to processmail.pl . Note @@ -1938,18 +1940,18 @@ exit; This step is 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.csh" utility to - speed part of this procedure, available in the Useful Patches and - Utilities for Bugzilla section of The Bugzilla Guide. However, it + 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.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 + 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. You should specify the full path to perl - for each system() call. For instance, change this line in + your Bugzilla directory. You should specify the full path to perl + for each system() call. For instance, change this line in processmail: @@ -1990,10 +1992,10 @@ system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Paramete rs\ScriptMap - The keys should be called ".pl" and ".cgi", and both should have a + The keys should be called ".pl" and ".cgi", and both should have a value something like: c:/perl/bin/perl.exe "%s" "%s" - The KB article only talks about .pl, but it goes into more detail + The KB article only talks about .pl, but it goes into more detail and provides a perl test script. Tip @@ -2023,30 +2025,30 @@ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . 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 + 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 . - Follow the instructions for setting up Fink. Once it's installed, + 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 + 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, because it looks for the specific paths instead of getting them + 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, because 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 this patch to the Makefile.PL file (save the patch + GD module, then it will open a shell and drop you into the build + directory. Apply this patch to the Makefile.PL file (save the patch into a file and use the command patch < patchfile.) Then, run these commands to finish the installation of the GD module: @@ -2067,18 +2069,18 @@ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . Try executing perl -MCPAN -e 'install CPAN' and then continuing. - Certain older versions of the CPAN toolset were somewhat naive about - how to upgrade Perl modules. When a couple of modules got rolled into - the core Perl distribution for 5.6.1, CPAN thought that the best way + Certain older versions of the CPAN toolset were somewhat naive about + how to upgrade Perl modules. When a couple of modules got rolled into + the core Perl distribution for 5.6.1, CPAN thought that the best way to get those modules up to date was to haul down the Perl distribution - itself and build it. Needless to say, this has caused headaches for - just about everybody. Upgrading to a newer version of CPAN with the + itself and build it. Needless to say, this has caused headaches for + just about everybody. Upgrading to a newer version of CPAN with the commandline above should fix things. _________________________________________________________________ 4.5.2. DBD::Sponge::db prepare failed - The following error message may appear due to a bug in DBD::mysql + The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site /lib/DBD/mysql.pm line 248. @@ -2086,7 +2088,7 @@ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . REFCNT = 1 FLAGS = (PADBUSY,PADMY) - To fix this, go to /lib/DBD/sponge.pm in your Perl + To fix this, go to /lib/DBD/sponge.pm in your Perl installation and replace my $numFields; if ($attribs->{'NUM_OF_FIELDS'}) { @@ -2106,13 +2108,13 @@ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . 4.5.3. cannot chdir(/var/spool/mqueue) - If you are installing Bugzilla on SuSE Linux, or some other - distributions with "paranoid" security options, it is possible that + If you are installing Bugzilla on SuSE 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 + 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. _________________________________________________________________ @@ -2120,94 +2122,93 @@ Chapter 5. Administering Bugzilla 5.1. Bugzilla Configuration - Bugzilla is configured by changing various parameters, accessed from - the "Edit parameters" link in the page footer. Here are some of the - key parameters on that page. You should run down this list and set + Bugzilla is configured by changing various parameters, accessed from + the "Edit parameters" link in the page footer. Here are some of the + key parameters on that page. You should run down this list and set them appropriately after installing Bugzilla. - 1. maintainer: The maintainer parameter is the email address of the + 1. maintainer: The maintainer parameter is the email address of the person responsible for maintaining this Bugzilla installation. The address need not be that of a valid Bugzilla account. - 2. urlbase: This parameter defines the fully qualified domain name + 2. urlbase: This parameter defines the fully qualified domain name and web server path to your Bugzilla installation. - For example, if your Bugzilla query page is - http://www.foo.com/bugzilla/query.cgi, set your "urlbase" to + For example, if your Bugzilla query page is + http://www.foo.com/bugzilla/query.cgi, set your "urlbase" to http://www.foo.com/bugzilla/. - 3. usebuggroups: This dictates whether or not to implement - group-based security for Bugzilla. If set, Bugzilla bugs can have - an associated 'group', defining which users are allowed to see and - edit the bug. - Set "usebuggroups" to "on" only if you may wish to restrict access - to particular bugs to certain groups of users. I suggest leaving - this parameter off while initially testing your Bugzilla. - 4. usebuggroupsentry: Bugzilla Products can have a group associated - with them, so that certain users can only see bugs in certain - products. When this parameter is set to "on", this places all - newly-created bugs in the group for their product immediately. - 5. shadowdb: You run into an interesting problem when Bugzilla - reaches a high level of continuous activity. MySQL supports only - table-level write locking. What this means is that if someone - needs to make a change to a bug, they will lock the entire table - until the operation is complete. Locking for write also blocks - reads until the write is complete. Note that more recent versions - of mysql support row level locking using different table types. - These types are slower than the standard type, and Bugzilla does - not yet take advantage of features such as transactions which + 3. makeproductgroups: This dictates whether or not to automatically + create groups when new products are created. + 4. useentrygroupdefault: Bugzilla products can have a group + associated with them, so that certain users can only see bugs in + certain products. When this parameter is set to "on", this causes + the initial group controls on newly created products to place all + newly-created bugs in the group having the same name as the + product immediately. After a product is initially created, the + group controls can be further adjusted without interference by + this mechanism. + 5. shadowdb: You run into an interesting problem when Bugzilla + reaches a high level of continuous activity. MySQL supports only + table-level write locking. What this means is that if someone + needs to make a change to a bug, they will lock the entire table + until the operation is complete. Locking for write also blocks + reads until the write is complete. Note that more recent versions + of mysql support row level locking using different table types. + These types are slower than the standard type, and Bugzilla does + not yet take advantage of features such as transactions which would justify this speed decrease. The Bugzilla team are, however, - happy to hear about any experiences with row level locking and + happy to hear about any experiences with row level locking and Bugzilla - The "shadowdb" parameter was designed to get around this - limitation. While only a single user is allowed to write to a - table at a time, reads can continue unimpeded on a read-only - shadow copy of the database. Although your database size will - double, a shadow database can cause an enormous performance - improvement when implemented on extremely high-traffic Bugzilla + The "shadowdb" parameter was designed to get around this + limitation. While only a single user is allowed to write to a + table at a time, reads can continue unimpeded on a read-only + shadow copy of the database. Although your database size will + double, a shadow database can cause an enormous performance + improvement when implemented on extremely high-traffic Bugzilla databases. As a guide, mozilla.org began needing "shadowdb" when they reached - around 40,000 Bugzilla users with several hundred Bugzilla bug + around 40,000 Bugzilla users with several hundred Bugzilla bug changes and comments per day. - The value of the parameter defines the name of the shadow bug + The value of the parameter defines the name of the shadow bug database. You will need to set the host and port settings from the - params page, and set up replication in your database server so - that updates reach this readonly mirror. Consult your database + params page, and set up replication in your database server so + that updates reach this readonly mirror. Consult your database documentation for more detail. - 6. shutdownhtml: If you need to shut down Bugzilla to perform - administration, enter some descriptive HTML here and anyone who - tries to use Bugzilla will receive a page to that effect. - Obviously, editparams.cgi will still be accessible so you can + 6. shutdownhtml: If you need to shut down Bugzilla to perform + administration, enter some descriptive HTML here and anyone who + tries to use Bugzilla will receive a page to that effect. + Obviously, editparams.cgi will still be accessible so you can remove the HTML and re-enable Bugzilla. :-) - 7. passwordmail: Every time a user creates an account, the text of - this parameter (with substitutions) is sent to the new user along + 7. passwordmail: Every time a user creates an account, the text of + this parameter (with substitutions) is sent to the new user along with their password message. - Add any text you wish to the "passwordmail" parameter box. For - instance, many people choose to use this box to give a quick + 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. - 8. movebugs: This option is an undocumented feature to allow moving - bugs between separate Bugzilla installations. You will need to - understand the source code in order to use this feature. Please - consult movebugs.pl in your Bugzilla source tree for further + 8. movebugs: This option is an undocumented feature to allow moving + bugs between separate Bugzilla installations. You will need to + understand the source code in order to use this feature. Please + consult movebugs.pl in your Bugzilla source tree for further documentation, such as it is. - 9. useqacontact: This allows you to define an email address for each - component, in addition to that of the default owner, who will be + 9. useqacontact: This allows you to define an email address for each + component, in addition to that of the default owner, who will be sent carbon copies of incoming bugs. - 10. usestatuswhiteboard: This defines whether you wish to have a - free-form, overwritable field associated with each bug. The - advantage of the Status Whiteboard is that it can be deleted or - modified with ease, and provides an easily-searchable field for + 10. usestatuswhiteboard: This defines whether you wish to have a + free-form, overwritable field associated with each bug. The + advantage of the Status Whiteboard is that it can be deleted or + modified with ease, and provides an easily-searchable field for indexing some bugs that have some trait in common. - 11. whinedays: Set this to the number of days you want to let bugs go - in the NEW or REOPENED state before notifying people they have + 11. whinedays: Set this to the number 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 installation + do not set up the whining cron job described in the installation instructions, or set this value to "0" (never whine). 12. commenton*: All these fields allow you to dictate what changes can - pass without comment, and which must have a comment from the + pass without comment, and which must have a comment from the person who changed them. Often, administrators will allow users to - add themselves to the CC list, accept bugs, or change the Status - Whiteboard without adding a comment as to their reasons for the - change, yet require that most other changes come with an + add themselves to the CC list, accept bugs, or change the Status + Whiteboard without adding a comment as to their reasons for the + change, yet require that most other changes come with an explanation. Set the "commenton" options according to your site policy. It is a - wise idea to require comments when users resolve, reassign, or + wise idea to require comments when users resolve, reassign, or reopen bugs at the very least. Note @@ -2216,13 +2217,13 @@ Chapter 5. Administering Bugzilla resolving bugs than not. Few things are more annoying to bug database users than having a developer mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) - 13. supportwatchers: Turning on this option allows users to ask to - receive copies of all a particular other user's bug email. This + 13. supportwatchers: Turning on this option allows users to ask to + receive copies of all a particular other user's bug email. This is, of course, subject to the groupset restrictions on the bug; if - the "watcher" would not normally be allowed to view a bug, the - watcher cannot get around the system by setting herself up to - watch the bugs of someone with bugs outside her privileges. They - would still only receive email updates for those bugs she could + the "watcher" would not normally be allowed to view a bug, the + watcher cannot get around the system by setting herself up to + watch the bugs of someone with bugs outside her privileges. They + would still only receive email updates for those bugs she could normally view. _________________________________________________________________ @@ -2230,10 +2231,10 @@ Chapter 5. Administering Bugzilla 5.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 - password for this "super user". If for some reason you delete the - "super user" account, re-running checksetup.pl will again prompt you + When you first run checksetup.pl after installing Bugzilla, it will + prompt you for the administrative username (email address) and + password for this "super user". If for some reason you delete the + "super user" account, re-running checksetup.pl will again prompt you for this username and password. Tip @@ -2248,14 +2249,14 @@ Chapter 5. Administering Bugzilla 5.2.2.1. Creating new users - Your users can create their own user accounts by clicking the "New - Account" link at the bottom of each page (assuming they aren't logged + Your users can create their own user accounts by clicking the "New + Account" link at the bottom of each page (assuming they aren't logged in as someone else already.) However, should you desire to create user accounts ahead of time, here is how you do it. - 1. After logging in, click the "Users" link at the footer of the + 1. After logging in, click the "Users" link at the footer of the query page, and then click "Add a new user". - 2. Fill out the form presented. This page is self-explanatory. When + 2. Fill out the form presented. This page is self-explanatory. When done, click "Submit". Note @@ -2271,33 +2272,33 @@ Chapter 5. Administering Bugzilla 5.2.2.2. Modifying Users - To see a specific user, search for their login name in the box - provided on the "Edit Users" page. To see all users, leave the box + To see a specific user, search for their login name in the box + provided on the "Edit Users" page. To see all users, leave the box blank. - You can search in different ways the listbox to the right of the text - entry box. You can match by case-insensitive substring (the default), + You can search in different ways the listbox to the right of the text + entry box. You can match by case-insensitive substring (the default), regular expression, or a reverse regular expression match, which finds - every user name which does NOT match the regular expression. (Please - see the man regexp manual page for details on regular expression + every user name which does NOT match the regular expression. (Please + see the man regexp manual page for details on regular expression syntax.) Once you have found your user, you can change the following fields: - * Login Name: This is generally the user's full email address. - However, if you have are using the emailsuffix Param, this may - just be the user's login name. Note that users can now change + * Login Name: This is generally the user's full email address. + However, if you have are using the emailsuffix Param, this may + just be the user's login name. Note that users can now change their login names themselves (to any valid email address.) - * Real Name: The user's real name. Note that Bugzilla does not + * Real Name: The user's real name. Note that Bugzilla does not require this to create an account. - * Password: You can change the user's password here. Users can - automatically request a new password, so you shouldn't need to do - this often. If you want to disable an account, see Disable Text + * Password: You can change the user's password here. Users can + automatically request a new password, so you shouldn't need to do + this often. If you want to disable an account, see Disable Text below. - * Disable Text: If you type anything in this box, including just a - space, the user is prevented from logging in, or making any - changes to bugs via the web interface. The HTML you type in this - box is presented to the user when they attempt to perform these + * Disable Text: If you type anything in this box, including just a + space, the user is prevented from logging in, or making any + changes to bugs via the web interface. The HTML you type in this + box is presented to the user when they attempt to perform these actions, and should explain why the account was disabled. Warning @@ -2309,37 +2310,37 @@ Chapter 5. Administering Bugzilla The user can still submit bugs via the e-mail gateway, if you set it up, even if the disabled text field is filled in. The e-mail gateway should not be enabled for secure installations of Bugzilla. - * : If you have created some groups, e.g. + * : If you have created some groups, e.g. "securitysensitive", then checkboxes will appear here to allow you to add users to, or remove them from, these groups. - * canconfirm: This field is only used if you have enabled the + * canconfirm: This field is only used if you have enabled the "unconfirmed" status. If you enable this for a user, that user can - then move bugs from "Unconfirmed" to a "Confirmed" status (e.g.: + then move bugs from "Unconfirmed" to a "Confirmed" status (e.g.: "New" status). - * creategroups: This option will allow a user to create and destroy + * creategroups: This option will allow a user to create and destroy groups in Bugzilla. * editbugs: Unless a user has this bit set, they can only edit those bugs for which they are the assignee or the reporter. Even if this option is unchecked, users can still add comments to bugs. * 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 - associated with it, those bugs must be moved to a different - product or component before Bugzilla will allow them to be + components, as well as modify and destroy those that have no bugs + associated with them. If a product or component has bugs + associated with it, those bugs must be moved to a different + product or component before Bugzilla will allow them to be destroyed. - * editkeywords: If you use Bugzilla's keyword functionality, - enabling this feature allows a user to create and destroy + * editkeywords: If you use Bugzilla's keyword functionality, + enabling this feature allows a user to create and destroy keywords. As always, the keywords for existing bugs containing the keyword the user wishes to destroy must be changed before Bugzilla will allow it to die. - * editusers: This flag allows a user to do what you're doing right - now: edit other users. This will allow those with the right to do - so to remove administrator privileges from other users or grant + * editusers: This flag allows a user to do what you're doing right + now: edit other users. This will allow those with the right to do + so to remove administrator privileges from other users or grant them to themselves. Enable with care. - * tweakparams: This flag allows a user to change Bugzilla's Params + * tweakparams: This flag allows a user to change Bugzilla's Params (using editparams.cgi.) - * : This allows an administrator to specify the - products in which a user can see bugs. The user must still have + * : This allows an administrator to specify the + products in which a user can see bugs. The user must still have the "editbugs" privilege to edit bugs in these products. _________________________________________________________________ @@ -2347,80 +2348,80 @@ Chapter 5. Administering Bugzilla 5.3.1. Products - Products are the broadest category in Bugzilla, and tend to represent - real-world shipping products. E.g. if your company makes computer - games, you should have one product per game, perhaps a "Common" - product for units of technology used in multiple games, and maybe a + Products are the broadest category in Bugzilla, and tend to represent + real-world shipping products. E.g. if your company makes computer + games, you should have one product per game, perhaps a "Common" + product for units of technology used in multiple games, and maybe a few special products (Website, Administration...) - Many of Bugzilla's settings are configurable on a per-product basis. + Many of Bugzilla's settings are configurable on a per-product basis. The number of "votes" available to users is set per-product, as is the - number of votes required to move a bug automatically from the + number of votes required to move a bug automatically from the UNCONFIRMED status to the NEW status. To create a new product: 1. Select "products" from the footer 2. Select the "Add" link in the bottom right - 3. Enter the name of the product and a description. The Description + 3. Enter the name of the product and a description. The Description field may contain HTML. - Don't worry about the "Closed for bug entry", "Maximum Votes per - person", "Maximum votes a person can put on a single bug", "Number of - votes a bug in this Product needs to automatically get out of the - UNCOMFIRMED state", and "Version" options yet. We'll cover those in a + Don't worry about the "Closed for bug entry", "Maximum Votes per + person", "Maximum votes a person can put on a single bug", "Number of + votes a bug in this Product needs to automatically get out of the + UNCOMFIRMED state", and "Version" options yet. We'll cover those in a few moments. _________________________________________________________________ 5.3.2. Components - Components are subsections of a Product. E.g. the computer game you - are designing may have a "UI" component, an "API" component, a "Sound - System" component, and a "Plugins" component, each overseen by a - different programmer. It often makes sense to divide Components in - Bugzilla according to the natural divisions of responsibility within + Components are subsections of a Product. E.g. the computer game you + are designing may have a "UI" component, an "API" component, a "Sound + System" component, and a "Plugins" component, each overseen by a + different programmer. It often makes sense to divide Components in + Bugzilla according to the natural divisions of responsibility within your Product or company. - Each component has a owner and (if you turned it on in the - parameters), a QA Contact. The owner should be the primary person who - fixes bugs in that component. The QA Contact should be the person who - will ensure these bugs are completely fixed. The Owner, QA Contact, - and Reporter will get email when new bugs are created in this - Component and when these bugs change. Default Owner and Default QA - Contact fields only dictate the default assignments; these can be + Each component has a owner and (if you turned it on in the + parameters), a QA Contact. The owner should be the primary person who + fixes bugs in that component. The QA Contact should be the person who + will ensure these bugs are completely fixed. The Owner, QA Contact, + and Reporter will get email when new bugs are created in this + Component and when these bugs change. Default Owner and Default QA + Contact fields only dictate the default assignments; these can be changed on bug submission, or at any later point in a bug's life. To create a new Component: 1. Select the "Edit components" link from the "Edit product" page 2. Select the "Add" link in the bottom right. - 3. Fill out the "Component" field, a short "Description", the - "Initial Owner" and "Initial QA Contact" (if enabled.) The - Component and Description fields may contain HTML; the "Initial - Owner" field must be a login name already existing in the + 3. Fill out the "Component" field, a short "Description", the + "Initial Owner" and "Initial QA Contact" (if enabled.) The + Component and Description fields may contain HTML; the "Initial + Owner" field must be a login name already existing in the database. _________________________________________________________________ 5.3.3. Versions - Versions are the revisions of the product, such as "Flinders 3.1", - "Flinders 95", and "Flinders 2000". Version is not a multi-select - field; the usual practice is to select the most recent version with + Versions are the revisions of the product, such as "Flinders 3.1", + "Flinders 95", and "Flinders 2000". Version is not a multi-select + field; the usual practice is to select the most recent version with the bug. To create and edit Versions: 1. From the "Edit product" screen, select "Edit Versions" - 2. You will notice that the product already has the default version + 2. You will notice that the product already has the default version "undefined". Click the "Add" link in the bottom right. - 3. Enter the name of the Version. This field takes text only. Then + 3. Enter the name of the Version. This field takes text only. Then click the "Add" button. _________________________________________________________________ 5.3.4. Milestones - Milestones are "targets" that you plan to get a bug fixed by. For - example, you have a bug that you plan to fix for your 3.0 release, it + 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. Note @@ -2428,18 +2429,18 @@ Chapter 5. Administering Bugzilla Milestone options will only appear for a Product if you turned on the "usetargetmilestone" Param in the "Edit Parameters" screen. - To create new Milestones, set Default Milestones, and set Milestone + To create new Milestones, set Default Milestones, and set Milestone URL: 1. Select "Edit milestones" from the "Edit product" page. 2. Select "Add" in the bottom right corner. text - 3. Enter the name of the Milestone in the "Milestone" field. You can - optionally set the "sortkey", which is a positive or negative - number (-255 to 255) that defines where in the list this - particular milestone appears. This is because milestones often do - not occur in alphanumeric order For example, "Future" might be + 3. Enter the name of the Milestone in the "Milestone" field. You can + optionally set the "sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this + particular milestone appears. This is because milestones often do + not occur in alphanumeric order For example, "Future" might be after "Release 1.2". Select "Add". - 4. From the Edit product screen, you can enter the URL of a page + 4. From the Edit product screen, you can enter the URL of a page which gives information about your milestones and what they mean. Tip @@ -2453,55 +2454,72 @@ Chapter 5. Administering Bugzilla 5.4. Voting Voting allows users to be given a pot of votes which they can allocate - to bugs, to indicate that they'd like them fixed. This allows - developers to gauge user need for a particular enhancement or bugfix. - By allowing bugs with a certain number of votes to automatically move - from "UNCONFIRMED" to "NEW", users of the bug system can help - high-priority bugs garner attention so they don't sit for a long time + to bugs, to indicate that they'd like them fixed. This allows + developers to gauge user need for a particular enhancement or bugfix. + By allowing bugs with a certain number of votes to automatically move + from "UNCONFIRMED" to "NEW", users of the bug system can help + high-priority bugs garner attention so they don't sit for a long time awaiting triage. 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. Maximum Votes per person: Setting this field to "0" disables + 2. Maximum Votes per person: Setting this field to "0" disables voting. - 3. Maximum Votes a person can put on a single bug": It should + 3. Maximum Votes a person can put on a single bug": It should probably be some number lower than the "Maximum votes per person". - Don't set this field to "0" if "Maximum votes per person" is + Don't set this field to "0" if "Maximum votes per person" is non-zero; that doesn't make any sense. - 4. Number of votes a bug in this product needs to automatically get - out of the UNCONFIRMED state: Setting this field to "0" disables + 4. Number of votes a bug in this product needs to automatically get + out of the UNCONFIRMED state: Setting this field to "0" disables the automatic move of bugs from UNCONFIRMED to NEW. - 5. Once you have adjusted the values to your preference, click + 5. Once you have adjusted the values to your preference, click "Update". _________________________________________________________________ 5.5. Groups and Group Security Groups allow the administrator to isolate bugs or products that should - only be seen by certain people. There are two types of group - Generic - Groups, and Product-Based Groups. - - Product-Based Groups are matched with products, and allow you to - restrict access to bugs on a per-product basis. They are enabled using - the usebuggroups Param. Turning on the usebuggroupsentry Param will - mean bugs automatically get added to their product group when filed. - - Generic Groups have no special relationship to products; you create - them, and put bugs in them as required. One example of the use of - Generic Groups is Mozilla's "Security" group, into which - security-sensitive bugs are placed until fixed. Only the Mozilla - Security Team are members of this group. - - To create Generic Groups: + only be seen by certain people. The association between products and + groups is controlled from the product edit page under "Edit Group + Controls." + + If the makeproductgroups param is on, a new group will be + automatically created for every new product. + + On the product edit page, there is a page to edit the "Group Controls" + for a product and determine which groups are applicable, default, and + mandatory for each product as well as controlling entry for each + product and being able to set bugs in a product to be totally + read-only unless some group restrictions are met. + + For each group, it is possible to specify if membership in that group + is... + + 1. required for bug entry, + 2. Not applicable to this product(NA), a possible restriction for a + member of the group to place on a bug in this product(Shown), a + default restriction for a member of the group to place on a bug in + this product(Default), or a mandatory restriction to be placed on + bugs in this product(Mandatory). + 3. Not applicable by non-members to this product(NA), a possible + restriction for a non-member of the group to place on a bug in + this product(Shown), a default restriction for a non-member of the + group to place on a bug in this product(Default), or a mandatory + restriction to be placed on bugs in this product when entered by a + non-member(Mandatory). + 4. required in order to make any change to bugs in this product + including comments. + + To create Groups: 1. Select the "groups" link in the footer. - 2. Take a moment to understand the instructions on the "Edit Groups" + 2. Take a moment to understand the instructions on the "Edit Groups" screen, then select the "Add Group" link. - 3. Fill out the "Group", "Description", and "User RegExp" fields. - "New User RegExp" allows you to automatically place all users who - fulfill the Regular Expression into the new group. When you have + 3. Fill out the "Group", "Description", and "User RegExp" fields. + "User RegExp" allows you to automatically place all users who + fulfill the Regular Expression into the new group. When you have finished, click "Add". Warning @@ -2510,23 +2528,17 @@ Chapter 5. Administering Bugzilla part of an address. So, if you do not want to grant access into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use '@mycompany\.com$' as the regexp. - 4. After you add your new group, edit the new group. On the edit + 4. After you add your new group, edit the new group. On the edit page, you can specify other groups that should be included in this group and which groups should be permitted to add and delete users from this group. - To use Product-Based Groups: - - 1. Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen. - 2. In future, when you create a Product, a matching group will be - automatically created. If you need to add a Product Group to a - Product which was created before you turned on usebuggroups, then - simply create a new group, as outlined above, with the same name - as the Product. - - Note that group permissions are such that you need to be a member of + Note that group permissions are such that you need to be a member of all the groups a bug is in, for whatever reason, to see that bug. + Similarly, you must be a member of all of the entry groups for a + product to add bugs to a product and you must be a member of all of + the canedit groups for a product in order to make any change to bugs + in that product. _________________________________________________________________ 5.6. Bugzilla Security @@ -2548,17 +2560,14 @@ Chapter 5. Administering Bugzilla To secure your installation: - 1. Ensure you are running at least MysQL version 3.22.32 or newer. - Earlier versions had notable security holes and (from a security - point of view) poor default configuration choices. - 2. There is no substitute for understanding the tools on your system! - Read The MySQL Privilege System until you can recite it from + 1. There is no substitute for understanding the tools on your system! + Read The MySQL Privilege System until you can recite it from memory! - 3. Lock down /etc/inetd.conf. Heck, disable inet entirely on this + 2. Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to port 25 for Sendmail and port 80 for Apache. - 4. Do not run Apache as "nobody" . This will require very lax - permissions in your Bugzilla directories. Run it, instead, as a + 3. 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 @@ -2569,33 +2578,43 @@ Chapter 5. Administering Bugzilla 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/ directory, as well as the - $BUGZILLA_HOME/localconfig file. The localconfig file stores your - "bugs" database account password. In addition, some files under + 4. Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ directory, as well as the + $BUGZILLA_HOME/localconfig file. The localconfig file stores your + "bugs" database account password. In addition, some files under $BUGZILLA_HOME/data/ store sensitive information. - 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 + Also, beware that some text editors create backup files in the + current working directory so you need to also secure files like + localconfig~. + + Note + + Simply blocking .*localconfig.* won't work because the QuickSearch + feature requires the web browser to be able to retrieve localconfig.js + and others may be introduced in the future (see bug 186383 for more + information. + 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 + 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 + 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 + then it probably respects the .htaccess conventions and you are good to go. - When you run checksetup.pl, the script will attempt to modify - various permissions on files which Bugzilla uses. If you do not - have a webservergroup set in the localconfig file, then Bugzilla - will have to make certain files world readable and/or writable. - THIS IS INSECURE! . This means that anyone who can get access to - your system can do whatever they want to your Bugzilla + 5. When you run checksetup.pl, the script will attempt to modify + various permissions on files which Bugzilla uses. If you do not + have a webservergroup set in the localconfig file, then Bugzilla + will have to make certain files world readable and/or writable. + THIS IS INSECURE! . This means that anyone who can get access to + your system can do whatever they want to your Bugzilla installation. Note @@ -2603,74 +2622,129 @@ Chapter 5. Administering Bugzilla This also means that if your webserver runs all cgi scripts as the same user/group, anyone on the system who can run cgi scripts will be able to take control of your Bugzilla installation. - 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/ directory. + On Apache, you can use .htaccess files to protect access to these + directories, as outlined in Bugs 57161 and 186383 for the + localconfig file, and Bug 65572 for adequate protection in your + data/ directory. Also, don't forget about the template/ and + Bugzilla/ directories and to allow access to the data/webdot + directory for the 192.20.225.10 IP address if you are using webdot + from research.att.com. The easiest way to accomplish this is to + set $create_htaccess to 1 in localconfig. However, the information + below is provided for those that want to know exactly what is + created. Note the instructions which follow are Apache-specific. If you use - IIS, Netscape, or other non-Apache web servers, please consult + IIS, Netscape, or other non-Apache web servers, please consult your system documentation for how to secure these files from being transmitted to curious users. - Place the following text into a file named ".htaccess", readable - by your web server, in your $BUGZILLA_HOME/data directory. - allow from all - deny from all - Place the following text into a file named ".htaccess", readable - by your web server, in your $BUGZILLA_HOME/ directory. - deny from all - allow from all + $BUGZILLA_HOME/.htaccess + +# don't allow people to retrieve non-cgi executable files or our private data + + deny from all + + + allow from all + + + + $BUGZILLA_HOME/data/.htaccess + +# nothing in this directory is retrievable unless overriden by an .htaccess +# in a subdirectory; the only exception is duplicates.rdf, which is used by +# duplicates.xul and must be loadable over the web +deny from all + + allow from all + + + + $BUGZILLA_HOME/data/webdot + +# Restrict access to .dot files to the public webdot server at research.att.com + +# if research.att.com ever changed their IP, or if you use a different +# webdot server, you'll need to edit this + + Allow from 192.20.225.10 + Deny from all + + +# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and +# .map files + + Allow from all + + +# And no directory listings, either. +Deny from all + + + $BUGZILLA_HOME/Bugzilla/.htaccess + +# nothing in this directory is retrievable unless overriden by an .htaccess +# in a subdirectory +deny from all + + + $BUGZILLA_HOME/template/.htaccess + +# nothing in this directory is retrievable unless overriden by an .htaccess +# in a subdirectory +deny from all + _________________________________________________________________ -5.7. Template Customisation +5.7. Template Customization - One of the large changes for 2.16 was the templatisation of the entire - user-facing UI, using the Template Toolkit. Administrators can now - configure the look and feel of Bugzilla without having to edit Perl - files or face the nightmare of massive merge conflicts when they + One of the large changes for 2.16 was the templatization of the entire + user-facing UI, using the Template Toolkit. Administrators can now + configure the look and feel of Bugzilla without having to edit Perl + files or face the nightmare of massive merge conflicts when they upgrade to a newer version in the future. - Templatisation also makes localised versions of Bugzilla possible, for - the first time. In the future, a Bugzilla installation may have - templates installed for multiple localisations, and select which ones + Templatization also makes localized versions of Bugzilla possible, for + the first time. In the future, a Bugzilla installation may have + templates installed for multiple localizations, and select which ones to use based on the user's browser language setting. _________________________________________________________________ 5.7.1. What to Edit - There are two different ways of editing of Bugzilla's templates, and + There are two different ways of editing of Bugzilla's templates, and which you use depends mainly on how you upgrade Bugzilla. The template - directory structure is that there's a top level directory, template, - which contains a directory for each installed localisation. The - default English templates are therefore in en. Underneath that, there - is the default directory and optionally the custom directory. The - default directory contains all the templates shipped with Bugzilla, - whereas the custom directory does not exist at first and must be + directory structure is that there's a top level directory, template, + which contains a directory for each installed localization. The + default English templates are therefore in en. Underneath that, there + is the default directory and optionally the custom directory. The + default directory contains all the templates shipped with Bugzilla, + whereas the custom directory does not exist at first and must be created if you want to use it. - The first method of making customisations is to directly edit the + The first method of making customizations is to directly edit the templates in template/en/default. This is probably the best method for - small changes if you are going to use the CVS method of upgrading, - because if you then execute a cvs update, any template fixes will get + small changes if you are going to use the CVS method of upgrading, + because if you then execute a cvs update, any template fixes will get automagically merged into your modified versions. - If you use this method, your installation will break if CVS conflicts + If you use this method, your installation will break if CVS conflicts occur. - The other method is to copy the templates into a mirrored directory - structure under template/en/custom. The templates in this directory - automatically override those in default. This is the technique you - need to use if you use the overwriting method of upgrade, because + The other method is to copy the templates into a mirrored directory + structure under template/en/custom. The templates in this directory + automatically override those in default. This is the technique you + need to use if you use the overwriting method of upgrade, because otherwise your changes will be lost. This method is also better if you - are using the CVS method of upgrading and are going to make major - changes, because it is guaranteed that the contents of this directory + are using the CVS method of upgrading and are going to make major + changes, because it is guaranteed that the contents of this directory will not be touched during an upgrade, and you can then decide whether to continue using your own templates, or make the effort to merge your changes into the new versions by hand. - If you use this method, your installation may break if incompatible - changes are made to the template interface. If such changes are made + If you use this method, your installation may break if incompatible + changes are made to the template interface. If such changes are made they will be documented in the release notes, provided you are using a - stable release of Bugzilla. If you use using unstable code, you will - need to deal with this one yourself, although if possible the changes + stable release of Bugzilla. If you use using unstable code, you will + need to deal with this one yourself, although if possible the changes will be mentioned before they occur in the deprecations section of the previous stable release's release notes. @@ -2682,33 +2756,33 @@ Chapter 5. Administering Bugzilla 5.7.2. How To Edit Templates - The syntax of the Template Toolkit language is beyond the scope of - this guide. It's reasonably easy to pick up by looking at the current - templates; or, you can read the manual, available on the Template - Toolkit home page. However, you should particularly remember (for - security reasons) to always HTML filter things which come from the + The syntax of the Template Toolkit language is beyond the scope of + this guide. It's reasonably easy to pick up by looking at the current + templates; or, you can read the manual, available on the Template + Toolkit home page. However, you should particularly remember (for + security reasons) to always HTML filter things which come from the database or user input, to prevent cross-site scripting attacks. - However, one thing you should take particular care about is the need - to properly HTML filter data that has been passed into the template. - This means that if the data can possibly contain special HTML - characters such as <, and the data was not intended to be HTML, they - need to be converted to entity form, ie <. You use the 'html' + However, one thing you should take particular care about is the need + to properly HTML filter data that has been passed into the template. + This means that if the data can possibly contain special HTML + characters such as <, and the data was not intended to be HTML, they + need to be converted to entity form, ie <. You use the 'html' filter in the Template Toolkit to do this. If you fail to do this, you may open up your installation to cross-site scripting attacks. Also note that Bugzilla adds a few filters of its own, that are not in - standard Template Toolkit. In particular, the 'url_quote' filter can - convert characters that are illegal or have special meaning in URLs, - such as &, to the encoded form, ie %26. This actually encodes most + standard Template Toolkit. In particular, the 'url_quote' filter can + convert characters that are illegal or have special meaning in URLs, + such as &, to the encoded form, ie %26. This actually encodes most characters (but not the common ones such as letters and numbers and so on), including the HTML-special characters, so there's never a need to HTML filter afterwards. Editing templates is a good way of doing a "poor man's custom fields". - For example, if you don't use the Status Whiteboard, but want to have - a free-form text entry box for "Build Identifier", then you can just - edit the templates to change the field labels. It's still be called + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called status_whiteboard internally, but your users don't need to know that. Note @@ -2722,91 +2796,91 @@ Chapter 5. Administering Bugzilla Some CGIs have the ability to use more than one template. For example, buglist.cgi can output bug lists as RDF or two different forms of HTML - (complex and simple). (Try this out by appending &format=simple to a + (complex and simple). (Try this out by appending &format=simple to a buglist.cgi URL on your Bugzilla installation.) This mechanism, called template 'formats', is extensible. - To see if a CGI supports multiple output formats, grep the CGI for - "ValidateOutputFormat". If it's not present, adding multiple format + To see if a CGI supports multiple output formats, grep the CGI for + "ValidateOutputFormat". If it's not present, adding multiple format support isn't too hard - see how it's done in other CGIs. - To make a new format template for a CGI which supports this, open a - current template for that CGI and take note of the INTERFACE comment + To make a new format template for a CGI which supports this, open a + current template for that CGI and take note of the INTERFACE comment (if present.) This comment defines what variables are passed into this - template. If there isn't one, I'm afraid you'll have to read the + template. If there isn't one, I'm afraid you'll have to read the template and the code to find out what information you get. Write your template in whatever markup or text style is appropriate. You now need to decide what content type you want your template served - as. Open up the localconfig file and find the $contenttypes variable. - If your content type is not there, add it. Remember the three- or + as. Open up the localconfig file and find the $contenttypes variable. + If your content type is not there, add it. Remember the three- or four-letter tag assigned to you content type. This tag will be part of the template filename. - Save the template as -..tmpl. + Save the template as -..tmpl. Try out the template by calling the CGI as .cgi?format= . _________________________________________________________________ 5.7.4. Particular Templates - There are a few templates you may be particularly interested in - customising for your installation. + There are a few templates you may be particularly interested in + customizing for your installation. index.html.tmpl: This is the Bugzilla front page. - global/header.html.tmpl: This defines the header that goes on all - Bugzilla pages. The header includes the banner, which is what appears - to users and is probably what you want to edit instead. However the - header also includes the HTML HEAD section, so you could for example + global/header.html.tmpl: This defines the header that goes on all + Bugzilla pages. The header includes the banner, which is what appears + to users and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for example add a stylesheet or META tag by editing the header. - global/banner.html.tmpl: This contains the "banner", the part of the - header that appears at the top of all Bugzilla pages. The default - banner is reasonably barren, so you'll probably want to customise this - to give your installation a distinctive look and feel. It is - recommended you preserve the Bugzilla version number in some form so - the version you are running can be determined, and users know what + global/banner.html.tmpl: This contains the "banner", the part of the + header that appears at the top of all Bugzilla pages. The default + banner is reasonably barren, so you'll probably want to customize this + to give your installation a distinctive look and feel. It is + recommended you preserve the Bugzilla version number in some form so + the version you are running can be determined, and users know what docs to read. - global/footer.html.tmpl: This defines the footer that goes on all - Bugzilla pages. Editing this is another way to quickly get a + global/footer.html.tmpl: This defines the footer that goes on all + Bugzilla pages. Editing this is another way to quickly get a distinctive look and feel for your Bugzilla installation. bug/create/user-message.html.tmpl: This is a message that appears near - the top of the bug reporting page. By modifying this, you can tell + the top of the bug reporting page. By modifying this, you can tell your users how they should report bugs. - bug/process/midair.html.tmpl: This is the page used if two people - submit simultaneous changes to the same bug. The second person to - submit their changes will get this page to tell them what the first + bug/process/midair.html.tmpl: This is the page used if two people + submit simultaneous changes to the same bug. The second person to + submit their changes will get this page to tell them what the first person did, and ask if they wish to overwrite those changes or go back - and revisit the bug. The default title and header on this page read + and revisit the bug. The default title and header on this page read "Mid-air collision detected!" If you work in the aviation industry, or - other environment where this might be found offensive (yes, we have - true stories of this happening) you'll want to change this to + other environment where this might be found offensive (yes, we have + true stories of this happening) you'll want to change this to something more appropriate for your environment. - bug/create/create.html.tmpl and bug/create/comment.txt.tmpl: You may - wish to get bug submitters to give certain bits of structured + bug/create/create.html.tmpl and bug/create/comment.txt.tmpl: You may + wish to get bug submitters to give certain bits of structured information, each in a separate input widget, for which there is not a - field in the database. The bug entry system has been designed in an - extensible fashion to enable you to define arbitrary fields and - widgets, and have their values appear formatted in the initial + field in the database. The bug entry system has been designed in an + extensible fashion to enable you to define arbitrary fields and + widgets, and have their values appear formatted in the initial Description, rather than in database fields. An example of this is the mozilla.org guided bug submission form. - To make this work, create a custom template for enter_bug.cgi (the - default template, on which you could base it, is create.html.tmpl), - and either call it create.html.tmpl or use a format and call it - create-.html.tmpl. Put it in the custom/bug/create + To make this work, create a custom template for enter_bug.cgi (the + default template, on which you could base it, is create.html.tmpl), + and either call it create.html.tmpl or use a format and call it + create-.html.tmpl. Put it in the custom/bug/create directory. In it, add widgets for each piece of information you'd like collected - such as a build number, or set of steps to reproduce. - Then, create a template like custom/bug/create/comment.txt.tmpl, also - named after your format if you are using one, which references the - form fields you have created. When a bug report is submitted, the + Then, create a template like custom/bug/create/comment.txt.tmpl, also + named after your format if you are using one, which references the + form fields you have created. When a bug report is submitted, the initial comment attached to the bug report will be formatted according to the layout of this template. @@ -2822,7 +2896,7 @@ Chapter 5. Administering Bugzilla would appear in the initial checkin comment. _________________________________________________________________ -5.8. Change Permission Customisation +5.8. Change Permission Customization Warning @@ -2832,23 +2906,23 @@ Chapter 5. Administering Bugzilla to re-make them or port them if Bugzilla changes internally between versions. - Companies often have rules about which employees, or classes of + Companies often have rules about which employees, or classes of employees, are allowed to change certain things in the bug system. For example, only the bug's designated QA Contact may be allowed to VERIFY - the bug. Bugzilla has been designed to make it easy for you to write - your own custom rules to define who is allowed to make what sorts of + the bug. Bugzilla has been designed to make it easy for you to write + your own custom rules to define who is allowed to make what sorts of value transition. - For maximum flexibility, customising this means editing Bugzilla's - Perl code. This gives the administrator complete control over exactly - who is allowed to do what. The relevant function is called - CheckCanChangeField(), and is found in process_bug.cgi in your - Bugzilla directory. If you open that file and grep for "sub + For maximum flexibility, customizing this means editing Bugzilla's + Perl code. This gives the administrator complete control over exactly + who is allowed to do what. The relevant function is called + CheckCanChangeField(), and is found in process_bug.cgi in your + Bugzilla directory. If you open that file and grep for "sub CheckCanChangeField", you'll find it. This function has been carefully commented to allow you to see exactly - how it works, and give you an idea of how to make changes to it. - Certain marked sections should not be changed - these are the + how it works, and give you an idea of how to make changes to it. + Certain marked sections should not be changed - these are the "plumbing" which makes the rest of the function work. In between those sections, you'll find snippets of code like: # Allow the owner to change anything. @@ -2859,17 +2933,17 @@ Chapter 5. Administering Bugzilla It's fairly obvious what this piece of code does. So, how does one go about changing this function? Well, simple changes - can be made just be removing pieces - for example, if you wanted to - prevent any user adding a comment to a bug, just remove the lines + can be made just be removing pieces - for example, if you wanted to + prevent any user adding a comment to a bug, just remove the lines marked "Allow anyone to change comments." And if you want the reporter - to have no special rights on bugs they have filed, just remove the + to have no special rights on bugs they have filed, just remove the entire section which refers to him. - More complex customisations are not much harder. Basically, you add a + More complex customizations are not much harder. Basically, you add a check in the right place in the function, i.e. after all the variables - you are using have been set up. So, don't look at $ownerid before - $ownerid has been obtained from the database. You can either add a - positive check, which returns 1 (allow) if certain conditions are + you are using have been set up. So, don't look at $ownerid before + $ownerid has been obtained from the database. You can either add a + positive check, which returns 1 (allow) if certain conditions are true, or a negative check, which returns 0 (deny.) E.g.: if ($field eq "qacontact") { if (UserInGroup("quality_assurance")) { @@ -2880,7 +2954,7 @@ Chapter 5. Administering Bugzilla } } - This says that only users in the group "quality_assurance" can change + This says that only users in the group "quality_assurance" can change the QA Contact field of a bug. Getting more weird: if (($field eq "priority") && ($vars->{'user'}{'login'} =~ /.*\@example\.com$/)) @@ -2894,40 +2968,40 @@ Chapter 5. Administering Bugzilla } This says that if the user is trying to change the priority field, and - their email address is @example.com, they can only do so if the old + their email address is @example.com, they can only do so if the old value of the field was "P1". Not very useful, but illustrative. - For a list of possible field names, look in data/versioncache for the - list called @::log_columns. If you need help writing custom rules for - your organisation, ask in the newsgroup. + For a list of possible field names, look in data/versioncache for the + list called @::log_columns. If you need help writing custom rules for + your organization, ask in the newsgroup. _________________________________________________________________ 5.9. Upgrading to New Releases A plain Bugzilla is fairly easy to upgrade from one version to a newer one. Always read the release notes to see if there are any issues that - you might need to take note of. It is recommended that you take a - backup of your database and your entire Bugzilla installation before - attempting an upgrade. You can upgrade a 'clean' installation by - untarring a new tarball over the old installation. If you are + you might need to take note of. It is recommended that you take a + backup of your database and your entire Bugzilla installation before + attempting an upgrade. You can upgrade a 'clean' installation by + untarring a new tarball over the old installation. If you are upgrading from 2.12 or later, and have cvs installed, you can type cvs -z3 update, and resolve conflicts if there are any. - However, things get a bit more complicated if you've made changes to - Bugzilla's code. In this case, you may have to re-make or reapply - those changes. One good method is to take a diff of your customised - version against the original, so you can survey all that you've - changed. Hopefully, templatisation will reduce the need for this in + However, things get a bit more complicated if you've made changes to + Bugzilla's code. In this case, you may have to re-make or reapply + those changes. One good method is to take a diff of your customized + version against the original, so you can survey all that you've + changed. Hopefully, templatization will reduce the need for this in the future. - From version 2.8 onwards, Bugzilla databases can be automatically - carried forward during an upgrade. However, because the developers of - Bugzilla are constantly adding new tables, columns and fields, you'll + From version 2.8 onward, Bugzilla databases can be automatically + carried forward during an upgrade. However, because the developers of + Bugzilla are constantly adding new tables, columns and fields, you'll probably get SQL errors if you just update the code and attempt to use - Bugzilla. Always run the checksetup.pl script whenever you upgrade + Bugzilla. Always run the checksetup.pl script whenever you upgrade your installation. - If you are running Bugzilla version 2.8 or lower, and wish to upgrade + 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. _________________________________________________________________ @@ -2937,43 +3011,43 @@ Chapter 5. Administering Bugzilla 5.10.1. Bonsai Bonsai is a web-based tool for managing CVS, the Concurrent Versioning - System . Using Bonsai, administrators can control open/closed status - of trees, query a fast relational database back-end for change, - branch, and comment information, and view changes made since the last - time the tree was closed. Bonsai also integrates with Tinderbox, the + System . Using Bonsai, administrators can control open/closed status + of trees, query a fast relational database back-end for change, + branch, and comment information, and view changes made since the last + time the tree was closed. Bonsai also integrates with Tinderbox, the Mozilla automated build management system. _________________________________________________________________ 5.10.2. CVS - CVS integration is best accomplished, at this point, using the + CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway. - Follow the instructions in this Guide for enabling Bugzilla e-mail - integration. Ensure that your check-in script sends an email to your - Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can - have CVS check-in comments append to your Bugzilla bug. If you have + Follow the instructions in this Guide for enabling Bugzilla e-mail + integration. Ensure that your check-in script sends an email to your + Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can + have CVS check-in comments append to your Bugzilla bug. If you have your check-in script include an @resolution field, you can even change the Bugzilla bug state. - There is also a CVSZilla project, based upon somewhat dated Bugzilla - code, to integrate CVS and Bugzilla through CVS' ability to email. + There is also a CVSZilla project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to email. Check it out at: http://homepages.kcbbs.gen.nz/~tonyg/. _________________________________________________________________ 5.10.3. Perforce SCM - You can find the project page for Bugzilla and Teamtrack Perforce - integration (p4dti) at: http://www.ravenbrook.com/project/p4dti . - "p4dti" is now an officially supported product from Perforce, and you - can find the "Perforce Public Depot" p4dti page at + You can find the project page for Bugzilla and Teamtrack Perforce + integration (p4dti) at: http://www.ravenbrook.com/project/p4dti . + "p4dti" is now an officially supported product from Perforce, and you + can find the "Perforce Public Depot" p4dti page at http://public.perforce.com/public/perforce/p4dti/index.html . - Integration of Perforce with Bugzilla, once patches are applied, is - seamless. Perforce replication information will appear below the - comments of each bug. Be certain you have a matching set of patches - for the Bugzilla version you are installing. p4dti is designed to - support multiple defect trackers, and maintains its own documentation + Integration of Perforce with Bugzilla, once patches are applied, is + seamless. Perforce replication information will appear below the + comments of each bug. Be certain you have a matching set of patches + for the Bugzilla version you are installing. p4dti is designed to + support multiple defect trackers, and maintains its own documentation for it. Please consult the pages linked above for further information. _________________________________________________________________ @@ -2999,7 +3073,7 @@ Appendix A. The Bugzilla FAQ databases? A.1.7. Why doesn't Bugzilla offer this or that feature or - compatability with this other tracking software? + compatibility with this other tracking software? A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL. @@ -3123,13 +3197,10 @@ Appendix A. The Bugzilla FAQ entries. What do I do? A.5.3. I want to manually edit some entries in my database. How? - A.5.4. I try to add myself as a user, but Bugzilla always tells - me my password is wrong. - - A.5.5. I think I've set up MySQL permissions correctly, but + A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla still can't connect. - A.5.6. How do I synchronize bug information among multiple + A.5.5. How do I synchronize bug information among multiple different Bugzilla databases? 6. Bugzilla and Win32 @@ -3157,10 +3228,7 @@ Appendix A. The Bugzilla FAQ A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? - A.7.5. Email submissions to Bugzilla that have attachments end up - asking me to save it as a "cgi" file. - - A.7.6. How do I change a keyword in Bugzilla, once some bugs are + A.7.5. How do I change a keyword in Bugzilla, once some bugs are using it? 8. Bugzilla Hacking @@ -3178,35 +3246,37 @@ Appendix A. The Bugzilla FAQ A.1.1. Where can I find information about Bugzilla? - You can stay up-to-date with the latest Bugzilla information at + You can stay up-to-date with the latest Bugzilla information at http://www.bugzilla.org/ A.1.2. What license is Bugzilla distributed under? - Bugzilla is covered by the Mozilla Public License. See details at + Bugzilla is covered by the Mozilla Public License. See details at http://www.mozilla.org/MPL/ A.1.3. How do I get commercial support for Bugzilla? - www.collab.net offers Bugzilla as part of their standard offering to - large projects. They do have some minimum fees that are pretty hefty, + http://bugzilla.org/consulting.html is a list of people and companies + who have asked us to list them as consultants for Bugzilla. + + www.collab.net offers Bugzilla as part of their standard offering to + large projects. They do have some minimum fees that are pretty hefty, and generally aren't interested in small projects. - There are several experienced Bugzilla hackers on the mailing - list/newsgroup who are willing to make themselves available for - generous compensation. Try sending a message to the mailing list + There are several experienced Bugzilla hackers on the mailing + list/newsgroup who are willing to make themselves available for + generous compensation. Try sending a message to the mailing list asking for a volunteer. - A.1.4. What major companies or projects are currently using Bugzilla + A.1.4. What major companies or projects are currently using Bugzilla for bug-tracking? - There are dozens of major comapanies with public Bugzilla sites to + There are dozens of major companies with public Bugzilla sites to track bugs in their products. A few include: Netscape/AOL Mozilla.org NASA - AtHome Corporation Red Hat Software SuSe Corp The Horde Project @@ -3221,59 +3291,66 @@ Appendix A. The Bugzilla FAQ Ximian Linux-Mandrake - Suffice to say, there are more than enough huge projects using + Suffice to say, there are more than enough huge projects using Bugzilla that we can safely say it's extremely popular. A.1.5. Who maintains Bugzilla? - A core team, led by Dave Miller (justdave@syndicomm.com). + A core team, led by Dave Miller (justdave@netscape.com). - A.1.6. How does Bugzilla stack up against other bug-tracking + A.1.6. How does Bugzilla stack up against other bug-tracking databases? - We can't find any head-to-head comparisons of Bugzilla against other - defect-tracking software. If you know of one, please get in touch. - However, from the author's personal experience with other - bug-trackers, Bugzilla offers superior performance on commodity - hardware, better price (free!), more developer- friendly features - (such as stored queries, email integration, and platform - independence), improved scalability, open source code, greater + We can't find any head-to-head comparisons of Bugzilla against other + defect-tracking software. If you know of one, please get in touch. + However, from the author's personal experience with other + bug-trackers, Bugzilla offers superior performance on commodity + hardware, better price (free!), more developer- friendly features + (such as stored queries, email integration, and platform + independence), improved scalability, open source code, greater flexibility, and superior ease-of-use. - If you happen to be a commercial bug-tracker vendor, please step + If you happen to be a commercial bug-tracker vendor, please step forward with a list of advantages your product has over Bugzilla. We'd be happy to include it in the "Competitors" section. - A.1.7. Why doesn't Bugzilla offer this or that feature or - compatability with this other tracking software? + A.1.7. Why doesn't Bugzilla offer this or that feature or + compatibility with this other tracking software? - It may be that the support has not been built yet, or that you have - not yet found it. Bugzilla is making tremendous strides in usability, - customizability, scalability, and user interface. It is widely - considered the most complete and popular open-source bug-tracking + It may be that the support has not been built yet, or that you have + not yet found it. Bugzilla is making tremendous strides in usability, + customizability, scalability, and user interface. It is widely + considered the most complete and popular open-source bug-tracking software in existence. - That doesn't mean it can't use improvement! You can help the project - along by either hacking a patch yourself that supports the - functionality you require, or else submitting a "Request for - Enhancement" (RFE) using the bug submission interface at + That doesn't mean it can't use improvement! You can help the project + along by either hacking a patch yourself that supports the + functionality you require, or else submitting a "Request for + Enhancement" (RFE) using the bug submission interface at bugzilla.mozilla.org. - A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on + A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL. - There is DB-independence work afoot. PostgreSQL support is planned for - 2.18, and full DB-independence can't be far further on. + MySQL was originally chosen because it is free, easy to install, and + was available for the hardware Netscape intended to run it on. + + There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track the + progress of these initiatives in bugs 98304 and 173130 respectively. - A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of + Once both of these are done, adding support for additional database + servers should be trivial. + + A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? - Mozilla.org uses /usr/bonsaitools/bin/perl, because originally Terry - wanted a place to put a version of Perl and other tools that was + Mozilla.org uses /usr/bonsaitools/bin/perl, because originally Terry + wanted a place to put a version of Perl and other tools that was strictly under his control. - We always recommend that, if possible, you keep the path as - /usr/bonsaitools/bin/perl, and simply add symlink. This will make + We always recommend that, if possible, you keep the path as + /usr/bonsaitools/bin/perl, and simply add symlink. This will make upgrading your Bugzilla much easier in the future. A.1.10. Is there an easy way to change the Bugzilla cookie name? @@ -3289,76 +3366,75 @@ Appendix A. The Bugzilla FAQ A.2.1. Is Bugzilla web-based, or do you have to have specific software or a specific operating system on your machine? - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the + It is web and e-mail based. You can edit bugs by sending specially + formatted email to a properly configured Bugzilla, or control via the web. A.2.2. Can Bugzilla integrate with Perforce (SCM software)? - Yes! You can find more information elsewhere in "The Bugzilla Guide" + Yes! You can find more information elsewhere in "The Bugzilla Guide" in the "Integration with Third-Party Products" section. A.2.3. Does Bugzilla allow the user to track multiple projects? - Absolutely! You can track any number of Products (although you are - limited to about 55 or so if you are using Product-Based Groups), that - can each be composed of any number of Components. + Absolutely! You can track any number of Products that can each be + composed of any number of Components. - A.2.4. If I am on many projects, and search for all bugs assigned to - me, will Bugzilla list them for me and allow me to sort by project, + A.2.4. If I am on many projects, and search for all bugs assigned to + me, will Bugzilla list them for me and allow me to sort by project, severity etc? Yes. - A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? + A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, are there any that are NOT allowed? - Yes - any sort of attachment is allowed, although administrators can - configure a maximum size. There are many specific MIME-types that are - pre-defined by Bugzilla, but you may specify any arbitrary MIME-type - you need when you upload the file. + Yes - any sort of attachment is allowed, although administrators can + configure a maximum size. Bugzilla gives the user the option of either + using the MIME-type supplied by the browser, choosing from a + pre-defined list or manually typing any arbitrary MIME-type. A.2.6. Does Bugzilla allow us to define our own priorities and levels? - Do we have complete freedom to change the labels of fields and format + Do we have complete freedom to change the labels of fields and format of them, and the choice of acceptable values? - Yes. However, modifying some fields, notably those related to bug - progression states, also require adjusting the program logic to + Yes. However, modifying some fields, notably those related to bug + progression states, also require adjusting the program logic to compensate for the change. - There is no GUI for adding fields to Bugzilla at this time. You can + There is no GUI for adding fields to Bugzilla at this time. You can follow development of this feature at http://bugzilla.mozilla.org/show_bug.cgi?id=91037 - A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, + A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) - Yes. Look at http://bugzilla.mozilla.org/reports.cgi for basic - reporting and graphing facilities. + Yes. Look at http://bugzilla.mozilla.org/report.cgi for samples of + what Bugzilla can do in reporting and graphing. - For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access the - MySQL database. You can do a lot through the Query page of Bugzilla as - well, but right now Advanced Reporting is much better accomplished - through third-party utilities that can interface with the database - directly. + If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, beware + that giving direct access to the database does contain some security + implications. Even if you give read-only access to the bugs database + it will bypass the secure bugs features of Bugzilla. A.2.8. Is there email notification and if so, what do you see when you get an email? - Email notification is user-configurable. By default, the bug id and - Summary of the bug report accompany each email notification, along + Email notification is user-configurable. By default, the bug id and + Summary of the bug report accompany each email notification, along with a list of the changes made. - A.2.9. Can email notification be set up to send to multiple people, + A.2.9. Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? Yes. - A.2.10. Do users have to have any particular type of email + A.2.10. Do users have to have any particular type of email application? - Bugzilla email is sent in plain text, the most compatible mail format + Bugzilla email is sent in plain text, the most compatible mail format on the planet. Note @@ -3371,291 +3447,294 @@ Appendix A. The Bugzilla FAQ into Bugzilla the resulting comment looks downright awful. A.2.11. Does Bugzilla allow data to be imported and exported? If I had - outsiders write up a bug report using a MS Word bug template, could - that template be imported into "matching" fields? If I wanted to take - the results of a query and export that data to MS Excel, could I do + outsiders write up a bug report using a MS Word bug template, could + that template be imported into "matching" fields? If I wanted to take + the results of a query and export that data to MS Excel, could I do that? - Mozilla allows data export through a custom DTD in XML format. It does - not, however, export to specific formats other than the XML Mozilla - DTD. Importing the data into Excel or any other application is left as - an exercise for the reader. + Bugzilla can output buglists as HTML (the default), CSV or RDF. The + link for CSV can be found at the bottom of the buglist in HTML format. + This CSV format can easily be imported into MS Excel or other + spread-sheet applications. + + To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF is meant to be machine readable and thus it + is assumed that the URL would be generated progmatically so there is + no user visible link to this format. - If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. + Currently the only script included with Bugzilla that can import data + is importxml.pl which is intended to be used for importing the data + generated by xml.cgi in association with bug moving. Any other use is + left as an exercise for the user. - As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; it makes - more sense to create a simplified bug submission form in HTML. You can - find an excellent example at - http://www.mozilla.org/quality/help/bugzilla-helper.html + There are also scripts included in the contrib/ directory for using + e-mail to import information into Bugzilla, but these scripts are not + currently supported and included for educational purposes. - A.2.12. Has anyone converted Bugzilla to another language to be used + A.2.12. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? - To a certain extent, yes. 2.16's templates mean that you can localise - the user-facing UI (and several projects are doing exactly that.) - However, error messages and the admin interface are currently not - localisable. This should be achieved by 2.18. + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html. The admin interfaces are + still not included in these translated templates and is therefore + still English only. Also, there may be issues with the charset not + being declared. See bug 126226 for more information. - A.2.13. Can a user create and save reports? Can they do this in Word + A.2.13. Can a user create and save reports? Can they do this in Word format? Excel format? - Yes. No. No. + Yes. No. Yes (using the CSV format). - A.2.14. Does Bugzilla have the ability to search by word, phrase, + A.2.14. Does Bugzilla have the ability to search by word, phrase, compound search? - You have no idea. Bugzilla's query interface, particularly with the + You have no idea. Bugzilla's query interface, particularly with the advanced Boolean operators, is incredibly versatile. - A.2.15. Does Bugzilla provide record locking when there is - simultaneous access to the same bug? Does the second person get a + A.2.15. Does Bugzilla provide record locking when there is + simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? - Bugzilla does not lock records. It provides mid-air collision - detection, and offers the offending user a choice of options to deal + Bugzilla does not lock records. It provides mid-air collision + detection, and offers the offending user a choice of options to deal with the conflict. A.2.16. Are there any backup features provided? - MySQL, the database back-end for Bugzilla, allows hot-backup of data. - You can find strategies for dealing with backup considerations at + MySQL, the database back-end for Bugzilla, allows hot-backup of data. + You can find strategies for dealing with backup considerations at http://www.mysql.com/doc/B/a/Backup.html A.2.17. Can users be on the system while a backup is in progress? - Yes. However, commits to the database must wait until the tables are - unlocked. Bugzilla databases are typically very small, and backups + Yes. However, commits to the database must wait until the tables are + unlocked. Bugzilla databases are typically very small, and backups routinely take less than a minute. - A.2.18. What type of human resources are needed to be on staff to - install and maintain Bugzilla? Specifically, what type of skills does - the person need to have? I need to find out if we were to go with + A.2.18. What type of human resources are needed to be on staff to + install and maintain Bugzilla? Specifically, what type of skills does + the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an "Out-of-the-Box" solution. If Bugzilla is set up correctly from the start, continuing maintenance needs are minimal and can be done easily using the web interface. - Commercial Bug-tracking software typically costs somewhere upwards of - $20,000 or more for 5-10 floating licenses. Bugzilla consultation is - available from skilled members of the newsgroup. Simple questions are + Commercial Bug-tracking software typically costs somewhere upwards of + $20,000 or more for 5-10 floating licenses. Bugzilla consultation is + available from skilled members of the newsgroup. Simple questions are answered there and then. - A.2.19. What time frame are we looking at if we decide to hire people - to install and maintain the Bugzilla? Is this something that takes - hours or weeks to install and a couple of hours per week to maintain - and customize or is this a multi-week install process, plus a full + A.2.19. What time frame are we looking at if we decide to hire people + to install and maintain the Bugzilla? Is this something that takes + hours or weeks to install and a couple of hours per week to maintain + and customize or is this a multi-week install process, plus a full time job for 1 person, 2 people, etc? It all depends on your level of commitment. Someone with much Bugzilla - experience can get you up and running in less than a day, and your + experience can get you up and running in less than a day, and your Bugzilla install can run untended for years. If your Bugzilla strategy - is critical to your business workflow, hire somebody with reasonable + is critical to your business workflow, hire somebody with reasonable UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. - A.2.20. Is there any licensing fee or other fees for using Bugzilla? - Any out-of-pocket cost other than the bodies needed as identified + A.2.20. Is there any licensing fee or other fees for using Bugzilla? + Any out-of-pocket cost other than the bodies needed as identified above? - No. MySQL asks, if you find their product valuable, that you purchase + No. MySQL asks, if you find their product valuable, that you purchase a support contract from them that suits your needs. 3. Bugzilla Security - A.3.1. How do I completely disable MySQL security if it's giving me - problems (I've followed the instructions in the installation section + A.3.1. How do I completely disable MySQL security if it's giving me + problems (I've followed the instructions in the installation section of this guide)? - Run MySQL like this: "mysqld --skip-grant-tables". Please remember + Run MySQL like this: "mysqld --skip-grant-tables". Please remember this makes MySQL as secure as taping a $100 to the floor of a football stadium bathroom for safekeeping. A.3.2. Are there any security problems with Bugzilla? - The Bugzilla code has undergone a reasonably complete security audit, - and user-facing CGIs run under Perl's taint mode. However, it is - recommended that you closely examine permissions on your Bugzilla - installation, and follow the recommended security guidelines found in + The Bugzilla code has undergone a reasonably complete security audit, + and user-facing CGIs run under Perl's taint mode. However, it is + recommended that you closely examine permissions on your Bugzilla + installation, and follow the recommended security guidelines found in The Bugzilla Guide. - A.3.3. I've implemented the security fixes mentioned in Chris Yeh's - security advisory of 5/10/2000 advising not to run MySQL as root, and + A.3.3. I've implemented the security fixes mentioned in Chris Yeh's + security advisory of 5/10/2000 advising not to run MySQL as root, and am running into problems with MySQL no longer working correctly. - This is a common problem, related to running out of file descriptors. + This is a common problem, related to running out of file descriptors. Simply add "ulimit -n unlimited" to the script which starts mysqld. 4. Bugzilla Email - A.4.1. I have a user who doesn't want to receive any more email from + A.4.1. I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user? The user should be able to set this in user email preferences (uncheck - all boxes.) + all boxes) or you can add their email address to the data/nomail file. - A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send + A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? - Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", replace - "Cc:" with "X-Real-CC:", and add a "To: ". + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", + replace "Cc:" with "X-Real-CC:", and add a "To: ". - A.4.3. I want whineatnews.pl to whine at something more, or other + A.4.3. I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? - Try Klaas Freitag's excellent patch for "whineatassigned" + Try Klaas Freitag's excellent patch for "whineatassigned" functionality. You can find it at - http://bugzilla.mozilla.org/show_bug.cgi?id=6679. This patch is - against an older version of Bugzilla, so you must apply the diffs + http://bugzilla.mozilla.org/show_bug.cgi?id=6679. This patch is + against an older version of Bugzilla, so you must apply the diffs manually. - A.4.4. I don't like/want to use Procmail to hand mail off to + A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? - You can call bug_email.pl directly from your aliases file, with an + You can call bug_email.pl directly from your aliases file, with an entry like this: bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" - However, this is fairly nasty and subject to problems; you also need - to set up your smrsh (sendmail restricted shell) to allow it. In a + However, this is fairly nasty and subject to problems; you also need + to set up your smrsh (sendmail restricted shell) to allow it. In a pinch, though, it can work. - A.4.5. How do I set up the email interface to submit/change bugs via + A.4.5. How do I set up the email interface to submit/change bugs via email? - You can find an updated README.mailif file in the contrib/ directory + You can find an updated README.mailif file in the contrib/ directory of your Bugzilla distribution that walks you through the setup. A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. What gives? - If you are using an alternate Mail Transport Agent (MTA other than - sendmail), make sure the options given in the "processmail" and other + If you are using an alternate Mail Transport Agent (MTA other than + sendmail), make sure the options given in the "processmail" and other scripts for all instances of "sendmail" are correct for your MTA. - If you are using Sendmail, try enabling "sendmailnow" in + If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. If you are using Postfix, you will also need to enable "sendmailnow". A.4.7. How come email from Bugzilla changes never reaches me? - Double-check that you have not turned off email in your user - preferences. Confirm that Bugzilla is able to send email by visiting - the "Log In" link of your Bugzilla installation and clicking the + Double-check that you have not turned off email in your user + preferences. Confirm that Bugzilla is able to send email by visiting + the "Log In" link of your Bugzilla installation and clicking the "Email me a password" button after entering your email address. - If you never receive mail from Bugzilla, chances you do not have - sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is + If you never receive mail from Bugzilla, chances you do not have + sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked to, "/usr/lib/sendmail". 5. Bugzilla Database A.5.1. I've heard Bugzilla can be used with Oracle? - Red Hat Bugzilla works with Oracle. The current version from - Mozilla.org does not have this capability. Unfortunately, though you - will sacrifice a lot of the really great features available in - Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. Red + Hat's newer version (based on 2.17.1 and soon to be merged into the + main distribution) runs on PostgreSQL. At this time we know of no + recent ports of Bugzilla to Oracle but do intend to support it in the + future (possibly the 2.20 time-frame). - A.5.2. I think my database might be corrupted, or contain invalid + A.5.2. I think my database might be corrupted, or contain invalid entries. What do I do? Run the "sanity check" utility (./sanitycheck.cgi in the Bugzilla_home - directory) from your web browser to see! If it finishes without - errors, you're probably OK. If it doesn't come back OK (i.e. any red - letters), there are certain things Bugzilla can recover from and - certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to - manage your database. Sanity Check, although it is a good basic check - on your database integrity, by no means is a substitute for competent - database administration and avoiding deletion of data. It is not - exhaustive, and was created to do a basic check for the most common + directory) from your web browser to see! If it finishes without + errors, you're probably OK. If it doesn't come back OK (i.e. any red + letters), there are certain things Bugzilla can recover from and + certain things it can't. If it can't auto-recover, I hope you're + familiar with mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good basic check + on your database integrity, by no means is a substitute for competent + database administration and avoiding deletion of data. It is not + exhaustive, and was created to do a basic check for the most common problems in Bugzilla databases. A.5.3. I want to manually edit some entries in my database. How? - There is no facility in Bugzilla itself to do this. It's also - generally not a smart thing to do if you don't know exactly what - you're doing. However, if you understand SQL you can use the - mysqladmin utility to manually insert, delete, and modify table - information. Personally, I use "phpMyAdmin". You have to compile a PHP - module with MySQL support to make it work, but it's very clean and - easy to use. + There is no facility in Bugzilla itself to do this. It's also + generally not a smart thing to do if you don't know exactly what + you're doing. However, if you understand SQL you can use the mysql + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL + Control Center. - A.5.4. I try to add myself as a user, but Bugzilla always tells me my - password is wrong. + A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla + still can't connect. - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally - disabled the "crypt()" function. This prevented MySQL from storing - encrypted passwords. Upgrade to the "3.23 stable" version of MySQL and - you should be good to go. + Try running MySQL from its binary: "mysqld --skip-grant-tables". This + will allow you to completely rule out grant tables as the cause of + your frustration. If this Bugzilla is able to connect at this point + then you need to check that you have granted proper permission to the + user password combo defined in localconfig. - A.5.5. I think I've set up MySQL permissions correctly, but Bugzilla - still can't connect. + Warning - Try running MySQL from its binary: "mysqld --skip-grant-tables". This - will allow you to completely rule out grant tables as the cause of - your frustration. However, I do not recommend you run it this way on a - regular basis, unless you really want your web site defaced and your - machine cracked. + Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network as a + troubleshooting step. - A.5.6. How do I synchronize bug information among multiple different + A.5.5. How do I synchronize bug information among multiple different Bugzilla databases? - Well, you can synchronize or you can move bugs. Synchronization will - only work one way -- you can create a read-only copy of the database - at one site, and have it regularly updated at intervals from the main + Well, you can synchronize or you can move bugs. Synchronization will + only work one way -- you can create a read-only copy of the database + at one site, and have it regularly updated at intervals from the main database. - MySQL has some synchronization features builtin to the latest - releases. It would be great if someone looked into the possibilities - there and provided a report to the newsgroup on how to effectively + MySQL has some synchronization features builtin to the latest + releases. It would be great if someone looked into the possibilities + there and provided a report to the newsgroup on how to effectively synchronize two Bugzilla installations. - If you simply need to transfer bugs from one Bugzilla to another, + If you simply need to transfer bugs from one Bugzilla to another, checkout the "move.pl" script in the Bugzilla distribution. 6. Bugzilla and Win32 - A.6.1. What is the easiest way to run Bugzilla on Win32 + A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? - Remove Windows. Install Linux. Install Bugzilla. The boss will never + Remove Windows. Install Linux. Install Bugzilla. The boss will never know the difference. A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? - Not currently. Bundle::Bugzilla enormously simplifies Bugzilla - installation on UNIX systems. If someone can volunteer to create a + Not currently. Bundle::Bugzilla enormously simplifies Bugzilla + installation on UNIX systems. If someone can volunteer to create a suitable PPM bundle for Win32, it would be appreciated. - A.6.3. CGI's are failing with a "something.cgi is not a valid Windows + A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? Depending on what Web server you are using, you will have to configure - the Web server to treat *.cgi files as CGI scripts. In IIS, you do - this by adding *.cgi to the App Mappings with the \perl.exe %s + the Web server to treat *.cgi files as CGI scripts. In IIS, you do + this by adding *.cgi to the App Mappings with the \perl.exe %s %s as the executable. Microsoft has some advice on this matter, as well: - "Set application mappings. In the ISM, map the extension for the - script file(s) to the executable for the script interpreter. For - example, you might map the extension .py to Python.exe, the - executable for the Python script interpreter. Note For the - ActiveState Perl script interpreter, the extension .pl is - associated with PerlIS.dll by default. If you want to change the - association of .pl to perl.exe, you need to change the application + "Set application mappings. In the ISM, map the extension for the + script file(s) to the executable for the script interpreter. For + example, you might map the extension .py to Python.exe, the + executable for the Python script interpreter. Note For the + ActiveState Perl script interpreter, the extension .pl is + associated with PerlIS.dll by default. If you want to change the + association of .pl to perl.exe, you need to change the application mapping. In the mapping, you must add two percent (%) characters to - the end of the pathname for perl.exe, as shown in this example: + the end of the pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s" - A.6.4. I'm having trouble with the perl modules for NT not being able + A.6.4. I'm having trouble with the perl modules for NT not being able to talk to to the database. Your modules may be outdated or inaccurate. Try: @@ -3666,52 +3745,45 @@ Appendix A. The Bugzilla FAQ 4. Type 'ppm' 5. PPM> install DBI DBD-mysql GD - I reckon TimeDate and Data::Dumper come with the activeperl. You can - check the ActiveState site for packages for installation through PPM. + I reckon TimeDate and Data::Dumper come with the activeperl. You can + check the ActiveState site for packages for installation through PPM. http://www.activestate.com/Packages/ 7. Bugzilla Usage A.7.1. How do I change my user name (email address) in Bugzilla? - New in 2.16 - go to the Account section of the Preferences. You will + New in 2.16 - go to the Account section of the Preferences. You will be emailed at both addresses for confirmation. - A.7.2. The query page is very confusing. Isn't there a simpler way to + A.7.2. The query page is very confusing. Isn't there a simpler way to query? - The interface was simplified by a UI designer for 2.16. Further - suggestions for improvement are welcome, but we won't sacrifice power + The interface was simplified by a UI designer for 2.16. Further + suggestions for improvement are welcome, but we won't sacrifice power for simplicity. A.7.3. I'm confused by the behavior of the "accept" button in the Show Bug form. Why doesn't it assign the bug to me when I accept it? - The current behavior is acceptable to bugzilla.mozilla.org and most - users. You have your choice of patches to change this behavior, + The current behavior is acceptable to bugzilla.mozilla.org and most + users. You have your choice of patches to change this behavior, however. Add a "and accept bug" radio button "Accept" button automatically assigns to you - Note that these patches are somewhat dated. You will need to apply + Note that these patches are somewhat dated. You will need to apply them manually. - A.7.4. I can't upload anything into the database via the "Create + A.7.4. I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? - The most likely cause is a very old browser or a browser that is - incompatible with file upload via POST. Download the latest Netscape, + The most likely cause is a very old browser or a browser that is + incompatible with file upload via POST. Download the latest Netscape, Microsoft, or Mozilla browser to handle uploads correctly. - A.7.5. Email submissions to Bugzilla that have attachments end up - asking me to save it as a "cgi" file. - - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime soon, because it would - cripple some other functionality. - - A.7.6. How do I change a keyword in Bugzilla, once some bugs are using + A.7.5. How do I change a keyword in Bugzilla, once some bugs are using it? In the Bugzilla administrator UI, edit the keyword and it will let you @@ -3722,7 +3794,7 @@ Appendix A. The Bugzilla FAQ A.8.1. What kind of style should I use for templatization? - Gerv and Myk suggest a 2-space endent, with embedded code sections on + Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this: [% IF foo %] @@ -3737,32 +3809,32 @@ Appendix A. The Bugzilla FAQ [% END %] - Myk also recommends you turn on PRE_CHOMP in the template - initialization to prevent bloating of HTML with unnecessary + Myk also recommends you turn on PRE_CHOMP in the template + initialization to prevent bloating of HTML with unnecessary whitespace. Please note that many have differing opinions on this subject, and the - existing templates in Bugzilla espouse both this and a 4-space style. + existing templates in Bugzilla espouse both this and a 4-space style. Either is acceptable; the above is preferred. A.8.2. What bugs are in Bugzilla right now? - Try this link to view current bugs or requests for enhancement for + Try this link to view current bugs or requests for enhancement for Bugzilla. - You can view bugs marked for 2.18 release here. This list includes - bugs for the 2.18 release that have already been fixed and checked - into CVS. Please consult the Bugzilla Project Page for details on how - to check current sources out of CVS so you can have these bug fixes + You can view bugs marked for 2.18 release here. This list includes + bugs for the 2.18 release that have already been fixed and checked + into CVS. Please consult the Bugzilla Project Page for details on how + to check current sources out of CVS so you can have these bug fixes early! - A.8.3. How can I change the default priority to a null value? For + A.8.3. How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? This is well-documented here: http://bugzilla.mozilla.org/show_bug.cgi?id=49862. Ultimately, it's as - easy as adding the "---" priority field to your localconfig file in - the appropriate area, re-running checksetup.pl, and then changing the + easy as adding the "---" priority field to your localconfig file in + the appropriate area, re-running checksetup.pl, and then changing the default priority in your browser using "editparams.cgi". A.8.4. What's the best way to submit patches? What guidelines should I @@ -3770,22 +3842,22 @@ Appendix A. The Bugzilla FAQ 1. Enter a bug into bugzilla.mozilla.org for the "Bugzilla" product. 2. Upload your patch as a unified diff (having used "diff -u" against - the current sources checked out of CVS), or new source file by - clicking "Create a new attachment" link on the bug page you've + the current sources checked out of CVS), or new source file by + clicking "Create a new attachment" link on the bug page you've just created, and include any descriptions of database changes you - may make, into the bug ID you submitted in step #1. Be sure and + may make, into the bug ID you submitted in step #1. Be sure and click the "Patch" checkbox to indicate the text you are sending is a patch! - 3. Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for - discussion in the newsgroup (netscape.public.mozilla.webtools). - You'll get a really good, fairly immediate reaction to the - implications of your patch, which will also give us an idea how + 3. Announce your patch and the associated URL + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for + discussion in the newsgroup (netscape.public.mozilla.webtools). + You'll get a really good, fairly immediate reaction to the + implications of your patch, which will also give us an idea how well-received the change would be. - 4. If it passes muster with minimal modification, the person to whom - the bug is assigned in Bugzilla is responsible for seeing the + 4. If it passes muster with minimal modification, the person to whom + the bug is assigned in Bugzilla is responsible for seeing the patch is checked into CVS. - 5. Bask in the glory of the fact that you helped write the most + 5. Bask in the glory of the fact that you helped write the most successful open-source bug-tracking software on the planet :) _________________________________________________________________ @@ -3800,100 +3872,100 @@ Appendix B. The Bugzilla Database B.1. Modifying Your Running System - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ + Bugzilla optimizes database lookups by storing all relatively static + information in the versioncache file, located in the data/ subdirectory under your installation directory. - If you make a change to the structural data in your database (the - versions table for example), or to the "constants" encoded in + 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 + directory (by doing a "rm data/versioncache" ), or your changes won't show up. versioncache gets automatically regenerated whenever it's more than an - hour old, so Bugzilla will eventually notice your changes by itself, - but generally you want it to notice right away, so that you can test + hour old, so Bugzilla will eventually notice your changes by itself, + but generally you want it to notice right away, so that you can test things. _________________________________________________________________ B.2. MySQL Bugzilla Database Introduction - This information comes straight from my life. I was forced to learn - how Bugzilla organizes database because of nitpicky requests from - users for tiny changes in wording, rather than having people - re-educate themselves or figure out how to work our procedures around - the tool. It sucks, but it can and will happen to you, so learn how + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + Thus begins your adventure into the heart of Bugzilla. You've been forced to learn about non-portable enum() fields, varchar columns, and tinyint definitions. The Adventure Awaits You! _________________________________________________________________ B.2.1. Bugzilla Database Basics - If you were like me, at this point you're totally clueless about the - internals of MySQL, and if it weren't for this executive order from + 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 + 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 + 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 + If this works without asking you for a password, shame on you ! + You should have locked your security down like the installation + instructions told you to. You can find details on locking down + your database in the Bugzilla FAQ in this directory (under + "Security"), or more robust security generalities in the MySQL searchable documentation. 2. You should now be at a prompt that looks like this: mysql> - At the prompt, if "bugs" is the name you chose in the localconfig + At the prompt, if "bugs" is the name you chose in the localconfig file for your Bugzilla database, type: mysql use bugs; _________________________________________________________________ @@ -3905,10 +3977,10 @@ B.2.1.1. Bugzilla Database Tables mysql> show tables from bugs; - you'll be able to see the names of all the "spreadsheets" (tables) in + you'll be able to see the names of all the "spreadsheets" (tables) in your database. - From the command issued above, ou should have some output that looks + From the command issued above, ou should have some output that looks like this: +-------------------+ | Tables in bugs | @@ -4123,7 +4195,7 @@ B.2.1.1. Bugzilla Database Tables Appendix C. Useful Patches and Utilities for Bugzilla - Are you looking for a way to put your Bugzilla into overdrive? Catch + Are you looking for a way to put your Bugzilla into overdrive? Catch some of the niftiest tricks here in this section. _________________________________________________________________ @@ -4132,8 +4204,8 @@ C.1. Apache mod_rewrite magic Apache's mod_rewrite module lets you do some truly amazing things with URL rewriting. Here are a couple of examples of what you can do. - 1. Make it so if someone types http://www.foo.com/12345 , Bugzilla - spits back http://www.foo.com/show_bug.cgi?id=12345. Try setting + 1. Make it so if someone types http://www.foo.com/12345 , Bugzilla + spits back http://www.foo.com/show_bug.cgi?id=12345. Try setting up your VirtualHost section for Bugzilla with a rule like this: @@ -4141,129 +4213,145 @@ RewriteEngine On RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] - 2. There are many, many more things you can do with mod_rewrite. - Please refer to the mod_rewrite documentation at + 2. There are many, many more things you can do with mod_rewrite. + Please refer to the mod_rewrite documentation at http://www.apache.org. _________________________________________________________________ C.2. Command-line Bugzilla Queries - There are a suite of Unix utilities for querying Bugzilla from the - command line. They live in the contrib/cmdline directory. However, - they have not yet been updated to work with 2.16 - (post-templatisation.). There are three files - query.conf, buglist + There are a suite of Unix utilities for querying Bugzilla from the + command line. They live in the contrib/cmdline directory. However, + they have not yet been updated to work with 2.16 + (post-templatisation.). There are three files - query.conf, buglist and bugs. - query.conf contains the mapping from options to field names and - comparison types. Quoted option names are "grepped" for, so it should - be easy to edit this file. Comments (#) have no effect; you must make + query.conf contains the mapping from options to field names and + comparison types. Quoted option names are "grepped" for, so it should + be easy to edit this file. Comments (#) have no effect; you must make sure these lines do not contain any quoted "option". - buglist is a shell script which submits a Bugzilla query and writes - the resulting HTML page to stdout. It supports both short options, - (such as "-Afoo" or "-Rbar") and long options (such as - "--assignedto=foo" or "--reporter=bar"). If the first character of an - option is not "-", it is treated as if it were prefixed with + buglist is a shell script which submits a Bugzilla query and writes + the resulting HTML page to stdout. It supports both short options, + (such as "-Afoo" or "-Rbar") and long options (such as + "--assignedto=foo" or "--reporter=bar"). If the first character of an + option is not "-", it is treated as if it were prefixed with "--default=". - The column list is taken from the COLUMNLIST environment variable. - This is equivalent to the "Change Columns" option when you list bugs + The column list is taken from the COLUMNLIST environment variable. + This is equivalent to the "Change Columns" option when you list bugs in buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST in your cookies file to see your current COLUMNLIST setting. bugs is a simple shell script which calls buglist and extracts the bug numbers from the output. Adding the prefix - "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list + "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into a working link if any bugs are found. Counting bugs is easy. Pipe the results through sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}' - Akkana Peck says she has good results piping buglist output through + Akkana Peck says she has good results piping buglist output through w3m -T text/html -dump _________________________________________________________________ Appendix D. Bugzilla Variants and Competitors - I created this section to answer questions about Bugzilla competitors + I created this section to answer questions about Bugzilla competitors and variants, then found a wonderful site which covers an awful lot of - what I wanted to discuss. Rather than quote it in its entirety, I'll + what I wanted to discuss. Rather than quote it in its entirety, I'll simply refer you here: http://linas.org/linux/pm.html _________________________________________________________________ D.1. Red Hat Bugzilla - Red Hat Bugzilla is a fork of Bugzilla 2.8. One of its major benefits - is the ability to work with Oracle, MySQL, and PostGreSQL databases - serving as the back-end, instead of just MySQL. Dave Lawrence of Red - Hat is active in the Bugzilla community, and we hope to see a - reunification of the fork before too long. + Red Hat's old fork of Bugzilla which was based on version 2.8 is now + obsolete. The newest version in use is based on version 2.17.1 and is + in the process of being integrated into the main Bugzilla source tree. + The back-end is modified to work with PostgreSQL instead of MySQL and + they have custom templates to get their desired look and feel, but + other than that it is Bugzilla 2.17.1. Dave Lawrence of Red Hat put + forth a great deal of effort to make sure that the changes he made + could be integrated back into the main tree. Bug 98304 exists to track + this integration. URL: http://bugzilla.redhat.com/bugzilla/ + + This section last updated 24 Dec 2002 _________________________________________________________________ D.2. Loki Bugzilla (Fenris) - Fenris was a fork from Bugzilla made by Loki Games; when Loki went - into receivership, it died. While Loki's other code lives on, its + Fenris was a fork from Bugzilla made by Loki Games; when Loki went + into receivership, it died. While Loki's other code lives on, its custodians recommend Bugzilla for future bug-tracker deployments. + + This section last updated 27 Jul 2002 _________________________________________________________________ D.3. Issuezilla - Issuezilla was another fork from Bugzilla, made by collab.net and - hosted at tigris.org. It is also dead; the primary focus of + Issuezilla was another fork from Bugzilla, made by collab.net and + hosted at tigris.org. It is also dead; the primary focus of bug-tracking at tigris.org is their Java-based bug-tracker, Scarab. + + This section last updated 27 Jul 2002 _________________________________________________________________ D.4. Scarab - Scarab is a new open source bug-tracking system built using Java + Scarab is a new open source bug-tracking system built using Java Serlet technology. It is currently at version 1.0 beta 8. URL: http://scarab.tigris.org + + This section last updated 27 Jul 2002 _________________________________________________________________ D.5. Perforce SCM - Although Perforce isn't really a bug tracker, it can be used as such + Although Perforce isn't really a bug tracker, it can be used as such through the "jobs" functionality. URL: http://www.perforce.com/perforce/technotes/note052.html + + This section last updated 27 Jul 2002 _________________________________________________________________ D.6. SourceForge - SourceForge is a way of coordinating geographically distributed free + SourceForge is a way of coordinating geographically distributed free software and open source projects over the Internet. It has a built-in bug tracker, but it's not highly thought of. URL: http://www.sourceforge.net + This section last updated 27 Jul 2002 + 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 to restrict access to certain files. In Bugzilla, - they are used to keep secret files which would otherwise - compromise your installation - e.g. the localconfig file + Apache web server, and other NCSA-compliant web servers, + observe the convention of using files in directories called + .htaccess to restrict access to certain files. In Bugzilla, + they are used to keep secret files which would otherwise + compromise your installation - e.g. the localconfig file contains the password to your database. curious. A Apache - In this context, Apache is the web server most commonly used - for serving up Bugzilla pages. Contrary to popular belief, the - apache web server has nothing to do with the ancient and noble - Native American tribe, but instead derived its name from the - fact that it was "a patchy" version of the original NCSA + In this context, Apache is the web server most commonly used + for serving up Bugzilla pages. Contrary to popular belief, the + apache web server has nothing to do with the ancient and noble + Native American tribe, but instead derived its name from the + fact that it was "a patchy" version of the original NCSA world-wide-web server. B Bug - A "bug" in Bugzilla refers to an issue entered into the + A "bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Some also refer to a "tickets" or "issues"; in the context of Bugzilla, they are synonymous. @@ -4271,101 +4359,101 @@ B Bug Number Each Bugzilla bug is assigned a number that uniquely identifies that bug. The bug associated with a bug number can be pulled up - via a query, or easily from the very front page by typing the + via a query, or easily from the very front page by typing the number in the "Find" box. Bugzilla - Bugzilla is the world-leading free software bug tracking + Bugzilla is the world-leading free software bug tracking system. Component A Component is a subsection of a Product. It should be a narrow - category, tailored to your organization. All Products must - contain at least one Component (and, as a matter of fact, - creating a Product with no Components will create an error in + category, tailored to your organization. All Products must + contain at least one Component (and, as a matter of fact, + creating a Product with no Components will create an error in Bugzilla). CPAN - CPAN stands for the "Comprehensive Perl Archive Network". CPAN - maintains a large number of extremely useful Perl modules - + CPAN stands for the "Comprehensive Perl Archive Network". CPAN + maintains a large number of extremely useful Perl modules - encapsulated chunks of code for performing a particular task. D daemon A daemon is a computer program which runs in the background. In - general, most daemons are started at boot time via System V - init scripts, or through RC scripts on BSD-based systems. - mysqld, the MySQL server, and apache, a web server, are + general, most daemons are started at boot time via System V + init scripts, or through RC scripts on BSD-based systems. + mysqld, the MySQL server, and apache, a web server, are generally run as daemons. Groups - The word "Groups" has a very special meaning to Bugzilla. - Bugzilla's main security mechanism comes by placing users in - groups, and assigning those groups certain privileges to view + The word "Groups" has a very special meaning to Bugzilla. + Bugzilla's main security mechanism comes by placing users in + groups, and assigning those groups certain privileges to view bugs in particular Products in the Bugzilla database. M mysqld - mysqld is the name of the daemon for the MySQL database. In - general, it is invoked automatically through the use of the - System V init scripts on GNU/Linux and AT&T System V-based - systems, such as Solaris and HP/UX, or through the RC scripts + mysqld is the name of the daemon for the MySQL database. In + general, it is invoked automatically through the use of the + System V init scripts on GNU/Linux and AT&T System V-based + systems, such as Solaris and HP/UX, or through the RC scripts on BSD-based systems. P Product - A Product is a broad category of types of bugs, normally - representing a single piece of software or entity. In general, + A Product is a broad category of types of bugs, normally + representing a single piece of software or entity. In general, there are several Components to a Product. A Product may define - a group (used for security) for all bugs entered into its + a group (used for security) for all bugs entered into its Components. Perl - First written by Larry Wall, Perl is a remarkable program - language. It has the benefits of the flexibility of an + First written by Larry Wall, Perl is a remarkable program + language. It has the benefits of the flexibility of an interpreted scripting language (such as shell script), combined - with the speed and power of a compiled language, such as C. + with the speed and power of a compiled language, such as C. Bugzilla is maintained in Perl. Q 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", "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. S SGML SGML stands for "Standard Generalized Markup Language". Created - in the 1980's to provide an extensible means to maintain - documentation based upon content instead of presentation, SGML - has withstood the test of time as a robust, powerful language. - XML is the "baby brother" of SGML; any valid XML document it, - by definition, a valid SGML document. The document you are - reading is written and maintained in SGML, and is also valid + in the 1980's to provide an extensible means to maintain + documentation based upon content instead of presentation, SGML + has withstood the test of time as a robust, powerful language. + XML is the "baby brother" of SGML; any valid XML document it, + by definition, a valid SGML document. The document you are + reading is written and maintained in SGML, and is also valid XML if you modify the Document Type Definition. T Target Milestone Target Milestones are Product goals. They are configurable on a - per-Product basis. Most software development houses have a - concept of "milestones" where the people funding a project - expect certain functionality on certain dates. Bugzilla - facilitates meeting these milestones by giving you the ability - to declare by which milestone a bug will be fixed, or an + per-Product basis. Most software development houses have a + concept of "milestones" where the people funding a project + expect certain functionality on certain dates. Bugzilla + facilitates meeting these milestones by giving you the ability + to declare by which milestone a bug will be fixed, or an enhancement will be implemented. Z Zarro Boogs Found - This is the cryptic response sent by Bugzilla when a query - returned no results. It is just a goofy way of saying "Zero + This is the cryptic response sent by Bugzilla when a query + returned no results. It is just a goofy way of saying "Zero Bugs Found". -- cgit v1.2.3-24-g4f1b