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, “OS-Specific Installation Notes” 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.
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:
Installed Version Test:
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.org. Although Bugzilla runs with Perl 5.8.1, it's a good idea to be using the latest stable version.
Bugzilla supports MySQL, PostgreSQL and Oracle as database servers. You only require one of these systems to make use of Bugzilla.
Installed Version Test:
If you don't have it and your OS doesn't provide official packages, visit http://www.mysql.com. You need MySQL version 5.0.15 or higher.
Many of the binary
versions of MySQL store their data files in
If you install from something other than a packaging/installation system, such as .rpm (RPM Package Manager), .deb (Debian Package), .exe (Windows Executable), or .msi (Windows Installer), make sure the MySQL server is started when the machine boots.
Installed Version Test:
If you don't have it and your OS doesn't provide official packages, visit http://www.postgresql.org/. You need PostgreSQL version 8.03.0000 or higher.
If you install from something other than a packaging/installation system, such as .rpm (RPM Package Manager), .deb (Debian Package), .exe (Windows Executable), or .msi (Windows Installer), make sure the PostgreSQL server is started when the machine boots.
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 (RPM Package Manager), .deb (Debian Package), .exe (Windows Executable), or .msi (Windows Installer), make sure the Oracle server is started when the machine boots.
Installed Version Test: view the default welcome page at http://<your-machine>/
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/.
Download a Bugzilla tarball
(or check it out from Bzr)
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
/usr/local with a symbolic link to the web server's
document directories or an alias in the web server's configuration.
The default Bugzilla distribution is NOT designed to be placed
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
script, which locks down your installation.
Bugzilla's installation process is based
on a script called
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, “Configuration”.
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:
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.
The preferred way to install missing Perl modules is to use the package
manager provided by your operating system (e.g “rpm” or
“yum” on Linux distros, or “ppm” on Windows
if using ActivePerl, see Section 18.104.22.168, “Perl Modules on Win32”).
If some Perl modules are still missing or are too old, then we recommend
install-module.pl script (doesn't work
with ActivePerl on Windows). If for some reason you really need to
install the Perl modules manually, see
Appendix C, Manual Installation of Perl Modules. For instance, on Unix,
install-module.pl as follows:
bash#perl install-module.pl <modulename>
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.
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
Here is a complete list of modules and their minimum versions. Some modules have special installation notes, which follow.
Required Perl modules:
DBD::mysql (4.001) if using MySQL
DBD::Pg (2.7.0) if using PostgreSQL
DBD::Oracle (1.19) if using Oracle
Optional Perl modules:
GD (1.20) for bug charting
Template::Plugin::GD::Image (any) for Graphical Reports
Chart::Lines (2.1.0) for bug charting
GD::Graph (any) for bug charting
GD::Text (any) for bug charting
XML::Twig (any) for bug import/export
MIME::Parser (5.406) for bug import/export
LWP::UserAgent (any) for Automatic Update Notifications
PatchReader (0.9.6) for pretty HTML view of patches
Net::LDAP (any) for LDAP Authentication
Authen::SASL (any) for SASL Authentication
Authen::Radius (any) for RADIUS Authentication
SOAP::Lite (0.712) for the web service interface
JSON::RPC (any) for the JSON-RPC interface
Test::Taint (any) for the web service interface
HTML::Parser (3.40) for More HTML in Product/Group Descriptions
HTML::Scrubber (any) for More HTML in Product/Group Descriptions
Email::Reply (any) for Inbound Email
TheSchwartz (1.07) for Mail Queueing
Daemon::Generic (any) for Mail Queueing
mod_perl2 (1.999022) for mod_perl
Bugzilla is dependent on the availability of an e-mail system for its user authentication and for other tasks.
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, “Bugzilla Configuration”.
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.
It is now possible to run the Bugzilla software under
mod_perl has some additional requirements to that of running
mod_cgi (the standard and previous way).
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.