These installation instructions are presented assuming you are
These installation instructions are presented assuming you are
...
@@ -50,6 +50,7 @@
...
@@ -50,6 +50,7 @@
refer to these documents when installing, configuring, and
refer to these documents when installing, configuring, and
maintaining your Bugzilla installation.
maintaining your Bugzilla installation.
</member>
</member>
</simplelist>
</simplelist>
<warning>
<warning>
...
@@ -108,8 +109,7 @@
...
@@ -108,8 +109,7 @@
the CPAN dependencies listed below, and are running the very
the CPAN dependencies listed below, and are running the very
most recent version of Perl and MySQL (both the executables
most recent version of Perl and MySQL (both the executables
and development libraries) on your system, check out
and development libraries) on your system, check out
Bundle::Bugzilla in <xref
Bundle::Bugzilla in <xreflinkend="bundlebugzilla"></para>
linkend="bundlebugzilla"></para>
</note>
</note>
<para>
<para>
The software packages necessary for the proper running of bugzilla are:
The software packages necessary for the proper running of bugzilla are:
...
@@ -185,39 +185,64 @@
...
@@ -185,39 +185,64 @@
attack.
attack.
</para>
</para>
</warning>
</warning>
<note>
<para>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
<filename>urpmi</filename> utility. If you follow these
commands, you should have everything you need for
Bugzilla, and <filename>checksetup.pl</filename> should
not complain about any missing libraries. You may already
have some of these installed.</para>
<simplelist>
<member><prompt>bash#</prompt><command> urpmi
perl-mysql</command></member>
<member><prompt>bash#</prompt><command> urpmi
perl-chart</command></member>
<member><prompt>bash#</prompt><command> urpmi
perl-gd</command></member>
<member><prompt>bash#</prompt><command> urpmi
perl-MailTools</command> (for Bugzilla email
integration)</member>
<member><prompt>bash#</prompt><command> urpmi
apache-modules</command></member>
</simplelist>
</note>
</para>
</para>
</section>
</section>
<sectionid="install-mysql">
<sectionid="install-mysql">
<title>Installing MySQL Database</title>
<title>Installing MySQL Database</title>
<para>
<para>
Visit MySQL homepage at http://www.mysql.com/ and grab the
Visit MySQL homepage at <ulink
latest stable release of the server. Both binaries and source
url="http://www.mysql.com">www.mysql.com</ulink> and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in <filename>/var</filename> 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 <filename>configure</filename>.
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.
</para>
</para>
<para>
<para>
If you've installed from source or non-package (RPM, deb,
If you install from source or non-package (RPM, deb, etc.)
etc.) binaries you'll want to make sure to add mysqld to your
binaries you need to add
<firstterm>mysqld</firstterm> to your
init scripts so the server daemon will come back up whenever
init scripts so the server daemon will come back up whenever
your machine reboots. You also may want to edit those init
your machine reboots. Further discussion of UNIX init
scripts, to make sure that mysqld will accept large packets.
sequences are beyond the scope of this guide.
By default, mysqld is set up to only accept packets up to 64K
<note>
long. This limits the size of attachments you may put on
<para>You should have your init script start
bugs. If you add something like "-O max_allowed_packet=1M" to
<glossterm>mysqld</glossterm> with the ability to accept
the command that starts mysqld (or safe_mysqld), then you will
large packets. By default, <filename>mysqld</filename>
be able to have attachments up to about 1 megabyte.
only accepts packets up to 64K long. This limits the size
of attachments you may put on bugs. If you add <option>-O
max_allowed_packet=1M</option> to the command that starts
<filename>mysqld</filename> (or
<filename>safe_mysqld</filename>), then you will be able
to have attachments up to about 1 megabyte.</para>
</note>
</para>
</para>
<note>
<note>
<para>
<para>
If you plan on running Bugzilla and MySQL on the same
If you plan on running Bugzilla and MySQL on the same
machine, consider using the "--skip-networking" option in
machine, consider using the <option>--skip-networking</option>
the init script. This enhances security by preventing
option in the init script. This enhances security by
network access to MySQL.
preventing network access to MySQL.
</para>
</para>
</note>
</note>
</section>
</section>
...
@@ -260,9 +285,10 @@
...
@@ -260,9 +285,10 @@
<tipid="bundlebugzilla"xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
<tipid="bundlebugzilla"xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
<para>
<para>
You can skip the following Perl module installation steps by
You can skip the following Perl module installation steps by
installing "Bundle::Bugzilla" from CPAN, which includes
installing <productname>Bundle::Bugzilla</productname> from
them. All Perl module installation steps require you have an
<glosstermlinkend="gloss_cpan">CPAN</glossterm>, which
active Internet connection. If you wish to use
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
Bundle::Bugzilla, however, you must be using the latest
version of Perl (at this writing, version &perl-ver;)
version of Perl (at this writing, version &perl-ver;)
</para>
</para>
...
@@ -293,7 +319,7 @@
...
@@ -293,7 +319,7 @@
Like almost all Perl modules DBI can be found on the Comprehensive Perl
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
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
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 <xreflinkend="downloadlinks">.
</para>
</para>
<para>
<para>
Quality, general Perl module installation instructions can be found on
Quality, general Perl module installation instructions can be found on
...
@@ -370,9 +396,11 @@
...
@@ -370,9 +396,11 @@
hurt anything.
hurt anything.
</para>
</para>
<para>
<para>
Data::Dumper is used by the MySQL-related Perl modules. It can be
Data::Dumper is used by the MySQL-related Perl modules. It
found on CPAN (link in Appendix A) and can be installed by following
can be found on CPAN (see <xreflinkend="downloadlinks">) and
the same four step make sequence used for the DBI module.
can be
installed by following the same four step make sequence used
for the DBI module.
</para>
</para>
</section>
</section>
...
@@ -414,37 +442,42 @@
...
@@ -414,37 +442,42 @@
<section>
<section>
<title>TimeDate Perl Module Collection</title>
<title>TimeDate Perl Module Collection</title>
<para>
<para>
Many of the more common date/time/calendar related Perl modules have
Many of the more common date/time/calendar related Perl
been grouped into a bundle similar to the MySQL modules bundle. This
modules have been grouped into a bundle similar to the MySQL
bundle is stored on the CPAN under the name TimeDate. A link
modules bundle. This bundle is stored on the CPAN under the
link may be found in Appendix B, Software Download Links.
name TimeDate (see link: <xreflinkend="downloadlinks">). The
The component module we're
component module we're most interested in is the Date::Format
most interested in is the Date::Format module, but installing all of them
module, but installing all of them is probably a good idea
is probably a good idea anyway. The standard Perl module installation
anyway. The standard Perl module installation instructions
instructions should work perfectly for this simple package.
should work perfectly for this simple package.
</para>
</para>
</section>
</section>
<section>
<section>
<title>GD Perl Module (1.8.3)</title>
<title>GD Perl Module (1.8.3)</title>
<para>
<para>
The GD library was written by Thomas Boutell a long while ago to
The GD library was written by Thomas Boutell a long while
programatically generate images in C. Since then it's become almost a
ago to programatically generate images in C. Since then it's
defacto standard for programatic image construction. The Perl bindings
become the defacto standard for programatic image
to it found in the GD library are used on a million web pages to generate
construction. The Perl bindings to it found in the GD library
graphs on the fly. That's what bugzilla will be using it for so you'd
are used on millions of web pages to generate graphs on the
better install it if you want any of the graphing to work.
fly. That's what bugzilla will be using it for so you must
install it if you want any of the graphing to work.
</para>
</para>
<para>
<para>
Actually bugzilla uses the Graph module which relies on GD itself,
Actually bugzilla uses the Graph module which relies on GD
but isn't that always the way with OOP. At any rate, you can find the
itself. Isn't that always the way with object-oriented
GD library on CPAN (link in Appendix B, Software Download Links).
programming? At any rate, you can find the GD library on CPAN
in <xreflinkend="downloadlinks">.
</para>
</para>
<note>
<note>
<para>
<para>
The Perl GD library requires some other libraries that may or may not be
The Perl GD library requires some other libraries that may
installed on your system, including "libpng" and "libgd". The full requirements
or may not be installed on your system, including
are listed in the Perl GD library README. Just realize that if compiling GD fails,
<classname>libpng</classname> and
it's probably because you're missing a required library.
<classname>libgd</classname>. 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.
</para>
</para>
</note>
</note>
</section>
</section>
...
@@ -453,62 +486,78 @@
...
@@ -453,62 +486,78 @@
<title>Chart::Base Perl Module (0.99c)</title>
<title>Chart::Base Perl Module (0.99c)</title>
<para>
<para>
The Chart module provides bugzilla with on-the-fly charting
The Chart module provides bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been
abilities. It can be installed in the usual fashion after it
fetched from CPAN where it is found as the Chart-x.x... tarball in a
has been fetched from CPAN where it is found as the
directory to be listed in Appendix B, "Software Download Links".
Chart-x.x... tarball, linked in <xreflinkend="downloadlinks">. Note that
Note that as with the GD perl
as with the GD perl module, only the version listed above, or
module, only the version listed above, or newer, will work.
newer, will work. Earlier versions used GIF's, which are no
Earlier
longer supported by the latest versions of GD.
versions used GIF's, which are no longer supported by the latest
versions of GD.
</para>
</para>
</section>
</section>
<section>
<section>
<title>DB_File Perl Module</title>
<title>DB_File Perl Module</title>
<para>
<para>
DB_File is a module which allows Perl programs to make use of the facilities provided by
DB_File is a module which allows Perl programs to make use
Berkeley DB version 1.x. This module is required by collectstats.pl which is used for
of the facilities provided by Berkeley DB version 1.x. This
bug charting. If you plan to make use of bug charting, you must install this module.
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.
</para>
</para>
</section>
</section>
<section>
<section>
<title>HTTP Server</title>
<title>HTTP Server</title>
<para>
<para>
You have a freedom of choice here - Apache, Netscape or any other
You have a freedom of choice here - Apache, Netscape or any
server on UNIX would do. You can easily run the web server on a different
other server on UNIX would do. You can easily run the web
machine than MySQL, but need to adjust the MySQL "bugs" user permissions
server on a different machine than MySQL, but need to adjust
accordingly.
the MySQL <quote>bugs</quote> user permissions accordingly.
<note>
<para>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.</para>
</note>
</para>
</para>
<para>
<para>
You'll want to make sure that your web server will run any file
You'll want to make sure that your web server will run any
with the .cgi extension as a cgi and not just display it. If you're using
file with the .cgi extension as a cgi and not just display it.
apache that means uncommenting the following line in the srm.conf file:
If you're using apache that means uncommenting the following
</simplelist> replacing XXX with the Bugzilla email address.
</simplelist> replacing XXX with the Bugzilla email address.
</para>
</para>
...
@@ -1156,33 +1203,74 @@ bash# ./checksetup.pl
...
@@ -1156,33 +1203,74 @@ bash# ./checksetup.pl
<parameter>0</parameter>.
<parameter>0</parameter>.
</para>
</para>
</section>
</section>
<sectionid="mod_throttle"xreflabel="Using mod_throttle to prevent Denial of Service attacks">
<title><filename>mod_throttle</filename> and Security</title>
<para>
It is possible for a user, by mistake or on purpose, to access
the database many times in a row which can result in very slow
access speeds for other users. If your Bugzilla installation
is experiencing this problem , you may install the Apache
module <filename>mod_throttle</filename> which can limit
connections by ip-address. You may download this module at
<ulink
url="http://www.snert.com/Software/Throttle/">http://www.snert.com/Software/Throttle/</ulink>. Follow the instructions to install into your Apache install. <emphasis>This module only functions with the Apache web server!</emphasis>. You may use the <command>ThrottleClientIP</command> command provided by this module to accomplish this goal. See the <ulinkurl="http://www.snert.com/Software/Throttle/">Module Instructions</ulink> for more information. </para>
<title>Preventing untrusted Bugzilla content from executing malicious Javascript code</title>
<para>It is possible for a Bugzilla to execute malicious
Javascript code. Due to internationalization concerns, we are
unable to incorporate the code changes necessary to fulfill
the CERT advisory requirements mentioned in <ulink
url="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3">http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</ulink>. Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience. As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it. </para>
<para><programlisting>
bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
mv $i.tmp $i; done
</programlisting></para>
<para>
All this one-liner command does is search for all instances of
<quote>Content-type: text/html</quote> and replaces it with
This document was heavily modified again Wednesday, March 07 2001 to
This document was heavily modified again Wednesday, March 07
reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The
2001 to reflect changes for Bugzilla 2.12 release by Matthew
securing MySQL section should be changed to become standard procedure
P. Barnson. The securing MySQL section should be changed to
for Bugzilla installations.
become standard procedure for Bugzilla installations.
</para>
</para>
<para>
<para>
Finally, the README in its entirety was marked up in SGML and included into
Finally, the README in its entirety was marked up in SGML and
the Guide on April 24, 2001 by Matt Barnson. Since that time, it's undergone
included into the Guide on April 24, 2001 by Matt Barnson.
extensive modification as Bugzilla grew.
Since that time, it's undergone extensive modification as
Bugzilla grew.
</para>
</para>
<para>
<para>
Comments from people using this Guide for the first time are particularly welcome.
Comments from people using this Guide for the first time are
particularly welcome.
</para>
</para>
</section>
</section>
</section>
</section>
...
@@ -1217,27 +1305,33 @@ bash# ./checksetup.pl
...
@@ -1217,27 +1305,33 @@ bash# ./checksetup.pl
picnic. Support for Win32 has improved dramatically in the
picnic. Support for Win32 has improved dramatically in the
last few releases, but, if you choose to proceed, you should
last few releases, but, if you choose to proceed, you should
be a <emphasis>very</emphasis> skilled Windows Systems
be a <emphasis>very</emphasis> skilled Windows Systems
Administrator with both strong troubleshooting abilities and
Administrator with strong troubleshooting abilities, a high
a high tolerance for pain. Bugzilla on NT requires hacking
tolerance for pain, and moderate perl skills. Bugzilla on NT
source code and implementing some advanced utilities. What
requires hacking source code and implementing some advanced
follows is the recommended installation procedure for Win32;
utilities. What follows is the recommended installation
additional suggestions are provided in <xreflinkend="faq">.
procedure for Win32; additional suggestions are provided in
<xreflinkend="faq">.
</para>
</para>
</note>
</note>
<procedure>
<procedure>
<step>
<step>
<para>
<para>
Install <ulinkurl="http://www.apache.org/">Apache Web Server</ulink>
Install <ulinkurl="http://www.apache.org/">Apache Web
for Windows.
Server</ulink> for Windows, and copy the Bugzilla files
somewhere Apache can serve them. Please follow all the
instructions referenced in <xreflinkend="installation">
regarding your Apache configuration, particularly
instructions regarding the <quote>AddHandler</quote>
parameter and <quote>ExecCGI</quote>.
</para>
</para>
<note>
<note>
<para>
<para>
You may also use Internet Information Server or Personal Web
You may also use Internet Information Server or Personal
Server for this purpose. However, setup is slightly more
Web Server for this purpose. However, setup is quite
difficult. If ActivePerl doesn't seem to handle your file
different. If ActivePerl doesn't seem to handle your
associations correctly (for .cgi and .pl files), please
file associations correctly (for .cgi and .pl files),
consult <xreflinkend="faq">.
please consult <xreflinkend="faq">.
</para>
</para>
<para>
<para>
If you are going to use IIS, if on Windows NT you must
If you are going to use IIS, if on Windows NT you must
...
@@ -1299,8 +1393,7 @@ bash# ./checksetup.pl
...
@@ -1299,8 +1393,7 @@ bash# ./checksetup.pl
Install MySQL for NT.
Install MySQL for NT.
<note>
<note>
<para>
<para>
You can download MySQL for Windows NT from <ulink
You can download MySQL for Windows NT from <ulinkurl="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
</para>
</para>
</note>
</note>
</para>
</para>
...
@@ -1393,13 +1486,21 @@ bash# ./checksetup.pl
...
@@ -1393,13 +1486,21 @@ bash# ./checksetup.pl
this line:
this line:
</para>
</para>
<para>
<para>
"my $webservergid = getgrnam($my_webservergroup); "
<programlisting>
my $webservergid = getgrnam($my_webservergroup);
</programlisting>
</para>
</para>
<para>
<para>
to
to
</para>
</para>
<para>
<para>
"my $webservergid = $my_webservergroup; "
<programlisting>
my $webservergid = $my_webservergroup;
</programlisting>
or the name of the group you wish to own the files explicitly:
<programlisting>
my $webservergid = 'Administrators'
</programlisting>
</para>
</para>
</step>
</step>
...
@@ -1412,8 +1513,7 @@ bash# ./checksetup.pl
...
@@ -1412,8 +1513,7 @@ bash# ./checksetup.pl
<step>
<step>
<para>Edit <filename>localconfig</filename> to suit your
<para>Edit <filename>localconfig</filename> to suit your
requirements. Set <varname>$db_pass</varname> to your
requirements. Set <varname>$db_pass</varname> to your
<quote>bugs_password</quote> from <xref
<quote>bugs_password</quote> from <xreflinkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para>
linkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para>
<note>
<note>
<para>Not sure on the <quote>8</quote> for
<para>Not sure on the <quote>8</quote> for
<varname>$webservergroup</varname> above. If it's
<varname>$webservergroup</varname> above. If it's
...
@@ -1455,8 +1555,7 @@ bash# ./checksetup.pl
...
@@ -1455,8 +1555,7 @@ bash# ./checksetup.pl
<procedure>
<procedure>
<step>
<step>
<para>
<para>
Download NTsendmail, available from<ulink
Download NTsendmail, available from<ulinkurl="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. 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)
url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. 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)
http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" is now an officially
url="http://www.ravenbrook.com/project/p4dti/"> http://www.ravenbrook.com/project/p4dti</ulink> . <quote>p4dti</quote> is now an officially supported product from Perforce, and you can find the "Perforce Public Depot" p4dti page at <ulinkurl="http://public.perforce.com/public/perforce/p4dti/index.html"> http://public.perforce.com/public/perforce/p4dti/index.html</ulink>.
supported product from Perforce, and you can find the "Perforce Public Depot"
p4dti page at <ulinkurl="http://public.perforce.com/public/perforce/p4dti/index.html">
<para>Apache's <filename>mod_rewrite</filename> module lets you do some truly amazing things with URL rewriting. Here are a couple of examples of what you can do.</para>
@@ -92,8 +92,10 @@ system against which all others are measured.
...
@@ -92,8 +92,10 @@ system against which all others are measured.
</listitem>
</listitem>
<listitem>
<listitem>
<para>
<para>
available integration with automated software configuration management systems, including
available integration with automated software
Perforce and CVS
configuration management systems, including Perforce and
CVS (through the Bugzilla email interface and
checkin/checkout scripts)
</para>
</para>
</listitem>
</listitem>
<listitem>
<listitem>
...
@@ -104,23 +106,28 @@ system against which all others are measured.
...
@@ -104,23 +106,28 @@ system against which all others are measured.
</itemizedlist>
</itemizedlist>
</para>
</para>
<para>
<para>
Despite its current robustness and popularity, however, Bugzilla
Despite its current robustness and popularity, Bugzilla faces
faces some near-term challenges, such as reliance on a single database, a lack of
some near-term challenges, such as reliance on a single
abstraction of the user interface and program logic, verbose email bug
database, a lack of abstraction of the user interface and
notifications, a powerful but daunting query interface, little reporting configurability,
program logic, verbose email bug notifications, a powerful but
problems with extremely large queries, some unsupportable bug resolution options,
daunting query interface, little reporting configurability,
no internationalization, and dependence on some nonstandard libraries.
problems with extremely large queries, some unsupportable bug
resolution options, little internationalization (although non-US
character sets are accepted for comments), and dependence on
some nonstandard libraries.
</para>
</para>
<para>
<para>
Some recent headway has been made on the query front, however. If you are using the latest
Some recent headway has been made on the query front, however.
version of Bugzilla, you should see a "simple search" form on the default front page of
If you are using the latest version of Bugzilla, you should see
your Bugzilla install. Type in two or three search terms and you should pull up some
a <quote>simple search</quote> form on the default front page of
relevant information. This is also available as "queryhelp.cgi".
your Bugzilla install. Type in two or three search terms and
you should pull up some relevant information. This is also
available as "queryhelp.cgi".
</para>
</para>
<para>
<para>
Despite these small problems, Bugzilla is very hard to beat. It is under <emphasis>very</emphasis>
Despite these small problems, Bugzilla is very hard to beat. It
active development to address the current issues, and a long-awaited overhaul in the form
is under <emphasis>very</emphasis> active development to address
of Bugzilla 3.0 is expected sometime later this year.
the current issues, and continually gains new features.
</para>
</para>
</section>
</section>
...
@@ -132,50 +139,57 @@ system against which all others are measured.
...
@@ -132,50 +139,57 @@ system against which all others are measured.
</para>
</para>
</epigraph>
</epigraph>
<para>
<para>
For many years, defect-tracking software has remained principally the domain
For many years, defect-tracking software has remained
of large software development houses. Even then, most shops never bothered
principally the domain of large software development houses.
with bug-tracking software, and instead simply relied on shared lists and
Even then, most shops never bothered with bug-tracking software,
email to monitor the status of defects. This procedure is error-prone and
and instead simply relied on shared lists and email to monitor
tends to cause those bugs judged least significant by developers to be
the status of defects. This procedure is error-prone and tends
to cause those bugs judged least significant by developers to be
dropped or ignored.
dropped or ignored.
</para>
</para>
<para>
<para>
These days, many companies are finding that integrated defect-tracking
These days, many companies are finding that integrated
systems reduce downtime, increase productivity, and raise customer
defect-tracking systems reduce downtime, increase productivity,
satisfaction with their systems. Along with full disclosure, an open
and raise customer satisfaction with their systems. Along with
bug-tracker allows manufacturers to keep in touch with their clients
full disclosure, an open bug-tracker allows manufacturers to
and resellers, to communicate about problems effectively throughout
keep in touch with their clients and resellers, to communicate
the data management chain. Many corporations have also discovered that
about problems effectively throughout the data management chain.
defect-tracking helps reduce costs by providing IT support accountability,
Many corporations have also discovered that defect-tracking
telephone support knowledge bases, and a common, well-understood system
helps reduce costs by providing IT support accountability,
for accounting for unusual system or software issues.
telephone support knowledge bases, and a common, well-understood
system for accounting for unusual system or software issues.
</para>
</para>
<para>
<para>
But why should <emphasis>you</emphasis> use Bugzilla?
But why should <emphasis>you</emphasis> use Bugzilla?
</para>
</para>
<para>
<para>
Bugzilla is very adaptable to various situations. Known uses currently
Bugzilla is very adaptable to various situations. Known uses
include IT support queues, Systems Administration deployment management,
currently include IT support queues, Systems Administration
chip design and development problem tracking (both pre-and-post fabrication),
deployment management, chip design and development problem
and software and hardware bug tracking for luminaries such as Redhat, Loki software,
tracking (both pre-and-post fabrication), and software and
Linux-Mandrake, and VA Systems. Combined with systems such as CVS, Bonsai,
hardware bug tracking for luminaries such as Redhat, Loki
or Perforce SCM, Bugzilla provides a powerful, easy-to-use solution to
software, Linux-Mandrake, and VA Systems. Combined with systems
configuration management and replication problems
such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a
powerful, easy-to-use solution to configuration management and
replication problems
</para>
</para>
<para>
<para>
Bugzilla can dramatically increase the productivity and accountability
Bugzilla can dramatically increase the productivity and
of individual employees by providing a documented workflow and positive
accountability of individual employees by providing a documented
feedback for good performance. How many times do you wake up in the
workflow and positive feedback for good performance. How many
morning, remembering that you were supposed to do *something* today,
times do you wake up in the morning, remembering that you were
but you just can't quite remember? Put it in Bugzilla, and you have a record
supposed to do <emphasis>something</emphasis> today, but you
of it from which you can extrapolate milestones, predict product versions
just can't quite remember? Put it in Bugzilla, and you have a
for integration, and by using Bugzilla's e-mail integration features
record of it from which you can extrapolate milestones, predict
be able to follow the discussion trail that led to critical decisions.
product versions for integration, and by using Bugzilla's e-mail
integration features be able to follow the discussion trail that
led to critical decisions.
</para>
</para>
<para>
<para>
Ultimately, Bugzilla puts the power in your hands to improve your value
Ultimately, Bugzilla puts the power in your hands to improve
to your employer or business while providing a usable framework for your natural
your value to your employer or business while providing a usable
attention to detail and knowledge store to flourish.
framework for your natural attention to detail and knowledge
store to flourish.
</para>
</para>
</section>
</section>
...
@@ -189,46 +203,45 @@ system against which all others are measured.
...
@@ -189,46 +203,45 @@ system against which all others are measured.
<para>
<para>
Bugzilla is a large, complex system. Describing how to use it
Bugzilla is a large, complex system. Describing how to use it
requires some time. If you are only interested in installing or administering
requires some time. If you are only interested in installing or
a Bugzilla installation, please consult the Installing and Administering
administering a Bugzilla installation, please consult the
Bugzilla portions of this Guide. This section is principally aimed towards
Installing and Administering Bugzilla portions of this Guide.
developing end-user mastery of Bugzilla, so you may fully enjoy the benefits
This section is principally aimed towards developing end-user
afforded by using this reliable open-source bug-tracking software.
mastery of Bugzilla, so you may fully enjoy the benefits
afforded by using this reliable open-source bug-tracking
software.
</para>
</para>
<para>
<para>
Throughout this portion of the Guide, we will refer to user account
Throughout this portion of the Guide, we will refer to user
options available at the Bugzilla test installation,
account options available at the Bugzilla test installation,
<ulinkurl="http://landfill.tequilarista.org/">
<ulinkurl="http://landfill.tequilarista.org/">
landfill.tequilarista.org</ulink>.
landfill.tequilarista.org</ulink>.
<note>
<note>
<para>
<para>
Some people have run into difficulties completing this tutorial. If
Some people have run into difficulties completing this
you run into problems, please check the updated, online documentation available
tutorial. If you run into problems, please check the
at <ulinkurl="http://www.trilobyte.net/barnsons/">http://www.trilobyte.net/barnsons</ulink>.
updated online documentation available at <ulink
If you're still stumped, please subscribe to the newsgroup and provide details of exactly
url="http://www.trilobyte.net/barnsons/">http://www.trilobyte.net/barnsons</ulink>. If you're still stumped, please subscribe to the newsgroup and provide details of exactly what's stumping you! If enough people complain, I'll have to fix it in the next version of this Guide. You can subscribe to the newsgroup at <ulinkurl="news://news.mozilla.org/netscape.public.mozilla.webtools"> news://news.mozilla.org/netscape.public.mozilla.webtools</ulink>
what's stumping you! If enough people complain, I'll have to fix it in the next
version of this Guide. You can subscribe to the newsgroup at
encourage you to read some bug-writing guidelines. If you
Writing Guidelines</ulink>. While some of the advice is Mozilla-specific, the basic
are reading this document as part of a Bugzilla CVS checkout
principles of reporting Reproducible, Specific bugs, isolating the Product you are
or un-tarred Bugzilla distribution, you should be able to
using, the Version of the Product, the Component which failed, the Hardware Platform, and
read them by clicking <ulink
Operating System you were using at the time of the failure go a long way toward ensuring accurate,
url="../../bugwritinghelp.html">here</ulink>. If you are reading this online, check out the Mozilla.org bug-writing guidelines at <ulinkurl="http://www.mozilla.org/quality/bug-writing-guidelines.html">http://www.mozilla.org/quality/bug-writing-guidelines.html</ulink>. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
responsible fixes for the bug that bit you.
</para>
</para>
<para>
<para>
While you are at it, why not learn how to find previously reported bugs? Mozilla.org
While you are at it, why not learn how to find previously
has published a great tutorial on finding duplicate bugs, available at
reported bugs? Mozilla.org has published a great tutorial
url="http://bugzilla.mozilla.org/describecomponents.cgi">Component</ulink> box of the Query page, you will be presented a form that will describe what all the components are.
box of the Query page, you will be presented a form that will describe what all
the components are.
</para>
</para>
<para>
<para>
Possibly the most powerful feature of the Query page is the
Possibly the most powerful feature of the Query page is the
It's a bit confusing to use the first time, but can provide unparalleled
url="http://bugzilla.mozilla.org/booleanchart.html">Boolean Chart</ulink> section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests.
flexibility in your queries,
allowing you to build extremely powerful requests.
url="http://bugzilla.mozilla.org/reports.cgi">Reports</ulink> using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page.
using the "Bug Reports" link near the bottom of the query page, and also
available via the "Reports" link
at the footer of each page.
</para>
</para>
</section>
</section>
</section>
</section>
...
@@ -701,7 +734,7 @@ system against which all others are measured.
...
@@ -701,7 +734,7 @@ system against which all others are measured.
</section>
</section>
<sectionid="init4me">
<sectionid="init4me">
<title>What's in it for me?</title>
<title>Where can I find my user preferences?</title>
<epigraph>
<epigraph>
<para>
<para>
Indiana, it feels like we walking on fortune cookies!
Indiana, it feels like we walking on fortune cookies!
...
@@ -711,98 +744,95 @@ system against which all others are measured.
...
@@ -711,98 +744,95 @@ system against which all others are measured.
</para>
</para>
</epigraph>
</epigraph>
<para>
<para>
Customized User Preferences offer tremendous versatility to
Customized User Preferences offer tremendous versatility to your
your individual Bugzilla experience.
individual Bugzilla experience. Let's plunge into what you can
Let's plunge into what you can do! The first step is to click
do! The first step is to click the "Edit prefs" link at the
the "Edit prefs" link at the footer of each page once you
footer of each page once you have logged in to <ulink
make, please submit your contributions to the <ulink
mailing list/newsgroup. The mailing list is mirrored to the netscape.public.mozilla.webtools
url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools</ulink> mailing list/newsgroup. The mailing list is mirrored to the netscape.public.mozilla.webtools newsgroup, and the newsgroup is mirrored to mozilla-webtools@mozilla.org
newsgroup, and the newsgroup is mirrored to mozilla-webtools@mozilla.org
