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.
|
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. +> 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.
If you've installed from source or non-package (RPM, deb, - etc.) binaries you'll want to make sure to add mysqld to your +> 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. 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. + 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 -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. + machine, consider using the --skip-networking + option in the init script. This enhances security by + preventing network access to MySQL.
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 + 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 5.6.1)
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. + at the time of this writing can be found in Appendix B.
Quality, general Perl module installation instructions can be found on @@ -468,7 +642,7 @@ NAME="AEN537"
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. +> Data::Dumper is used by the MySQL-related Perl modules. It + can be found on CPAN (see Appendix B) and + can be + installed by following the same four step make sequence used + for the DBI module.
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 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. +> 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: Appendix B). 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.
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. +> 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, - but isn't that always the way with OOP. At any rate, you can find the - GD library on CPAN (link in Appendix B, Software Download Links). +> 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 Appendix B.
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. +> 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.
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 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. + 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 Appendix B. 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 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. +> 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.
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 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 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 - With apache you'll also want to make sure that within the + access.conf file the line: +
Options ExecCGI |
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. +>
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. |
There are two critical directories and a file that should not be a served by - the HTTP server. These are the 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 - 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 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 .htaccess files and security for details. +> for details + on how to do this for Apache. I appreciate notes on how to + get this same functionality using other webservers.
You should untar the Bugzilla files into a directory that you're - willing to make writable by the default web server user (probably - 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 (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. +>). 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. + 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" 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. To make future upgrades easier, you should use the symlink - approach. -
Example 3-1. 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
- 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 for
+ "/usr/bin/perl"
- below; if on certain other UNIX systems,
- Perl may live in weird places like 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# 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, +> If you don't have root access to set this symlink up, check out the , listed in Useful Patches and Utilities for Bugzilla. - It will change the path to perl in all your Bugzilla files for you. -
. It will change the path to perl in all your Bugzilla files for you. +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. - +> 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. +
Give the MySQL root user a password. MySQL passwords are - limited to 16 characters. -
Give the MySQL root user a password. MySQL passwords are + limited to 16 characters. +
| bash# - mysql -u root mysql - mysql + -u root mysql - |
| mysql> - UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root'; - - UPDATE user SET Password=PASSWORD ('new_password') + WHERE user='root'; - |
| mysql> - FLUSH PRIVILEGES; - FLUSH + PRIVILEGES; - |
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. -
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. -
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> - mysql> + - FLUSH PRIVILEGES; - 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. -
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 - - |
This file contains a variety of settings you may need to tweak including - how Bugzilla should connect to the MySQL database. -
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: -
The connection settings include: +
server's host: just use "localhost" if the MySQL server is - local -
server's host: just use "localhost" if the + MySQL server is local +database name: "bugs" if you're following these directions -
database name: "bugs" if you're following + these directions +MySQL username: "bugs" if you're following these directions -
MySQL username: "bugs" if you're following + these directions +Password for the "bugs" MySQL account above -
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 You should also install .htaccess files that the Apache + webserver will use to restrict access to Bugzilla data files. + See .htaccess files and security. -
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. -
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. +Should everything work, you should have a nearly empty copy of the bug - tracking setup. -
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. +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. Should everything work, you will have a nearly empty Bugzilla + database and a newly-created localconfig -
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. -
Example 3-2. 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 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:
- of
+ checksetup.pl, do this:
+
-
- bash# chown -R apache:apache /usr/local/bugzilla
-bash# su - apache
-bash# cd /usr/local/bugzilla
-bash# ./checksetup.pl
-
+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 +> 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. -
If you want to add someone else to every group by hand, you +> 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 + mysql -u root -p bugs You may need different parameters, depending on your security settings. Then:
+> (yes, that's fifteen"f"'s.