From d819eae3af3b13d4b6f17e818d449eaabe58ff9d Mon Sep 17 00:00:00 2001 From: "barnboy%trilobyte.net" <> Date: Sat, 11 Aug 2001 05:13:47 +0000 Subject: Checkin for 2.14 release. Still some problems; this cannot yet be used for 2.14 documentation due to inconsistencies. --- docs/sgml/installation.sgml | 2667 +++++++++++++++++++++++++------------------ 1 file changed, 1529 insertions(+), 1138 deletions(-) (limited to 'docs/sgml/installation.sgml') diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml index 8165afd6d..dfbc35071 100644 --- a/docs/sgml/installation.sgml +++ b/docs/sgml/installation.sgml @@ -1,578 +1,633 @@ - + - - Installing Bugzilla + + 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. -
- UNIX Installation -
- ERRATA - - - 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. - - + + + 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. + - - - Release Notes for Bugzilla 2.12 are available at docs/rel_notes.txt - - + + 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 + - - - 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. - - + + Release Notes for Bugzilla &bz-ver; are available at + docs/rel_notes.txt in your Bugzilla + source distribution. + - - - 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. - - + + 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 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 (Win98+/NT/2K) are not - included in this section of the Guide; please check out the "Win32 Installation Instructions" - for further advice on getting Bugzilla to work on Microsoft Windows. - - - - The Bugzilla Guide is contained in the "docs/" folder. It is available - in plain text (docs/txt), HTML (docs/html), or SGML source (docs/sgml). - -
-
- Installing the Prerequisites - - - 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) - - - - - DBI Perl module - - - - - Data::Dumper Perl module - - - - - DBD::mySQL - - - - - 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) - - - - - - You must run Bugzilla on a filesystem that supports file locking via - flock(). This is necessary for Bugzilla to operate safely with multiple - instances. - - - - - 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. - - - - -
-
- Installing MySQL Database - - Visit MySQL homepage at http://www.mysql.org/ and grab the latest stable - release of the server. Both binaries and source are available and which - you get shouldn't matter. Be aware that many of the binary versions - of MySQL store their data files in /var which on many installations - (particularly common with linux installations) is part of a smaller - root partition. If you decide to build from sources you can easily set - the dataDir as an option to configure. - - - If you've installed from source or non-package (RPM, deb, etc.) binaries - you'll want to make sure to add mysqld to your init scripts so the server - daemon will come back up whenever your machine reboots. - You also may want to edit those init scripts, to make sure that - mysqld will accept large packets. By default, mysqld is set up to only - accept packets up to 64K long. This limits the size of attachments you - may put on bugs. If you add something like "-O max_allowed_packet=1M" - 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 "--skip-networking" 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. - - - Perl is now a far cry from the the single compiler/interpreter binary it - once was. It now 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. - - - - 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. - - - - 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. - - - 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 (02/17/99) can be found in Appendix A. - - - 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 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. - - - -
-
- 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. - - - Data::Dumper is used by the MySQL related Perl modules. It can be - found on CPAN (link in Appendix A) and can be installed by following - the same four step make sequence used for the DBI module. - -
+ + 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). + +
+
+ Installing the Prerequisites + + 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 + + + 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) + + + -
- 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. - - - The MySQL modules are all built using one make file which is generated - by running: - bash# - perl Makefile.pl - - - 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. - - - When asked if your desired target is the MySQL or mSQL packages - selected the MySQL related ones. Later you will be asked if you wish - to provide backwards compatibility with the older MySQL packages; you - must answer YES to this question. The default will be no, and if you - select it things won't work later. - - + + + 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. + + + + +
+
+ Installing MySQL Database + + Visit MySQL homepage at http://www.mysql.com/ and grab the + latest stable release of the server. Both binaries and source + are available and which you get shouldn't matter. Be aware + that many of the binary versions of MySQL store their data + files in /var which on many installations (particularly common + with linux installations) is part of a smaller root partition. + If you decide to build from sources you can easily set the + dataDir as an option to configure. + + + If you've installed from source or non-package (RPM, deb, + etc.) binaries you'll want to make sure to add mysqld to your + init scripts so the server daemon will come back up whenever + your machine reboots. You also may want to edit those init + scripts, to make sure that mysqld will accept large packets. + By default, mysqld is set up to only accept packets up to 64K + long. This limits the size of attachments you may put on + bugs. If you add something like "-O max_allowed_packet=1M" 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 "--skip-networking" 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;. + + + 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. + + + 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. + + + 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 (02/17/99) can be found in Appendix A. + + + 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 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. + + + +
+
+ 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. + + + Data::Dumper is used by the MySQL-related Perl modules. It can be + found on CPAN (link in Appendix A) and can be installed by following + the same four step make sequence used for the DBI module. + +
+ +
+ 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. + + + The MySQL modules are all built using one make file which is generated + by running: + bash# + perl Makefile.pl + + + 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. + + + 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 - +
+ 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. A (hopefully - current) link can be found in Appendix A. The component module we're + bundle is stored on the CPAN under the name TimeDate. A link + link may be found in Appendix B, Software Download Links. + 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) - + +
+
+ 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 almost a defacto standard for programatic image construction. The Perl bindings to it found in the GD library are used on a million web pages to generate graphs on the fly. That's what bugzilla will be using it for so you'd better install it if you want any of the graphing to work. - - + + Actually bugzilla uses the Graph module which relies on GD itself, but isn't that always the way with OOP. At any rate, you can find the - GD library on CPAN (link in Appendix "Required Software"). - - - + GD library on CPAN (link in Appendix B, Software Download Links). + + + 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) - +
+ 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 in a - directory to be listed in Appendix "Required Software". Note that as with the GD perl - module, only the specific versions listed above (or newer) will work. Earlier + directory to be listed in Appendix B, "Software Download Links". + 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 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 - +
+ 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. - - + + 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 - - + AddHandler cgi-script .cgi + + With apache you'll also want to make sure that within the access.conf file the line: - + Options ExecCGI - + is in the stanza that covers the directories you intend to put the bugzilla .html and .cgi files into. - - + + If you are using a newer version of Apache, both of the above lines will be (or will need to be) in the httpd.conf file, rather than srm.conf or access.conf. - - - + + + There are two critical directories and a file that should not be a served by - the HTTP server. These are the 'data' and 'shadow' directories and the - 'localconfig' file. You should configure your HTTP server to not serve + the HTTP server. These are 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 your HTTP server configuration manual on how - to do this. If you use quips (at the top of the buglist pages) you will want - the 'data/comments' file to still be served. This file contains those quips. - - -
+ and other data. Please see for details. + + +
-
- Installing the Bugzilla Files - +
+ 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 + 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 (optionally omitting the CVS directories if they were accidentally tarred up with the rest of Bugzilla) 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 (which may require just making it world writable). This is a temporary step until you run - the post-install "checksetup.pl" script, which locks down your + 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. To make future upgrades easier, you should use the symlink approach. - - Setting up bonsaitools symlink - + + Setting up bonsaitools symlink + Here's how you set up the Perl symlink on Linux to make Bugzilla work. Your mileage may vary; if you are running on Solaris, 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: - + /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/bosaitools/bin/perl - - - - - - If you don't have root access to set this symlink up, check out the - "setperl.csh" utility, listed in the Patches section of this - Guide. It will change the path to perl in all your Bugzilla files for - you. - - - -
+ + + + + + 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 - +
+ 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. - - + 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. + + + + Give the MySQL root user a password. MySQL passwords are limited to 16 characters. - - - - bash# - mysql -u root mysql - - - - - mysql> - + + + + bash# + mysql -u root mysql + + + + + mysql> + UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; - - - - - - mysql> - FLUSH PRIVILEGES; - - - + + + + + + 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 @@ -580,755 +635,1091 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl 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, + + + + mysql> + GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password'; - - - - - + 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 - - - + + + + bash# + ./checksetup.pl + + + The first time you run it, it will create a file called "localconfig". - -
+ +
-
- Tweaking "localconfig" - +
+ Tweaking "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 above - - - - - + + + + + + You may also install .htaccess files that the Apache webserver will use + to restrict access to Bugzilla data files. See . + + 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. - - + + 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. - - + + Should everything work, you should have a nearly empty copy of the bug tracking setup. - - + + The second time around, checksetup.pl will stall if it is on a filesystem that does not fully support file locking via flock(), such as NFS mounts. This support is required for Bugzilla to operate safely with multiple instances. If flock() is not fully supported, it will stall at: - Now regenerating the shadow database for all bugs. - - + Now regenerating the shadow database for all bugs. + + The second time you run checksetup.pl, you should become the - user your web server runs as, and that you ensure you have 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 + 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: - + + 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 - - - - - - - - - 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. - - -
- -
- 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 - according to section 3, above). Then: - - - - mysql> - update profiles set groupset=0x7fffffffffffffff - where login_name = 'XXX'; - - - - replacing XXX with the Bugzilla email address. - -
+ + + + + + + + + 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 Whining Cron (Optional) - - By now you've got 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 - - - - -
+
+ 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'; + + replacing XXX with the Bugzilla email address. + +
-
- 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. - -
+
+ 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 + + + +
+ +
+ 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. + +
+ +
+ 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; + + + + Use .htaccess files with the Apache webserver to secure your + bugzilla install. See + + + 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 ;-) + + + + +
+
+
+ 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') { -
- Securing MySQL - - If you followed the README 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. - - - - - 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 ;-) - - - - -
- -
- Installation General Notes -
- 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 (we said before it needs to be writable, - right?!) - - - 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! - - - 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. - -
-
- Upgrading From Previous Versions - - The developers of Bugzilla are constantly adding new tables, columns and - fields. You'll get SQL errors if you just update the code. The strategy - to update is to simply always run the checksetup.pl script whenever - you upgrade your installation of Bugzilla. If you want to see what has - changed, you can read the comments in that file, starting from the end. - -
-
- 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 , - project Webtools, component 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. - - - Comments from people using this Guide for the first time are particularly welcome. - -
-
- -
-
+]]> + + + + Then, run these commands to finish the installation of the perl module: + + perl Makefile.PL + make + make test + make install + And don't forget to run exit to get back to cpan. + + + + Happy Hacking! + +
+ +
+ BSD Installation Notes + + For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please + consult . + +
+ + +
+ Installation General Notes +
+ 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. + + + 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. + + + 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. + +
+
+ Upgrading From Previous Versions + + The developers of Bugzilla are constantly adding new tables, columns and + fields. You'll get SQL errors if you just update the code. The strategy + to update is to simply always run the checksetup.pl script whenever + you upgrade your installation of Bugzilla. If you want to see what has + changed, you can read the comments in that file, starting from the end. + + + 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. + +
-
- Win32 (Win98+/NT/2K) Installation - - These directions have not been extensively tested. - We need testers! Please try these out and post any changes to the - newsgroup. - -
- Win32 Installation: Step-by-step - - - You should be familiar with, and cross-reference, the UNIX README - while performing your Win32 installation. Unfortunately, Win32 - directions are not yet as detailed as those for UNIX. - - - The most critical difference for Win32 users is - the lack of support for a crypt() function in MySQL for Windows. It does not - have it! All ENCRYPT statements must be modified. - - +
+ <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. + + + + 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. + + + + + + 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. + +
+ +
+ 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 , + project Webtools, component 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. - - - - Install Apache Web Server +
+ 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 both strong troubleshooting abilities and + a high tolerance for pain. 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. - - - + + + You may also use Internet Information Server or Personal Web Server for this purpose. However, setup is slightly more difficult. If ActivePerl doesn't seem to handle your file associations correctly (for .cgi and .pl files), please - consult the FAQ, in the "Win32" section. - - - If you are going to use IIS, if on Windows NT you must be updated - to at least Service Pack 4. - - - - - - Install ActivePerl - - + 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 - - Hixie Click Here - - - - + + 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, and GD. You may need to extract them from .zip format using Winzip or other unzip program first. These additional ppm modules can be downloaded from ActiveState. - - + + + + You can find a list of modules at + + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ + + + The syntax for ppm is: - - C:> ppm install <module>.ppd - - - + + C:> ppm <modulename> + + + + + Installing ActivePerl ppd Modules on Microsoft Windows + C:>ppm + + Watch your capitalization! + + + You can find ActiveState ppm modules at - - http://www.activestate.com/PPMPackages/5.6plus - - - - - Download and install the Windows GNU tools from - www.cygwin.com. - Make sure the GNU utilities are in your $PATH. - - - - + + http://www.activestate.com/PPMPackages/5.6plus + + + + + Install MySQL for NT. - - - Your configuration file for MySQL must be named C:\MY.CNF. - - - - - - + + + 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'; - - - - - - - mysql> - GRANT SELECT, INSERT, UPDATE, DELETE, + + + + + + 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'; - - - - - - - mysql> - FLUSH PRIVILEGES; - - - - - - - mysql> - create database bugs; - - - - - - - mysql> - exit - - - - - - - C:> - C:\mysql\bin\mysqladmin -u root -p reload - - - - - + 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 + + + + + - - - Configure Bugzilla. For Win32, this involves editing "defparams.pl" - and "localconfig" to taste. Running "checksetup.pl" should create - localconfig for you. Note that getgrnam() doesn't work, and should be - deleted. Change this line: + + + Edit checksetup.pl in your Bugzilla directory. Change + this line: + + "my $webservergid = getgrnam($my_webservergroup); " + + to + + "my $webservergid = $my_webservergroup; " - - + + + + + + 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 + The one mentioned here is a suggestion, not a requirement. Some other mail packages that can work include - BLAT, - Windmail, - Mercury Sendmail, + 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. In order for it to work, you must set up some - new environment variables (detailed on the ntsendmail home page). Figuring - out where to put those variables is left as an exercise for the reader. - 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) - - - Once downloaded and installed, modify all open(SENDMAIL) calls to open - "| c:\ntsendmail\ntsendmail -t" instead of "|/usr/lib/sendmail -t". - - - - We need someone to test this and make sure this works as advertised. - - - - - - Modify globals.pl and CGI.pl to remove the word "encrypt". - - - - I'm not sure this is all that is involved to remove crypt. Any - NT Bugzilla hackers want to pipe up? - - - - - - Change all references to "processmail" to "processmail.pl" in - all files, and rename "processmail" to "processmail.pl" - - - - I really think this may be a change we want to make for + + + + + + + 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); + + + + The code above needs testing as well to make sure it is correct. + + + + + + + + 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. - - - - - - 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.pl" utility to speed part of this procedure, - available in the "Patches and Utilities" section of The Bugzilla Guide. - - - - - In processmail.pl, add "binmode(HANDLE)" before all read() calls. - This may not be necessary, but in some cases the read() under - Win32 doesn't count the EOL's without using a binary read(). - - - + + + + + Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work. + +new(''); #connect to SMTP server +$smtp->mail('@');# use the sender's adress here +$smtp->to($tolist); # recipient's address +$smtp->data(); # Start the mail +$smtp->datasend($msg); +$smtp->dataend(); # Finish sending the mail +$smtp->quit; # Close the SMTP connection +$logstr = "$logstr; mail sent to $tolist $cclist"; +} + +]]> + +here is a test mail program for Net::SMTP: + + +use Net::SMTP; + my $smtp = Net::SMTP->new(' 30, Debug +=> 1, ); # connect to SMTP server + $smtp->auth; + $smtp->mail('you@yourcompany.com');# use the sender's adress +here + $smtp->to('someotherAddress@someotherdomain.com'); # +recipient's address + $smtp->data(); # Start the mail + $smtp->datasend('test'); + $smtp->dataend(); # Finish sending the mail + $smtp->quit; # Close the SMTP connection +exit; -
- Additional Windows Tips - - +]]> + + + + + + + + This step is completely 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. For instance, change this line in processmail: + +system ("./processmail.pl",@ARGLIST); + +to + +system ("perl processmail.pl",@ARGLIST); + + + + + + + + If you are using IIS 5.0 or higher, 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 - - + + 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" - - + 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. - -
- - - - "Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions: -
- + +
+ + + + "Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions: +
+ Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I deleted the current dir and copied the files in). - - + + In checksetup.pl, I did the following... - - - - + + + + my $webservergid = getgrnam($my_webservergroup); - - to - + + to + my $webservergid = 'Administrators' - - - - + + + + I then ran checksetup.pl - - - - + + + + I removed all the encrypt() - - Removing encrypt() for Windows NT installations - + + Removing encrypt() for Windows NT installations + Replace this: - + SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); my $enteredcryptpwd = FetchOneColumn(); - + with this: - + my $enteredcryptpwd = $enteredpwd - + in cgi.pl. - - - - - - + + + + + + I renamed processmail to processmail.pl - - - - + + + + I altered the sendmail statements to windmail: - + open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - - - + + + The quotes around the dir is for the spaces. mail.log is for the output - - - -
- - - + + + +
+ + + This was some late breaking information from Jan Evert. Sorry for the lack of formatting. - - + + I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you at this moment of the commments I have to section 2.2.1 of the bugzilla guide (at http://www.trilobyte.net/barnsons/html/). @@ -1340,7 +1731,7 @@ necessary to add the ExecCGI option to the bugzilla directory. Also the 'AddHandler' line for .cgi is by default commented out. Step 3: although just a detail, 'ppm install <module%gt;' will also work -(wihtout .ppd). And, it can also download these automatically from +(without .ppd). And, it can also download these automatically from ActiveState. Step 4: although I have cygwin installed, it seems that it is not necessary. @@ -1372,30 +1763,30 @@ that apache can serve them. Just noticed the updated guide... Brian's comment is new. His first comment will work, but opens up a huge security hole. - - -
-
- - - - + + +
+
+ -- cgit v1.2.3-24-g4f1b