# Installation

## Step-by-step Install

### Introduction

Bugzilla has been successfully installed under Solaris, Linux, and Win32. Win32 is not yet officially supported, but many people have got it working fine. Please see the for further advice on getting Bugzilla to work on Microsoft Windows.

### Package List

If you are running the very most recent version of Perl and MySQL (both the executables and development libraries) on your system, you can skip these manual installation steps for the Perl modules by using Bundle::Bugzilla; see .

The software packages necessary for the proper running of Bugzilla (with download links) are:

1. MySQL database server (3.22.5 or greater)

2. Perl (5.005 or greater, 5.6.1 is recommended if you wish to use Bundle::Bugzilla)

3. Perl Modules (minimum version):

   1. Template (v2.07)

   2. AppConfig (v1.52)

   3. Text::Wrap (v2001.0131)

   4. File::Spec (v0.8.2)

   5. Data::Dumper (any)

   6. DBD::mysql (v1.2209)

   7. DBI (v1.13)

   8. Date::Parse (any)

   9. CGI::Carp (any)

   and, optionally:

   1. GD (v1.19) for bug charting

   2. Chart::Base (v0.99c) for bug charting

   3. XML::Parser (any) for the XML interface

   4. MIME::Parser (any) for the email interface

4. The web server of your choice. Apache is highly recommended.

5. At least version 8.7 of Sendmail, or any Sendmail-compatible MTA congruent with this version or higher.

   Windows users will have to see the for one alternative to Sendmail for Windows.

It is a good idea, while installing Bugzilla, to ensure that there is some kind of firewall between you and the rest of the Internet, because your machine may be insecure for periods during the install. Many installation steps require an active Internet connection to complete, but you must take care to ensure that at no point is your machine vulnerable to an attack.

Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the `urpmi`

utility. If you follow these commands, you should have everything you need for Bugzilla, and `checksetup.pl`

should not complain about any missing libraries. You may already have some of these installed.

- bash#

  `urpmi perl-mysql`
- bash#

  `urpmi perl-chart`
- bash#

  `urpmi perl-gd`
- bash#

  `urpmi perl-MailTools`

  (for Bugzilla email integration)
- bash#

  `urpmi apache-modules`

### MySQL

Visit the MySQL homepage at www.mysql.com to grab and install the latest stable release of MySQL.

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. You can set the data directory as an option to `configure` if you build MySQL from source yourself.

If you install from something other than an RPM or Debian package, you will need to add `mysqld` to your init scripts so the server daemon will come back up whenever your machine reboots. Further discussion of UNIX init sequences are beyond the scope of this guide.

By default, MySQL will only accept packets up to 64Kb in size. If you want to have attachments larger than this, you will need to modify your `/etc/my.cnf` as below.

If you are using MySQL 4.0 or newer, enter:

      [mysqld]
      # Allow packets up to 1M
      max_allowed_packet=1M

If you are using an older version of MySQL, enter:

      [mysqld]
      # Allow packets up to 1M
      set-variable = max_allowed_packet=1M

There is also a parameter in Bugzilla called 'maxattachmentsize' (default = 1000 Kb) that controls the maximum allowable attachment size. Attachments larger than either the 'max_allowed_packet' or 'maxattachmentsize' value will not be accepted by Bugzilla.

If you plan on running Bugzilla and MySQL on the same machine, consider using the `--skip-networking` option in the init script. This enhances security by preventing network access to MySQL.

### Perl

Any machine that doesn't have Perl on it is a sad machine indeed. Perl can be got in source form from perl.com for the rare *nix systems which don't have it. Although Bugzilla runs with all post-5.005 versions of Perl, it's a good idea to be up to the very latest version if you can when running Bugzilla. As of this writing, that is Perl version &perl-ver;.

You can skip the following Perl module installation steps by installing Bundle::Bugzilla

from CPAN, which installs all required modules for you.

`bash# `perl -MCPAN -e 'install "Bundle::Bugzilla"'``

Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser, which are not essential to a basic Bugzilla install. If installing this bundle fails, you should install each module individually to isolate the problem.

### Perl Modules

All Perl modules can be found on the Comprehensive Perl Archive Network (CPAN). The CPAN servers have a real tendency to bog down, so please use mirrors.

Quality, general Perl module installation instructions can be found on the CPAN website, but the easy thing to do is to just use the CPAN shell which does all the hard work for you. To use the CPAN shell to install a module:

`bash# `perl -MCPAN -e 'install "<modulename>"'``

To do it the hard way:

Untar the module tarball -- it should create its own directory

CD to the directory just created, and enter the following commands:

1. `bash# `perl Makefile.PL``

2. `bash# `make``

3. `bash# `make test``

4. `bash# `make install``

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.

#### DBI

