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: MySQL database server (3.22.5 or greater) Perl (5.005 or greater, 5.6.1 is recommended if you wish to use Bundle::Bugzilla) Perl Modules (minimum version): Template (v2.07) File::Temp (v1.804) (Prerequisite for Template) AppConfig (v1.52) Text::Wrap (v2001.0131) File::Spec (v0.8.2) Data::Dumper (any) DBD::mysql (v1.2209) DBI (v1.13) Date::Parse (any) CGI::Carp (any) and, optionally: GD (v1.19) for bug charting Chart::Base (v0.99c) for bug charting XML::Parser (any) for the XML interface MIME::Parser (any) for the email interface The web server of your choice. Apache is highly recommended. 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 the server. 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. Change your init script to start mysqld with the ability to accept large packets. By default, mysqld only accepts packets up to 64K long. This limits the size of attachments you may put on bugs. If you add to the command that starts mysqld (or safe_mysqld), then you will be able to have attachments up to about 1 megabyte. There is a Bugzilla parameter for maximum attachment size; you should configure it to match the value you choose here. If you plan on running Bugzilla and MySQL on the same machine, consider using the 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: bash# perl Makefile.PL bash# make bash# make test 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. mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost IDENTIFIED BY '<bugs_password>'; mysql> FLUSH PRIVILEGES;
<filename>checksetup.pl</filename> 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: server's host: just use localhost if the MySQL server is local database name: bugs if you're following these directions MySQL username: bugs if you're following these directions 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.
Securing MySQL If you followed the installation instructions for setting up your "bugs" and "root" user in MySQL, much of this should not apply to you. If you are upgrading an existing installation of Bugzilla, you should pay close attention to this section. Most MySQL installs have "interesting" default security parameters: mysqld defaults to running as root it defaults to allowing external network connections it has a known port number, and is easy to detect it defaults to no passwords whatsoever it defaults to allowing "File_Priv" This means anyone from anywhere on the internet can not only drop the database with one SQL command, and they can write as root to the system. To see your permissions do: bash# mysql -u root -p mysql> use mysql; mysql> show tables; mysql> select * from user; mysql> select * from db; To fix the gaping holes: DELETE FROM user WHERE User=''; UPDATE user SET Password=PASSWORD('new_password') WHERE user='root'; FLUSH PRIVILEGES; If you're not running "mit-pthreads" you can use: GRANT USAGE ON *.* TO bugs@localhost; GRANT ALL ON bugs.* TO bugs@localhost; REVOKE DROP ON bugs.* FROM bugs@localhost; FLUSH PRIVILEGES; With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect line to specify a specific host name instead of "localhost", and accept external connections: GRANT USAGE ON *.* TO bugs@bounce.hop.com; GRANT ALL ON bugs.* TO bugs@bounce.hop.com; REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com; FLUSH PRIVILEGES; Consider also: Turning off external networking with "--skip-networking", unless you have "mit-pthreads", in which case you can't. Without networking, MySQL connects with a Unix domain socket. using the --user= option to mysqld to run it as an unprivileged user. running MySQL in a chroot jail running the httpd in a chroot jail making sure the MySQL passwords are different from the OS passwords (MySQL "root" has nothing to do with system "root"). running MySQL on a separate untrusted machine making backups ;-)
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: A complete file path to the command 'dot' (part of GraphViz) will generate the graphs locally A URL prefix pointing to an installation of the webdot package will generate the graphs remotely 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.
<filename>.htaccess</filename> 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: Options +FollowSymLinks +Indexes +Includes +ExecCGI AllowOverride All ]]> 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.
<filename>directoryindex</filename> for the Bugzilla default page. You should modify the <DirectoryIndex> parameter for the Apache virtual host running your Bugzilla installation to allow index.cgi as the index page for a directory, as well as the usual index.html, index.htm, and so forth.
<filename>mod_throttle</filename> and Security It is possible for a user, by mistake or on purpose, to access the database many times in a row which can result in very slow access speeds for other users. If your Bugzilla installation is experiencing this problem , you may install the Apache module mod_throttle which can limit connections by ip-address. You may download this module at http://www.snert.com/Software/Throttle/. Follow the instructions to install into your Apache install. This module only functions with the Apache web server! You may use the ThrottleClientIP command provided by this module to accomplish this goal. See the Module Instructions 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 . 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. 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 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 <modulename> Installing ActivePerl ppd Modules on Microsoft Windows C:> ppm 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 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. Setup MySQL C:> C:\mysql\bin\mysql -u root mysql mysql> DELETE FROM user WHERE Host='localhost' AND User=''; 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. 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. mysql> FLUSH PRIVILEGES; mysql> create database bugs; mysql> exit; C:> C:\mysql\bin\mysqladmin -u root -p reload 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' Run checksetup.pl from the Bugzilla directory. 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. 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. 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. 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) Put ntsendmail.pm into your .\perl\lib directory. 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. 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. 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. new(''); #connect to SMTP server $smtp->mail('@');# 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: new(' 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; ]]> 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. 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: to system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); ]]> 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. 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.
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): To fix this, go to <path-to-perl>/lib/DBD/sponge.pm in your Perl installation and replace {'NUM_OF_FIELDS'}) { $numFields = $attribs->{'NUM_OF_FIELDS'}; } elsif ($attribs->{'NAME'}) { $numFields = @{$attribs->{NAME}}; ]]> by {'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: 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.