From 1252fe4ecdc1dc3af7ad57955c062c2c1a185bb3 Mon Sep 17 00:00:00 2001 From: "jake%bugzilla.org" <> Date: Sat, 17 May 2003 08:39:29 +0000 Subject: Recompile docs so (hopefully) I can get some feedback on the installation chapter changes. --- docs/html/Bugzilla-Guide.html | 2292 +++++++++++++++++++++++++---------------- 1 file changed, 1417 insertions(+), 875 deletions(-) (limited to 'docs/html/Bugzilla-Guide.html') diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index 9fe33476c..fe8ecffdc 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -448,11 +448,16 @@ CLASS="LOT" >
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation - License, Version 1.1 or any later version published by the + License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no - Front-Cover Texts, and with no Back-Cover Texts. A copy of + Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in Appendix E
All copyrights are held by their respective owners, unless - specifically noted otherwise. Use of a term in this document + specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark.
Naming of particular products or brands should not be seen as - endorsements, with the exception of the term "GNU/Linux". We + endorsements, with the exception of the term "GNU/Linux". We wholeheartedly endorse the use of GNU/Linux in every situation - where it is appropriate. It is an extremely versatile, stable, + where it is appropriate. It is an extremely versatile, stable, and robust operating system that offers an ideal operating environment for Bugzilla.
The newest version of this guide can always be found at bugzilla.orghttp://www.bugzilla.org; including documentation for past releases and the current development version.The latest version of this document can always be checked out via CVS. - Please follow the instructions available at - the Mozilla CVS page, - and check out the Mozilla CVS + instructions and check out the mozilla/webtools/bugzilla/docs/ @@ -788,13 +797,13 @@ HREF="news://news.mozilla.org/netscape/public/mozilla/webtools" TARGET="_top" >news://news.mozilla.org/netscape/public/mozilla/webtools - newsgroup. Without your discussions, insight, suggestions, and patches, + newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
Thanks also go to the following people for significant contributions to this documentation (in alphabetical order): - Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Ron Teitelbaum, Spencer Smith, Zach Liption + Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption .
The Search page has controls for selecting different possible values for all of the fields in a bug, as described above. Once you've @@ -1878,7 +1885,7 @@ CLASS="section" >
4.1. Step-by-step Install
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 +>Bugzilla has been successfully installed under many different + operating systems including almost all Unix clones and + Microsoft Windows. Many + operating systems have utilities that make installation easier or quirks + that make it harder. We have tried to collect that information in Section 4.3.1 - for further advice on getting Bugzilla to work on Microsoft - Windows.
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 +>Windows is one of those operating systems that has many quirks + and is not yet officially supported by the Bugzilla team. If you wish + to install Bugzilla on Windows, be sure to see Using Bundle::Bugzilla instead of manually installing Perl modulesSection 4.3.1.
The software packages necessary for the proper running of - Bugzilla (with download links) are: -
MySQL database server - (3.23.41 or greater) - |
Perl - (5.6, 5.6.1 is recommended if you wish to - use Bundle::Bugzilla) -
Perl Modules (minimum version): -
The listing below is a basic step-by-step list. More information + can be found in the sections below. Minimum versions will be + included in parenthesis where appropriate. +TemplateInstall MySQL - (v2.08) -
File::TempInstall Perl - (1.804) (Prerequisite for Template) -
AppConfig - Install Perl Modules - (1.52) -
Text::Wrap - (2001.0131) -
File::Spec - Install a Webserver - (0.82) -
Data::Dumper - - (any) -
DBD::mysql - - (2.1010) -
DBI - (1.32) -
Date::Parse - - (2.21) -
CGI - - (2.88) -
GDPut Bugzilla in the Webspace - (1.20) for bug charting -
GD::Graph - (any) for bug charting -
GD::Text::Align - (any) for bug charting -
Chart::Base - Setup the MySQL Database - (0.99c) for bug charting -
XML::Parser - (any) for the XML interface -
MIME::Parser - (any) for the email interface -
The web server of your choice. - Apache - is highly recommended. -
It is a good idea, while installing Bugzilla, to ensure that there - is some kind of firewall between you and the rest of the Internet, - because your machine may be insecure for periods during the install. - Many - installation steps require an active Internet connection to complete, - but you must take care to ensure that at no point is your machine - vulnerable to an attack. |
Visit the MySQL homepage at www.mysql.comhttp://www.mysql.com to grab and install the latest stable release of the server.
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. +>If you install from something other than a packaging/installation + system (such as .rpm, .dep, .exe, or .msi) you will need to configure + your system so the MySQL server daemon will come back up whenever + your machine reboots.
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 - -O max_allowed_packet=1M - to the command that starts +>If you wish to have attachments larger than 64K, you will have to + configure MySQL to accept large packets. This is done by adding the text + in Figure 4-1 to your 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.
my.conf file. There is also a parameter in Bugzilla + for setting the maximum allowable attachment size. + + You should set this value to be slightly larger than that parameter. +If you plan on running Bugzilla and MySQL on the same machine, - consider using the - Figure 4-1. Set Max Packet Size in MySQL
[mysqld] +# Allow packets up to 1M +set-variable = max_allowed_packet=1M + |
If you are running Bugzilla and MySQL on the same machine, you may + also wish to utilize the --skip-networking - option in the init script. This enhances security by preventing - network access to MySQL.
skip-networking option as + mentioned in Section 5.6.2 for the added security. +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. +>http://www.perl.com. + There are also binary versions available for many platforms, most of which + are linked to from perl.com. Although Bugzilla runs with perl 5.6, 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 5.8.
Perl modules can be found using + CPAN on Unix based systems or + PPM on Win32. The root servers + have a real tendency to bog down, so please use mirrors. +
Good instuctions can be found for using each of these services on + their respective websites. The basics can be found in + Example 4-1 for CPAN and + Section 4.3.1.2 for PPM. +
Example 4-1. Installing perl modules with CPAN
The easy way: +
bash# perl -MCPAN -e 'install "<modulename>"' + |
Or the hard way: +
bash# tar xzvf <module>.tar.gz +bash# cd <module> +bash# perl Makefile.PL +bash# make +bash# make test +bash# make install + |
- All Perl modules can be found on the - Comprehensive Perl - Archive Network (CPAN). The - CPAN servers have a real tendency to bog down, so please use mirrors. -
Quality, general Perl module installation instructions can be - found on the CPAN website, but the easy thing to do is to just use the - CPAN shell which does all the hard work for you. - To use the CPAN shell to install a module: -
bash# - perl -MCPAN -e 'install "<modulename>"' - -
To do it the hard way: -
Untar the module tarball -- it should create its own - directory
CD to the directory just created, and enter the following - commands: -
Perl Modules (minimum version): +
bash# - - perl Makefile.PL - Bundle::Bugzilla -
bash# AppConfig - - make
CGI + (2.88) +
Data::Dumper + (any) +
DBI + (1.32) +
bash# File::Spec - - make test
bash# Text::Wrap + (2001.0131) +
GD -
XML::Parser + (any) for the XML interface +
GD::Graph + (any) for bug charting +
GD::Text::Align + (any) for bug charting
MIME::Parser + (any) for the email interface +
Assuming your perl was installed with CPAN (most unix installations + are), using Bundle::Bugzilla is really easy. Simply follow along with the + commands below. +
Dependency for Template Toolkit. We probably don't need to + specifically check for it anymore. +
The CGI module parses form elements and cookies and does many + other usefule things. It come as a part of recent perl distributions, but + Bugzilla needs a fairly new version. +
+ CPAN Download Page: http://search.cpan.org/dist/CGI.pm/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html
+
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. +
+ CPAN Download Page: http://search.cpan.org/dist/Data-Dumper/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html
+
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. +
+ CPAN Download Page: http://search.cpan.org/dist/TimeDate/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip
+ Documentation: http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm
+
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.
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.
The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -2896,34 +3120,161 @@ NAME="AEN572" with a null password should find itself with sufficient access to run tests on the 'test' database which MySQL created upon installation.
+ CPAN Download Page: http://search.cpan.org/dist/DBD-mysql/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip
+ Documentation: http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pod
+
File::Spec is a perl module that allows file operations, such as + generating full path names, to work cross platform. +
+ CPAN Download Page: http://search.cpan.org/dist/File-Spec/
+ PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Spec.html
+
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. +>File::Temp is used to generate a temporary filename that is + guaranteed to be unique. It comes as a standard part of perl +
+ CPAN Download Page: http://search.cpan.org/dist/File-Spec/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Temp.html
+
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. +
+ CPAN Download Page: http://search.cpan.org/dist/Template-Toolkit/
+ PPM Download Link: http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz
+ Documentation: http://www.template-toolkit.org/docs.html
+
Text::Wrap is designed to proved intelligent text wrapping.
+ CPAN Download Page: http://search.cpan.org/dist/Text-Tabs+Wrap/
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html
+
The GD library was written by Thomas Boutell a long while ago to - programatically generate images in C. Since then it's become the + programmatically generate images in C. Since then it's become the defacto standard for programmatic 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 @@ -2967,36 +3318,224 @@ CLASS="classname" >
The version of the GD perl module you need is very closely tied + to the libgd version installed on your system. + If you have a version 1.x of libgd the 2.x + versions of the GD perl module won't work for you. + |
+ CPAN Download Page: http://search.cpan.org/dist/GD/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip
+ Documentation: http://stein.cshl.org/WWW/software/GD/
+
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.
+ CPAN Download Page: http://search.cpan.org/dist/Chart/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Chart.zip
+
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. +>XML::Parser is used by the importxml.pl + script. You only need it if you are going to be importing bugs (such as + for bug moving). XML::Parser requires that the + expat library is already installed on your machine. +
+ CPAN Download Page: http://search.cpan.org/dist/XML-Parser/
+ Documentation: http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html
+
In addition to GD listed above, the reporting interface of Bugzilla + needs to have the GD::Graph module installed. +
+ CPAN Download Page: http://search.cpan.org/dist/GDGraph/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip
+ Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm
+
GD::Text::Align, as the name implies, is used to draw aligned + strings of text. It is needed by the reporting interface. +
+ CPAN Download Page: http://search.cpan.org/dist/GDTextUtil/
+ PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip
+ Documentation: http://search.cpan.org/dist/GDTextUtil/Text/Align.pm
+
MIME::Parser is only needed if you want to use the e-mail interface + located in the contrib directory.
+ CPAN Download Page: http://search.cpan.org/dist/MIME-tools/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip
+ Documentation: http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm
+
You have freedom of choice here, pretty much any web server that is capable of running 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.
Bugzilla Documentation. +You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably @@ -3113,112 +3657,129 @@ CLASS="QUOTE" >
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.
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.
The default Bugzilla distribution is not designed to be placed + in a cgi-bin directory (this + includes any directory which is configured using the + ScriptAlias directive of Apache). This will probably + change as part of + bug + 44659. + |
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 +>This first thing you'll want to do is make sure you've given the "bugs", and will have minimal permissions. +>"root" user a password as suggested in + Section 5.6.2. For clarity, these instructions will + assume that your MySQL user for Bugzilla will be "bugs_user", + the database will be called "bugs_db" and the password for + the "bugs_user" user is "bugs_password". You + should, of course, substitute the values you intend to use for your site.
Begin by giving the MySQL root user a password. MySQL passwords are limited - to 16 characters. -
bash# - - mysql -u root mysql - - |
mysql> - - UPDATE user SET Password=PASSWORD('<new_password>') - WHERE user='root'; - - |
mysql> - - FLUSH PRIVILEGES; - - |
Next, we use an SQL command to create a "bugs""bugs_user" - user, and grant sufficient permissions for checksetup.pl, which we'll use later, to work its magic. This also restricts the "bugs""bugs_user" user to operations within a database called "bugs""bugs_db", and only allows the account to connect from . 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>'; -- |
GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost + IDENTIFIED BY 'bugs_password'; +mysql> - - FLUSH PRIVILEGES; - - | FLUSH PRIVILEGES; +
If you are using MySQL 4, the bugs user also needs to be granted - the LOCK TABLES and CREATE TEMPORARY TABLES permissions. + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions.
bash# - - ./checksetup.pl -- | ./checksetup.pl
+
You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. @@ -3508,7 +4048,7 @@ CLASS="section" >
OpenLDAP with Bugzilla, using any of a number of administration - tools. You should apply the patch attached this bug: + tools. You should apply the patch attached to http://bugzilla.mozilla.org/show_bug.cgi?id=158630, then set - the following object classes for your users: +>bug 158630 + , then set the following object classes for your users:
http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3http://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 @@ -3950,13 +4490,13 @@ VALIGN="TOP" >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. See + marked up in this way to load twice. See bug - 126266 for more information including progress toward making +>bug 126266 + for more information including progress toward making bugzilla charset aware by default.
http://www.snert.com/Software/mod_throttle/ +>. Follow the instructions to install into your Apache install. This module only functions with the Apache web @@ -4134,19 +4674,23 @@ CLASS="section" >Bugzilla on Windows requires the same perl modules found in Section 4.1.2Section 4.1.3. The main difference is that - windows uses ppm instead of CPAN. + windows uses PPM instead of + CPAN.