The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done correctly the DBI module should be a breeze. It's a mixed Perl/C module, but Perl's MakeMaker system simplifies the C compilation greatly.

#### Data::Dumper

The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later sub-releases of Perl 5.004, but a re-installation just to be sure it's available won't hurt anything.

#### MySQL-related modules

The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the Msql-Mysql-modules package.

The MakeMaker process will ask you a few questions about the desired compilation target and your MySQL installation. For most of the questions the provided default will be adequate, but when asked if your desired target is the MySQL or mSQL packages, you should select the MySQL related ones. Later you will be asked if you wish to provide backwards compatibility with the older MySQL packages; you should answer YES to this question. The default is NO.

A host of 'localhost' should be fine and a testing user of 'test' with a null password should find itself with sufficient access to run tests on the 'test' database which MySQL created upon installation.

#### TimeDate modules

Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This bundle is stored on the CPAN under the name TimeDate. The component module we're most interested in is the Date::Format module, but installing all of them is probably a good idea anyway.

#### GD (optional)

The GD library was written by Thomas Boutell a long while ago to programatically generate images in C. Since then it's become the defacto standard for programatic image construction. The Perl bindings to it found in the GD library are used on millions of web pages to generate graphs on the fly. That's what Bugzilla will be using it for so you must install it if you want any of the graphing to work.

The Perl GD library requires some other libraries that may or may not be installed on your system, including `libpng` and `libgd`. The full requirements are listed in the Perl GD library README. If compiling GD fails, it's probably because you're missing a required library.

#### Chart::Base (optional)

The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched from CPAN. Note that earlier versions that 0.99c used GIFs, which are no longer supported by the latest versions of GD.

#### Template Toolkit

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

### HTTP Server

You have a freedom of choice here - Apache, Netscape or any other server on UNIX would do. You can run the web server on a different machine than MySQL, but need to adjust the MySQL bugs user permissions accordingly.

We strongly recommend Apache as the web server to use. The Bugzilla Guide installation instructions, in general, assume you are using Apache. If you have got Bugzilla working using another webserver, please share your experiences with us.

You'll want to make sure that your web server will run any file with the .cgi extension as a CGI and not just display it. If you're using Apache that means uncommenting the following line in the httpd.conf file:

    AddHandler cgi-script .cgi

With Apache you'll also want to make sure that within the httpd.conf file the line:

    Options ExecCGI
    AllowOverride Limit

is in the stanza that covers the directories into which you intend to put the bugzilla .html and .cgi files.

AllowOverride Limit allows the use of a Deny statement in the .htaccess file generated by checksetup.pl

Users of older versions of Apache may find the above lines in the srm.conf and access.conf files, respecitvely.

There are important files and directories that should not be a served by the HTTP server - most files in the data and shadow directories and the localconfig file. You should configure your HTTP server to not serve these files. Failure to do so will expose critical passwords and other data. Please see for details on how to do this for Apache; the checksetup.pl script should create appropriate .htaccess files for you.

### Bugzilla

You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably nobody). You may decide to put the files in the main web space for your web server or perhaps in `/usr/local` with a symbolic link in the web space that points to the Bugzilla directory.

If you symlink the bugzilla directory into your Apache's HTML heirarchy, you may receive Forbidden errors unless you add the FollowSymLinks directive to the <Directory> entry for the HTML root in httpd.conf.

Once all the files are in a web accessible directory, make that directory writable by your webserver's user. This is a temporary step until you run the post-install `checksetup.pl` script, which locks down your installation.

Lastly, you'll need to set up a symbolic link to `/usr/bonsaitools/bin/perl` for the correct location of your Perl executable (probably `/usr/bin/perl`). Otherwise you must hack all the .cgi files to change where they look for Perl. This can be done using the following Perl one-liner, but I suggest using the symlink approach to avoid upgrade hassles.

    perl -pi -e
            's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
            processmail syncshadowdb

Change `/usr/bin/perl` to match the location of Perl on your machine.

### Setting Up the MySQL Database

After you've gotten all the software installed and working you're ready to start preparing the database for its life as the back end to a high quality bug tracker.

First, you'll want to fix MySQL permissions to allow access from Bugzilla. For the purpose of this Installation section, the Bugzilla username will be bugs, and will have minimal permissions.

Begin by giving the MySQL root user a password. MySQL passwords are limited to 16 characters.

- `bash# `mysql -u root mysql``
- `mysql> `UPDATE user SET Password=PASSWORD('<new_password>') WHERE user='root';``
- `mysql> `FLUSH PRIVILEGES;``

From this point on, if you need to access MySQL as the MySQL root user, you will need to use `mysql -u root -p`

and enter <new_password>. Remember that MySQL user names have nothing to do with Unix user names (login names).

Next, we use an SQL `GRANT` command to create a bugs

