The Bugzilla Guide - 2.22.5 Release The Bugzilla Team 2008-08-12 This is the documentation for Bugzilla, a bug-tracking system from mozilla.org. Bugzilla is an enterprise-class piece of software that tracks millions of bugs and issues for hundreds of organizations around the world. The most current version of this document can always be found on the Bugzilla Documentation Page. _________________________________________________________________ Table of Contents 1. About This Guide 1.1. Copyright Information 1.2. Disclaimer 1.3. New Versions 1.4. Credits 1.5. Document Conventions 2. Installing Bugzilla 2.1. Installation 2.2. Configuration 2.3. Optional Additional Configuration 2.4. Multiple Bugzilla databases with a single installation 2.5. OS-Specific Installation Notes 2.6. UNIX (non-root) Installation Notes 3. Administering Bugzilla 3.1. Bugzilla Configuration 3.2. User Administration 3.3. Classifications 3.4. Products 3.5. Components 3.6. Versions 3.7. Milestones 3.8. Flags 3.9. Keywords 3.10. Legal Values 3.11. Voting 3.12. Quips 3.13. Groups and Group Security 3.14. Checking and Maintaining Database Integrity 3.15. Upgrading to New Releases 4. Bugzilla Security 4.1. Operating System 4.2. MySQL 4.3. Web server 4.4. Bugzilla 5. Using Bugzilla 5.1. Introduction 5.2. Create a Bugzilla Account 5.3. Anatomy of a Bug 5.4. Life Cycle of a Bug 5.5. Searching for Bugs 5.6. Filing Bugs 5.7. Attachments 5.8. Hints and Tips 5.9. Time Tracking Information 5.10. User Preferences 5.11. Reports and Charts 5.12. Flags 5.13. Whining 6. Customizing Bugzilla 6.1. Template Customization 6.2. Template Hooks 6.3. Customizing Who Can Change What 6.4. Modifying Your Running System 6.5. Integrating Bugzilla with Third-Party Tools A. The Bugzilla FAQ B. Troubleshooting B.1. General Advice B.2. The Apache webserver is not serving Bugzilla pages B.3. I installed a Perl module, but checksetup.pl claims it's not installed! B.4. DBD::Sponge::db prepare failed B.5. cannot chdir(/var/spool/mqueue) B.6. Your vendor has not defined Fcntl macro O_NOINHERIT B.7. Everybody is constantly being forced to relogin B.8. Some users are constantly being forced to relogin B.9. index.cgi doesn't show up unless specified in the URL B.10. checksetup.pl reports "Client does not support authentication protocol requested by server..." C. Contrib C.1. Command-line Search Interface C.2. Command-line 'Send Unsent Bug-mail' tool D. Manual Installation of Perl Modules D.1. Instructions D.2. Download Locations D.3. Optional Modules E. GNU Free Documentation License 0. Preamble 1. Applicability and Definition 2. Verbatim Copying 3. Copying in Quantity 4. Modifications 5. Combining Documents 6. Collections of Documents 7. Aggregation with Independent Works 8. Translation 9. Termination 10. Future Revisions of this License How to use this License for your documents Glossary List of Figures 5-1. Lifecycle of a Bugzilla Bug List of Examples 4-1. Assigning the MySQL "root" User a Password 4-2. Disabling the MySQL "anonymous" User 4-3. Disabling Networking in MySQL B-1. Examples of urlbase/cookiepath pairs for sharing login cookies B-2. Examples of urlbase/cookiepath pairs to restrict the login cookie _________________________________________________________________ Chapter 1. About This Guide 1.1. Copyright Information This document is copyright (c) 2000-2008 by the various Bugzilla contributors who wrote it. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in Appendix E. If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, please contact the Bugzilla Team. _________________________________________________________________ 1.2. Disclaimer No liability for the contents of this document can be accepted. Follow the instructions herein at your own risk. This document may contain errors and inaccuracies that may damage your system, cause your partner to leave you, your boss to fire you, your cats to pee on your furniture and clothing, and global thermonuclear war. Proceed with caution. Naming of particular products or brands should not be seen as endorsements, with the exception of the term "GNU/Linux". We wholeheartedly endorse the use of GNU/Linux; it is an extremely versatile, stable, and robust operating system that offers an ideal operating environment for Bugzilla. Although the Bugzilla development team has taken great care to ensure that all exploitable bugs have been fixed, security holes surely exist in any piece of code. Great care should be taken both in the installation and usage of this software. The Bugzilla development team members assume no liability for your use of Bugzilla. You have the source code, and are responsible for auditing it yourself to ensure your security needs are met. _________________________________________________________________ 1.3. New Versions This is the 2.22.5 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. The latest version of this guide can always be found at http://www.bugzilla.org, or checked out via CVS by following the Mozilla CVS instructions and check out the mozilla/webtools/bugzilla/docs/ subtree. However, you should read the version which came with the Bugzilla release you are using. The Bugzilla Guide, or a section of it, is also available in the following languages: French, German, Japanese. Note that these may be outdated or not up to date. In addition, there are Bugzilla template localization projects in the following languages. They may have translated documentation available: Arabic, Belarusian, Bulgarian, Brazilian Portuguese, Chinese, French, German, Italian, Japanese, Korean, Russian and Spanish. If you would like to volunteer to translate the Guide into additional languages, please contact Dave Miller. _________________________________________________________________ 1.4. Credits The people listed below have made enormous contributions to the creation of this Guide, through their writing, dedicated hacking efforts, numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: Matthew P. Barnson for the Herculean task of pulling together the Bugzilla Guide and shepherding it to 2.14. Terry Weissman for initially writing Bugzilla and creating the README upon which the UNIX installation documentation is largely based. Tara Hernandez for keeping Bugzilla development going strong after Terry left mozilla.org and for running landfill. Dave Lawrence for providing insight into the key differences between Red Hat's customized Bugzilla. Dawn Endico for being a hacker extraordinaire and putting up with Matthew's incessant questions and arguments on irc.mozilla.org in #mozwebtools Jacob Steenhagen for taking over documentation during the 2.17 development period. Dave Miller for taking over as project lead when Tara stepped down and continually pushing for the documentation to be the best it can be. Thanks also go to the following people for significant contributions to this documentation: Kevin Brannen, Vlad Dascalu, Ben FrantzDale, Eric Hanson, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Ron Teitelbaum, Shane Travis, Martin Wulffeld. Also, thanks are due to the members of the mozilla.support.bugzilla newsgroup (and its predecessor, netscape.public.mozilla.webtools). Without your discussions, insight, suggestions, and patches, this could never have happened. _________________________________________________________________ 1.5. Document Conventions This document uses the following conventions: Descriptions Appearance Caution Caution Don't run with scissors! Hint or Tip Tip For best results... Note Note Dear John... Warning Warning Read this or the cat gets it. File or directory name filename Command to be typed command Application name application Normal user's prompt under bash shell bash$ Root user's prompt under bash shell bash# Normal user's prompt under tcsh shell tcsh$ Environment variables VARIABLE Term found in the glossary Bugzilla Code example Beginning and end of paragraph This documentation is maintained in DocBook 4.1.2 XML format. Changes are best submitted as plain text or XML diffs, attached to a bug filed in the Bugzilla Documentation component. _________________________________________________________________ Chapter 2. Installing Bugzilla 2.1. Installation Note If you just want to use Bugzilla, you do not need to install it. None of this chapter is relevant to you. Ask your Bugzilla administrator for the URL to access it over the web. The Bugzilla server software is usually installed on Linux or Solaris. If you are installing on another OS, check Section 2.5 before you start your installation to see if there are any special instructions. As an alternative to following these instructions, you may wish to try Arne Schirmacher's unofficial and unsupported Bugzilla Installer, which installs Bugzilla and all its prerequisites on Linux or Solaris systems. This guide assumes that you have administrative access to the Bugzilla machine. It not possible to install and run Bugzilla itself without administrative access except in the very unlikely event that every single prerequisite is already installed. Warning The installation process may make your machine insecure for short periods of time. Make sure there is a firewall between you and the Internet. You are strongly recommended to make a backup of your system before installing Bugzilla (and at regular intervals thereafter :-). In outline, the installation proceeds as follows: 1. Install Perl (5.6.1 or above for non-Windows platforms; 5.8.1 for Windows) 2. Install a Database Engine 3. Install a Webserver 4. Install Bugzilla 5. Install Perl modules 6. Install a Mail Transfer Agent (Sendmail 8.7 or above, or an MTA that is Sendmail-compatible with at least this version) 7. Configure all of the above. _________________________________________________________________ 2.1.1. Perl Installed Version Test: perl -v Any machine that doesn't have Perl on it is a sad machine indeed. If you don't have it and your OS doesn't provide official packages, visit http://www.perl.com. Although Bugzilla runs with Perl 5.6.1, it's a good idea to be using the latest stable version. _________________________________________________________________ 2.1.2. Database Engine From Bugzilla 2.20, support is included for using both the MySQL and PostgreSQL database servers. You only require one of these systems to make use of Bugzilla. _________________________________________________________________ 2.1.2.1. MySQL Installed Version Test: mysql -V If you don't have it and your OS doesn't provide official packages, visit http://www.mysql.com. You need MySQL version 4.0.14 or higher. Note Many of the binary versions of MySQL store their data files in /var. On some Unix systems, this is part of a smaller root partition, and may not have room for your bug database. To change the data directory, you have to build MySQL from source yourself, and set it as an option to configure. If you install from something other than a packaging/installation system, such as .rpm (Redhat Package), .deb (Debian Package), .exe (Windows Executable), or .msi (Microsoft Installer), make sure the MySQL server is started when the machine boots. _________________________________________________________________ 2.1.2.2. PostgreSQL Installed Version Test: psql -V If you don't have it and your OS doesn't provide official packages, visit http://www.postgresql.org/. You need PostgreSQL version 7.3.x or higher. If you install from something other than a packaging/installation system, such as .rpm (Redhat Package), .deb (Debian Package), .exe (Windows Executable), or .msi (Microsoft Installer), make sure the PostgreSQL server is started when the machine boots. _________________________________________________________________ 2.1.3. Web Server Installed Version Test: view the default welcome page at http:/// You have freedom of choice here, pretty much any web server that is capable of running CGI scripts will work. However, we strongly recommend using the Apache web server (either 1.3.x or 2.x), and the installation instructions usually assume you are using it. If you have got Bugzilla working using another webserver, please share your experiences with us by filing a bug in Bugzilla Documentation. If you don't have Apache and your OS doesn't provide official packages, visit http://httpd.apache.org/. _________________________________________________________________ 2.1.4. Bugzilla Download a Bugzilla tarball (or check it out from CVS) and place it in a suitable directory, accessible by the default web server user (probably "apache" or "www"). Good locations are either directly in the main web space for your web server or perhaps in /usr/local with a symbolic link from the web space. Caution The default Bugzilla distribution is NOT designed to be placed in a cgi-bin directory. This includes any directory which is configured using the ScriptAlias directive of Apache. 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 checksetup.pl script, which locks down your installation. _________________________________________________________________ 2.1.5. Perl Modules Bugzilla's installation process is based on a script called checksetup.pl. The first thing it checks is whether you have appropriate versions of all the required Perl modules. The aim of this section is to pass this check. When it passes, proceed to Section 2.2. At this point, you need to su to root. You should remain as root until the end of the install. To check you have the required modules, run: bash# ./checksetup.pl --check-modules checksetup.pl will print out a list of the required and optional Perl modules, together with the versions (if any) installed on your machine. The list of required modules is reasonably long; however, you may already have several of them installed. There is a meta-module called Bundle::Bugzilla, which installs all the other modules with a single command. You should use this if you are running Perl 5.6.1 or above. The preferred way of installing Perl modules is via CPAN on Unix, or PPM on Windows (see Section 2.5.1.2). These instructions assume you are using CPAN; if for some reason you need to install the Perl modules manually, see Appendix D. bash# perl -MCPAN -e 'install ""' If you using Bundle::Bugzilla, invoke the magic CPAN command on it. Otherwise, you need to work down the list of modules that checksetup.pl says are required, in the order given, invoking the command on each. Tip Many people complain that Perl modules will not install for them. Most times, the error messages complain that they are missing a file in "@INC". Virtually every time, this error is due to permissions being set too restrictively for you to compile Perl modules or not having the necessary Perl development libraries installed on your system. Consult your local UNIX systems administrator for help solving these permissions issues; if you are the local UNIX sysadmin, please consult the newsgroup/mailing list for further assistance or hire someone to help you out. Note If you are using a package-based system, and attempting to install the Perl modules from CPAN, you may need to install the "development" packages for MySQL and GD before attempting to install the related Perl modules. The names of these packages will vary depending on the specific distribution you are using, but are often called -devel. Here is a complete list of modules and their minimum versions. Some modules have special installation notes, which follow. Required Perl modules: 1. AppConfig (1.52) 2. CGI (2.93) 3. Data::Dumper (any) 4. Date::Format (2.21) 5. DBI (1.38) 6. DBD::mysql (2.9003) if using MySQL 7. DBD::Pg (1.31) if using PostgreSQL 8. File::Spec (0.84) 9. File::Temp (any) 10. Template (2.10) 11. Text::Wrap (2001.0131) 12. Mail::Mailer (1.67) 13. MIME::Base64 (3.01) 14. MIME::Parser (5.406) 15. Storable (any) Optional Perl modules: 1. GD (1.20) for bug charting 2. Chart::Base (1.0) for bug charting 3. GD::Graph (any) for bug charting 4. GD::Text::Align (any) for bug charting 5. XML::Twig (any) for the XML interface 6. PatchReader (0.9.4) for pretty HTML view of patches 7. Image::Magick (any) for converting BMP image attachments to PNG _________________________________________________________________ 2.1.5.1. DBD::mysql The installation 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 answer YES to this question. The default is NO. A host of 'localhost' should be fine. A testing user of 'test', with a null password, should have sufficient access to run tests on the 'test' database which MySQL creates upon installation. _________________________________________________________________ 2.1.5.2. Template Toolkit (2.10) 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. _________________________________________________________________ 2.1.5.3. GD (1.20) The GD module is only required if you want graphical reports. Note The Perl GD module requires some other libraries that may or may not be installed on your system, including libpng and libgd. The full requirements are listed in the Perl GD module README. If compiling GD fails, it's probably because you're missing a required library. Tip The version of the GD module you need is very closely tied to the libgd version installed on your system. If you have a version 1.x of libgd the 2.x versions of the GD module won't work for you. _________________________________________________________________ 2.1.5.4. Chart::Base (1.0) The Chart::Base module is only required if you want graphical reports. Note that earlier versions that 0.99c used GIFs, which are no longer supported by the latest versions of GD. _________________________________________________________________ 2.1.5.5. GD::Graph (any) The GD::Graph module is only required if you want graphical reports. _________________________________________________________________ 2.1.5.6. GD::Text::Align (any) The GD::Text::Align module is only required if you want graphical reports. _________________________________________________________________ 2.1.5.7. XML::Twig (any) The XML::Twig module is only required if you want to import XML bugs using the importxml.pl script. This is required to use Bugzilla's "move bugs" feature; you may also want to use it for migrating from another bug database. _________________________________________________________________ 2.1.5.8. PatchReader (0.9.4) The PatchReader module is only required if you want to use Patch Viewer, a Bugzilla feature to show code patches in your web browser in a more readable form. _________________________________________________________________ 2.1.6. Mail Transfer Agent (MTA) Bugzilla is dependent on the availability of an e-mail system for its user authentication and for other tasks. Note This is not entirely true. It is possible to completely disable email sending, or to have Bugzilla store email messages in a file instead of sending them. However, this is mainly intended for testing, as disabling or diverting email on a production machine would mean that users could miss important events (such as bug changes or the creation of new accounts). For more information, see the "mail_delivery_method" parameter in Section 3.1. On Linux, any Sendmail-compatible MTA (Mail Transfer Agent) will suffice. Sendmail, Postfix, qmail and Exim are examples of common MTAs. Sendmail is the original Unix MTA, but the others are easier to configure, and therefore many people replace Sendmail with Postfix or Exim. They are drop-in replacements, so Bugzilla will not distinguish between them. If you are using Sendmail, version 8.7 or higher is required. If you are using a Sendmail-compatible MTA, it must be congruent with at least version 8.7 of Sendmail. Consult the manual for the specific MTA you choose for detailed installation instructions. Each of these programs will have their own configuration files where you must configure certain parameters to ensure that the mail is delivered properly. They are implemented as services, and you should ensure that the MTA is in the auto-start list of services for the machine. If a simple mail sent with the command-line 'mail' program succeeds, then Bugzilla should also be fine. _________________________________________________________________ 2.2. Configuration Warning Poorly-configured MySQL and Bugzilla installations have given attackers full access to systems in the past. Please take the security parts of these guidelines seriously, even for Bugzilla machines hidden away behind your firewall. Be certain to read Chapter 4 for some important security tips. _________________________________________________________________ 2.2.1. localconfig You should now run checksetup.pl again, this time without the --check-modules switch. bash# ./checksetup.pl This time, checksetup.pl should tell you that all the correct modules are installed and will display a message about, and write out a file called, localconfig. This file contains the default settings for a number of Bugzilla parameters. Load this file in your editor. The only value you need to change is $db_pass, the password for the user you will create for your database. Pick a strong password (for simplicity, it should not contain single quote characters) and put it here. You may need to change the value of webservergroup if your web server does not run in the "apache" group. On Debian, for example, Apache runs in the "www-data" group. If you are going to run Bugzilla on a machine where you do not have root access (such as on a shared web hosting account), you will need to leave webservergroup empty, ignoring the warnings that checksetup.pl will subsequently display every time it is run. Caution If you are using suexec, you should use your own primary group for webservergroup rather than leaving it empty, and see the additional directions in the suexec section Section 2.6.6.1. The other options in the localconfig file are documented by their accompanying comments. If you have a slightly non-standard MySQL setup, you may wish to change one or more of the other "$db_*" parameters. You may also wish to change the names of the priorities, severities, operating systems and platforms for your installation. However, you can always change these after installation has finished; if you then re-run checksetup.pl, the changes will get picked up. _________________________________________________________________ 2.2.2. Database Server This section deals with configuring your database server for use with Bugzilla. Currently, MySQL (Section 2.2.2.2) and PostgreSQL (Section 2.2.2.3) are available. _________________________________________________________________ 2.2.2.1. Bugzilla Database Schema The Bugzilla database schema is available at Ravenbrook. This very valuable tool can generate a written description of the Bugzilla database schema for any version of Bugzilla. It can also generate a diff between two versions to help someone see what has changed. _________________________________________________________________ 2.2.2.2. MySQL Caution MySQL's default configuration is very insecure. Section 4.2 has some good information for improving your installation's security. _________________________________________________________________ 2.2.2.2.1. Allow large attachments By default, MySQL will only accept packets up to 64Kb in size. If you want to have attachments larger than this, you will need to modify your /etc/my.cnf as below. [mysqld] # Allow packets up to 1M max_allowed_packet=1M There is also a parameter in Bugzilla called 'maxattachmentsize' (default = 1000 Kb) that controls the maximum allowable attachment size. Attachments larger than either the 'max_allowed_packet' or 'maxattachmentsize' value will not be accepted by Bugzilla. Note This does not affect Big Files, attachments that are stored directly on disk instead of in the database. Their maximum size is controlled using the 'maxlocalattachment' parameter. _________________________________________________________________ 2.2.2.2.2. Allow small words in full-text indexes By default, words must be at least four characters in length in order to be indexed by MySQL's full-text indexes. This causes a lot of Bugzilla specific words to be missed, including "cc", "ftp" and "uri". MySQL can be configured to index those words by setting the ft_min_word_len param to the minimum size of the words to index. This can be done by modifying the /etc/my.cnf according to the example below: [mysqld] # Allow small words in full-text indexes ft_min_word_len=2 Rebuilding the indexes can be done based on documentation found at http://www.mysql.com/doc/en/Fulltext_Fine-tuning.html. _________________________________________________________________ 2.2.2.2.3. Add a user to MySQL You need to add a new MySQL user for Bugzilla to use. (It's not safe to have Bugzilla use the MySQL root account.) The following instructions assume the defaults in localconfig; if you changed those, you need to modify the SQL command appropriately. You will need the $db_pass password you set in localconfig in Section 2.2.1. We use an SQL GRANT command to create a "bugs" user. 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. Run the mysql command-line client and enter: mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES, CREATE TEMPORARY TABLES, DROP, REFERENCES ON bugs.* TO bugs@localhost IDENTIFIED BY '$db_pass'; mysql> FLUSH PRIVILEGES; _________________________________________________________________ 2.2.2.2.4. Permit attachments table to grow beyond 4GB By default, MySQL will limit the size of a table to 4GB. This limit is present even if the underlying filesystem has no such limit. To set a higher limit, follow these instructions. After you have completed the rest of the installation (or at least the database setup parts), you should run the MySQL command-line client and enter the following, replacing $bugs_db with your Bugzilla database name (bugs by default): mysql> use $bugs_db mysql> ALTER TABLE attachments AVG_ROW_LENGTH=1000000, MAX_ROWS=20000; The above command will change the limit to 20GB. Mysql will have to make a temporary copy of your entire table to do this. Ideally, you should do this when your attachments table is still small. Note This does not affect Big Files, attachments that are stored directly on disk instead of in the database. _________________________________________________________________ 2.2.2.3. PostgreSQL Note If you are using PostgreSQL 8.0.1 or higher, then you will require to use a version of DBD::Pg which is equal to or greater than version 1.41 _________________________________________________________________ 2.2.2.3.1. Add a User to PostgreSQL You need to add a new user to PostgreSQL for the Bugzilla application to use when accessing the database. The following instructions assume the defaults in localconfig; if you changed those, you need to modify the commands appropriately. You will need the $db_pass password you set in localconfig in Section 2.2.1. On most systems, to create the user in PostgreSQL, you will need to login as the root user, and then bash# su - postgres As the postgres user, you then need to create a new user: bash$ createuser -U postgres -dAP bugs When asked for a password, provide the password which will be set as $db_pass in localconfig. The created user will have the ability to create databases and will not be able to create new users. _________________________________________________________________ 2.2.2.3.2. Configure PostgreSQL Now, you will need to edit pg_hba.conf which is usually located in /var/lib/pgsql/data/. In this file, you will need to add a new line to it as follows: host all bugs 127.0.0.1 255.255.255.255 md5 This means that for TCP/IP (host) connections, allow connections from '127.0.0.1' to 'all' databases on this server from the 'bugs' user, and use password authentication (md5) for that user. If you are using versions of PostgreSQL before version 8, you may also need to edit postgresql.conf , also usually found in the /var/lib/pgsql/data/ folder. You will need to make a single line change, changing # tcpip_socket = false to tcpip_socket = true Now, you will need to restart PostgreSQL, but you will need to fully stop and start the server rather than just restarting due to the possibility of a change to postgresql.conf. After the server has restarted, you will need to edit localconfig, finding the $db_driver variable and setting it to Pg and changing the password in $db_pass to the one you picked previously, while setting up the account. _________________________________________________________________ 2.2.3. checksetup.pl Next, rerun checksetup.pl. It reconfirms that all the modules are present, and notices the altered localconfig file, which it assumes you have edited to your satisfaction. It compiles the UI templates, connects to the database using the 'bugs' user you created and the password you defined, and creates the 'bugs' database and the tables therein. After that, it asks for details of an administrator account. Bugzilla can have multiple administrators - you can create more later - but it needs one to start off with. Enter the email address of an administrator, his or her full name, and a suitable Bugzilla password. checksetup.pl will then finish. You may rerun checksetup.pl at any time if you wish. _________________________________________________________________ 2.2.4. Web server Configure your web server according to the instructions in the appropriate section. (If it makes a difference in your choice, the Bugzilla Team recommends Apache.) To check whether your web server is correctly configured, try to access testagent.cgi from your web server. If "OK" is displayed, then your configuration is successful. Regardless of which web server you are using, however, ensure that sensitive information is not remotely available by properly applying the access controls in Section 4.3.1. You can run testserver.pl to check if your web server serves Bugzilla files as expected. _________________________________________________________________ 2.2.4.1. Apache httpd To configure your Apache web server to work with Bugzilla, do the following: 1. Load httpd.conf in your editor. In Fedora and Red Hat Linux, this file is found in /etc/httpd/conf. 2. Apache uses directives to permit fine-grained permission setting. Add the following lines to a directive that applies to the location of your Bugzilla installation. (If such a section does not exist, you'll want to add one.) In this example, Bugzilla has been installed at /var/www/html/bugzilla. AddHandler cgi-script .cgi Options +Indexes +ExecCGI DirectoryIndex index.cgi AllowOverride Limit These instructions: allow apache to run .cgi files found within the bugzilla directory; instructs the server to look for a file called index.cgi if someone only types the directory name into the browser; and allows Bugzilla's .htaccess files to override global permissions. Note It is possible to make these changes globally, or to the directive controlling Bugzilla's parent directory (e.g. ). Such changes would also apply to the Bugzilla directory... but they would also apply to many other places where they may or may not be appropriate. In most cases, including this one, it is better to be as restrictive as possible when granting extra access. 3. checksetup.pl can set tighter permissions on Bugzilla's files and directories if it knows what group the webserver runs as. Find the Group line in httpd.conf, place the value found there in the $webservergroup variable in localconfig, then rerun checksetup.pl. 4. Optional: If Bugzilla does not actually reside in the webspace directory, but instead has been symbolically linked there, you will need to add the following to the Options line of the Bugzilla directive (the same one as in the step above): +FollowSymLinks Without this directive, Apache will not follow symbolic links to places outside its own directory structure, and you will be unable to run Bugzilla. _________________________________________________________________ 2.2.4.2. Microsoft Internet Information Services If you are running Bugzilla on Windows and choose to use Microsoft's Internet Information Services or Personal Web Server you will need to perform a number of other configuration steps as explained below. You may also want to refer to the following Microsoft Knowledge Base articles: 245225 "HOW TO: Configure and Test a PERL Script with IIS 4.0, 5.0, and 5.1" (for Internet Information Services) and 231998 "HOW TO: FP2000: How to Use Perl with Microsoft Personal Web Server on Windows 95/98" (for Personal Web Server). You will need to create a virtual directory for the Bugzilla install. Put the Bugzilla files in a directory that is named something other than what you want your end-users accessing. That is, if you want your users to access your Bugzilla installation through "http:///Bugzilla", then do not put your Bugzilla files in a directory named "Bugzilla". Instead, place them in a different location, and then use the IIS Administration tool to create a Virtual Directory named "Bugzilla" that acts as an alias for the actual location of the files. When creating that virtual directory, make sure you add the "Execute (such as ISAPI applications or CGI)" access permission. You will also need to tell IIS how to handle Bugzilla's .cgi files. Using the IIS Administration tool again, open up the properties for the new virtual directory and select the Configuration option to access the Script Mappings. Create an entry mapping .cgi to: \perl.exe -x -wT "%s" %s For example: c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s Note The ActiveState install may have already created an entry for .pl files that is limited to "GET,HEAD,POST". If so, this mapping should be removed as Bugzilla's .pl files are not designed to be run via a webserver. IIS will also need to know that the index.cgi should be treated as a default document. On the Documents tab page of the virtual directory properties, you need to add index.cgi as a default document type. If you wish, you may remove the other default document types for this particular virtual directory, since Bugzilla doesn't use any of them. Also, and this can't be stressed enough, make sure that files such as localconfig and your data directory are secured as described in Section 4.3.1. _________________________________________________________________ 2.2.5. Bugzilla Your Bugzilla should now be working. Access http:/// - you should see the Bugzilla front page. If not, consult the Troubleshooting section, Appendix B. Note The URL above may be incorrect if you installed Bugzilla into a subdirectory or used a symbolic link from your web site root to the Bugzilla directory. Log in with the administrator account you defined in the last checksetup.pl run. You should go through the parameters on the Edit Parameters page (see link in the footer) and see if there are any you wish to change. They key parameters are documented in Section 3.1; you should certainly alter maintainer and urlbase; you may also want to alter cookiepath or requirelogin. This would also be a good time to revisit the localconfig file and make sure that the names of the priorities, severities, platforms and operating systems are those you wish to use when you start creating bugs. Remember to rerun checksetup.pl if you change it. Bugzilla has several optional features which require extra configuration. You can read about those in Section 2.3. _________________________________________________________________ 2.3. Optional Additional Configuration Bugzilla has a number of optional features. This section describes how to configure or enable them. _________________________________________________________________ 2.3.1. Bug Graphs If you have installed the necessary Perl modules you can start collecting statistics for the nifty Bugzilla graphs. bash# crontab -e This should bring up the crontab file in your editor. Add a cron entry like this to run collectstats.pl daily at 5 after midnight: 5 0 * * * cd ; ./collectstats.pl After two days have passed you'll be able to view bug graphs from the Reports page. Note Windows does not have 'cron', but it does have the Task Scheduler, which performs the same duties. There are also third-party tools that can be used to implement cron, such as nncron. _________________________________________________________________ 2.3.2. Dependency Charts As well as the text-based dependency trees, Bugzilla also supports a graphical view of dependency relationships, 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 generate the graphs locally 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. The easiest way to get this working is to 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. This is the default for the webdotbase param, but it's often overloaded and slow. Note that AT&T's server won't work if Bugzilla is only accessible using HARTS. Editor's note: What the heck is HARTS? Google doesn't know... _________________________________________________________________ 2.3.3. The Whining Cron What good are bugs if they're not annoying? To help make them more so you can set up Bugzilla's automatic whining system to complain at engineers which leave their bugs in the NEW or REOPENED state without triaging them. This can be done by adding the following command as a daily crontab entry, in the same manner as explained above for bug graphs. This example runs it at 12.55am. 55 0 * * * cd ; ./whineatnews.pl Note Windows does not have 'cron', but it does have the Task Scheduler, which performs the same duties. There are also third-party tools that can be used to implement cron, such as nncron. _________________________________________________________________ 2.3.4. Whining As of Bugzilla 2.20, users can configure Bugzilla to regularly annoy them at regular intervals, by having Bugzilla execute saved searches at certain times and emailing the results to the user. This is known as "Whining". The process of configuring Whining is described in Section 5.13, but for it to work a Perl script must be executed at regular intervals. This can be done by adding the following command as a daily crontab entry, in the same manner as explained above for bug graphs. This example runs it every 15 minutes. */15 * * * * cd ; ./whine.pl Note Whines can be executed as often as every 15 minutes, so if you specify longer intervals between executions of whine.pl, some users may not be whined at as often as they would expect. Depending on the person, this can either be a very Good Thing or a very Bad Thing. Note Windows does not have 'cron', but it does have the Task Scheduler, which performs the same duties. There are also third-party tools that can be used to implement cron, such as nncron. _________________________________________________________________ 2.3.5. Patch Viewer Patch Viewer is the engine behind Bugzilla's graphical display of code patches. You can integrate this with copies of the cvs, lxr and bonsai tools if you have them, by giving the locations of your installation of these tools in editparams.cgi. Patch Viewer also optionally will use the cvs, diff and interdiff command-line utilities if they exist on the system. Interdiff can be obtained from http://cyberelk.net/tim/patchutils/. If these programs are not in the system path, you can configure their locations in localconfig. _________________________________________________________________ 2.3.6. LDAP Authentication LDAP authentication is a module for Bugzilla's plugin authentication architecture. The existing authentication scheme for Bugzilla uses email addresses as the primary user ID, and a password to authenticate that user. All 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. 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 tasks are still handled by email address, not LDAP username. You still assign bugs by email address, query on users by email address, etc. Caution Because the Bugzilla account is not created until the first time a user logs in, a user who has not yet logged is unknown to Bugzilla. This means they cannot be used as an assignee or QA contact (default or otherwise), added to any cc list, or any other such operation. One possible workaround is the bugzilla_ldapsync.rb script in the contrib directory. Another possible solution is fixing bug 201069. Parameters required to use LDAP Authentication: user_verify_class This parameter should be set to "LDAP" only if you will be using an LDAP directory for authentication. If you set this param to "LDAP" but fail to set up the other parameters listed below you will not be able to log back in to Bugzilla one you log out. If this happens to you, you will need to manually edit data/params and set user_verify_class to "DB". LDAPserver This parameter should be set to the name (and optionally the port) of your LDAP server. If no port is specified, it assumes the default LDAP port of 389. Ex. "ldap.company.com" or "ldap.company.com:3268" LDAPbinddn [Optional] Some LDAP servers will not allow an anonymous bind to search the directory. If this is the case with your configuration you should set the LDAPbinddn parameter to the user account Bugzilla should use instead of the anonymous bind. Ex. "cn=default,cn=user:password" LDAPBaseDN The LDAPBaseDN parameter should be set to the location in your LDAP tree that you would like to search for email addresses. Your uids should be unique under the DN specified here. Ex. "ou=People,o=Company" LDAPuidattribute The LDAPuidattribute parameter should be set to the attribute which contains the unique UID of your users. The value retrieved from this attribute will be used when attempting to bind as the user to confirm their password. Ex. "uid" LDAPmailattribute The LDAPmailattribute parameter should be the name of the attribute which contains the email address your users will enter into the Bugzilla login boxes. Ex. "mail" _________________________________________________________________ 2.3.7. Serving Alternate Formats with the right MIME type Some Bugzilla pages have alternate formats, other than just plain HTML. In particular, a few Bugzilla pages can output their contents as either XUL (a special Mozilla format, that looks like a program GUI) or RDF (a type of structured XML that can be read by various programs). In order for your users to see these pages correctly, Apache must send them with the right MIME type. To do this, add the following lines to your Apache configuration, either in the section for your Bugzilla, or in the section for your Bugzilla: AddType application/vnd.mozilla.xul+xml .xul AddType application/rdf+xml .rdf _________________________________________________________________ 2.4. Multiple Bugzilla databases with a single installation The previous instructions referred to a standard installation, with one unique Bugzilla database. However, you may want to host several distinct installations, without having several copies of the code. This is possible by using the PROJECT environment variable. When accessed, Bugzilla checks for the existence of this variable, and if present, uses its value to check for an alternative configuration file named localconfig. in the same location as the default one (localconfig). It also checks for customized templates in a directory named in the same location as the default one (template/). By default this is template/en/default so PROJECT's templates would be located at template/en/PROJECT. To set up an alternate installation, just export PROJECT=foo before running checksetup.pl for the first time. It will result in a file called localconfig.foo instead of localconfig. Edit this file as described above, with reference to a new database, and re-run checksetup.pl to populate it. That's all. Now you have to configure the web server to pass this environment variable when accessed via an alternate URL, such as virtual host for instance. The following is an example of how you could do it in Apache, other Webservers may differ. ServerName foo.bar.baz SetEnv PROJECT foo Alias /bugzilla /var/www/bugzilla Don't forget to also export this variable before accessing Bugzilla by other means, such as cron tasks for instance. _________________________________________________________________ 2.5. OS-Specific Installation Notes Many aspects of the Bugzilla installation can be affected by the operating system you choose to install it on. Sometimes it can be made easier and others more difficult. This section will attempt to help you understand both the difficulties of running on specific operating systems and the utilities available to make it easier. If you have anything to add or notes for an operating system not covered, please file a bug in Bugzilla Documentation. _________________________________________________________________ 2.5.1. Microsoft Windows Making Bugzilla work on Windows is more difficult than making it work on Unix. For that reason, we still recommend doing so on a Unix based system such as GNU/Linux. That said, if you do want to get Bugzilla running on Windows, you will need to make the following adjustments. A detailed step-by-step installation guide for Windows is also available if you need more help with your installation. _________________________________________________________________ 2.5.1.1. Win32 Perl Perl for Windows can be obtained from ActiveState. You should be able to find a compiled binary at http://aspn.activestate.com/ASPN/Downloads/ActivePerl/. The following instructions assume that you are using version 5.8.1 of ActiveState. _________________________________________________________________ 2.5.1.2. Perl Modules on Win32 Bugzilla on Windows requires the same perl modules found in Section 2.1.5. The main difference is that windows uses PPM instead of CPAN. C:\perl> ppm install The best source for the Windows PPM modules needed for Bugzilla is probably the Bugzilla Test Server (aka 'Landfill'), so you should add the Landfill package repository as follows: ppm repository add landfill http://www.landfill.bugzilla.org/ppm/ Note The PPM repository stores modules in 'packages' that may have a slightly different name than the module. If retrieving these modules from there, you will need to pay attention to the information provided when you run checksetup.pl as it will tell you what package you'll need to install. Tip If you are behind a corporate firewall, you will need to let the ActiveState PPM utility know how to get through it to access the repositories by setting the HTTP_proxy system environmental variable. For more information on setting that variable, see the ActiveState documentation. _________________________________________________________________ 2.5.1.3. Code changes required to run on Win32 Bugzilla on Win32 is supported out of the box from version 2.20; this means that no code changes are required to get Bugzilla running. _________________________________________________________________ 2.5.1.4. Serving the web pages As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay attention to the security notes in Section 4.3.1. More information on configuring specific web servers can be found in Section 2.2.4. Note If using Apache on windows, you can set the ScriptInterpreterSource directive in your Apache config to avoid having to modify the first line of every script to contain your path to Perl instead of /usr/bin/perl. When setting ScriptInterpreterSource, do not forget to specify the -T flag to enable the taint mode. For example: C:\Perl\bin\perl.exe -T. _________________________________________________________________ 2.5.1.5. Sending Email To enable Bugzilla to send email on Windows, the server running the Bugzilla code must be able to connect to, or act as, an SMTP server. _________________________________________________________________ 2.5.2. Mac OS X Making Bugzilla work on Mac OS X requires the following adjustments. _________________________________________________________________ 2.5.2.1. Sendmail In Mac OS X 10.3 and later, Postfix is used as the built-in email server. Postfix provides an executable that mimics sendmail enough to fool Bugzilla, as long as Bugzilla can find it. As of version 2.20, Bugzilla will be able to find the fake sendmail executable without any assistance. However, you will have to turn on the sendmailnow parameter before you do anything that would result in email being sent. For more information, see the description of the sendmailnow parameter in Section 3.1. _________________________________________________________________ 2.5.2.2. Libraries & Perl Modules on Mac OS X Apple does not include the GD library with Mac OS X. Bugzilla needs this for bug graphs. You can use DarwinPorts (http://darwinports.com/) or Fink (http://sourceforge.net/projects/fink/), both of which are similar in nature to the CPAN installer, but install common unix programs. Follow the instructions for setting up DarwinPorts or Fink. Once you have one installed, you'll want to use it to install the gd2 package. Fink will prompt you for a number of dependencies, type 'y' and hit enter to install all of the dependencies and then watch it work. You will then be able to use CPAN to install the GD Perl module. Note To prevent creating conflicts with the software that Apple installs by default, Fink creates its own directory tree at /sw where it installs most of the software that it installs. This means your libraries and headers will be at /sw/lib and /sw/include instead of /usr/lib and /usr/include. When the Perl module config script asks where your libgd is, be sure to tell it /sw/lib. Also available via DarwinPorts and Fink is expat. After installing the expat package, you will be able to install XML::Parser using CPAN. If you use fink, there is one caveat. Unlike recent versions of the GD module, XML::Parser doesn't prompt for the location of the required libraries. When using CPAN, you will need to use the following command sequence: # perl -MCPAN -e'look XML::Parser' (1) # perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include # make; make test; make install (2) # exit (3) (1) (3) The look command will download the module and spawn a new shell with the extracted files as the current working directory. The exit command will return you to your original shell. (2) You should watch the output from these make commands, especially "make test" as errors may prevent XML::Parser from functioning correctly with Bugzilla. _________________________________________________________________ 2.5.3. Linux Distributions Many Linux distributions include Bugzilla and its dependencies in their native package management systems. Installing Bugzilla with root access on any Linux system should be as simple as finding the Bugzilla package in the package management application and installing it using the normal command syntax. Several distributions also perform the proper web server configuration automatically on installation. Please consult the documentation of your Linux distribution for instructions on how to install packages, or for specific instructions on installing Bugzilla with native package management tools. There is also a Bugzilla Wiki Page for distro-specific installation notes. _________________________________________________________________ 2.6. UNIX (non-root) Installation Notes 2.6.1. Introduction If you are running a *NIX OS as non-root, either due to lack of access (web hosts, for example) or for security reasons, this will detail how to install Bugzilla on such a setup. It is recommended that you read through the Section 2.1 first to get an idea on the installation steps required. (These notes will reference to steps in that guide.) _________________________________________________________________ 2.6.2. MySQL You may have MySQL installed as root. If you're setting up an account with a web host, a MySQL account needs to be set up for you. From there, you can create the bugs account, or use the account given to you. Warning You may have problems trying to set up GRANT permissions to the database. If you're using a web host, chances are that you have a separate database which is already locked down (or one big database with limited/no access to the other areas), but you may want to ask your system administrator what the security settings are set to, and/or run the GRANT command for you. Also, you will probably not be able to change the MySQL root user password (for obvious reasons), so skip that step. _________________________________________________________________ 2.6.2.1. Running MySQL as Non-Root 2.6.2.1.1. The Custom Configuration Method Create a file .my.cnf in your home directory (using /home/foo in this example) as follows.... [mysqld] datadir=/home/foo/mymysql socket=/home/foo/mymysql/thesock port=8081 [mysql] socket=/home/foo/mymysql/thesock port=8081 [mysql.server] user=mysql basedir=/var/lib [safe_mysqld] err-log=/home/foo/mymysql/the.log pid-file=/home/foo/mymysql/the.pid _________________________________________________________________ 2.6.2.1.2. The Custom Built Method You can install MySQL as a not-root, if you really need to. Build it with PREFIX set to /home/foo/mysql, or use pre-installed executables, specifying that you want to put all of the data files in /home/foo/mysql/data. If there is another MySQL server running on the system that you do not own, use the -P option to specify a TCP port that is not in use. _________________________________________________________________ 2.6.2.1.3. Starting the Server After your mysqld program is built and any .my.cnf file is in place, you must initialize the databases (ONCE). bash$ mysql_install_db Then start the daemon with bash$ safe_mysql & After you start mysqld the first time, you then connect to it as "root" and GRANT permissions to other users. (Again, the MySQL root account has nothing to do with the *NIX root account.) Note You will need to start the daemons yourself. You can either ask your system administrator to add them to system startup files, or add a crontab entry that runs a script to check on these daemons and restart them if needed. Warning Do NOT run daemons or other services on a server without first consulting your system administrator! Daemons use up system resources and running one may be in violation of your terms of service for any machine on which you are a user! _________________________________________________________________ 2.6.3. Perl On the extremely rare chance that you don't have Perl on the machine, you will have to build the sources yourself. The following commands should get your system installed with your own personal version of Perl: bash$ wget http://perl.com/CPAN/src/stable.tar.gz bash$ tar zvxf stable.tar.gz bash$ cd perl-5.8.1 (or whatever the version of Perl is called) bash$ sh Configure -de -Dprefix=/home/foo/perl bash$ make && make test && make install Once you have Perl installed into a directory (probably in ~/perl/bin), you'll have to change the locations on the scripts, which is detailed later on this page. _________________________________________________________________ 2.6.4. Perl Modules Installing the Perl modules as a non-root user is probably the hardest part of the process. There are two different methods: a completely independant Perl with its own modules, or personal modules using the current (root installed) version of Perl. The independant method takes up quite a bit of disk space, but is less complex, while the mixed method only uses as much space as the modules themselves, but takes more work to setup. _________________________________________________________________ 2.6.4.1. The Independant Method The independant method requires that you install your own personal version of Perl, as detailed in the previous section. Once installed, you can start the CPAN shell with the following command: bash$ /home/foo/perl/bin/perl -MCPAN -e 'shell' And then: cpan> install Bundle::Bugzilla With this method, module installation will usually go a lot smoother, but if you have any hang-ups, you can consult the next section. _________________________________________________________________ 2.6.4.2. The Mixed Method First, you'll need to configure CPAN to install modules in your home directory. The CPAN FAQ says the following on this issue: 5) I am not root, how can I install a module in a personal directory? You will most probably like something like this: o conf makepl_arg "LIB=~/myperl/lib \ INSTALLMAN1DIR=~/myperl/man/man1 \ INSTALLMAN3DIR=~/myperl/man/man3" install Sybase::Sybperl You can make this setting permanent like all "o conf" settings with "o conf commit". You will have to add ~/myperl/man to the MANPATH environment variable and a lso tell your Perl programs to look into ~/myperl/lib, e.g. by including use lib "$ENV{HOME}/myperl/lib"; or setting the PERL5LIB environment variable. Another thing you should bear in mind is that the UNINST parameter should n ever be set if you are not root. So, you will need to create a Perl directory in your home directory, as well as the lib, man, man/man1, and man/man3 directories in that Perl directory. Set the MANPATH variable and PERL5LIB variable, so that the installation of the modules goes smoother. (Setting UNINST=0 in your "make install" options, on the CPAN first-time configuration, is also a good idea.) After that, go into the CPAN shell: bash$ perl -MCPAN -e 'shell' From there, you will need to type in the above "o conf" command and commit the changes. Then you can run through the installation: cpan> install Bundle::Bugzilla Most of the module installation process should go smoothly. However, you may have some problems with Template. When you first start, you will want to try to install Template with the XS Stash options on. If this doesn't work, it may spit out C compiler error messages and croak back to the CPAN shell prompt. So, redo the install, and turn it off. (In fact, say no to all of the Template questions.) It may also start failing on a few of the tests. If the total tests passed is a reasonable figure (90+%), force the install with the following command: cpan> force install Template You may also want to install the other optional modules: cpan> install GD cpan> install Chart::Base cpan> install MIME::Parser _________________________________________________________________ 2.6.5. HTTP Server Ideally, this also needs to be installed as root and run under a special webserver account. As long as the web server will allow the running of *.cgi files outside of a cgi-bin, and a way of denying web access to certain files (such as a .htaccess file), you should be good in this department. _________________________________________________________________ 2.6.5.1. Running Apache as Non-Root You can run Apache as a non-root user, but the port will need to be set to one above 1024. If you type httpd -V, you will get a list of the variables that your system copy of httpd uses. One of those, namely HTTPD_ROOT, tells you where that installation looks for its config information. From there, you can copy the config files to your own home directory to start editing. When you edit those and then use the -d option to override the HTTPD_ROOT compiled into the web server, you get control of your own customized web server. Note You will need to start the daemons yourself. You can either ask your system administrator to add them to system startup files, or add a crontab entry that runs a script to check on these daemons and restart them if needed. Warning Do NOT run daemons or other services on a server without first consulting your system administrator! Daemons use up system resources and running one may be in violation of your terms of service for any machine on which you are a user! _________________________________________________________________ 2.6.6. Bugzilla If you had to install Perl modules as a non-root user (Section 2.6.4) or to non-standard directories, you will need to change the scripts, setting the correct location of the Perl modules: perl -pi -e 's@use strict\;@use strict\; use lib \"/home/foo/perl/lib\"\;@' *cgi *pl Bug.pm processmail syncshadowdb Change /home/foo/perl/lib to your personal Perl library directory. You can probably skip this step if you are using the independant method of Perl module installation. When you run ./checksetup.pl to create the localconfig file, it will list the Perl modules it finds. If one is missing, go back and double-check the module installation from the CPAN shell, then delete the localconfig file and try again. Warning The one option in localconfig you might have problems with is the web server group. If you can't successfully browse to the index.cgi (like a Forbidden error), you may have to relax your permissions, and blank out the web server group. Of course, this may pose as a security risk. Having a properly jailed shell and/or limited access to shell accounts may lessen the security risk, but use at your own risk. _________________________________________________________________ 2.6.6.1. suexec or shared hosting If you are running on a system that uses suexec (most shared hosting environments do this), you will need to set the webservergroup value in localconfig to match your primary group, rather than the one the web server runs under. You will need to run the following shell commands after running ./checksetup.pl, every time you run it (or modify checksetup.pl to do them for you via the system() command). for i in docs graphs images js skins; do find $i -type d -exec chmod o+ rx {} \; ; done for i in jpg gif css js png html rdf xul; do find . -name \*.$i -exec c hmod o+r {} \; ; done find . -name .htaccess -exec chmod o+r {} \; Pay particular attention to the number of semicolons and dots. They are all important. A future version of Bugzilla will hopefully be able to do this for you out of the box. _________________________________________________________________ Chapter 3. Administering Bugzilla 3.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 them appropriately after installing Bugzilla. 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. 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 http://www.foo.com/bugzilla/. makeproductgroups This dictates whether or not to automatically create groups when new products are created. 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. mail_delivery_method This is used to specify how email is sent, or if it is sent at all. There are several options included for different MTAs, along with two additional options that disable email sending. "testfile" does not send mail, but instead saves it in data/mailer.testfile for later review. "none" disables email sending entirely. 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 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, on reasonably old hardware, mozilla.org began needing "shadowdb" when they reached around 40,000 Bugzilla users with several hundred Bugzilla bug changes and comments per day. The value of the parameter defines the name of the shadow bug database. You will need to set the host and port settings from the params page, and set up replication in your database server so that updates reach this readonly mirror. Consult your database documentation for more detail. shutdownhtml If you need to shut down Bugzilla to perform administration, enter some descriptive text (with embedded HTML codes, if you'd like) into this box. Anyone who tries to use Bugzilla (including admins) will receive a page displaying this text. Users can neither log in nor log out while shutdownhtml is enabled. Note Although regular log-in capability is disabled while 'shutdownhtml' is enabled, safeguards are in place to protect the unfortunate admin who loses connection to Bugzilla. Should this happen to you, go directly to the editparams.cgi (by typing the URL in manually, if necessary). Doing this will prompt you to log in, and your name/password will be accepted here (but nowhere else). 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 training blurb about how to use Bugzilla at your site. 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. useqacontact This allows you to define an email address for each component, in addition to that of the default assignee, who will be sent carbon copies of incoming bugs. 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. 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 instructions, or set this value to "0" (never whine). commenton* All these fields allow you to dictate what changes can 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 explanation. Set the "commenton" options according to your site policy. It is a wise idea to require comments when users resolve, reassign, or reopen bugs at the very least. Note It is generally far better to require a developer comment when resolving bugs than not. Few things are more annoying to bug database users than having a developer mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) supportwatchers Turning on this option allows users to ask to receive copies of bug mail sent to another user. Watching a user with different group permissions is not a way to 'get around' the system; copied emails are still subject to the normal groupset permissions of a bug, and "watchers" will only be copied on emails from bugs they would normally be allowed to view. noresolveonopenblockers This option will prevent users from resolving bugs as FIXED if they have unresolved dependencies. Only the FIXED resolution is affected. Users will be still able to resolve bugs to resolutions other than FIXED if they have unresolved dependent bugs. sendmailnow When Bugzilla is using Sendmail older than 8.12, turning this option off will improve performance by not waiting for Sendmail to actually send mail. If Sendmail 8.12 or later is being used, there is nothing to gain by turning this off. If another MTA is being used, such as Postfix, then this option *must* be turned on (even if you are using the fake sendmail executable that Postfix provides). _________________________________________________________________ 3.2. User Administration 3.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 for this username and password. Tip If you wish to add more administrative users, add them to the "admin" group and, optionally, edit the tweakparams, editusers, creategroups, editcomponents, and editkeywords groups to add the entire admin group to those groups (which is the case by default). _________________________________________________________________ 3.2.2. Managing Other Users 3.2.2.1. Searching for existing users If you have "editusers" privileges or if you are allowed to grant privileges for some groups, the "Users" link appears in the footer. The first screen you get is a search form to search for existing user accounts. You can run searches based either on the ID, real name or login name (i.e. the email address in most cases) of users. 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, a reverse regular expression match, which finds every user name which does NOT match the regular expression, or the exact string if you know exactly who you are looking for. You can also restrict your search to users being in some specific group. By default, the restriction is turned off. Then you get a list of users matching your criteria, and clicking their login name lets you edit their properties. _________________________________________________________________ 3.2.2.2. Creating new users 3.2.2.2.1. Self-registration By default, 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). If you want to disable this self-registration, or if you want to restrict who can create his own user account, you have to edit the "createemailregexp" parameter in the "Configuration" page, see Section 3.1. _________________________________________________________________ 3.2.2.2.2. Accounts created by an administrator Users with "editusers" privileges, such as administrators, can create user accounts for other users: 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 done, click "Submit". Note Adding a user this way will not send an email informing them of their username and password. While useful for creating dummy accounts (watchers which shuttle mail to another system, for instance, or email addresses which are a mailing list), in general it is preferable to log out and use the "New Account" button to create users, as it will pre-populate all the required fields and also notify the user of her account name and password. _________________________________________________________________ 3.2.2.3. Modifying Users 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" parameter, 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 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 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 actions, and should explain why the account was disabled. Users with disabled accounts will continue to receive mail from Bugzilla; furthermore, they will not be able to log in themselves to change their own preferences and stop it. If you want an account (disabled or active) to stop receiving mail, add the account name (one account per line) to the file data/nomail. Note Even users whose accounts have been disabled can still submit bugs via the e-mail gateway, if one exists. The e-mail gateway should not be enabled for secure installations of Bugzilla. Warning Don't disable all the administrator accounts! * : 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 "unconfirmed" status. If you enable this for a user, that user can then move bugs from "Unconfirmed" to a "Confirmed" status (e.g.: "New" status). * 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 destroyed. * 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 them to themselves. Enable with care. * 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. If you turn on the "makeproductgroups" parameter in the Group Security Panel in the Parameters page, then Bugzilla creates one group per product (at the time you create the product), and this group has exactly the same name as the product itself. Note that for products that already exist when the parameter is turned on, the corresponding group will not be created. The user must still have the "editbugs" privilege to edit bugs in these products. _________________________________________________________________ 3.2.2.4. Deleting Users If the "allowuserdeletion" parameter is turned on, see Section 3.1, then you can also delete user accounts. Note that this is most of the time not the best thing to do. If only a warning in a yellow box is displayed, then the deletion is safe. If a warning is also displayed in a red box, then you should NOT try to delete the user account, else you will get referential integrity problems in your database, which can lead to unexpected behavior, such as bugs not appearing in bug lists anymore, or data displaying incorrectly. You have been warned! _________________________________________________________________ 3.2.2.5. Impersonating Users There may be times when an administrator would like to do something as another user. The sudo feature may be used to do this. Note To use the sudo feature, you must be in the bz_sudoers group. By default, all administrators are in this group. If you have access to this feature, you may start a session by going to the Edit Users page, Searching for a user and clicking on their login. You should see a link below their login name titled "Impersonate this user". Click on the link. This will take you to a page where you will see a description of the feature and instructions for using it. After reading the text, simply enter the login of the user you would like to impersonate, provide a short message explaining why you are doing this, and press the button. As long as you are using this feature, everything you do will be done as if you were logged in as the user you are impersonating. Warning The user you are impersonating will not be told about what you are doing. If you do anything that results in mail being sent, that mail will appear to be from the user you are impersonating. You should be extremely careful while using this feature. _________________________________________________________________ 3.3. Classifications Classifications tend to be used in order to group several related products into one distinct entity. The classifications layer is disabled by default; it can be turned on or off using the useclassification parameter, in the Bug Fields section of the edit parameters screen. Access to the administration of classifications is controlled using the editclassifications system group, which defines a privilege for creating, destroying, and editing classifications. When activated, classifications will introduce an additional step when filling bugs (dedicated to classification selection), and they will also appear in the advanced search form. _________________________________________________________________ 3.4. Products Products 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. 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 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 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 UNCONFIRMED state", and "Version" options yet. We'll cover those in a few moments. _________________________________________________________________ 3.5. 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 your Product or company. Each component has a default assignee and (if you turned it on in the parameters), a QA Contact. The default assignee 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 Assignee, QA Contact, and Reporter will get email when new bugs are created in this Component and when these bugs change. Default Assignee 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 "Default Assignee" and "Default QA Contact" (if enabled). The Component and Description fields may contain HTML; the "Default Assignee" field must be a login name already existing in the database. _________________________________________________________________ 3.6. 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 earliest version known to have 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 "undefined". Click the "Add" link in the bottom right. 3. Enter the name of the Version. This field takes text only. Then click the "Add" button. _________________________________________________________________ 3.7. Milestones Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Note Milestone options will only appear for a Product if you turned on the "usetargetmilestone" Param in the "Edit Parameters" screen. To create new Milestones, set Default Milestones, and set Milestone URL: 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 (-32768 to 32767) 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 which gives information about your milestones and what they mean. _________________________________________________________________ 3.8. Flags Flags are a way to attach a specific status to a bug or attachment, either "+" or "-". The meaning of these symbols depends on the text the flag itself, but contextually they could mean pass/fail, accept/reject, approved/denied, or even a simple yes/no. If your site allows requestable flags, then users may set a flag to "?" as a request to another user that they look at the bug/attachment, and set the flag to its correct status. _________________________________________________________________ 3.8.1. A Simple Example A developer might want to ask their manager, "Should we fix this bug before we release version 2.0?" They might want to do this for a lot of bugs, so it would be nice to streamline the process... In Bugzilla, it would work this way: 1. The Bugzilla administrator creates a flag type called "blocking2.0" that shows up on all bugs in your product. It shows up on the "Show Bug" screen as the text "blocking2.0" with a drop-down box next to it. The drop-down box contains four values: an empty space, "?", "-", and "+". 2. The developer sets the flag to "?". 3. The manager sees the blocking2.0 flag with a "?" value. 4. If the manager thinks the feature should go into the product before version 2.0 can be released, he sets the flag to "+". Otherwise, he sets it to "-". 5. Now, every Bugzilla user who looks at the bug knows whether or not the bug needs to be fixed before release of version 2.0. _________________________________________________________________ 3.8.2. About Flags 3.8.2.1. Values Flags can have three values: ? A user is requesting that a status be set. (Think of it as 'A question is being asked'.) - The status has been set negatively. (The question has been answered "no".) + The status has been set positively. (The question has been answered "yes".) Actually, there's a fourth value a flag can have -- "unset" -- which shows up as a blank space. This just means that nobody has expressed an opinion (or asked someone else to express an opinion) about this bug or attachment. _________________________________________________________________ 3.8.3. Using flag requests If a flag has been defined as 'requestable', and a user has enough privileges to request it (see below), the user can set the flag's status to "?". This status indicates that someone (a.k.a. "the requester") is asking someone else to set the flag to either "+" or "-". If a flag has been defined as 'specifically requestable', a text box will appear next to the flag into which the requester may enter a Bugzilla username. That named person (a.k.a. "the requestee") will receive an email notifying them of the request, and pointing them to the bug/attachment in question. If a flag has not been defined as 'specifically requestable', then no such text-box will appear. A request to set this flag cannot be made of any specific individual, but must be asked "to the wind". A requester may "ask the wind" on any flag simply by leaving the text-box blank. _________________________________________________________________ 3.8.4. Two Types of Flags Flags can go in two places: on an attachment, or on a bug. _________________________________________________________________ 3.8.4.1. Attachment Flags Attachment flags are used to ask a question about a specific attachment on a bug. Many Bugzilla installations use this to request that one developer "review" another developer's code before they check it in. They attach the code to a bug report, and then set a flag on that attachment called "review" to review?boss@domain.com. boss@domain.com is then notified by email that he has to check out that attachment and approve it or deny it. For a Bugzilla user, attachment flags show up in three places: 1. On the list of attachments in the "Show Bug" screen, you can see the current state of any flags that have been set to ?, +, or -. You can see who asked about the flag (the requester), and who is being asked (the requestee). 2. When you "Edit" an attachment, you can see any settable flag, along with any flags that have already been set. This "Edit Attachment" screen is where you set flags to ?, -, +, or unset them. 3. Requests are listed in the "Request Queue", which is accessible from the "My Requests" link (if you are logged in) or "Requests" link (if you are logged out) visible in the footer of all pages. _________________________________________________________________ 3.8.4.2. Bug Flags Bug flags are used to set a status on the bug itself. You can see Bug Flags in the "Show Bug" and "Requests" screens, as described above. Only users with enough privileges (see below) may set flags on bugs. This doesn't necessarily include the assignee, reporter, or users with the editbugs permission. _________________________________________________________________ 3.8.5. Administering Flags If you have the "editcomponents" permission, you will have "Edit: ... | Flags | ..." in your page footer. Clicking on that link will bring you to the "Administer Flag Types" page. Here, you can select whether you want to create (or edit) a Bug flag, or an Attachment flag. No matter which you choose, the interface is the same, so we'll just go over it once. _________________________________________________________________ 3.8.5.1. Creating a Flag When you click on the "Create a Flag Type for..." link, you will be presented with a form. Here is what the fields in the form mean: _________________________________________________________________ 3.8.5.1.1. Name This is the name of the flag. This will be displayed to Bugzilla users who are looking at or setting the flag. The name may contain any valid Unicode characters except commas and spaces. _________________________________________________________________ 3.8.5.1.2. Description The description describes the flag in more detail. It is visible in a tooltip when hovering over a flag either in the "Show Bug" or "Edit Attachment" pages. This field can be as long as you like, and can contain any character you want. _________________________________________________________________ 3.8.5.1.3. Category Default behaviour for a newly-created flag is to appear on products and all components, which is why "__Any__:__Any__" is already entered in the "Inclusions" box. If this is not your desired behaviour, you must either set some exclusions (for products on which you don't want the flag to appear), or you must remove "__Any__:__Any__" from the Inclusions box and define products/components specifically for this flag. To create an Inclusion, select a Product from the top drop-down box. You may also select a specific component from the bottom drop-down box. (Setting "__Any__" for Product translates to, "all the products in this Bugzilla". Selecting "__Any__" in the Component field means "all components in the selected product.") Selections made, press "Include", and your Product/Component pairing will show up in the "Inclusions" box on the right. To create an Exclusion, the process is the same; select a Product from the top drop-down box, select a specific component if you want one, and press "Exclude". The Product/Component pairing will show up in the "Exclusions" box on the right. This flag will and can be set for any products/components that appearing in the "Inclusions" box (or which fall under the appropriate "__Any__"). This flag will not appear (and therefore cannot be set) on any products appearing in the "Exclusions" box. IMPORTANT: Exclusions override inclusions. You may select a Product without selecting a specific Component, but you can't select a Component without a Product, or to select a Component that does not belong to the named Product. If you do so, Bugzilla will display an error message, even if all your products have a component by that name. Example: Let's say you have a product called "Jet Plane" that has thousands of components. You want to be able to ask if a problem should be fixed in the next model of plane you release. We'll call the flag "fixInNext". But, there's one component in "Jet Plane," called "Pilot." It doesn't make sense to release a new pilot, so you don't want to have the flag show up in that component. So, you include "Jet Plane:__Any__" and you exclude "Jet Plane:Pilot". _________________________________________________________________ 3.8.5.1.4. Sort Key Flags normally show up in alphabetical order. If you want them to show up in a different order, you can use this key set the order on each flag. Flags with a lower sort key will appear before flags with a higher sort key. Flags that have the same sort key will be sorted alphabetically, but they will still be after flags with a lower sort key, and before flags with a higher sort key. Example: I have AFlag (Sort Key 100), BFlag (Sort Key 10), CFlag (Sort Key 10), and DFlag (Sort Key 1). These show up in the order: DFlag, BFlag, CFlag, AFlag. _________________________________________________________________ 3.8.5.1.5. Active Sometimes, you might want to keep old flag information in the Bugzilla database, but stop users from setting any new flags of this type. To do this, uncheck "active". Deactivated flags will still show up in the UI if they are ?, +, or -, but they may only be cleared (unset), and cannot be changed to a new value. Once a deactivated flag is cleared, it will completely disappear from a bug/attachment, and cannot be set again. _________________________________________________________________ 3.8.5.1.6. Requestable New flags are, by default, "requestable", meaning that they offer users the "?" option, as well as "+" and "-". To remove the ? option, uncheck "requestable". _________________________________________________________________ 3.8.5.1.7. Specifically Requestable By default this box is checked for new flags, meaning that users may make flag requests of specific individuals. Unchecking this box will remove the text box next to a flag; if it is still requestable, then requests may only be made "to the wind." Removing this after specific requests have been made will not remove those requests; that data will stay in the database (though it will no longer appear to the user). _________________________________________________________________ 3.8.5.1.8. Multiplicable Any flag with "Multiplicable" set (default for new flags is 'on') may be set more than once. After being set once, an unset flag of the same type will appear below it with "addl." (short for "additional") before the name. There is no limit to the number of times a Multiplicable flags may be set on the same bug/attachment. _________________________________________________________________ 3.8.5.1.9. CC List If you want certain users to be notified every time this flag is set to ?, -, +, or unset, add them here. This is a comma-separated list of email addresses that need not be restricted to Bugzilla usernames. _________________________________________________________________ 3.8.5.1.10. Grant Group When this field is set to some given group, only users in the group can set the flag to "+" and "-". This field does not affect who can request or cancel the flag. For that, see the "Request Group" field below. If this field is left blank, all users can set or delete this flag. This field is useful for restricting which users can approve or reject requests. _________________________________________________________________ 3.8.5.1.11. Request Group When this field is set to some given group, only users in the group can request or cancel this flag. Note that this field has no effect if the "grant group" field is empty. You can set the value of this field to a different group, but both fields have to be set to a group for this field to have an effect. _________________________________________________________________ 3.8.5.2. Deleting a Flag When you are at the "Administer Flag Types" screen, you will be presented with a list of Bug flags and a list of Attachment Flags. To delete a flag, click on the "Delete" link next to the flag description. Warning Once you delete a flag, it is gone from your Bugzilla. All the data for that flag will be deleted. Everywhere that flag was set, it will disappear, and you cannot get that data back. If you want to keep flag data, but don't want anybody to set any new flags or change current flags, unset "active" in the flag Edit form. _________________________________________________________________ 3.8.5.3. Editing a Flag To edit a flag's properties, just click on the "Edit" link next to the flag's description. That will take you to the same form described in the "Creating a Flag" section. _________________________________________________________________ 3.9. Keywords The administrator can define keywords which can be used to tag and categorise bugs. For example, the keyword "regression" is commonly used. A company might have a policy stating all regressions must be fixed by the next release - this keyword can make tracking those bugs much easier. Keywords are global, rather than per-product. If the administrator changes a keyword currently applied to any bugs, the keyword cache must be rebuilt using the Section 3.14 script. Currently keywords can not be marked obsolete to prevent future usage. Keywords can be created, edited or deleted by clicking the "Keywords" link in the footer. There are two fields for each keyword - the keyword itself and a brief description. Once created, keywords can be selected and applied to individual bugs in that bug's "Details" section. _________________________________________________________________ 3.10. Legal Values Since Bugzilla 2.20 RC1, legal values for Operating Systems, platforms, bug priorities and severities can be edited from the User Interface directly. This means that it is no longer required to manually edit localconfig. _________________________________________________________________ 3.10.1. Viewing/Editing legal values Editing legal values requires "editcomponents" privileges. A link named "Field Values" is visible in your footer and clicking on it displays the list of fields whose values can be edited. You can add as many legal values as you want, and each value must be unique (on a per field basis). The sortkey is important to display these values in the desired order. _________________________________________________________________ 3.10.2. Deleting legal values You can also delete legal values, but only if the two following conditions are respected: 1. The value is not used by default for the field. 2. No bug is currently using this value. If any of these conditions is not respected, the value cannot be deleted. The only way to delete these values is to reassign bugs to another value and to set another value as default for the field. _________________________________________________________________ 3.11. 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 awaiting triage. To modify Voting settings: 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 voting. 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 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 the automatic move of bugs from UNCONFIRMED to NEW. 5. Once you have adjusted the values to your preference, click "Update". _________________________________________________________________ 3.12. Quips Quips are small text messages that can be configured to appear next to search results. A Bugzilla installation can have its own specific quips. Whenever a quip needs to be displayed, a random selection is made from the pool of already existing quips. Quips are controlled by the enablequips parameter. It has several possible values: on, approved, frozen or off. In order to enable quips approval you need to set this parameter to "approved". In this way, users are free to submit quips for addition but an administrator must explicitly approve them before they are actually used. In order to see the user interface for the quips, it is enough to click on a quip when it is displayed together with the search results. Or it can be seen directly in the browser by visiting the quips.cgi URL (prefixed with the usual web location of the Bugzilla installation). Once the quip interface is displayed, it is enough to click the "view and edit the whole quip list" in order to see the administration page. A page with all the quips available in the database will be displayed. Next to each tip there is a checkbox, under the "Approved" column. Quips who have this checkbox checked are already approved and will appear next to the search results. The ones that have it unchecked are still preserved in the database but they will not appear on search results pages. User submitted quips have initially the checkbox unchecked. Also, there is a delete link next to each quip, which can be used in order to permanently delete a quip. _________________________________________________________________ 3.13. Groups and Group Security Groups allow the administrator to isolate bugs or products that should only be seen by certain people. The association between products and 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. It is primarily available for backward compatibility with older sites. 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. Note By default, bugs can also be seen by the Assignee, the Reporter, and by everyone on the CC List, regardless of whether or not the bug would typically be viewable by them. Visibility to the Reporter and CC List can be overridden (on a per-bug basis) by bringing up the bug, finding the section that starts with "Users in the roles selected below..." and un-checking the box next to either 'Reporter' or 'CC List' (or both). _________________________________________________________________ 3.13.1. Creating Groups 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. 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". Users whose email addresses match the regular expression will automatically be members of the group as long as their email addresses continue to match the regular expression. Note This is a change from 2.16 where the regular expression resulted in a user acquiring permanent membership in a group. To remove a user from a group the user was in due to a regular expression in version 2.16 or earlier, the user must be explicitly removed from the group. This can easily be done by pressing buttons named 'Remove Memberships' or 'Remove Memberships included in regular expression' under the table. Warning If specifying a domain in the regexp, make sure you end the regexp with a $. Otherwise, when granting access to "@mycompany\.com", you will allow access to 'badperson@mycompany.com.cracker.net'. You need to use '@mycompany\.com$' as the regexp. 4. If you plan to use this group to directly control access to bugs, check the "use for bugs" box. Groups not used for bugs are still useful because other groups can include the group as a whole. 5. 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. _________________________________________________________________ 3.13.2. Assigning Users to Groups Users can become a member of a group in several ways. 1. The user can be explicitly placed in the group by editing the user's own profile 2. The group can include another group of which the user is a member. 3. The user's email address can match a regular expression that the group specifies to automatically grant membership to the group. _________________________________________________________________ 3.13.3. Assigning Group Controls to Products On the product edit page, there is a page to edit the "Group Controls" for a product. This allows you to configure how a group relates to the product. Groups may be applicable, default, and mandatory as well as used to control entry or used to make bugs in the product totally read-only unless the 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. These controls are often described in this order, so a product that requires a user to be a member of group "foo" to enter a bug and then requires that the bug stay restricted to group "foo" at all times and that only members of group "foo" can edit the bug even if they otherwise could see the bug would have its controls summarized by... foo: ENTRY, MANDATORY/MANDATORY, CANEDIT _________________________________________________________________ 3.13.4. Common Applications of Group Controls 3.13.4.1. General User Access With Security Group To permit any user to file bugs in each product (A, B, C...) and to permit any user to submit those bugs into a security group.... Product A... security: SHOWN/SHOWN Product B... security: SHOWN/SHOWN Product C... security: SHOWN/SHOWN _________________________________________________________________ 3.13.4.2. General User Access With A Security Product To permit any user to file bugs in a Security product while keeping those bugs from becoming visible to anyone outside the securityworkers group unless a member of the securityworkers group removes that restriction.... Product Security... securityworkers: DEFAULT/MANDATORY _________________________________________________________________ 3.13.4.3. Product Isolation With Common Group To permit users of product A to access the bugs for product A, users of product B to access product B, and support staff to access both, 3 groups are needed 1. Support: Contains members of the support staff. 2. AccessA: Contains users of product A and the Support group. 3. AccessB: Contains users of product B and the Support group. Once these 3 groups are defined, the products group controls can be set to.. Product A... AccessA: ENTRY, MANDATORY/MANDATORY Product B... AccessB: ENTRY, MANDATORY/MANDATORY Optionally, the support group could be permitted to make bugs inaccessible to the users and could be permitted to publish bugs relevant to all users in a common product that is read-only to anyone outside the support group. That configuration could be... Product A... AccessA: ENTRY, MANDATORY/MANDATORY Support: SHOWN/NA Product B... AccessB: ENTRY, MANDATORY/MANDATORY Support: SHOWN/NA Product Common... Support: ENTRY, DEFAULT/MANDATORY, CANEDIT _________________________________________________________________ 3.14. Checking and Maintaining Database Integrity Over time it is possible for the Bugzilla database to become corrupt or to have anomalies. This could happen through normal usage of Bugzilla, manual database administration outside of the Bugzilla user interface, or from some other unexpected event. Bugzilla includes a "Sanity Check" script that can perform several basic database checks, and repair certain problems or inconsistencies. To run the "Sanity Check" script, log in as an Administrator and click the "Sanity Check" link in the footer. Any problems that are found will be displayed in red letters. If the script is capable of fixing a problem, it will present a link to initiate the fix. If the script can not fix the problem it will require manual database administration or recovery. The "Sanity Check" script should be run on a regular basis as a matter of best practice. Warning The "Sanity Check" script is no substitute for a competent database administrator. It is only designed to check and repair basic database problems. _________________________________________________________________ 3.15. Upgrading to New Releases Upgrading Bugzilla is something we all want to do from time to time, be it to get new features or pick up the latest security fix. How easy it is to update depends on a few factors: * If the new version is a revision or a new point release * How many local changes (if any) have been made _________________________________________________________________ 3.15.1. Version Definitions Bugzilla displays the version you are using at the top of most pages you load. It will look something like '2.16.7' or '2.18rc3' or '2.19.1+'. The first number in this series is the Major Version. This does not change very often (that is to say, almost never); Bugzilla was 1.x.x when it was first created, and went to 2.x.x when it was re-written in perl in Sept 1998. If/When the major version is changed to 3.x.x, it will signify a significant structural change and will be accompanied by much fanfare and many instructions on how to upgrade, including a revision to this page. :) The second number in the version is called the 'minor number', and a release that changes the minor number is called a 'point release'. An even number in this position (2.14, 2.16, 2.18, 2.20, etc.) represents a stable version, while an odd number (2.17, 2.19, etc.) represents a development version. In the past, stable point releases were feature-based, coming when certain enhancements had been completed, or the Bugzilla development team felt that enough progress had been made overall. As of version 2.18, however, Bugzilla has moved to a time-based release schedule; current plans are to create a stable point release every 6 months or so after 2.18 is deployed. The third number in the Bugzilla version represents a bugfix version. Bugfix Revisions are normally released only to address security vulnerabilities; in the future, it is likely that the Bugzilla development team will back-port bugfixes in a new point release to the old point release for a limited period. Once enough of these bugfixes have accumulated (or a new security vulnerability is identified and closed), a bugfix release will be made. As an example, 2.16.6 was a bugfix release, and improved on 2.16.5. Note When reading version numbers, everything separated by a point ('.') should be read as a single number. It is not the same as decimal. 2.14 is newer than 2.8 because minor version 14 is greater than minor version 8. 2.24.11 would be newer than 2.24.9 (because bugfix 11 is greater than bugfix 9. This is confusing to some people who aren't used to dealing with software. _________________________________________________________________ 3.15.2. Upgrading - Methods and Procedure There are three different ways to upgrade your installation. 1. Using CVS (Section 3.15.2.1) 2. Downloading a new tarball (Section 3.15.2.2) 3. Applying the relevant patches (Section 3.15.2.3) Each of these options has its own pros and cons; the one that's right for you depends on how long it has been since you last installed, the degree to which you have customized your installation, and/or your network configuration. (Some discussion of the various methods of updating compared with degree and methods of local customization can be found in Section 6.1.2.) The larger the jump you are trying to make, the more difficult it is going to be to upgrade if you have made local customizations. Upgrading from 2.18 to 2.18.1 should be fairly painless even if you are heavily customized, but going from 2.14 to 2.18 is going to mean a fair bit of work re-writing your local changes to use the new files, logic, templates, etc. If you have done no local changes at all, however, then upgrading should be approximately the same amount of work regardless of how long it has been since your version was released. Warning Upgrading is a one-way process. You should backup your database and current Bugzilla directory before attempting the upgrade. If you wish to revert to the old Bugzilla version for any reason, you will have to restore from these backups. The examples in the following sections are written as though the user were updating to version 2.18.1, but the procedures are the same regardless of whether one is updating to a new point release or simply trying to obtain a new bugfix release. Also, in the examples the user's Bugzilla installation is found at /var/www/html/bugzilla. If that is not the same as the location of your Bugzilla installation, simply substitute the proper paths where appropriate. _________________________________________________________________ 3.15.2.1. Upgrading using CVS Every release of Bugzilla, whether it is a point release or a bugfix, is tagged in CVS. Also, every tarball that has been distributed since version 2.12 has been created in such a way that it can be used with CVS once it is unpacked. Doing so, however, requires that you are able to access cvs-mirror.mozilla.org on port 2401, which may not be an option or a possibility for some users, especially those behind a highly restrictive firewall. Tip If you can, updating using CVS is probably the most painless method, especially if you have a lot of local changes. The following shows the sequence of commands needed to update a Bugzilla installation via CVS, and a typical series of results. bash$ cd /var/www/html/bugzilla bash$ cvs login Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot CVS password: ('anonymous', or just leave it blank) bash$ cvs -q update -r BUGZILLA-2_18_1 -dP P checksetup.pl P collectstats.pl P globals.pl P docs/rel_notes.txt P template/en/default/list/quips.html.tmpl (etc.) Caution If a line in the output from cvs update begins with a C, then that represents a file with local changes that CVS was unable to properly merge. You need to resolve these conflicts manually before Bugzilla (or at least the portion using that file) will be usable. _________________________________________________________________ 3.15.2.2. Upgrading using the tarball If you are unable (or unwilling) to use CVS, another option that's always available is to obtain the latest tarball from the Download Page and create a new Bugzilla installation from that. This sequence of commands shows how to get the tarball from the command-line; it is also possible to download it from the site directly in a web browser. If you go that route, save the file to the /var/www/html directory (or its equivalent, if you use something else) and omit the first three lines of the example. bash$ cd /var/www/html bash$ wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.1.tar.g z (Output omitted) bash$ tar xzvf bugzilla-2.18.1.tar.gz bugzilla-2.18.1/ bugzilla-2.18.1/.cvsignore bugzilla-2.18.1/1x1.gif (Output truncated) bash$ cd bugzilla-2.18.1 bash$ cp ../bugzilla/localconfig* . bash$ cp -r ../bugzilla/data . bash$ cd .. bash$ mv bugzilla bugzilla.old bash$ mv bugzilla-2.18.1 bugzilla Warning The cp commands both end with periods which is a very important detail, it tells the shell that the destination directory is the current working directory. This upgrade method will give you a clean install of Bugzilla with the same version as the tarball. That's fine if you don't have any local customizations that you want to maintain, but if you do then you will need to reapply them by hand to the appropriate files. It's worth noting that since 2.12, the Bugzilla tarballs come CVS-ready, so if you decide at a later date that you'd rather use CVS as an upgrade method, your code will already be set up for it. _________________________________________________________________ 3.15.2.3. Upgrading using patches If you are doing a bugfix upgrade -- that is, one where only the last number of the revision changes, such as from 2.16.6 to 2.16.7 -- then you have the option of obtaining and applying a patch file from the Download Page. This file is made available by the Bugzilla Development Team, and is a collection of all the bug fixes and security patches that have been made since the last bugfix release. If you are planning to upgrade via patches, it is safer to grab this developer-made patch file than to read the patch notes and apply all (or even just some of) the patches oneself, as sometimes patches on bugs get changed before they get checked in. As above, this example starts with obtaining the file via the command line. If you have already downloaded it, you can omit the first two commands. bash$ cd /var/www/html/bugzilla bash$ wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.0-to-2. 18.1.diff.gz (Output omitted) bash$ gunzip bugzilla-2.18.0-to-2.18.1.diff.gz bash$ patch -p1 < bugzilla-2.18.0-to-2.18.1.diff patching file checksetup.pl patching file collectstats.pl patching file globals.pl (etc.) Warning Be aware that upgrading from a patch file does not change the entries in your CVS directory. This could make it more difficult to upgrade using CVS (Section 3.15.2.1) in the future. _________________________________________________________________ 3.15.3. Completing Your Upgrade Regardless of which upgrade method you choose, you will need to run ./checksetup.pl before your Bugzilla upgrade will be complete. bash$ cd bugzilla bash$ ./checksetup.pl Warning The period at the beginning of the command ./checksetup.pl is important and can not be omitted. If you have done a lot of local modifications, it wouldn't hurt to run the Bugzilla Testing suite. This is not a required step, but it isn't going to hurt anything, and might help point out some areas that could be improved. (More information on the test suite can be had by following this link to the appropriate section in the Developers' Guide.) _________________________________________________________________ Chapter 4. Bugzilla Security While some of the items in this chapter are related to the operating system Bugzilla is running on or some of the support software required to run Bugzilla, it is all related to protecting your data. This is not intended to be a comprehensive guide to securing Linux, Apache, MySQL, or any other piece of software mentioned. There is no substitute for active administration and monitoring of a machine. The key to good security is actually right i