From d8caf6045d10344c431918128e3803ca497565f3 Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Sun, 28 Jul 2002 05:00:17 +0000 Subject: Merging new docs from 2.16 branch. --- docs/sgml/installation.sgml | 3818 ++++++++++++++++++++++--------------------- 1 file changed, 1984 insertions(+), 1834 deletions(-) (limited to 'docs/sgml/installation.sgml') diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml index 8cadbdd58..0433b4b52 100644 --- a/docs/sgml/installation.sgml +++ b/docs/sgml/installation.sgml @@ -1,1729 +1,1766 @@ + + Installation - - Installation - - These installation instructions are presented assuming you are - installing on a UNIX or completely POSIX-compliant system. If - you are installing on Microsoft Windows or another oddball - operating system, please consult the appropriate sections in - this installation guide for notes on how to be successful. - -
- ERRATA - Here are some miscellaneous notes about possible issues you - main run into when you begin your Bugzilla installation. - Reference platforms for Bugzilla installation are Redhat Linux - 7.2, Linux-Mandrake 8.0, and Solaris 8. - - - - If you are installing Bugzilla on S.u.S.e. 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. - - - - Bugzilla may be installed on Macintosh OS X (10), which is a - unix-based (BSD) operating system. Everything required for - Bugzilla on OS X will install cleanly, but the optional GD - perl module which is used for bug charting requires some - additional setup for installation. Please see the Mac OS X - installation section below for details - - - - Release Notes for Bugzilla &bz-ver; are available at - docs/rel_notes.txt in your Bugzilla - source distribution. - - - - The preferred documentation for Bugzilla is available in - docs/, with a variety of document types available. Please - refer to these documents when installing, configuring, and - maintaining your Bugzilla installation. - - - - - - - Bugzilla is not a package where you can just plop it in a directory, - twiddle a few things, and you're off. Installing Bugzilla assumes you - know your variant of UNIX or Microsoft Windows well, are familiar with the - command line, and are comfortable compiling and installing a plethora - of third-party utilities. To install Bugzilla on Win32 requires - fair Perl proficiency, and if you use a webserver other than Apache you - should be intimately familiar with the security mechanisms and CGI - environment thereof. - - - - - - Bugzilla has not undergone a complete security review. Security holes - may exist in the code. Great care should be taken both in the installation - and usage of this software. Carefully consider the implications of - installing other network services with Bugzilla. - - -
-
Step-by-step Install +
Introduction - - Installation of bugzilla is pretty straightforward, particularly if your - machine already has MySQL and the MySQL-related perl packages installed. - If those aren't installed yet, then that's the first order of business. The - other necessary ingredient is a web server set up to run cgi scripts. - While using Apache for your webserver is not required, it is recommended. - - - - Bugzilla has been successfully installed under Solaris, Linux, - and Win32. The peculiarities of installing on Win32 (Microsoft - Windows) are not included in this section of the Guide; please - check out the for further advice - on getting Bugzilla to work on Microsoft Windows. - - - - The Bugzilla Guide is contained in the "docs/" folder in your - Bugzilla distribution. It is available in plain text - (docs/txt), HTML (docs/html), or SGML source (docs/sgml). - + + 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. +
+
- Installing the Prerequisites + Package List + - If you want to skip these manual installation steps for - the CPAN dependencies listed below, and are running the very - most recent version of Perl and MySQL (both the executables - and development libraries) on your system, check out - Bundle::Bugzilla in + 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): + + - The software packages necessary for the proper running of bugzilla are: - - - - MySQL database server and the mysql client (3.22.5 or greater) - - - - - Perl (5.004 or greater, 5.6.1 is recommended if you wish - to use Bundle::Bugzilla) - - - - - DBI Perl module - - - - - Data::Dumper Perl module - - - - - Bundle::Mysql Perl module collection - - - - - TimeDate Perl module collection - - - - - GD perl module (1.8.3) (optional, for bug charting) - - - - - Chart::Base Perl module (0.99c) (optional, for bug charting) - - - - - DB_File Perl module (optional, for bug charting) - - - - - The web server of your choice. Apache is recommended. - - - - - MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - - - - - - - It is a good idea, while installing Bugzilla, to ensure it - is not accessible by other machines - on the Internet. Your machine may be vulnerable to attacks - while you are installing. In other words, ensure there is - some kind of firewall between you and the rest of the - Internet. 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, the author's test system, 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 - - - + Template + (v2.07) -
-
- Installing MySQL Database + + + - Visit MySQL homepage at www.mysql.com and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in /var which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to configure. + AppConfig + + (v1.52) - - If you install from source or non-package (RPM, deb, etc.) - binaries you 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. - - You should have your init script 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. - + - - - - 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 (5.004 or greater) + - Any machine that doesn't have perl on it is a sad machine - indeed. Perl for *nix systems can be gotten in source form - from http://www.perl.com. Although Bugzilla runs with most - post-5.004 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;. + Text::Wrap + (v2001.0131) + + + - Perl is now a far cry from the the single compiler/interpreter - binary it once was. It includes a great many required modules - and quite a few other support files. If you're not up to or - not inclined to build perl from source, you'll want to install - it on your machine using some sort of packaging system (be it - RPM, deb, or what have you) to ensure a sane install. In the - subsequent sections you'll be installing quite a few perl - modules; this can be quite ornery if your perl installation - isn't up to snuff. + File::Spec + + (v0.8.2) - - 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 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. - - - - - You can skip the following Perl module installation steps by - installing Bundle::Bugzilla from - CPAN, which - includes them. All Perl module installation steps require - you have an active Internet connection. If you wish to use - Bundle::Bugzilla, however, you must be using the latest - version of Perl (at this writing, version &perl-ver;) - - - 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. - - -
- -
- DBI Perl Module + + + - The DBI module is a generic Perl module used by other database related - Perl modules. For our purposes it's required by 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 + + (any) + + + - Like almost all Perl modules DBI can be found on the Comprehensive Perl - Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a - real tendency to bog down, so please use mirrors. The current location - at the time of this writing can be found in . + DBD::mysql + + (v1.2209) + + + - 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. + DBI + (v1.13) + + + - To use the CPAN shell to install DBI: - - - - bash# - perl -MCPAN -e 'install "DBI"' - - - Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc. - - - - 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 - - - - - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. - - + Date::Parse + + (any) -
-
- Data::Dumper Perl Module + + + - 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. + CGI::Carp + (any) + + + + and, optionally: + + - Data::Dumper is used by the MySQL-related Perl modules. It - can be found on CPAN (see ) and - can be - installed by following the same four step make sequence used - for the DBI module. + GD + (v1.19) for bug charting -
- -
- MySQL related Perl Module Collection + + + - The Perl/MySQL interface requires a few mutually-dependent perl - modules. These modules are grouped together into the the - Msql-Mysql-modules package. This package can be found at CPAN. - After the archive file has been downloaded it should - be untarred. + Chart::Base + + (v0.99c) for bug charting + + + - The MySQL modules are all built using one make file which is generated - by running: - bash# - perl Makefile.pl + XML::Parser + (any) for the XML interface + + + - The MakeMaker process will ask you a few questions about the desired - compilation target and your MySQL installation. For many of the questions - the provided default will be adequate. + MIME::Parser + (any) for the email interface - - When asked if your desired target is the MySQL or mSQL packages, - 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' and - a null password should find itself with sufficient access to run tests - on the 'test' database which MySQL created upon installation. If 'make - test' and 'make install' go through without errors you should be ready - to go as far as database connectivity is concerned. - -
- -
- TimeDate Perl Module Collection - - 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 (see link: ). The - component module we're most interested in is the Date::Format - module, but installing all of them is probably a good idea - anyway. The standard Perl module installation instructions - should work perfectly for this simple package. - -
-
- GD Perl Module (1.8.3) - - 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. - - - Actually bugzilla uses the Graph module which relies on GD - itself. Isn't that always the way with object-oriented - programming? At any rate, you can find the GD library on CPAN - in . - - - - 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. Just realize that if - compiling GD fails, it's probably because you're missing a - required library. - - -
- -
- Chart::Base Perl Module (0.99c) - - 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 where it is found as the - Chart-x.x... tarball, linked in . Note that - as with the GD perl module, only the version listed above, or - newer, will work. Earlier versions used GIF's, which are no - longer supported by the latest versions of GD. - -
- -
- DB_File Perl Module - - DB_File is a module which allows Perl programs to make use - of the facilities provided by Berkeley DB version 1.x. This - module is required by collectstats.pl which is used for bug - charting. If you plan to make use of bug charting, you must - install this module. - -
- -
- HTTP Server - - You have a freedom of choice here - Apache, Netscape or any - other server on UNIX would do. You can easily run the web - server on a different machine than MySQL, but need to adjust - the MySQL bugs user permissions accordingly. - - I strongly recommend Apache as the web server to use. - The Bugzilla Guide installation instructions, in general, - assume you are using Apache. As more users use different - webservers and send me information on the peculiarities of - installing using their favorite webserver, I will provide - notes for them. - - - - 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 srm.conf file: - -AddHandler cgi-script .cgi - - - - With apache you'll also want to make sure that within the - access.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. - + + + + + + + + + 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. + + - - AllowOverride Limit allows the use of a Deny statement in the - .htaccess file generated by checksetup.pl - - - Users of newer versions of Apache will generally find both - of the above lines will be in the httpd.conf file, rather - than srm.conf or access.conf. - + 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 + + - - - There are important files and directories that should not - be a served by the HTTP server. These are most files in the - data and shadow directories - and the localconfig file. You should - configure your HTTP server to not serve content from these - files. Failure to do so will expose critical passwords and - other data. Please see for details - on how to do this for Apache. I appreciate notes on how to - get this same functionality using other webservers. - - -
- -
- Installing the Bugzilla Files - - 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 off of the main web space for your web server or perhaps - off of /usr/local with a symbolic link in - the web space that points to the Bugzilla directory. At any - rate, just dump all the files in the same place, and make sure - you can access the files in that directory through your web - server. - - - - 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. - - - - 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, or use - , found in - . I suggest using the symlink - approach for future release compatability. - - Setting up bonsaitools symlink - - Here's how you set up the Perl symlink on Linux to make - Bugzilla work. Your mileage may vary. For some UNIX - operating systems, you probably need to subsitute - /usr/local/bin/perl for - /usr/bin/perl below; if on certain other - UNIX systems, Perl may live in weird places like - /opt/perl. As root, run these commands: - -bash# mkdir /usr/bonsaitools -bash# mkdir /usr/bonsaitools/bin -bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl - - - - Alternately, you can simply run this perl one-liner to - change your path to perl in all the files in your Bugzilla - installation: - -perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm -processmail syncshadowdb - - Change the second path to perl to match your installation. - - - - - If you don't have root access to set this symlink up, - check out the - , listed in . It will change the path to perl in all your Bugzilla files for you. - - - -
- -
- 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 a 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. - - - - Bugzilla has not undergone a thorough security audit. It - may be possible for a system cracker to somehow trick - Bugzilla into executing a command such as DROP - DATABASE mysql. - - That would be bad. - +
+ +
+ MySQL + + Visit the MySQL homepage at + www.mysql.com + to grab and install the latest stable release of the server. - - Give 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 your - new_password. Remember that MySQL user names have nothing to - do with Unix user names (login names). - - - Next, we create the 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; - - - - - - - Next, run the magic checksetup.pl script. (Many thanks to - Holger Schurig <holgerschurig@nikocity.de> for writing - this script!) 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. + + 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. + -
- Tweaking <filename>localconfig</filename> - - 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 above - - - + 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: + - You should also install .htaccess files that the Apache - webserver will use to restrict access to Bugzilla data files. - See . + + bash# + perl -MCPAN -e 'install "<modulename>"' + + - Once you are happy with the settings, re-run - checksetup.pl. On this second run, it will - create the database and an administrator account for which - you will be prompted to provide information. + To do it the hard way: - - When logged into an administrator account once Bugzilla is - running, if you go to the query page (off of the Bugzilla main - menu), you'll find an edit parameters option - that is filled with editable treats. + + 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 + + + + - - Should everything work, you will have a nearly empty Bugzilla - database and a newly-created localconfig - file in your Bugzilla root directory. + + + 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. - - - - The second time you run checksetup.pl, you should become - the user your web server runs as, and that you ensure that - you set the webservergroup parameter in localconfig to - match the web server's group name, if any. I believe, - for the next release of Bugzilla, this will be fixed so - that Bugzilla supports a webserveruser parameter in - localconfig as well. - - Running checksetup.pl as the web user - - Assuming your web server runs as user "apache", and - Bugzilla is installed in "/usr/local/bugzilla", here's - one way to run checksetup.pl as the web server user. - As root, for the second run of - checksetup.pl, do this: - -bash# chown -R apache:apache /usr/local/bugzilla -bash# su - apache -bash# cd /usr/local/bugzilla -bash# ./checksetup.pl - - - - - +
+ +
+ 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 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. - + 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.
- +
- Setting Up Maintainers Manually (Optional) - - If you want to add someone else to every group by hand, you - can do it by typing the appropriate MySQL commands. Run - mysql -u root -p bugs You - may need different parameters, depending on your security - settings. Then: - - - mysql> update - profiles set groupset=0x7fffffffffffffff where - login_name = 'XXX'; (yes, that's fifteenf's. - - replacing XXX with the Bugzilla email address. - -
- -
- The Whining Cron (Optional) - - 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. 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 - - - + 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.
- Bug Graphs (Optional) - - 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 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. - -
+ 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. +
+ +
+
- 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; - + 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. + - - 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; - + + 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 "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; - + + 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. + - - Use .htaccess files with the Apache webserver to secure your - bugzilla install. See + + + 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. - - 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. - - - - - starting MySQL in a chroot jail - - - - - running the httpd in a "chrooted" 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 ;-) - - - + + + 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.
-
-
- 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 (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 the - following patch to the Makefile.PL file (save the patch into a - file and use the command patch < - patchfile: - - - - PATHS: CHECK AND ADJUST <===== --my @INC = qw(-I/usr/local/include -I/usr/local/include/gd); --my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib ); -+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd); -+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib); - my @LIBS = qw(-lgd -lpng -lz); - - # FEATURE FLAGS -@@ -23,7 +23,7 @@ - - push @LIBS,'-lttf' if $TTF; - push @LIBS,'-ljpeg' if $JPEG; --push @LIBS, '-lm' unless $^O eq 'MSWin32'; -+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/); - - # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified - if ($^O ne 'freebsd' && $^O ne 'MSWin32') { - -]]> - - - - Then, run these commands to finish the installation of the perl module: + +
+ 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. - perl Makefile.PL - make - make test - make install - And don't forget to run exit to get back to cpan. + + + bash# + + mysql -u root mysql + + + + + + mysql> + + UPDATE user SET Password=PASSWORD('<new_password'>) + WHERE user='root'; + + + + + + mysql> + + FLUSH PRIVILEGES; + + - - - Happy Hacking! - -
- -
- BSD Installation Notes - - For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please - consult . - + + 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 . + +
- -
- Installation General Notes +
+ Optional Additional Configuration +
- Modifying Your Running System - - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory. + 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: + - If you make a change to the structural data in your database - (the versions table for example), or to the - constants encoded in defparams.pl, you will - need to remove the cached content from the data directory - (by doing a rm data/versioncache), or your - changes won't show up. + + + + 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. + + + - - That file gets automatically regenerated whenever it's more than an - hour old, so Bugzilla will eventually notice your changes by itself, but - generally you want it to notice right away, so that you can test things. + + 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.
+
- Upgrading From Previous Versions + 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. + - A plain Bugzilla is fairly easy to upgrade from one version to a newer one. - However, things get a bit more complicated if you've made changes to - Bugzilla's code. In this case, you may have to re-make or reapply those - changes. - It is recommended that you take a backup of your database and your entire - Bugzilla installation before attempting an upgrade. You can upgrade a 'clean' - installation by untarring a new tarball over the old installation. If you - are upgrading from 2.12 or later, you can type cvs -z3 - update, and resolve conflicts if there are any. + 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 - Because the developers of Bugzilla are constantly adding new tables, columns - and fields, you'll probably get SQL errors if you just update the code and - attempt to use Bugzilla. Always run the checksetup.pl script whenever - you upgrade your installation. + + 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. + - If you are running Bugzilla version 2.8 or lower, and wish to upgrade to - the latest version, please consult the file, "UPGRADING-pre-2.8" in the - Bugzilla root directory after untarring the archive. + 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>.htaccess</filename> files and security - - To enhance the security of your Bugzilla installation, - Bugzilla will generate - .htaccess files - which the Apache webserver can use to restrict access to - the bugzilla data files. The checksetup script will - generate the .htaccess 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. - - - - +
+ + <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 - - 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: - + user. + - - - - Options +FollowSymLinks +Indexes +Includes +ExecCGI - AllowOverride All - -]]> - - + + + + mysql> - - 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. - + FLUSH PRIVILEGES; + + + - - If you are using Internet Information Server or other web - server which does not observe .htaccess - conventions, you can disable their creation by editing - localconfig and setting the - $create_htaccess variable to - 0. - -
+ + + + mysql> -
- <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. -
- -
- 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# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ - do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \ - mv $i.tmp $i; done - - - 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. - -
+ create database bugs; + + + - -
- UNIX Installation Instructions History - - This document was originally adapted from the Bonsai - installation instructions by Terry Weissman - <terry@mozilla.org>. - - - The February 25, 1999 re-write of this page was done by Ry4an - Brase <ry4an@ry4an.org>, with some edits by Terry - Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But - don't send bug reports to them; report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ). - - - This document was heavily modified again Wednesday, March 07 - 2001 to reflect changes for Bugzilla 2.12 release by Matthew - P. Barnson. The securing MySQL section should be changed to - become standard procedure for Bugzilla installations. - - - Finally, the README in its entirety was marked up in SGML and - included into the Guide on April 24, 2001 by Matt Barnson. - Since that time, it's undergone extensive modification as - Bugzilla grew. - - - Comments from people using this Guide for the first time are - particularly welcome. - -
-
- -
- Win32 Installation Notes - This section covers installation on Microsoft Windows 95, - 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms, - but please remember that the Bugzilla team and the author of the - Guide neither endorse nor support installation on Microsoft - Windows. Bugzilla installs and runs best - and easiest on UNIX-like operating systems, - and that is the way it will stay for the foreseeable future. The - Bugzilla team is considering supporting Win32 for the 2.16 - release and later. - 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. + + + + mysql> + + exit; + + + + + + + + C:> + + C:\mysql\bin\mysqladmin -u root -p + reload + + + + + + + + Edit + checksetup.pl + + in your Bugzilla directory. Change this line: -
- 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. + my $webservergid = + getgrnam($my_webservergroup); - - - 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) - - + + to + - 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 - - + my $webservergid = + $my_webservergroup; + + or the name of the group you wish to own the files explicitly: + my $webservergid = + 'Administrators' - - - - - 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. - + + + + 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 @@ -1737,9 +1774,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist"; } ]]> - -here is a test mail program for Net::SMTP: - + + + here is a test mail program for Net::SMTP: + - - - - - - - - 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: - + + + + + + + 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 - + to + system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST); -]]> - - - - - Add binmode() calls so attachments - will work (bug 62000). +]]> + + + + + 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. + - 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. - + 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. - + 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. - -
- + 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. - - - + 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.) + -
- Bugzilla LDAP Integration + 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}}; +]]> + - What follows is some late-breaking information on using the - LDAP authentication options with Bugzilla. The author has not - tested these (nor even formatted this section!) so please - contribute feedback to the newsgroup. + (note the S added to NAME.) - -Mozilla::LDAP module - -The Mozilla::LDAP module allows you to use LDAP for authentication to -the Bugzilla system. This module is not required if you are not using -LDAP. - -Mozilla::LDAP (aka PerLDAP) is available for download from -http://www.mozilla.org/directory. - -NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. -Follow the link for "Directory SDK for C" on that same page to -download the SDK first. After you have installed this SDK, then -install the PerLDAP module. ----------------------------------------------------------------------- - -Post-Installation Checklist ----------------------------------------------------------------------- -Set 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. ----------------------------------------------------------------------- - -(Not sure where this bit should go, but it's important that it be in -there somewhere...) ----------------------------------------------------------------------- -Using LDAP authentication for Bugzilla: - -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. ----------------------------------------------------------------------- -
+ +
+ 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. + +
- + -- cgit v1.2.3-24-g4f1b