user, and grant sufficient permissions for checksetup.pl, which we'll use later, to work its magic. This also restricts the bugs user to operations within a database called bugs, and only allows the account to connect from localhost. Modify it to reflect your setup if you will be connecting from another machine or as a different user.

Remember to set <bugs_password> to some unique password.

If you are using MySQL 4.0 or newer, 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;

If you are using an older version of MySQL, the `LOCK TABLES` and `CREATE TEMPORARY TABLES` permissions will be unavailable and should be removed from the permissions list. In this case, the following command line can be used:

      mysql> GRANT SELECT, INSERT,
             UPDATE, DELETE, INDEX, ALTER, CREATE, DROP,
             REFERENCES ON bugs.* TO bugs@localhost IDENTIFIED BY
             '$db_pass';
        mysql> FLUSH PRIVILEGES;

### `checksetup.pl`

Next, run the magic checksetup.pl script. (Many thanks to Holger Schurig for writing this script!) This script is designed to make sure your MySQL database and other configuration options are consistent with the Bugzilla CGI files. It will make sure Bugzilla files and directories have reasonable permissions, set up the `data` directory, and create all the MySQL tables.

- `bash# `./checksetup.pl``

The first time you run it, it will create a file called `localconfig`.

This file contains a variety of settings you may need to tweak including how Bugzilla should connect to the MySQL database.

The connection settings include:

1. server's host: just use localhost if the MySQL server is local

2. database name: bugs if you're following these directions

3. MySQL username: bugs if you're following these directions

4. Password for the bugs MySQL account; (<bugs_password>) above

Once you are happy with the settings, `su` to the user your web server runs as, and re-run `checksetup.pl`. (Note: on some security-conscious systems, you may need to change the login shell for the webserver account before you can do this.) On this second run, it will create the database and an administrator account for which you will be prompted to provide information.

The checksetup.pl script is designed so that you can run it at any time without causing harm. You should run it after any upgrade to Bugzilla.

### Mail Transfer Agent (MTA)

Bugzilla is dependent on the availability of an e-mail system for its user authentication and for other tasks.

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 that Bugzilla will not distinguish between them.

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.

### Configuring Bugzilla

You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. They key parameters are documented in .

## Optional Additional Configuration

### Dependency Charts

As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. Exactly how this works is controlled by the 'webdotbase' parameter, which can have one of three values:

1. A complete file path to the command 'dot' (part of GraphViz) will generate the graphs locally

2. A URL prefix pointing to an installation of the webdot package will generate the graphs remotely

3. A blank value will disable dependency graphing.

So, to get this working, install GraphViz. If you do that, you need to enable server-side image maps in Apache. Alternatively, you could set up a webdot server, or use the AT&T public webdot server (the default for the webdotbase param). Note that AT&T's server won't work if Bugzilla is only accessible using HTTPS.

### Bug Graphs

As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs.

Add a cron entry like this to run `collectstats.pl` daily at 5 after midnight:

- `bash# `crontab -e``
- `5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl`

After two days have passed you'll be able to view bug graphs from the Bug Reports page.

### The Whining Cron

By now you have a fully functional Bugzilla, but what good are bugs if they're not annoying? To help make those bugs more annoying you can set up Bugzilla's automatic whining system to complain at engineers which leave their bugs in the NEW state without triaging them.

This can be done by adding the following command as a daily crontab entry (for help on that see that crontab man page):

- ``cd <your-bugzilla-directory> ; ./whineatnews.pl``

Depending on your system, crontab may have several manpages. The following command should lead you to the most useful page for this purpose:

    man 5 crontab

### LDAP Authentication

This information on using the LDAP authentication options with Bugzilla is old, and the authors do not know of anyone who has tested it. Approach with caution.

