The Bugzilla Guide - 3.3.1 Development Release The Bugzilla Team 2009-01-05 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 2.7. Upgrading to New Releases 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. Custom Fields 3.11. Legal Values 3.12. Bug Status Workflow 3.13. Voting 3.14. Quips 3.15. Groups and Group Security 3.16. Checking and Maintaining Database Integrity 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. Custom Skins 6.2. Template Customization 6.3. The Bugzilla Extension Mechanism 6.4. Customizing Who Can Change What 6.5. Integrating Bugzilla with Third-Party Tools A. Troubleshooting A.1. General Advice A.2. The Apache web server is not serving Bugzilla pages A.3. I installed a Perl module, but checksetup.pl claims it's not installed! A.4. DBD::Sponge::db prepare failed A.5. cannot chdir(/var/spool/mqueue) A.6. Everybody is constantly being forced to relogin A.7. Some users are constantly being forced to relogin A.8. index.cgi doesn't show up unless specified in the URL A.9. checksetup.pl reports "Client does not support authentication protocol requested by server..." B. Contrib B.1. Command-line Search Interface B.2. Command-line 'Send Unsent Bug-mail' tool C. Manual Installation of Perl Modules C.1. Instructions C.2. Download Locations C.3. Optional Modules D. 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 A-1. Examples of urlbase/cookiepath pairs for sharing login cookies A-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-2009 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 D. 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 3.3.1 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. This version of the guide, like its associated Bugzilla version, is a development version. 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 from your web browser. 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. 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.8.1 or above) 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.8.1, it's a good idea to be using the latest stable version. _________________________________________________________________ 2.1.2. Database Engine Bugzilla supports MySQL, PostgreSQL and Oracle as 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.1.2 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 8.00.0000 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.2.3. Oracle Installed Version Test: select * from v$version (you first have to log in into your DB) If you don't have it and your OS doesn't provide official packages, visit http://www.oracle.com/. You need Oracle version 10.02.0 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 Oracle 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 web server, 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 web server's document directories or in /usr/local with a symbolic link to the web server's document directories or an alias in the web server's configuration. 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 web server'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 C. 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. CGI 3.21 2. Date::Format (2.21) 3. DBI (1.41) 4. DBD::mysql (4.00) if using MySQL 5. DBD::Pg (1.45) if using PostgreSQL 6. DBD::Oracle (1.19) if using Oracle 7. File::Spec (0.84) 8. Template (2.15) 9. Email::Send (2.00) 10. Email::MIME::Modifier (1.442) Optional Perl modules: 1. GD (1.20) for bug charting 2. Template::Plugin::GD::Image (1.20) for Graphical Reports 3. Chart::Base (1.0) for bug charting 4. GD::Graph (any) for bug charting 5. GD::Text (any) for bug charting 6. XML::Twig (any) for bug import/export 7. MIME::Parser (5.406) for bug import/export 8. LWP::UserAgent (any) for Automatic Update Notifications 9. PatchReader (0.9.4) for pretty HTML view of patches 10. Image::Magick (any) for converting BMP image attachments to PNG 11. Net::LDAP (any) for LDAP Authentication 12. Authen::Radius (any) for RADIUS Authentication 13. SOAP::Lite (any) for the web service interface 14. HTML::Parser (3.40) for More HTML in Product/Group Descriptions 15. HTML::Scrubber (any) for More HTML in Product/Group Descriptions 16. Email::MIME::Attachment::Stripper (any) for Inbound Email 17. Email::Reply (any) for Inbound Email 18. mod_perl2 (1.999022) for mod_perl 19. CGI (3.21) for mod_perl _________________________________________________________________ 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.15) 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 (any) The GD::Text 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. SOAP::Lite (any) Installing SOAP::Lite enables your Bugzilla installation to be accessible at a standardized Web Service interface (SOAP/XML-RPC) by third-party applications via HTTP(S). _________________________________________________________________ 2.1.5.9. 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.1.7. Installing Bugzilla on mod_perl It is now possible to run the Bugzilla software under mod_perl on Apache. mod_perl has some additional requirements to that of running Bugzilla under mod_cgi (the standard and previous way). Bugzilla requires mod_perl to be installed, which can be obtained from http://perl.apache.org - Bugzilla requires version 1.999022 (AKA 2.0.0-RC5) to be installed. Bugzilla also requires a more up-to-date version of the CGI perl module to be installed, version 3.21 as opposed to 3.21 _________________________________________________________________ 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 two values you need to change are $db_driver and $db_pass, respectively the type of the database and 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. $db_driver can be either 'mysql', 'Pg' or 'oracle'. Note In Oracle, $db_name should actually be the SID name of your database (e.g. "XE" if you are using Oracle XE). 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 database setup, you may wish to change one or more of the other "$db_*" parameters. _________________________________________________________________ 2.2.2. Database Server This section deals with configuring your database server for use with Bugzilla. Currently, MySQL (Section 2.2.2.2), PostgreSQL (Section 2.2.2.3) and Oracle (Section 2.2.2.4) 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 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.2. 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.3. 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 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. 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.2.4. Oracle 2.2.2.4.1. Create a New Tablespace You can use the existing tablespace or create a new one for Bugzilla. To create a new tablespace, run the following command: CREATE TABLESPACE bugs DATAFILE '$path_to_datafile' SIZE 500M AUTOEXTEND ON NEXT 30M MAXSIZE UNLIMITED Here, the name of the tablespace is 'bugs', but you can choose another name. $path_to_datafile is the path to the file containing your database, for instance /u01/oradata/bugzilla.dbf. The initial size of the database file is set in this example to 500 Mb, with an increment of 30 Mb everytime we reach the size limit of the file. _________________________________________________________________ 2.2.2.4.2. Add a User to Oracle The user name and password must match what you set in localconfig ($db_user and $db_pass, respectively). Here, we assume that the user name is 'bugs' and the tablespace name is the same as above. CREATE USER bugs IDENTIFIED BY "$db_pass" DEFAULT TABLESPACE bugs TEMPORARY TABLESPACE TEMP PROFILE DEFAULT; -- GRANT/REVOKE ROLE PRIVILEGES GRANT CONNECT TO bugs; GRANT RESOURCE TO bugs; -- GRANT/REVOKE SYSTEM PRIVILEGES GRANT UNLIMITED TABLESPACE TO bugs; GRANT EXECUTE ON CTXSYS.CTX_DDL TO bugs; _________________________________________________________________ 2.2.2.4.3. Configure the Web Server If you use Apache, append these lines to httpd.conf to set ORACLE_HOME and LD_LIBRARY_PATH. For instance: SetEnv ORACLE_HOME /u01/app/oracle/product/10.2.0/ SetEnv LD_LIBRARY_PATH /u01/app/oracle/product/10.2.0/lib/ When this is done, restart your web server. _________________________________________________________________ 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. Bugzilla using Apache You have two options for running Bugzilla under Apache - mod_cgi (the default) and mod_perl (new in Bugzilla 2.23) _________________________________________________________________ 2.2.4.1.1. Apache httpd with mod_cgi To configure your Apache web server to work with Bugzilla while using mod_cgi, 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 web server 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.1.2. Apache httpd with mod_perl Some configuration is required to make Bugzilla work with Apache and mod_perl 1. Load httpd.conf in your editor. In Fedora and Red Hat Linux, this file is found in /etc/httpd/conf. 2. Add the following information to your httpd.conf file, substituting where appropriate with your own local paths. Note This should be used instead of the block shown above. This should also be above any other mod_perl directives within the httpd.conf and must be specified in the order as below. Warning You should also ensure that you have disabled KeepAlive support in your Apache install when utilizing Bugzilla under mod_perl PerlSwitches -I/var/www/html/bugzilla -I/var/www/html/bugzilla/lib -w -T PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl 3. checksetup.pl can set tighter permissions on Bugzilla's files and directories if it knows what group the web server runs as. Find the Group line in httpd.conf, place the value found there in the $webservergroup variable in localconfig, then rerun checksetup.pl. On restarting Apache, Bugzilla should now be running within the mod_perl environment. Please ensure you have run checksetup.pl to set permissions before you restart Apache. Note Please bear the following points in mind when looking at using Bugzilla under mod_perl: * mod_perl support in Bugzilla can take up a HUGE amount of RAM. You could be looking at 30MB per httpd child, easily. Basically, you just need a lot of RAM. The more RAM you can get, the better. mod_perl is basically trading RAM for speed. At least 2GB total system RAM is recommended for running Bugzilla under mod_perl. * Under mod_perl, you have to restart Apache if you make any manual change to any Bugzilla file. You can't just reload--you have to actually restart the server (as in make sure it stops and starts again). You can change localconfig and the params file manually, if you want, because those are re-read every time you load a page. * You must run in Apache's Prefork MPM (this is the default). The Worker MPM may not work--we haven't tested Bugzilla's mod_perl support under threads. (And, in fact, we're fairly sure it won't work.) * Bugzilla generally expects to be the only mod_perl application running on your entire server. It may or may not work if there are other applications also running under mod_perl. It does try its best to play nice with other mod_perl applications, but it still may have conflicts. * It is recommended that you have one Bugzilla instance running under mod_perl on your server. Bugzilla has not been tested with more than one instance running. _________________________________________________________________ 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 web server. 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 A. 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. 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.3. 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.4. 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. Note These instructions are for 32-bit versions of Windows. If you are using a 64-bit version of Windows, you will need to install 32-bit Perl in order to install the 32-bit modules as described below. _________________________________________________________________ 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. ActiveState provides a GUI to manage Perl modules. We highly recommend that you use it. If you prefer to use ppm from the command-line, type: C:\perl> ppm install The best source for the Windows PPM modules needed for Bugzilla is probably the theory58S website, which you can add to your list of repositories as follows (for Perl 5.8.x): ppm repo add theory58S http://theoryx5.uwinnipeg.ca/ppms/ If you are using Perl 5.10.x, you cannot use the same PPM modules as Perl 5.8.x as they are incompatible. In this case, you should add the following repository: ppm repo add theory58S http://cpan.uwinnipeg.ca/PPMPackages/10xx/ Note In versions prior to 5.8.8 build 819 of PPM the command is ppm repository add theory58S http://theoryx5.uwinnipeg.ca/ppms/ 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 will need to install the Perl Modules, described below. _________________________________________________________________ 2.6.4. Perl Modules Installing the Perl modules as a non-root user is accomplished by running the install-module.pl script. For more details on this script, see install-module.pl documentation _________________________________________________________________ 2.6.5. HTTP Server Ideally, this also needs to be installed as root and run under a special web server 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 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 Section 2.6.4, then delete the localconfig file and try again. Warning 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 {} \; chmod o+x . data data/webdot 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. _________________________________________________________________ 2.7. Upgrading to New Releases Upgrading to new Bugzilla releases is very simple. There is a script included with Bugzilla that will automatically do all of the database migration for you. The following sections explain how to upgrade from one version of Bugzilla to another. Whether you are upgrading from one bug-fix version to another (such as 3.0.1 to 3.0.2) or from one major version to another (such as from 3.0 to 3.2), the instructions are always the same. Note Any examples in the following sections are written as though the user were updating to version 2.22.1, but the procedures are the same no matter what version you're updating to. 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. _________________________________________________________________ 2.7.1. Before You Upgrade Before you start your upgrade, there are a few important steps to take: 1. Read the Release Notes of the version you're upgrading to, particularly the "Notes for Upgraders" section. 2. View the Sanity Check (Section 3.16) page on your installation before upgrading. Attempt to fix all warnings that the page produces before you go any further, or you may experience problems during your upgrade. 3. Shut down your Bugzilla installation by putting some HTML or text in the shutdownhtml parameter (see Section 3.1). 4. Make a backup of the Bugzilla database. THIS IS VERY IMPORTANT. If anything goes wrong during the upgrade, your installation can be corrupted beyond recovery. Having a backup keeps you safe. Warning Upgrading is a one-way process. You cannot "downgrade" an upgraded Bugzilla. If you wish to revert to the old Bugzilla version for any reason, you will have to restore your database from this backup. Here are some sample commands you could use to backup your database, depending on what database system you're using. You may have to modify these commands for your particular setup. MySQL: mysqldump --opt -u bugs -p bugs > bugs.sql PostgreSQL: pg_dump --no-privileges --no-owner -h localhost -U bugs > bugs.sql _________________________________________________________________ 2.7.2. Getting The New Bugzilla There are three ways to get the new version of Bugzilla. We'll list them here briefly and then explain them more later. CVS (Section 2.7.2.2) If have cvs installed on your machine and you have Internet access, this is the easiest way to upgrade, particularly if you have made modifications to the code or templates of Bugzilla. Download the tarball (Section 2.7.2.3) This is a very simple way to upgrade, and good if you haven't made many (or any) modifications to the code or templates of your Bugzilla. Patches (Section 2.7.2.4) If you have made modifications to your Bugzilla, and you don't have Internet access or you don't want to use cvs, then this is the best way to upgrade. You can only do minor upgrades (such as 3.0 to 3.0.1 or 3.0.1 to 3.0.2) with patches. _________________________________________________________________ 2.7.2.1. If you have modified your Bugzilla If you have modified the code or templates of your Bugzilla, then upgrading requires a bit more thought and effort. A discussion of the various methods of updating compared with degree and methods of local customization can be found in Section 6.2.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 3.0 to 3.0.1 should be fairly painless even if you are heavily customized, but going from 2.18 to 3.0 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. _________________________________________________________________ 2.7.2.2. Upgrading using CVS This requires that you have cvs installed (most Unix machines do), and requires that you are able to access cvs-mirror.mozilla.org on port 2401, which may not be an option if you are behind a highly restrictive firewall or don't have Internet access. 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_22_1 -dP P checksetup.pl P collectstats.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. _________________________________________________________________ 2.7.2.3. 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 http://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.22.1.tar. gz (Output omitted) bash$ tar xzvf bugzilla-2.22.1.tar.gz bugzilla-2.22.1/ bugzilla-2.22.1/.cvsignore (Output truncated) bash$ cd bugzilla-2.22.1 bash$ cp ../bugzilla/localconfig* . bash$ cp -r ../bugzilla/data . bash$ cd .. bash$ mv bugzilla bugzilla.old bash$ mv bugzilla-2.22.1 bugzilla Warning The cp commands both end with periods which is a very important detail--it means that the destination directory is the current working directory. This upgrade method will give you a clean install of Bugzilla. That's fine if you don't have any local customizations that you want to maintain. If you do have customizations, then you will need to reapply them by hand to the appropriate files. _________________________________________________________________ 2.7.2.4. Upgrading using patches A patch is a collection of all the bug fixes that have been made since the last bug-fix release. If you are doing a bug-fix upgrade—that is, one where only the last number of the revision changes, such as from 2.22 to 2.22.1—then you have the option of obtaining and applying a patch file from the Download Page. 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 http://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.22-to-2.2 2.1.diff.gz (Output omitted) bash$ gunzip bugzilla-2.22-to-2.22.1.diff.gz bash$ patch -p1 < bugzilla-2.22-to-2.22.1.diff patching file checksetup.pl patching file collectstats.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 2.7.2.2) in the future. _________________________________________________________________ 2.7.3. Completing Your Upgrade Now that you have the new Bugzilla code, there are a few final steps to complete your upgrade. 1. If your new Bugzilla installation is in a different directory or on a different machine than your old Bugzilla installation, make sure that you have copied the data directory and the localconfig file from your old Bugzilla installation. (If you followed the tarball instructions above, this has already happened.) 2. If this is a major update, check that the configuration (Section 2.2) for your new Bugzilla is up-to-date. Sometimes the configuration requirements change between major versions. 3. If you didn't do it as part of the above configuration step, now you need to run checksetup.pl, which will do everything required to convert your existing database and settings for the new version: bash$ cd /var/www/html/bugzilla bash$ ./checksetup.pl Warning The period at the beginning of the command ./checksetup.pl is important and can not be omitted. Caution If this is a major upgrade (say, 2.22 to 3.0 or similar), running checksetup.pl on a large installation (75,000 or more bugs) can take a long time, possibly several hours. 4. Clear any HTML or text that you put into the shutdownhtml parameter, to re-activate Bugzilla. 5. View the Sanity Check (Section 3.16) page in your upgraded Bugzilla. It is recommended that, if possible, you fix any problems you see, immediately. Failure to do this may mean that Bugzilla will not work correctly. Be aware that if the sanity check page contains more errors after an upgrade, it doesn't necessarily mean there are more errors in your database than there were before, as additional tests are added to the sanity check over time, and it is possible that those errors weren't being checked for in the old version. _________________________________________________________________ 2.7.4. Automatic Notifications of New Releases Bugzilla 3.0 introduced the ability to automatically notify administrators when new releases are available, based on the upgrade_notification parameter, see Section 3.1. Administrators will see these notifications when they access the index.cgi page, i.e. generally when logging in. Bugzilla will check once per day for new releases, unless the parameter is set to "disabled". If you are behind a proxy, you may have to set the proxy_url parameter accordingly. If the proxy requires authentication, use the http://user:pass@proxy_url/ syntax. _________________________________________________________________ Chapter 3. Administering Bugzilla 3.1. Bugzilla Configuration Bugzilla is configured by changing various parameters, accessed from the "Parameters" link in the Administration page (the Administration page can be found by clicking the "Administration" link in the footer). The parameters are divided into several categories, accessed via the menu on the left. Following is a description of the different categories and important parameters within those categories. _________________________________________________________________ 3.1.1. Required Settings The core required parameters for any Bugzilla installation are set here. These parameters must be set before a new Bugzilla installation can be used. Administrators should review this list before deploying a new Bugzilla installation. maintainer Email address of the person responsible for maintaining this Bugzilla installation. The address need not be that of a valid Bugzilla account. urlbase Defines the fully qualified domain name and web server path to this Bugzilla installation. For example, if the Bugzilla query page is http://www.foo.com/bugzilla/query.cgi, the "urlbase" should be set to http://www.foo.com/bugzilla/. docs_urlbase Defines path to the Bugzilla documentation. This can be a fully qualified domain name, or a path relative to "urlbase". For example, if the "Bugzilla Configuration" page of the documentation is http://www.foo.com/bugzilla/docs/html/parameters.html, set the "docs_urlbase" to http://www.foo.com/bugzilla/docs/html/. sslbase Defines the fully qualified domain name and web server path for HTTPS (SSL) connections to this Bugzilla installation. For example, if the Bugzilla main page is https://www.foo.com/bugzilla/index.cgi, the "sslbase" should be set to https://www.foo.com/bugzilla/. ssl Determines when Bugzilla will force HTTPS (SSL) connections, using the URL defined in sslbase. Options include "always", "never", and "authenticated sessions". cookiedomain Defines the domain for Bugzilla cookies. This is typically left blank. If there are multiple hostnames that point to the same webserver, which require the same cookie, then this parameter can be utilized. For example, If your website is at https://www.foo.com/, setting this to .foo.com/ will also allow bar.foo.com/ to access Bugzilla cookies. cookiepath Defines a path, relative to the web server root, that Bugzilla cookies will be restricted to. For example, if the urlbase is set to http://www.foo.com/bugzilla/, the cookiepath should be set to /bugzilla/. Setting it to "/" will allow all sites served by this web server or virtual host to read Bugzilla cookies. utf8 Determines whether to use UTF-8 (Unicode) encoding for all text in Bugzilla. New installations should set this to true to avoid character encoding problems. Existing databases should set this to true only after the data has been converted from existing legacy character encoding to UTF-8, using the contrib/recode.pl script. Note If you turn this parameter from "off" to "on", you must re-run checksetup.pl immediately afterward. shutdownhtml If there is any text in this field, this Bugzilla installation will be completely disabled and this text will appear instead of all Bugzilla pages for all users, including Admins. Used in the event of site maintenance or outage situations. 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). announcehtml Any text in this field will be displayed at the top of every HTML page in this Bugzilla installation. The text is not wrapped in any tags. For best results, wrap the text in a "
" tag. Any style attributes from the CSS can be applied. For example, to make the text green inside of a red box, add "id=message" to the "
" tag. proxy_url If this Bugzilla installation is behind a proxy, enter the proxy information here to enable Bugzilla to access the Internet. Bugzilla requires Internet access to utilize the upgrade_notification parameter (below). If the proxy requires authentication, use the syntax: http://user:pass@proxy_url/. upgrade_notification Enable or disable a notification on the homepage of this Bugzilla installation when a newer version of Bugzilla is available. This notification is only visible to administrators. Choose "disabled", to turn off the notification. Otherwise, choose which version of Bugzilla you want to be notified about: "development_snapshot" is the latest release on the trunk; "latest_stable_release" is the most recent release available on the most recent stable branch; "stable_branch_release" the most recent release on the branch this installation is based on. _________________________________________________________________ 3.1.2. Administrative Policies This page contains parameters for basic administrative functions. Options include whether to allow the deletion of bugs and users, and whether to allow users to change their email address. _________________________________________________________________ 3.1.3. User Authentication This page contains the settings that control how this Bugzilla installation will do its authentication. Choose what authentication mechanism to use (the Bugzilla database, or an external source such as LDAP), and set basic behavioral parameters. For example, choose whether to require users to login to browse bugs, the management of authentication cookies, and the regular expression used to validate email addresses. Some parameters are highlighted below. emailregexp Defines the regular expression used to validate email addresses used for login names. The default attempts to match fully qualified email addresses (i.e. 'user@example.com'). Some Bugzilla installations allow only local user names (i.e 'user' instead of 'user@example.com'). In that case, the emailsuffix parameter should be used to define the email domain. emailsuffix This string is appended to login names when actually sending email to a user. For example, If emailregexp has been set to allow local usernames, then this parameter would contain the email domain for all users (i.e. '@example.com'). _________________________________________________________________ 3.1.4. Attachments This page allows for setting restrictions and other parameters regarding attachments to bugs. For example, control size limitations and whether to allow pointing to external files via a URI. _________________________________________________________________ 3.1.5. Bug Change Policies Set policy on default behavior for bug change events. For example, choose which status to set a bug to when it is marked as a duplicate, and choose whether to allow bug reporters to set the priority or target milestone. Also allows for configuration of what changes should require the user to make a comment, described below. 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!) 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. _________________________________________________________________ 3.1.6. Bug Fields The parameters in this section determine the default settings of several Bugzilla fields for new bugs, and also control whether certain fields are used. For example, choose whether to use the "target milestone" field or the "status whiteboard" field. 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. _________________________________________________________________ 3.1.7. Bug Moving This page controls whether this Bugzilla installation allows certain users to move bugs to an external database. If bug moving is enabled, there are a number of parameters that control bug moving behaviors. For example, choose which users are allowed to move bugs, the location of the external database, and the default product and component that bugs moved from other bug databases to this Bugzilla installation are assigned to. _________________________________________________________________ 3.1.8. Dependency Graphs This page has one parameter that sets the location of a Web Dot server, or of the Web Dot binary on the local system, that is used to generate dependency graphs. Web Dot is a CGI program that creates images from .dot graphic description files. If no Web Dot server or binary is specified, then dependency graphs will be disabled. _________________________________________________________________ 3.1.9. Group Security Bugzilla allows for the creation of different groups, with the ability to restrict the visibility of bugs in a group to a set of specific users. Specific products can also be associated with groups, and users restricted to only see products in their groups. Several parameters are described in more detail below. Most of the configuration of groups and their relationship to products is done on the "Groups" and "Product" pages of the "Administration" area. The options on this page control global default behavior. For more information on Groups and Group Security, see Section 3.15 makeproductgroups Determines whether or not to automatically create groups when new products are created. If this is on, the groups will be used for querying bugs. 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. usevisibilitygroups If selected, user visibility will be restricted to members of groups, as selected in the group configuration settings. Each user-defined group can be allowed to see members of selected other groups. For details on configuring groups (including the visibility restrictions) see Section 3.15.2. querysharegroup The name of the group of users who are allowed to share saved searches with one another. For more information on using saved searches, see Saved Searches. _________________________________________________________________ 3.1.10. LDAP Authentication LDAP authentication is a module for Bugzilla's plugin authentication architecture. This page contains all the parameters necessary to configure Bugzilla for use with LDAP authentication. 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 that require a 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. Bugzilla tries to bind to LDAP using those credentials and, if successful, tries to map this account to a Bugzilla account. If an LDAP mail attribute is defined, the value of this attribute is used, otherwise the "emailsuffix" parameter is appended to LDAP username to form a full email address. If an account for this address already exists in the Bugzilla installation, 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. For example, bugs are still assigned by email address and users are still queried by email address. 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 If you want to list "LDAP" here, make sure to have set up the other parameters listed below. Unless you have other (working) authentication methods listed as well, you may otherwise not be able to log back in to Bugzilla once 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. For example: "ldap.company.com" or "ldap.company.com:3268" You can also specify a LDAP URI, so as to use other protocols, such as LDAPS or LDAPI. If port was not specified in the URI, the default is either 389 or 636 for 'LDAP' and 'LDAPS' schemes respectively. Tip In order to use SSL with LDAP, specify a URI with "ldaps://". This will force the use of SSL over port 636. For example, normal LDAP: "ldap://ldap.company.com", LDAP over SSL: "ldaps://ldap.company.com" or LDAP over a UNIX domain socket "ldapi://%2fvar%2flib%2fldap_sock". 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" _________________________________________________________________ 3.1.11. RADIUS Authentication RADIUS authentication is a module for Bugzilla's plugin authentication architecture. This page contains all the parameters necessary for configuring Bugzilla to use RADIUS authentication. Note Most caveats that apply to LDAP authentication apply to RADIUS authentication as well. See Section 3.1.10 for details. Parameters required to use RADIUS Authentication: user_verify_class If you want to list "RADIUS" here, make sure to have set up the other parameters listed below. Unless you have other (working) authentication methods listed as well, you may otherwise not be able to log back in to Bugzilla once you log out. If this happens to you, you will need to manually edit data/params and set user_verify_class to "DB". RADIUS_server This parameter should be set to the name (and optionally the port) of your RADIUS server. RADIUS_secret This parameter should be set to the RADIUS server's secret. RADIUS_email_suffix Bugzilla needs an e-mail address for each user account. Therefore, it needs to determine the e-mail address corresponding to a RADIUS user. Bugzilla offers only a simple way to do this: it can concatenate a suffix to the RADIUS user name to convert it into an e-mail address. You can specify this suffix in the RADIUS_email_suffix parameter. If this simple solution does not work for you, you'll probably need to modify Bugzilla/Auth/Verify/RADIUS.pm to match your requirements. _________________________________________________________________ 3.1.12. Email This page contains all of the parameters for configuring how Bugzilla deals with the email notifications it sends. See below for a summary of important options. 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. "Test" does not send mail, but instead saves it in data/mailer.testfile for later review. "None" disables email sending entirely. mailfrom This is the email address that will appear in the "From" field of all emails sent by this Bugzilla installation. Some email servers require mail to be from a valid email address, therefore it is recommended to choose a valid email address here. 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). 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). globalwatcher This allows you to define specific users who will receive notification each time a new bug in entered, or when an existing bug changes, according to the normal groupset permissions. It may be useful for sending notifications to a mailing-list, for instance. _________________________________________________________________ 3.1.13. Patch Viewer This page contains configuration parameters for the CVS server, Bonsai server and LXR server that Bugzilla will use to enable the features of the Patch Viewer. Bonsai is a tool that enables queries to a CVS tree. LXR is a tool that can cross reference and index source code. _________________________________________________________________ 3.1.14. Query Defaults This page controls the default behavior of Bugzilla in regards to several aspects of querying bugs. Options include what the default query options are, what the "My Bugs" page returns, whether users can freely add bugs to the quip list, and how many duplicate bugs are needed to add a bug to the "most frequently reported" list. _________________________________________________________________ 3.1.15. Shadow Database This page controls whether a shadow database is used, and all the parameters associated with the shadow database. Versions of Bugzilla prior to 3.2 used the MyISAM table type, which supports only table-level write locking. With MyISAM, any time someone is making a change to a bug, the entire table is locked until the write operation is complete. Locking for write also blocks reads until the write is complete. 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. Note As of version 3.2, Bugzilla no longer uses the MyISAM table type. Instead, InnoDB is used, which can do transaction-based locking. Therefore, the limitations the Shadow Database feature was designed to workaround no longer exist. _________________________________________________________________ 3.1.16. User Matching The settings on this page control how users are selected and queried when adding a user to a bug. For example, users need to be selected when choosing who the bug is assigned to, adding to the CC list or selecting a QA contact. With the "usemenuforusers" parameter, it is possible to configure Bugzilla to display a list of users in the fields instead of an empty text field. This should only be used in Bugzilla installations with a small number of users. If users are selected via a text box, this page also contains parameters for how user names can be queried and matched when entered. _________________________________________________________________ 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 will appear in the Administration page. The first screen is a search form to search for existing user accounts. You can run searches based either on the user ID, real name or login name (i.e. the email address, or just the first part of the email address if the "emailsuffix" parameter is set). The search can be conducted in different ways using 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. The search can be restricted to users who are in a specific group. By default, the restriction is turned off. The search returns a list of users matching your criteria. User properties can be edited by clicking the login name. The Account History of a user can be viewed by clicking the "View" link in the Account History column. The Account History displays changes that have been made to the user account, the time of the change and the user who made the change. For example, the Account History page will display details of when a user was added or removed from a group. _________________________________________________________________ 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. * Bugmail Disabled: Mark this checkbox to disable bugmail and whinemail completely for this account. This checkbox replaces the data/nomail file which existed in older versions of Bugzilla. * 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, simply check the "Bugmail Disabled" checkbox above. 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 typically represent real-world shipping products. Products can be given Classifications. For example, if a company makes computer games, they could have a classification of "Games", and a separate product for each game. This company might also have a "Common" product for units of technology used in multiple games, and perhaps a few special products that represent items that are not actually shipping products (for example, "Website", or "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. When creating or editing products the following options are available: Product The name of the product Description A brief description of the product URL describing milestones for this product If there is reference URL, provide it here Default milestone Select the default milestone for this product. Closed for bug entry Select this box to prevent new bugs from being entered against this product. Maximum votes per person Maximum votes a user is allowed to give for this product Maximum votes a person can put on a single bug Maximum votes a user is allowed to give for this product in a single bug Confirmation threshold Number of votes needed to automatically remove any bug against this product from the UNCONFIRMED state Version Specify which version of the product bugs will be entered against. Create chart datasets for this product Select to make chart datasets available for this product. When editing a product there is also a link to edit Group Access Controls, see Section 3.4.4. _________________________________________________________________ 3.4.1. Creating New Products To create a new product: 1. Select "Administration" from the footer and then choose "Products" from the main administration page. 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. 4. When the product is created, Bugzilla will give a message stating that a component must be created before any bugs can be entered against the new product. Follow the link to create a new component. See Components for more information. _________________________________________________________________ 3.4.2. Editing Products To edit an existing product, click the "Products" link from the "Administration" page. If the 'useclassification' parameter is turned on, a table of existing classifications is displayed, including an "Unclassified" category. The table indicates how many products are in each classification. Click on the classification name to see its products. If the 'useclassification' parameter is not in use, the table lists all products directly. The product table summarizes the information about the product defined when the product was created. Click on the product name to edit these properties, and to access links to other product attributes such as the product's components, versions, milestones, and group access controls. _________________________________________________________________ 3.4.3. Adding or Editing Components, Versions and Target Milestones To edit existing, or add new, Components, Versions or Target Milestones to a Product, select the "Edit Components", "Edit Versions" or "Edit Milestones" links from the "Edit Product" page. A table of existing Components, Versions or Milestones is displayed. Click on a item name to edit the properties of that item. Below the table is a link to add a new Component, Version or Milestone. For more information on components, see Components. For more information on versions, see Section 3.6. For more information on milestones, see Section 3.7. _________________________________________________________________ 3.4.4. Assigning Group Controls to Products On the "Edit Product" page, there is a link called "Edit Group Access Controls". The settings on this page control the relationship of the groups to the product being edited. Group Access Controls are an important aspect of using groups for isolating products and restricting access to bugs filed against those products. For more information on groups, including how to create, edit add users to, and alter permission of, see Section 3.15. After selecting the "Edit Group Access Controls" link from the "Edit Product" page, a table containing all user-defined groups for this Bugzilla installation is displayed. The system groups that are created when Bugzilla is installed are not applicable to Group Access Controls. Below is description of what each of these fields means. Groups may be applicable (e.g bugs in this product can be associated with this group) , default (e.g. bugs in this product are in this group by default), and mandatory (e.g. bugs in this product must be associated with this group) for each product. Groups can also control access to bugs for a given product, or be used to make bugs for a product totally read-only unless the group restrictions are met. The best way to understand these relationships is by example. See Section 3.4.4.1 for examples of product and group relationships. Note Products and Groups are not limited to a one-to-one relationship. Multiple groups can be associated with the same product, and groups can be associated with more than one product. If any group has Entry selected, then the product will restrict bug entry to only those users who are members of all the groups with Entry selected. If any group has Canedit selected, then the product will be read-only for any users who are not members of all of the groups with Canedit selected. Only users who are members of all the Canedit groups will be able to edit bugs for this product. This is an additional restriction that enables finer-grained control over products rather than just all-or-nothing access levels. The following settings let you choose privileges on a per-product basis. This is a convenient way to give privileges to some users for some products only, without having to give them global privileges which would affect all products. Any group having editcomponents selected allows users who are in this group to edit all aspects of this product, including components, milestones and versions. Any group having canconfirm selected allows users who are in this group to confirm bugs in this product. Any group having editbugs selected allows users who are in this group to edit all fields of bugs in this product. The MemberControl and OtherControl are used in tandem to determine which bugs will be placed in this group. The only allowable combinations of these two parameters are listed in a table on the "Edit Group Access Controls" page. Consult this table for details on how these fields can be used. Examples of different uses are described below. _________________________________________________________________ 3.4.4.1. Common Applications of Group Controls The use of groups is best explained by providing examples that illustrate configurations for common use cases. The examples follow a common syntax: Group: Entry, MemberControl, OtherControl, CanEdit, EditComponents, CanConfirm, EditBugs. Where "Group" is the name of the group being edited for this product. The other fields all correspond to the table on the "Edit Group Access Controls" page. If any of these options are not listed, it means they are not checked. Basic Product/Group Restriction Suppose there is a product called "Bar". The "Bar" product can only have bugs entered against it by users in the group "Foo". Additionally, bugs filed against product "Bar" must stay restricted to users to "Foo" at all times. Furthermore, only members of group "Foo" can edit bugs filed against product "Bar", even if other users could see the bug. This arrangement would achieved by the following: Product Bar: foo: ENTRY, MANDATORY/MANDATORY, CANEDIT Perhaps such strict restrictions are not needed for product "Bar". A more lenient way to configure product "Bar" and group "Foo" would be: Product Bar: foo: ENTRY, SHOWN/SHOWN, EDITCOMPONENTS, CANCONFIRM, EDITBUGS The above indicates that for product "Bar", members of group "Foo" can enter bugs. Any one with permission to edit a bug against product "Bar" can put the bug in group "Foo", even if they themselves are not in "Foo". Anyone in group "Foo" can edit all aspects of the components of product "Bar", can confirm bugs against product "Bar", and can edit all fields of any bug against product "Bar". General User Access With Security Group To permit any user to file bugs against "Product A", and to permit any user to submit those bugs into a group called "Security": Product A: security: SHOWN/SHOWN General User Access With A Security Product To permit any user to file bugs against product called "Security" while keeping those bugs from becoming visible to anyone outside the group "SecurityWorkers" (unless a member of the "SecurityWorkers" group removes that restriction): Product Security: securityworkers: DEFAULT/MANDATORY Product Isolation With a Common Group To permit users of "Product A" to access the bugs for "Product A", users of "Product B" to access the bugs for "Product B", and support staff, who are members of the "Support Group" to access both, three groups are needed: 1. Support Group: Contains members of the support staff. 2. AccessA Group: Contains users of product A and the Support group. 3. AccessB Group: Contains users of product B and the Support group. Once these three groups are defined, the product group controls can be set to: Product A: AccessA: ENTRY, MANDATORY/MANDATORY Product B: AccessB: ENTRY, MANDATORY/MANDATORY Perhaps the "Support Group" wants more control. For example, the "Support Group" could be permitted to make bugs inaccessible to users of both groups "AccessA" and "AccessB". Then, the "Support Group" could be permitted to publish bugs relevant to all users in a third product (let's call it "Product Common") that is read-only to anyone outside the "Support Group". In this way the "Support Group" could control bugs that should be seen by both groups. That configuration would 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 Make a Product Read Only Sometimes a product is retired and should no longer have new bugs filed against it (for example, an older version of a software product that is no longer supported). A product can be made read-only by creating a group called "readonly" and adding products to the group as needed: Product A: ReadOnly: ENTRY, NA/NA, CANEDIT Note For more information on Groups outside of how they relate to products see Section 3.15. _________________________________________________________________ 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", "Default CC List" and "Default QA Contact" (if enabled). The "Component Description" field may contain a limited subset of HTML tags. The "Default Assignee" field must be a login name already existing in the Bugzilla 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