The existing authentication scheme for Bugzilla uses email addresses as the primary user ID, and a password to authenticate that user. All places within Bugzilla where you need to deal with user ID (e.g assigning a bug) use the email address. The LDAP authentication builds on top of this scheme, rather than replacing it. The initial log in is done with a username and password for the LDAP directory. This then fetches the email address from LDAP and authenticates seamlessly in the standard Bugzilla authentication scheme using this email address. If an account for this address already exists in your Bugzilla system, it will log in to that account. If no account for that email address exists, one is created at the time of login. (In this case, Bugzilla will attempt to use the "displayName" or "cn" attribute to determine the user's full name.) After authentication, all other user-related tasks are still handled by email address, not LDAP username. You still assign bugs by email address, query on users by email address, etc.

Using LDAP for Bugzilla authentication requires the Mozilla::LDAP (aka PerLDAP) Perl module. The Mozilla::LDAP module in turn requires Netscape's Directory SDK for C. After you have installed the SDK, then install the PerLDAP module. Mozilla::LDAP and the Directory SDK for C are both available for download from mozilla.org.

Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP directory for authentication. Be very careful when setting up this parameter; if you set LDAP authentication, but do not have a valid LDAP directory set up, you will not be able to log back in to Bugzilla once you log out. (If this happens, you can get back in by manually editing the data/params file, and setting useLDAP back to 0.)

If using LDAP, you must set the three additional parameters: Set LDAPserver to the name (and optionally port) of your LDAP server. If no port is specified, it defaults to the default port of 389. (e.g "ldap.mycompany.com" or "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids must be unique under the DN specified here. Set LDAPmailattribute to the name of the attribute in your LDAP directory which contains the primary email address. On most directory servers available, this is "mail", but you may need to change this.

### Preventing untrusted Bugzilla content from executing malicious Javascript code

It is possible for a Bugzilla to execute malicious Javascript code. Due to internationalization concerns, we are unable to incorporate the code changes necessary to fulfill the CERT advisory requirements mentioned in http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience. As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it.

    bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl

All this one-liner command does is search for all instances of Content-type: text/html

and replaces it with Content-Type: text/html; charset=ISO-8859-1

. This specification prevents possible Javascript attacks on the browser, and is suggested for all English-speaking sites. For non-English-speaking Bugzilla sites, I suggest changing ISO-8859-1, above, to UTF-8.

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

### `.htaccess` files and security

To enhance the security of your Bugzilla installation, Bugzilla's `checksetup.pl` script will generate `.htaccess`

files which the Apache webserver can use to restrict access to the bugzilla data files. These .htaccess files will not work with Apache 1.2.x - but this has security holes, so you shouldn't be using it anyway.

If you are using an alternate provider of webdot

services for graphing (as described when viewing `editparams.cgi`

in your web browser), you will need to change the ip address in `data/webdot/.htaccess`

to the ip address of the webdot server that you are using.

The default .htaccess file may not provide adequate access restrictions, depending on your web server configuration. Be sure to check the <Directory> entries for your Bugzilla directory so that the `.htaccess`

file is allowed to override web server defaults. For instance, let's assume your installation of Bugzilla is installed to `/usr/local/bugzilla`

. You should have this <Directory> entry in your `httpd.conf`

file:

      <Directory /usr/local/bugzilla/>
      Options +FollowSymLinks +Indexes +Includes +ExecCGI
      AllowOverride All
    </Directory>

The important part above is AllowOverride All

. Without that, the `.htaccess`

file created by `checksetup.pl`

will not have sufficient permissions to protect your Bugzilla installation.

If you are using Internet Information Server (IIS) or another web server which does not observe `.htaccess` conventions, you can disable their creation by editing `localconfig` and setting the `$create_htaccess` variable to `0`.

### `mod_throttle` and Security

It is possible for a user, by mistake or on purpose, to access the database many times in a row which can result in very slow access speeds for other users. If your Bugzilla installation is experiencing this problem , you may install the Apache module `mod_throttle`

which can limit connections by ip-address. You may download this module at Follow the instructions to install into your Apache install. This module only functions with the Apache web server! You may use the `ThrottleClientIP`

command provided by this module to accomplish this goal. See the Module Instructions for more information.

## Win32 Installation Notes

This section covers installation on Microsoft Windows. Bugzilla has been made to work on Win32 platforms, but the Bugzilla team wish to emphasise that The easiest way to install Bugzilla on Intel-archiecture machines is to install some variant of GNU/Linux, then follow the UNIX installation instructions in this Guide. If you have any influence in the platform choice for running this system, please choose GNU/Linux instead of Microsoft Windows.

After that warning, here's the situation for 2.16 and Windows. It doesn't work at all out of the box. You are almost certainly better off getting the 2.17 version from CVS (after consultation with the Bugzilla Team to make sure you are pulling on a stable day) because we'll be doing a load of work to make the Win32 experience more pleasant than it is now.

If you still want to try this, to have any hope of getting it to work, you'll need to apply the mail patch from bug 124174. After that, you'll need to read the (outdated) installation instructions below, some (probably a lot better) more recent ones kindly provided by Toms Baugis and Jean-Sebastien Guay, and also check the Bugzilla 2.16 Win32 update page . If we get time, we'll write some better installation instructions for 2.16 and put them up there. But no promises.

### Win32 Installation: Step-by-step

You should be familiar with, and cross-reference, the rest of the

section while performing your Win32 installation.

Making Bugzilla work on Microsoft Windows is no picnic. Support for Win32 has improved dramatically in the last few releases, but, if you choose to proceed, you should be a very

skilled Windows Systems Administrator with strong troubleshooting abilities, a high tolerance for pain, and moderate perl skills. Bugzilla on NT requires hacking source code and implementing some advanced utilities. What follows is the recommended installation procedure for Win32; additional suggestions are provided in

.

1. Install Apache Web Server

   for Windows, and copy the Bugzilla files somewhere Apache can serve them. Please follow all the instructions referenced in

   regarding your Apache configuration, particularly instructions regarding the AddHandler

   parameter and ExecCGI

   .

   You may also use Internet Information Server or Personal Web Server for this purpose. However, setup is quite different. If ActivePerl doesn't seem to handle your file associations correctly (for .cgi and .pl files), please consult

   .

   If you are going to use IIS, if on Windows NT you must be updated to at least Service Pack 4. Windows 2000 ships with a sufficient version of IIS.

2. Install ActivePerl

   for Windows. Check http://aspn.activestate.com/ASPN/Downloads/ActivePerl

   for a current compiled binary.

   Please also check the following links to fully understand the status of ActivePerl on Win32: Perl Porting

   , and Perl on Win32 FAQ

3. Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD, AppConfig, and Template. You may need to extract them from .zip format using Winzip or other unzip program first. Most of these additional ppm modules can be downloaded from ActiveState, but AppConfig and Template should be obtained from OpenInteract using the instructions on the Template Toolkit web site

   .

   You can find a list of modules at http://www.activestate.com/PPMPackages/zips/5xx-builds-only/

   or http://www.activestate.com/PPMPackages/5.6plus

   The syntax for ppm is: `C:> `ppm install <modulename>``

   #### Installing ActivePerl ppd Modules on Microsoft Windows

       ppm repository add oi http://openinteract.sourceforge.net/ppmpackages
       ppm install DBD-mysql
       ppm install Template-Toolkit
       ppm install TimeDate

   Watch your capitalization!

   ActiveState's 5.6Plus directory also contains an AppConfig ppm, so you might see the following error when trying to install the version at OpenInteract:

   `Error installing package 'AppConfig': Read a PPD for 'AppConfig', but it is not intended for this build of Perl (MSWin32-x86-multi-thread)`

   If so, download both the tarball

   and the ppd

   directly from OpenInteract, then run ppm from within the same directory to which you downloaded those files and install the package by referencing the ppd file explicitly via in the install command, f.e.:

   #### Installing OpenInteract ppd Modules manually on Microsoft Windows

   ``install `C:\AppConfig.ppd```

4. Install MySQL for NT.

   You can download MySQL for Windows NT from MySQL.com

   . Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.

5. Setup MySQL

   1. `C:> `C:\mysql\bin\mysql -u root mysql``

   2. `mysql> `DELETE FROM user WHERE Host='localhost' AND User='';``

   3. `mysql> `UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root';``

      new_password

      , above, indicates whatever password you wish to use for your root

      user.

   4. `mysql> `GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost IDENTIFIED BY 'bugs_password';``

      bugs_password

      , above, indicates whatever password you wish to use for your bugs

      user.

   5. `mysql> `FLUSH PRIVILEGES;``

   6. `mysql> `create database bugs;``

   7. `mysql> `exit;``

   8. `C:> `C:\mysql\bin\mysqladmin -u root -p reload``

6. Edit `checksetup.pl`

   in your Bugzilla directory. Change this line:

       my $webservergid =
                   getgrnam($my_webservergroup);

   to

       my $webservergid =
                 $my_webservergroup;

   or the name of the group you wish to own the files explicitly:

       my $webservergid =
                 'Administrators'

7. Run `checksetup.pl`

   from the Bugzilla directory.

8. Edit `localconfig`

   to suit your requirements. Set `$db_pass`

   to your bugs_password

   from

   , and `$webservergroup`

   to 8

   .

   Not sure on the 8

   for `$webservergroup`

   above. If it's wrong, please send corrections.

9. Edit `defparams.pl`

   to suit your requirements. Particularly, set `DefParam("maintainer")`

   and `DefParam("urlbase") to match your install.`

   This is yet another step I'm not sure of, since the maintainer of this documentation does not maintain Bugzilla on NT. If you can confirm or deny that this step is required, please let me know.

10. There are several alternatives to Sendmail that will work on Win32. The one mentioned here is a suggestion

    , not a requirement. Some other mail packages that can work include BLAT

    , Windmail

    , Mercury Sendmail

    , and the CPAN Net::SMTP Perl module (available in .ppm). Every option requires some hacking of the Perl scripts for Bugzilla to make it work. The option here simply requires the least.

    1. Download NTsendmail, available from www.ntsendmail.com

       . You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)

    2. Put ntsendmail.pm into your .\perl\lib directory.

    3. Add to globals.pl:

           # these settings configure the NTsendmail
                         process use NTsendmail;
                         $ENV{"NTsendmail"}="your.smtpserver.box";
                         $ENV{"NTsendmail_debug"}=1;
                         $ENV{"NTsendmail_max_tries"}=5;

       Some mention to also edit `$db_pass`

       in `globals.pl`

       to be your bugs_password

       . Although this may get you around some problem authenticating to your database, since globals.pl is not normally restricted by `.htaccess`

       , your database password is exposed to whoever uses your web server.

    4. Find and comment out all occurences of `open(SENDMAIL`

       in your Bugzilla directory. Then replace them with:

           # new sendmail functionality my $mail=new
                         NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
                         $to=$login; my $subject=$urlbase;
                         $mail->send($from,$to,$subject,$msg);

       Some have found success using the commercial product, Windmail

       . You could try replacing your sendmail calls with:

           open SENDMAIL,
                           "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
                           mail.log";

       or something to that effect.

11. Change all references in all files from `processmail`

    to `processmail.pl`

    , and rename `processmail`

    to `processmail.pl`

    .

    Many think this may be a change we want to make for main-tree Bugzilla. It's painless for the UNIX folks, and will make the Win32 people happier.

    Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.

        my $smtp = Net::SMTP->new('<Name of your SMTP server>');   #connect to SMTP server
        $smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
        $smtp->to($tolist); # recipient's address
        $smtp->data();  # Start the mail
        $smtp->datasend($msg);
        $smtp->dataend();   # Finish sending the mail
        $smtp->quit;    # Close the SMTP connection
        $logstr = "$logstr; mail sent to $tolist $cclist";
        }

    here is a test mail program for Net::SMTP:

        use Net::SMTP;
         my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
        => 1, ); # connect to SMTP server
                         $smtp->auth;
                        $smtp->mail('you@yourcompany.com');# use the sender's adress
        here
                        $smtp->to('someotherAddress@someotherdomain.com'); #
        recipient's address
                        $smtp->data();  # Start the mail
                        $smtp->datasend('test');
                        $smtp->dataend();   # Finish sending the mail
                        $smtp->quit;    # Close the SMTP connection
        exit;

12. This step is optional if you are using IIS or another web server which only decides on an interpreter based upon the file extension (.pl), rather than the shebang

    line (#/usr/bonsaitools/bin/perl)

    Modify the path to perl on the first line (#!) of all files to point to your Perl installation, and add perl

    to the beginning of all Perl system calls that use a perl script as an argument. This may take you a while. There is a setperl.csh

    utility to speed part of this procedure, available in the

    section of The Bugzilla Guide. However, it requires the Cygwin GNU-compatible environment for Win32 be set up in order to work. See http://www.cygwin.com/

    for details on obtaining Cygwin.

13. Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. You should specify the full path to perl for each system() call. For instance, change this line in processmail:

        system ("./processmail",@ARGLIST);
                </programlisting> to
                <programlisting>
        system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);

14. Add `binmode()`

    calls so attachments will work ( bug 62000

    ).

    Because Microsoft Windows based systems handle binary files different than Unix based systems, you need to add the following lines to `createattachment.cgi`

    and `showattachment.cgi`

    before the `require 'CGI.pl';`

    line.

        binmode(STDIN);
        binmode(STDOUT);

    According to bug 62000

    , the perl documentation says that you should always use `binmode()`

    when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than arbitrarily putting

    `binmode()`

    at the beginning of the attachment files, there should be logic to determine if `binmode()`

    is needed or not.

If you are using IIS or Personal Web Server, you must add cgi relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as:

    .cgi to: <perl install directory>\perl.exe %s
            %s .pl to: <perl install directory>\perl.exe %s %s
            GET,HEAD,POST

Change the path to Perl to match your install, of course.

### Additional Windows Tips

From Andrew Pearson:

> You can make Bugzilla work with Personal Web Server for Windows 98 and higher, as well as for IIS 4.0. Microsoft has information available at http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP

> Basically you need to add two String Keys in the registry at the following location:

>                 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap

> The keys should be called ".pl" and ".cgi", and both should have a value something like: `c:/perl/bin/perl.exe "%s" "%s"`

> The KB article only talks about .pl, but it goes into more detail and provides a perl test script.

If attempting to run Bugzilla 2.12 or older, you will need to remove encrypt() calls from the Perl source. This is not necessary

for Bugzilla 2.13 and later, which includes the current release, Bugzilla &bz-ver;.

#### Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier

Replace this:

    SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
              ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
              $enteredcryptpwd = FetchOneColumn();

with this:

    my $enteredcryptpwd = $enteredpwd

in cgi.pl.

## Mac OS X Installation Notes

There are a lot of common libraries and utilities out there that Apple did not include with Mac OS X, but which run perfectly well on it. The GD library, which Bugzilla needs to do bug graphs, is one of these.

The easiest way to get a lot of these is with a program called Fink, which is similar in nature to the CPAN installer, but installs common GNU utilities. Fink is available from <http://sourceforge.net/projects/fink/>.

Follow the instructions for setting up Fink. Once it's installed, you'll want to run the following as root: `fink install gd`

It will prompt you for a number of dependencies, type 'y' and hit enter to install all of the dependencies. Then watch it work.

To prevent creating conflicts with the software that Apple installs by default, Fink creates its own directory tree at /sw where it installs most of the software that it installs. This means your libraries and headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib and /usr/local/include. Because of these changed locations for the libraries, the Perl GD module will not install directly via CPAN, because it looks for the specific paths instead of getting them from your environment. But there's a way around that :-)

Instead of typing install GD at the cpan> prompt, type `look GD`. This should go through the motions of downloading the latest version of the GD module, then it will open a shell and drop you into the build directory. Apply this patch to the Makefile.PL file (save the patch into a file and use the command `patch < patchfile`.)

Then, run these commands to finish the installation of the GD module:

- `perl Makefile.PL`
- `make`
- `make test`
- `make install`
- And don't forget to run `exit`

  to get back to CPAN.

## UNIX (non-root) Installation Notes

### 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 first to get an idea on the installation steps required. (These notes will reference to steps in that guide.)

### 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.

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 adminstrator 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.

#### Running MySQL as Non-Root

##### 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

##### 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.

##### 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.)

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.

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!

### Perl

On the extremely rare chance that you don't have Perl on the machine, you will have to build the sources yourself. The following commands should get your system installed with your own personal version of Perl:

            bash$
            wget http://perl.com/CPAN/src/stable.tar.gz
            bash$
            tar zvxf stable.tar.gz
            bash$
            cd perl-5.8.1 (or whatever the version of Perl is called)
            bash$
            sh Configure -de -Dprefix=/home/foo/perl
            bash$
            make && make test && make install

Once you have Perl installed into a directory (probably in `~/perl/bin`), you'll have to change the locations on the scripts, which is detailed later on this page.

### Perl Modules

Installing the Perl modules as a non-root user is probably the hardest part of the process. There are two different methods: a completely independant Perl with its own modules, or personal modules using the current (root installed) version of Perl. The independant method takes up quite a bit of disk space, but is less complex, while the mixed method only uses as much space as the modules themselves, but takes more work to setup.

#### The Independant Method

The independant method requires that you install your own personal version of Perl, as detailed in the previous section. Once installed, you can start the CPAN shell with the following command:

                bash$
                /home/foo/perl/bin/perl -MCPAN -e 'shell'

And then:

                cpan>
                install Bundle::Bugzilla

With this method, module installation will usually go a lot smoother, but if you have any hang-ups, you can consult the next section.

#### The Mixed Method

First, you'll need to configure CPAN to install modules in your home directory. The CPAN FAQ says the following on this issue:

    5)  I am not root, how can I install a module in a personal directory?

        You will most probably like something like this:

          o conf makepl_arg "LIB=~/myperl/lib \
                             INSTALLMAN1DIR=~/myperl/man/man1 \
                             INSTALLMAN3DIR=~/myperl/man/man3"
        install Sybase::Sybperl

        You can make this setting permanent like all "o conf" settings with "o conf commit".

        You will have to add ~/myperl/man to the MANPATH environment variable and also tell your Perl programs to
        look into ~/myperl/lib, e.g. by including

          use lib "$ENV{HOME}/myperl/lib";

        or setting the PERL5LIB environment variable.

        Another thing you should bear in mind is that the UNINST parameter should never be set if you are not root.

So, you will need to create a Perl directory in your home directory, as well as the `lib`, `man`, `man/man1`, and `man/man3` directories in that Perl directory. Set the MANPATH variable and PERL5LIB variable, so that the installation of the modules goes smoother. (Setting UNINST=0 in your "make install" options, on the CPAN first-time configuration, is also a good idea.)

After that, go into the CPAN shell:

                bash$
                perl -MCPAN -e 'shell'

From there, you will need to type in the above "o conf" command and commit the changes. Then you can run through the installation:

                cpan>
                install Bundle::Bugzilla

Most of the module installation process should go smoothly. However, you may have some problems with Template. When you first start, you will want to try to install Template with the XS Stash options on. If this doesn't work, it may spit out C compiler error messages and croak back to the CPAN shell prompt. So, redo the install, and turn it off. (In fact, say no to all of the Template questions.) It may also start failing on a few of the tests. If the total tests passed is a reasonable figure (90+%), force the install with the following command:

                cpan>
                force install Template

You may also want to install the other optional modules:

              cpan>
              install GD
              cpan>
              install Chart::Base
              cpan>
              install MIME::Parser

### HTTP Server

Ideally, this also needs to be installed as root and run under a special webserver account. As long as the web server will allow the running of *.cgi files outside of a cgi-bin, and a way of denying web access to certain files (such as a .htaccess file), you should be good in this department.

#### 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.

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.

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!

### Bugzilla

Since you probably can't set up a symbolic link to `/usr/bonsaitools/bin/perl` as a non-root user, you will need to hack the scripts to point to the right Perl:

    perl -pi -e
            's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
            processmail syncshadowdb

Change `/usr/bin/perl` to match the location of Perl on your machine. If you had to install Perl as non-root, this would be the location in your home directory.

Version 2.17+ of Bugzilla now already has the scripts pointing to `/usr/bin/perl`.

Of course, the scripts will not work if they don't know the location of your newly install Perl modules, so you will have to hack the scripts to look for those, too:

    perl -pi -e
            's@use strict\;@use strict\; use lib \"/home/foo/perl/lib\"\;@'
            *cgi *pl Bug.pm processmail syncshadowdb

Change `/home/foo/perl/lib` to your personal Perl library directory. You can probably skip this step if you are using the independant method of Perl module installation.

When you run `./checksetup.pl` to create the `localconfig` file, it will list the Perl modules it finds. If one is missing, go back and double-check the module installation from the CPAN shell, then delete the `localconfig` file and try again.

The one option in `localconfig` you might have problems with is the web server group. If you can't successfully browse to the `index.cgi` (like a Forbidden error), you may have to relax your permissions, and blank out the web server group. Of course, this may pose as a security risk. Having a properly jailed shell and/or limited access to shell accounts may lessen the security risk, but use at your own risk.

## Troubleshooting

This section gives solutions to common Bugzilla installation problems.

### Bundle::Bugzilla makes me upgrade to Perl 5.6.1

Try executing `perl -MCPAN -e 'install CPAN'` and then continuing.

Certain older versions of the CPAN toolset were somewhat naive about how to upgrade Perl modules. When a couple of modules got rolled into the core Perl distribution for 5.6.1, CPAN thought that the best way to get those modules up to date was to haul down the Perl distribution itself and build it. Needless to say, this has caused headaches for just about everybody. Upgrading to a newer version of CPAN with the commandline above should fix things.

### DBD::Sponge::db prepare failed

The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control):

     DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248.
      SV = NULL(0x0) at 0x20fc444
      REFCNT = 1
      FLAGS = (PADBUSY,PADMY)

To fix this, go to `<path-to-perl>/lib/DBD/sponge.pm` in your Perl installation and replace

     my $numFields;
     if ($attribs->{'NUM_OF_FIELDS'}) {
         $numFields = $attribs->{'NUM_OF_FIELDS'};
     } elsif ($attribs->{'NAME'}) {
         $numFields = @{$attribs->{NAME}};

by

     my $numFields;
     if ($attribs->{'NUM_OF_FIELDS'}) {
         $numFields = $attribs->{'NUM_OF_FIELDS'};
     } elsif ($attribs->{'NAMES'}) {
         $numFields = @{$attribs->{NAMES}};

(note the S added to NAME.)

### cannot chdir(/var/spool/mqueue)

If you are installing Bugzilla on SuSE Linux, or some other distributions with paranoid security options, it is possible that the checksetup.pl script may fail with the error:

    cannot chdir(/var/spool/mqueue): Permission denied

This is because your `/var/spool/mqueue` directory has a mode of drwx------. Type `chmod 755 `/var/spool/mqueue`` as root to fix this problem.

### Your vendor has not defined Fcntl macro O_NOINHERIT

This is caused by a bug in the version of File::Temp that is distributed with perl 5.6.0. Many minor variations of this error have been reported. Examples can be found in .

#### Other File::Temp error messages

    Your vendor has not defined Fcntl macro O_NOINHERIT, used
    at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208.

    Your vendor has not defined Fcntl macro O_EXLOCK, used
    at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210.

    Your vendor has not defined Fcntl macro O_TEMPORARY, used
    at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.

Numerous people have reported that upgrading to version 5.6.1 or higher solved the problem for them. A less involved fix is to apply the patch in . The patch is also available as a patch file.

#### Patch for File::Temp in Perl 5.6.0

    --- File/Temp.pm.orig   Thu Feb  6 16:26:00 2003
    +++ File/Temp.pm        Thu Feb  6 16:26:23 2003
    @@ -205,6 +205,7 @@
         # eg CGI::Carp
         local $SIG{__DIE__} = sub {};
         local $SIG{__WARN__} = sub {};
    +    local *CORE::GLOBAL::die = sub {};
         $bit = &$func();
         1;
       };
    @@ -226,6 +227,7 @@
         # eg CGI::Carp
         local $SIG{__DIE__} = sub {};
         local $SIG{__WARN__} = sub {};
    +    local *CORE::GLOBAL::die = sub {};
         $bit = &$func();
         1;
       };