summaryrefslogtreecommitdiffstats
path: root/docs/sgml
diff options
context:
space:
mode:
authorgerv%gerv.net <>2002-07-28 07:00:17 +0200
committergerv%gerv.net <>2002-07-28 07:00:17 +0200
commitd8caf6045d10344c431918128e3803ca497565f3 (patch)
tree1b2fbc50e442b6413a4ef0949e8ff7eed1df1361 /docs/sgml
parenta9bb18746686c1bf5497e27f7ac2e12d0e3fc31a (diff)
downloadbugzilla-d8caf6045d10344c431918128e3803ca497565f3.tar.gz
bugzilla-d8caf6045d10344c431918128e3803ca497565f3.tar.xz
Merging new docs from 2.16 branch.
Diffstat (limited to 'docs/sgml')
-rw-r--r--docs/sgml/Bugzilla-Guide.sgml54
-rw-r--r--docs/sgml/about.sgml104
-rw-r--r--docs/sgml/administration.sgml1588
-rw-r--r--docs/sgml/conventions.sgml15
-rw-r--r--docs/sgml/database.sgml468
-rw-r--r--docs/sgml/faq.sgml263
-rw-r--r--docs/sgml/gfdl.sgml54
-rw-r--r--docs/sgml/glossary.sgml87
-rw-r--r--docs/sgml/installation.sgml3760
-rw-r--r--docs/sgml/integration.sgml41
-rw-r--r--docs/sgml/patches.sgml241
-rw-r--r--docs/sgml/using.sgml409
-rw-r--r--docs/sgml/variants.sgml66
13 files changed, 3287 insertions, 3863 deletions
diff --git a/docs/sgml/Bugzilla-Guide.sgml b/docs/sgml/Bugzilla-Guide.sgml
index bd0b3a4a1..b8868a618 100644
--- a/docs/sgml/Bugzilla-Guide.sgml
+++ b/docs/sgml/Bugzilla-Guide.sgml
@@ -16,7 +16,7 @@
<!ENTITY database SYSTEM "database.sgml">
<!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml">
-<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
+<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.bugzilla.org/">
@@ -61,33 +61,35 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<title>The Bugzilla Guide</title>
<authorgroup>
-
<author>
- <firstname>Matthew</firstname>
- <othername>P.</othername>
- <surname>Barnson</surname>
- <affiliation>
- <address><email>mbarnson@sisna.com</email></address>
- </affiliation>
+ <firstname>Matthew</firstname>
+ <othername>P.</othername>
+ <surname>Barnson</surname>
+ </author>
+ <author>
+ <firstname>The</firstname>
+ <othername>Bugzilla</othername>
+ <surname>Team</surname>
</author>
</authorgroup>
<abstract>
<para>
- This is the documentation for Bugzilla, the mozilla.org
- bug-tracking system.
- Bugzilla is an enterprise-class piece of software
- that powers issue-tracking for hundreds of
- organizations around the world, tracking millions of bugs.
+ This is the documentation for Bugzilla, the mozilla.org
+ bug-tracking system.
+ Bugzilla is an enterprise-class piece of software
+ that powers issue-tracking for hundreds of
+ organizations around the world, tracking millions of bugs.
</para>
- <para>
- This documentation is maintained in DocBook 4.1.2 XML format.
- Changes are best submitted as plain text or SGML diffs, attached
- to a Bugzilla bug.
+
+ <para>
+ This documentation is maintained in DocBook 4.1.2 XML format.
+ Changes are best submitted as plain text or SGML diffs, attached
+ to a bug filed in
+ <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</ulink>.
</para>
</abstract>
-
<keywordset>
<keyword>Bugzilla</keyword>
<keyword>Guide</keyword>
@@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- About This Guide -->
&about;
+<!-- Introduction -->
+&introduction;
+
<!-- Using Bugzilla -->
&using;
@@ -113,26 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Administering Bugzilla -->
&administration;
-<!-- Integrating Bugzilla with Third-Party Tools -->
-&integration;
-
-<!-- Major Bugzilla Variants -->
-&variants;
-
<!-- Appendix: The Frequently Asked Questions -->
&faq;
-<!-- Appendix: Required Bugzilla Software Links -->
-&requiredsoftware;
-
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Custom Patches -->
&patches;
-<!-- Appendix: The GNU Free Documentation License -->
-&gfdl;
+<!-- Appendix: Major Bugzilla Variants -->
+&variants;
<!-- Glossary -->
&glossary;
diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml
index 62e486573..b4349644a 100644
--- a/docs/sgml/about.sgml
+++ b/docs/sgml/about.sgml
@@ -4,40 +4,6 @@
<chapter id="about">
<title>About This Guide</title>
- <section id="aboutthisguide">
- <title>Purpose and Scope of this Guide</title>
- <para>
- Bugzilla is simply the best piece of bug-tracking software the
- world has ever seen. This document is intended to be the
- comprehensive guide to the installation, administration,
- maintenance, and use of the Bugzilla bug-tracking system.
- </para>
- <para>
- This release of the Bugzilla Guide is the
- <emphasis>&bzg-ver;</emphasis> release. It is so named that it
- may match the current version of Bugzilla. The numbering
- tradition stems from that used for many free software projects,
- in which <emphasis>even-numbered</emphasis> point releases (1.2,
- 1.14, etc.) are considered "stable releases", intended for
- public consumption; on the other hand,
- <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09,
- etc.) are considered unstable <emphasis>development</emphasis>
- releases intended for advanced users, systems administrators,
- developers, and those who enjoy a lot of pain.
- </para>
- <para>
- Newer revisions of the Bugzilla Guide follow the numbering
- conventions of the main-tree Bugzilla releases, available at
- <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have
- a minor revision number following a period. The current version
- of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
- something were seriously wrong with that edition of the Guide,
- subsequent releases would receive an additional dotted-decimal
- digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
- Got it? Good.
- </para>
- </section>
-
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
@@ -48,8 +14,7 @@
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
- the license is included in the section entitled "GNU Free
- Documentation License".
+ the license is included below.
</para>
</blockquote>
<para>
@@ -57,6 +22,11 @@
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;.
</para>
+
+
+ <!-- The GNU Free Documentation License -->
+ &gfdl;
+
</section>
<section id="disclaimer">
@@ -64,12 +34,11 @@
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
- As this is a new edition of this document, there may be errors
- and inaccuracies that may damage your system. Use of this
- document may cause your girlfriend to leave you, your cats to
- pee on your furniture and clothing, your computer to cease
- functioning, your boss to fire you, and global thermonuclear
- war. Proceed with caution.
+ This document may contain errors
+ and inaccuracies that may damage your system, cause your partner
+ to leave you, your boss to fire you, your cats to
+ pee on your furniture and clothing, and global thermonuclear
+ war. Proceed with caution.
</para>
<para>
All copyrights are held by their respective owners, unless
@@ -100,7 +69,7 @@
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to insure
+ product, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
@@ -110,7 +79,8 @@
<section id="newversions">
<title>New Versions</title>
<para>
- This is the &bzg-ver; version of The Bugzilla Guide. If you are
+ This is the &bzg-ver; version of The Bugzilla Guide. It is so named
+ to match the current version of Bugzilla. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
@@ -134,9 +104,16 @@
</itemizedlist>
</para>
<para>
- The latest version of this document can be checked out via CVS.
- Please follow the instructions available at <ulink
- url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
+ The latest version of this document can always be checked out via CVS.
+ Please follow the instructions available at
+ <ulink url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>,
+ and check out the <filename>mozilla/webtools/bugzilla/docs/</filename>
+ subtree.
+ </para>
+ <para>
+ The Bugzilla Guide is currently only available in English.
+ If you would like to volunteer to translate it, please contact
+ <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
</para>
</section>
@@ -144,13 +121,14 @@
<title>Credits</title>
<para>
The people listed below have made enormous contributions to the
- creation of this Guide, through their dedicated hacking efforts,
+ creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<para>
<ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink>
- for pulling together the Bugzilla Guide and shepherding it to 2.14.
+ for the Herculaean task of pulling together the Bugzilla Guide and
+ shepherding it to 2.14.
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
@@ -158,13 +136,13 @@
README upon which the UNIX installation documentation is largely based.
</para>
<para>
- <ulink url="mailto://tara@tequilarista.org">Tara
- Hernandez</ulink> for keeping Bugzilla development going
- strong after Terry left Mozilla.org
+ <ulink url="mailto://tara@tequilarista.org">Tara Hernandez</ulink>
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
</para>
<para>
- <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for
- providing insight into the key differences between Red Hat's
+ <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink>
+ for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
</para>
@@ -174,8 +152,8 @@
questions and arguments on irc.mozilla.org in #mozwebtools
</para>
<para>
- Last but not least, all the members of the <ulink
- url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
+ Last but not least, all the members of the
+ <ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
</para>
<para>
Thanks also go to the following people for significant contributions
@@ -183,19 +161,7 @@
</para>
<para>
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
- </para>
- </section>
-
- <section id="translations">
- <title>Translations</title>
- <para>
- The Bugzilla Guide needs translators! Please volunteer your
- translation into the language of your choice. If you will
- translate this Guide, please notify the members of the
- mozilla-webtools mailing list at
- <email>mozilla-webtools@mozilla.org</email>, and arrange with
- &bzg-auth; to check it into CVS.
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
</para>
</section>
diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml
index cf52999e4..f932beb25 100644
--- a/docs/sgml/administration.sgml
+++ b/docs/sgml/administration.sgml
@@ -2,28 +2,13 @@
<chapter id="administration">
<title>Administering Bugzilla</title>
- <subtitle>Or, I just got this cool thing installed. Now what the heck do I
- do with it?</subtitle>
+ <section id="parameters">
+ <title>Bugzilla Configuration</title>
- <para>So you followed
- <quote>
- <xref linkend="installation" />
- </quote>
-
- to the letter, and logged into Bugzilla for the very first time with your
- super-duper god account. You sit, contentedly staring at the Bugzilla Query
- Screen, the worst of the whole mad business of installing this terrific
- program behind you. It seems, though, you have nothing yet to query! Your
- first act of business should be to setup the operating parameters for
- Bugzilla so you can get busy getting data into your bug tracker.</para>
-
- <section id="postinstall-check">
- <title>Post-Installation Checklist</title>
-
- <para>After installation, follow the checklist below to help ensure that
- you have a successful installation. If you do not see a recommended
- setting for a parameter, consider leaving it at the default while you
- perform your initial tests on your Bugzilla setup.</para>
+ <para>Bugzilla is configured by changing various parameters, accessed
+ from the "Edit parameters" link in the page footer. Here are
+ some of the key parameters on that page. You should run down this
+ list and set them appropriately after installing Bugzilla.</para>
<indexterm>
<primary>checklist</primary>
@@ -31,185 +16,112 @@
<procedure>
<step>
- <para>Bring up
- <filename>editparams.cgi</filename>
-
- in your web browser. This should be available as the
- <quote>edit parameters</quote>
-
- link from any Bugzilla screen once you have logged in.</para>
- </step>
-
- <step>
- <para>The
- <quote>maintainer</quote>
-
- is the email address of the person responsible for maintaining this
- Bugzilla installation. The maintainer need not be a valid Bugzilla
- user. Error pages, error emails, and administrative mail will be sent
- with the maintainer as the return email address.</para>
-
- <para>Set
- <quote>maintainer</quote>
-
- to
- <emphasis>your</emphasis>
-
- email address. This allows Bugzilla's error messages to display your
- email address and allow people to contact you for help.</para>
+ <para>
+ <command>maintainer</command>:
+ The maintainer parameter is the email address of the person
+ responsible for maintaining this
+ Bugzilla installation. The address need not be that of a valid Bugzilla
+ account.</para>
</step>
<step>
- <para>The
- <quote>urlbase</quote>
-
- parameter defines the fully qualified domain name and web server path
- to your Bugzilla installation.</para>
-
- <para>For example, if your bugzilla query page is
- http://www.foo.com/bugzilla/query.cgi, set your
- <quote>urlbase</quote>
-
- is http://www.foo.com/bugzilla/.</para>
+ <para>
+ <command>urlbase</command>:
+ This parameter defines the fully qualified domain name and web
+ server path to your Bugzilla installation.</para>
+
+ <para>For example, if your Bugzilla query page is
+ <filename>http://www.foo.com/bugzilla/query.cgi</filename>,
+ set your <quote>urlbase</quote>
+ to <filename>http://www.foo.com/bugzilla/</filename>.</para>
</step>
<step>
<para>
- <quote>usebuggroups</quote>
-
- dictates whether or not to implement group-based security for
- Bugzilla. If set, Bugzilla bugs can have an associated groupmask
- defining which groups of users are allowed to see and edit the
+ <command>usebuggroups</command>:
+ This dictates whether or not to implement group-based security for
+ Bugzilla. If set, Bugzilla bugs can have an associated 'group',
+ defining which users are allowed to see and edit the
bug.</para>
<para>Set "usebuggroups" to "on"
<emphasis>only</emphasis>
-
- if you may wish to restrict access to products. I suggest leaving
- this parameter
- <emphasis>off</emphasis>
-
+ if you may wish to restrict access to particular bugs to certain
+ groups of users. I suggest leaving
+ this parameter <emphasis>off</emphasis>
while initially testing your Bugzilla.</para>
</step>
<step>
<para>
- <quote>usebuggroupsentry</quote>
-
- , when set to
- <quote>on</quote>
-
- , requires that all bugs have an associated groupmask when submitted.
- This parameter is made for those installations where product
- isolation is a necessity.</para>
-
- <para>Set "usebuggroupsentry" to "on" if you absolutely need to
- restrict access to bugs from the moment they are submitted through
- resolution. Once again, if you are simply testing your installation,
- I suggest against turning this parameter on; the strict security
- checking may stop you from being able to modify your new
- entries.</para>
+ <command>usebuggroupsentry</command>:
+ Bugzilla Products can have a group associated with them, so that
+ certain users can only see bugs in certain products. When this parameter
+ is set to <quote>on</quote>, this places all newly-created bugs in the
+ group for their product immediately.</para>
</step>
<step>
- <para>You run into an interesting problem when Bugzilla reaches a
+ <para>
+ <command>shadowdb</command>:
+ You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only table-level
write locking. What this means is that if someone needs to make a
change to a bug, they will lock the entire table until the operation
is complete. Locking for write also blocks reads until the write is
complete. The
<quote>shadowdb</quote>
-
parameter was designed to get around this limitation. While only a
single user is allowed to write to a table at a time, reads can
continue unimpeded on a read-only shadow copy of the database.
Although your database size will double, a shadow database can cause
an enormous performance improvement when implemented on extremely
high-traffic Bugzilla databases.</para>
+
+ <para>
+ As a guide, mozilla.org began needing
+ <quote>shadowdb</quote>
+ when they reached around 40,000 Bugzilla users with several hundred
+ Bugzilla bug changes and comments per day.</para>
- <para>Set "shadowdb" to "bug_shadowdb" if you will be running a
- *very* large installation of Bugzilla. The shadow database enables
- many simultaneous users to read and write to the database without
- interfering with one another.
+ <para>The value of the parameter defines the name of the
+ shadow bug database.
+ Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a
+ *very* large installation of Bugzilla.
<note>
<para>Enabling "shadowdb" can adversely affect the stability of
your installation of Bugzilla. You should regularly check that your
database is in sync. It is often advisable to force a shadow
database sync nightly via
- <quote>cron</quote>
-
- .</para>
+ <quote>cron</quote>.
+ </para>
</note>
-
- Once again, in testing you should avoid this option -- use it if or
- when you
- <emphasis>need</emphasis>
-
- to use it, and have repeatedly run into the problem it was designed
- to solve -- very long wait times while attempting to commit a change
- to the database. Mozilla.org began needing
- <quote>shadowdb</quote>
-
- when they reached around 40,000 Bugzilla users with several hundred
- Bugzilla bug changes and comments per day.</para>
-
+ </para>
+
<para>If you use the "shadowdb" option, it is only natural that you
- should turn the "queryagainstshadowdb" option "On" as well. Otherwise
+ should turn the "queryagainstshadowdb" option on as well. Otherwise
you are replicating data into a shadow database for no reason!</para>
+
</step>
<step>
<para>
- <quote>headerhtml</quote>
-
- ,
- <quote>footerhtml</quote>
-
- ,
- <quote>errorhtml</quote>
-
- ,
- <quote>bannerhtml</quote>
-
- , and
- <quote>blurbhtml</quote>
-
- are all templates which control display of headers, footers, errors,
- banners, and additional data. We could go into some detail regarding
- the usage of these, but it is really best just to monkey around with
- them a bit to see what they do. I strongly recommend you copy your
- <filename>data/params</filename>
-
- file somewhere safe before playing with these values, though. If they
- are changed dramatically, it may make it impossible for you to
- display Bugzilla pages to fix the problem until you have restored
- your
- <filename>data/params</filename>
-
- file.</para>
-
- <para>If you have custom logos or HTML you must put in place to fit
- within your site design guidelines, place the code in the
- "headerhtml", "footerhtml", "errorhtml", "bannerhtml", or "blurbhtml"
- text boxes.
- <note>
- <para>The "headerhtml" text box is the HTML printed out
- <emphasis>before</emphasis>
+ <command>shutdownhtml</command>:
- any other code on the page, except the CONTENT-TYPE header sent by
- the Bugzilla engine. If you have a special banner, put the code for
- it in "bannerhtml". You may want to leave these settings at the
- defaults initially.</para>
- </note>
+ If you need to shut down Bugzilla to perform administration, enter
+ some descriptive HTML here and anyone who tries to use Bugzilla will
+ receive a page to that effect. Obviously, editparams.cgi will
+ still be accessible so you can remove the HTML and re-enable Bugzilla.
+ :-)
</para>
</step>
<step>
<para>
- <quote>passwordmail</quote>
+ <command>passwordmail</command>:
- is rather simple. Every time a user creates an account, the text of
- this parameter is read as the text to send to the new user along with
+ Every time a user creates an account, the text of
+ this parameter (with substitutions) is sent to the new user along with
their password message.</para>
<para>Add any text you wish to the "passwordmail" parameter box. For
@@ -219,45 +131,29 @@
<step>
<para>
- <quote>useqacontact</quote>
+ <command>useqacontact</command>:
- allows you to define an email address for each component, in addition
+ This allows you to define an email address for each component, in
+ addition
to that of the default owner, who will be sent carbon copies of
- incoming bugs. The critical difference between a QA Contact and an
- Owner is that the QA Contact follows the component. If you reassign a
- bug from component A to component B, the QA Contact for that bug will
- change with the reassignment, regardless of owner.</para>
-
+ incoming bugs.</para>
+ </step>
+ <step>
<para>
- <quote>usestatuswhiteboard</quote>
-
- defines whether you wish to have a free-form, overwritable field
+ <command>usestatuswhiteboard</command>:
+ This defines whether you wish to have a free-form, overwritable field
associated with each bug. The advantage of the Status Whiteboard is
that it can be deleted or modified with ease, and provides an
easily-searchable field for indexing some bugs that have some trait
- in common. Many people will put
- <quote>help wanted</quote>
-
- ,
- <quote>stalled</quote>
-
- , or
- <quote>waiting on reply from somebody</quote>
-
- messages into the Status Whiteboard field so those who peruse the
- bugs are aware of their status even more than that which can be
- indicated by the Resolution fields.</para>
-
- <para>Do you want to use the QA Contact ("useqacontact") and status
- whiteboard ("usestatuswhiteboard") fields? These fields are useful
- because they allow for more flexibility, particularly when you have
- an existing Quality Assurance and/or Release Engineering team, but
- they may not be needed for many smaller installations.</para>
+ in common.
+ </para>
</step>
<step>
- <para>Set "whinedays" to the amount of days you want to let bugs go
- in the "New" or "Reopened" state before notifying people they have
+ <para>
+ <command>whinedays</command>:
+ Set this to the number of days you want to let bugs go
+ in the NEW or REOPENED state before notifying people they have
untouched new bugs. If you do not plan to use this feature, simply do
not set up the whining cron job described in the installation
instructions, or set this value to "0" (never whine).</para>
@@ -265,8 +161,8 @@
<step>
<para>
- <quote>commenton</quote>
-
+ <command>commenton*</command>:
+ All these
fields allow you to dictate what changes can pass without comment,
and which must have a comment from the person who changed them.
Often, administrators will allow users to add themselves to the CC
@@ -288,30 +184,17 @@
</step>
<step>
- <para>The
- <quote>supportwatchers</quote>
+ <para>
+ <command>supportwatchers</command>:
- option can be an exceptionally powerful tool in the hands of a power
- Bugzilla user. By enabling this option, you allow users to receive
- email updates whenever other users receive email updates. This is, of
+ Turning on this option allows users to ask to receive copies of
+ all a particular other user's bug email. This is, of
course, subject to the groupset restrictions on the bug; if the
<quote>watcher</quote>
-
would not normally be allowed to view a bug, the watcher cannot get
around the system by setting herself up to watch the bugs of someone
- with bugs outside her privileges. She would still only receive email
- updates for those bugs she could normally view.</para>
-
- <para>For Bugzilla sites which require strong inter-Product security
- to prevent snooping, watchers are not a good idea.</para>
-
- <para>However, for most sites you should set
- <quote>supportwatchers</quote>
-
- to "On". This feature is helpful for team leads to monitor progress
- in their respective areas, and can offer many other benefits, such as
- allowing a developer to pick up a former engineer's bugs without
- requiring her to change all the information in the bug.</para>
+ with bugs outside her privileges. They would still only receive email
+ updates for those bugs she could normally view.</para>
</step>
</procedure>
</section>
@@ -319,34 +202,34 @@
<section id="useradmin">
<title>User Administration</title>
- <para>User administration is one of the easiest parts of Bugzilla.
- Keeping it from getting out of hand, however, can become a
- challenge.</para>
-
<section id="defaultuser">
<title>Creating the Default User</title>
<para>When you first run checksetup.pl after installing Bugzilla, it
will prompt you for the administrative username (email address) and
- password for this "super user". If for some reason you were to delete
+ password for this "super user". If for some reason you delete
the "super user" account, re-running checksetup.pl will again prompt
you for this username and password.</para>
<tip>
<para>If you wish to add more administrative users, you must use the
MySQL interface. Run "mysql" from the command line, and use these
- commands ("mysql&gt;" denotes the mysql prompt, not something you
- should type in):
- <command>
- <prompt>mysql&gt;</prompt>
-
- use bugs;</command>
-
- <command>
- <prompt>mysql&gt;</prompt>
-
- update profiles set groupset=0x7ffffffffffffff where login_name =
- "(user's login name)";</command>
+ commands:
+ <simplelist>
+ <member>
+ <prompt>mysql&gt;</prompt>
+ <command>use bugs;</command>
+ </member>
+
+ <member>
+ <prompt>mysql&gt;</prompt>
+
+ <command>
+ update profiles set groupset=0x7ffffffffffffff where login_name =
+ "(user's login name)";
+ </command>
+ </member>
+ </simplelist>
</para>
<para>Yes, that is
@@ -362,77 +245,24 @@
<section id="manageusers">
<title>Managing Other Users</title>
- <section id="login">
- <title>Logging In</title>
-
- <orderedlist>
- <listitem>
- <para>Open the index.html page for your Bugzilla installation in
- your browser window.</para>
- </listitem>
-
- <listitem>
- <para>Click the "Query Existing Bug Reports" link.</para>
- </listitem>
-
- <listitem>
- <para>Click the "Log In" link at the foot of the page.</para>
- </listitem>
-
- <listitem>
- <para>Type your email address, and the password which was emailed
- to you when you created your Bugzilla account, into the spaces
- provided.</para>
- </listitem>
- </orderedlist>
-
- <para>Congratulations, you are logged in!</para>
- </section>
-
<section id="createnewusers">
<title>Creating new users</title>
<para>Your users can create their own user accounts by clicking the
- "New Account" link at the bottom of each page. However, should you
+ "New Account" link at the bottom of each page (assuming they
+ aren't logged in as someone else already.) However, should you
desire to create user accounts ahead of time, here is how you do
it.</para>
<orderedlist>
<listitem>
<para>After logging in, click the "Users" link at the footer of
- the query page.</para>
- </listitem>
-
- <listitem>
- <para>To see a specific user, type a portion of their login name
- in the box provided and click "submit". To see all users, simply
- click the "submit" button. You must click "submit" here to be
- able to add a new user.</para>
-
- <tip>
- <para>More functionality is available via the list on the
- right-hand side of the text entry box. You can match what you
- type as a case-insensitive substring (the default) of all users
- on your system, a case-sensitive regular expression (please see
- the
- <command>man regexp</command>
-
- manual page for details on regular expression syntax), or a
- <emphasis>reverse</emphasis>
-
- regular expression match, where every user name which does NOT
- match the regular expression is selected.</para>
- </tip>
- </listitem>
-
- <listitem>
- <para>Click the "Add New User" link at the bottom of the user
- list</para>
+ the query page, and then click "Add a new user".</para>
</listitem>
<listitem>
<para>Fill out the form presented. This page is self-explanatory.
- When done, click "submit".</para>
+ When done, click "Submit".</para>
<note>
<para>Adding a user this way will
@@ -453,84 +283,71 @@
</orderedlist>
</section>
- <section id="disableusers">
- <title>Disabling Users</title>
-
- <para>I bet you noticed that big "Disabled Text" entry box available
- from the "Add New User" screen, when you edit an account? By entering
- any text in this box and selecting "submit", you have prevented the
- user from using Bugzilla via the web interface. Your explanation,
- written in this text box, will be presented to the user the next time
- she attempts to use the system.
- <warning>
- <para>Don't disable your own administrative account, or you will
- hate life!</para>
-
- <para>At this time,
- <quote>Disabled Text</quote>
-
- does not prevent a user from using the email interface. If you have
- the email interface enabled, they can still continue to submit bugs
- and comments that way. We need a patch to fix this.</para>
- </warning>
- </para>
- </section>
-
<section id="modifyusers">
<title>Modifying Users</title>
- <para>Here I will attempt to describe the function of each option on
- the Edit User screen.</para>
+ <para>To see a specific user, search for their login name
+ in the box provided on the "Edit Users" page. To see all users,
+ leave the box blank.</para>
+
+ <para>You can search in different ways the listbox to the right
+ of the text entry box. You can match by
+ case-insensitive substring (the default),
+ regular expression, or a
+ <emphasis>reverse</emphasis>
+ regular expression match, which finds every user name which does NOT
+ match the regular expression. (Please see
+ the <command>man regexp</command>
+ manual page for details on regular expression syntax.)
+ </para>
+
+ <para>Once you have found your user, you can change the following
+ fields:</para>
<itemizedlist>
<listitem>
<para>
- <emphasis>Login Name</emphasis>
-
- : This is generally the user's email address. However, if you
- have edited your system parameters, this may just be the user's
- login name or some other identifier.
- <tip>
- <para>For compatability reasons, you should probably stick with
- email addresses as user login names. It will make your life
- easier.</para>
- </tip>
+ <emphasis>Login Name</emphasis>:
+ This is generally the user's full email address. However, if you
+ have are using the emailsuffix Param, this may just be the user's
+ login name. Note that users can now change their login names
+ themselves (to any valid email address.)
</para>
</listitem>
<listitem>
<para>
- <emphasis>Real Name</emphasis>
-
- : Duh!</para>
+ <emphasis>Real Name</emphasis>: The user's real name. Note that
+ Bugzilla does not require this to create an account.</para>
</listitem>
<listitem>
<para>
- <emphasis>Password</emphasis>
-
- : You can change the user password here. It is normal to only see
- asterisks.</para>
+ <emphasis>Password</emphasis>:
+ You can change the user's password here. Users can automatically
+ request a new password, so you shouldn't need to do this often.
+ If you want to disable an account, see Disable Text below.
+ </para>
</listitem>
<listitem>
<para>
- <emphasis>Disable Text</emphasis>
-
- : If you type anything in this box, including just a space, the
- user account is disabled from making any changes to bugs via the
- web interface, and what you type in this box is presented as the
- reason.
+ <emphasis>Disable Text</emphasis>:
+ If you type anything in this box, including just a space, the
+ user is prevented from logging in, or making any changes to
+ bugs via the web interface.
+ The HTML you type in this box is presented to the user when
+ they attempt to perform these actions, and should explain
+ why the account was disabled.
<warning>
<para>Don't disable the administrator account!</para>
</warning>
<note>
- <para>As of this writing, the user can still submit bugs via
- the e-mail gateway, if you set it up, despite the disabled text
- field. The e-mail gateway should
+ <para>The user can still submit bugs via
+ the e-mail gateway, if you set it up, even if the disabled text
+ field is filled in. The e-mail gateway should
<emphasis>not</emphasis>
-
be enabled for secure installations of Bugzilla.</para>
</note>
</para>
@@ -538,90 +355,82 @@
<listitem>
<para>
- <emphasis>CanConfirm</emphasis>
-
- : This field is only used if you have enabled "unconfirmed"
- status in your parameters screen. If you enable this for a user,
- that user can then move bugs from "Unconfirmed" to "Confirmed"
- status (e.g.: "New" status). Be judicious about allowing users to
- turn this bit on for other users.</para>
+ <emphasis>&lt;groupname&gt;</emphasis>:
+ If you have created some groups, e.g. "securitysensitive", then
+ checkboxes will appear here to allow you to add users to, or
+ remove them from, these groups.
+ </para>
</listitem>
<listitem>
<para>
- <emphasis>Creategroups</emphasis>
-
- : This option will allow a user to create and destroy groups in
- Bugzilla. Unless you are using the Bugzilla GroupSentry security
- option "usebuggroupsentry" in your parameters, this setting has
- no effect.</para>
+ <emphasis>canconfirm</emphasis>:
+ This field is only used if you have enabled the "unconfirmed"
+ status. If you enable this for a user,
+ that user can then move bugs from "Unconfirmed" to a "Confirmed"
+ status (e.g.: "New" status).</para>
</listitem>
<listitem>
<para>
- <emphasis>Editbugs</emphasis>
+ <emphasis>creategroups</emphasis>:
+ This option will allow a user to create and destroy groups in
+ Bugzilla.</para>
+ </listitem>
- : Unless a user has this bit set, they can only edit those bugs
- for which they are the assignee or the reporter.
- <note>
- <para>Leaving this option unchecked does not prevent users from
- adding comments to a bug! They simply cannot change a bug
- priority, severity, etc. unless they are the assignee or
- reporter.</para>
- </note>
+ <listitem>
+ <para>
+ <emphasis>editbugs</emphasis>:
+ Unless a user has this bit set, they can only edit those bugs
+ for which they are the assignee or the reporter. Even if this
+ option is unchecked, users can still add comments to bugs.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Editcomponents</emphasis>
-
- : This flag allows a user to create new products and components,
+ <emphasis>editcomponents</emphasis>:
+ This flag allows a user to create new products and components,
as well as modify and destroy those that have no bugs associated
with them. If a product or component has bugs associated with it,
those bugs must be moved to a different product or component
- before Bugzilla will allow them to be destroyed. The name of a
- product or component can be changed without affecting the
- associated bugs, but it tends to annoy the hell out of your users
- when these change a lot.</para>
+ before Bugzilla will allow them to be destroyed.
+ </para>
</listitem>
<listitem>
<para>
- <emphasis>Editkeywords</emphasis>
-
- : If you use Bugzilla's keyword functionality, enabling this
- feature allows a user can create and destroy keywords. As always,
+ <emphasis>editkeywords</emphasis>:
+ If you use Bugzilla's keyword functionality, enabling this
+ feature allows a user to create and destroy keywords. As always,
the keywords for existing bugs containing the keyword the user
wishes to destroy must be changed before Bugzilla will allow it
- to die. You must be very careful about creating too many new
- keywords if you run a very large Bugzilla installation; keywords
- are global variables across products, and you can often run into
- a phenomenon called "keyword bloat". This confuses users, and
- then the feature goes unused.</para>
+ to die.</para>
</listitem>
<listitem>
<para>
- <emphasis>Editusers</emphasis>
-
- : This flag allows a user do what you're doing right now: edit
+ <emphasis>editusers</emphasis>:
+ This flag allows a user to do what you're doing right now: edit
other users. This will allow those with the right to do so to
remove administrator privileges from other users or grant them to
themselves. Enable with care.</para>
</listitem>
+
+ <listitem>
+ <para>
+ <emphasis>tweakparams</emphasis>:
+ This flag allows a user to change Bugzilla's Params
+ (using <filename>editparams.cgi</filename>.)</para>
+ </listitem>
+
<listitem>
<para>
- <emphasis>PRODUCT</emphasis>
-
- : PRODUCT bugs access. This allows an administrator, with
- product-level granularity, to specify in which products a user
- can edit bugs. The user must still have the "editbugs" privelege
- to edit bugs in this area; this simply restricts them from even
- seeing bugs outside these boundaries if the administrator has
- enabled the group sentry parameter "usebuggroupsentry". Unless
- you are using bug groups, this option has no effect.</para>
+ <emphasis>&lt;productname&gt;</emphasis>:
+ This allows an administrator to specify the products in which
+ a user can see bugs. The user must still have the
+ "editbugs" privilege to edit bugs in these products.</para>
</listitem>
</itemizedlist>
</section>
@@ -631,83 +440,63 @@
<section id="programadmin">
<title>Product, Component, Milestone, and Version Administration</title>
- <epigraph>
- <para>Dear Lord, we have to get our users to do WHAT?</para>
- </epigraph>
-
<section id="products">
<title>Products</title>
- <subtitle>Formerly, and in some spots still, called
- "Programs"</subtitle>
-
<para>
<glossterm linkend="gloss-product" baseform="product">
Products</glossterm>
- are the broadest category in Bugzilla, and you should have the least of
- these. If your company makes computer games, you should have one
- product per game, and possibly a few special products (website,
- meetings...)</para>
+ are the broadest category in Bugzilla, and tend to represent real-world
+ shipping products. E.g. if your company makes computer games,
+ you should have one product per game, perhaps a "Common" product for
+ units of technology used in multiple games, and maybe a few special
+ products (Website, Administration...)</para>
- <para>A Product (formerly called "Program", and still referred to that
- way in some portions of the source code) controls some very important
- functions. The number of "votes" available for users to vote for the
- most important bugs is set per-product, as is the number of votes
+ <para>Many of Bugzilla's settings are configurable on a per-product
+ basis. The number of "votes" available to users is set per-product,
+ as is the number of votes
required to move a bug automatically from the UNCONFIRMED status to the
- NEW status. One can close a Product for further bug entry and define
- various Versions available from the Edit product screen.</para>
+ NEW status.</para>
<para>To create a new product:</para>
<orderedlist>
<listitem>
- <para>Select "components" from the yellow footer</para>
+ <para>Select "products" from the footer</para>
- <tip>
- <para>It may seem counterintuitive to click "components" when you
- want to edit the properties associated with Products. This is one
- of a long list of things we want in Bugzilla 3.0...</para>
- </tip>
</listitem>
<listitem>
- <para>Select the "Add" link to the right of "Add a new
- product".</para>
+ <para>Select the "Add" link in the bottom right</para>
</listitem>
<listitem>
<para>Enter the name of the product and a description. The
- Description field is free-form.</para>
+ Description field may contain HTML.</para>
</listitem>
</orderedlist>
- <tip>
- <para>Don't worry about the "Closed for bug entry", "Maximum Votes
- per person", "Maximum votes a person can put on a single bug",
- "Number of votes a bug in this Product needs to automatically get out
- of the UNCOMFIRMED state", and "Version" options yet. We'll cover
- those in a few moments.</para>
- </tip>
+ <para>Don't worry about the "Closed for bug entry", "Maximum Votes
+ per person", "Maximum votes a person can put on a single bug",
+ "Number of votes a bug in this Product needs to automatically get out
+ of the UNCOMFIRMED state", and "Version" options yet. We'll cover
+ those in a few moments.
+ </para>
</section>
<section id="components">
<title>Components</title>
- <para>Components are subsections of a Product.
- <example>
- <title>Creating some Components</title>
-
- <informalexample>
- <para>The computer game you are designing may have a "UI"
- component, an "API" component, a "Sound System" component, and a
- "Plugins" component, each overseen by a different programmer. It
- often makes sense to divide Components in Bugzilla according to the
- natural divisions of responsibility within your Product or
- company.</para>
- </informalexample>
- </example>
-
+ <para>Components are subsections of a Product. E.g. the computer game
+ you are designing may have a "UI"
+ component, an "API" component, a "Sound System" component, and a
+ "Plugins" component, each overseen by a different programmer. It
+ often makes sense to divide Components in Bugzilla according to the
+ natural divisions of responsibility within your Product or
+ company.</para>
+
+ <para>
Each component has a owner and (if you turned it on in the parameters),
a QA Contact. The owner should be the primary person who fixes bugs in
that component. The QA Contact should be the person who will ensure
@@ -715,10 +504,9 @@
will get email when new bugs are created in this Component and when
these bugs change. Default Owner and Default QA Contact fields only
dictate the
- <emphasis>default assignments</emphasis>
-
- ; the Owner and QA Contact fields in a bug are otherwise unrelated to
- the Component.</para>
+ <emphasis>default assignments</emphasis>;
+ these can be changed on bug submission, or at any later point in
+ a bug's life.</para>
<para>To create a new Component:</para>
@@ -729,53 +517,17 @@
</listitem>
<listitem>
- <para>Select the "Add" link to the right of the "Add a new
- component" text on the "Select Component" page.</para>
+ <para>Select the "Add" link in the bottom right.</para>
</listitem>
<listitem>
- <para>Fill out the "Component" field, a short "Description", and
- the "Initial Owner". The Component and Description fields are
- free-form; the "Initial Owner" field must be that of a user ID
- already existing in the database. If the initial owner does not
- exist, Bugzilla will refuse to create the component.
- <tip>
- <para>Is your "Default Owner" a user who is not yet in the
- database? No problem.
- <orderedlist>
- <listitem>
- <para>Select the "Log out" link on the footer of the
- page.</para>
- </listitem>
-
- <listitem>
- <para>Select the "New Account" link on the footer of the
- "Relogin" page</para>
- </listitem>
-
- <listitem>
- <para>Type in the email address of the default owner you want
- to create in the "E-mail address" field, and her full name in
- the "Real name" field, then select the "Submit Query"
- button.</para>
- </listitem>
-
- <listitem>
- <para>Now select "Log in" again, type in your login
- information, and you can modify the product to use the
- Default Owner information you require.</para>
- </listitem>
- </orderedlist>
- </para>
- </tip>
+ <para>Fill out the "Component" field, a short "Description",
+ the "Initial Owner" and "Initial QA Contact" (if enabled.)
+ The Component and Description fields may contain HTML;
+ the "Initial Owner" field must be a login name
+ already existing in the database.
</para>
</listitem>
-
- <listitem>
- <para>Either Edit more components or return to the Bugzilla Query
- Page. To return to the Product you were editing, you must select
- the Components link as before.</para>
- </listitem>
</orderedlist>
</section>
@@ -783,36 +535,9 @@
<title>Versions</title>
<para>Versions are the revisions of the product, such as "Flinders
- 3.1", "Flinders 95", and "Flinders 2000". Using Versions helps you
- isolate code changes and are an aid in reporting.
- <example>
- <title>Common Use of Versions</title>
-
- <informalexample>
- <para>A user reports a bug against Version "Beta 2.0" of your
- product. The current Version of your software is "Release Candidate
- 1", and no longer has the bug. This will help you triage and
- classify bugs according to their relevance. It is also possible
- people may report bugs against bleeding-edge beta versions that are
- not evident in older versions of the software. This can help
- isolate code changes that caused the bug</para>
- </informalexample>
- </example>
-
- <example>
- <title>A Different Use of Versions</title>
-
- <informalexample>
- <para>This field has been used to good effect by an online service
- provider in a slightly different way. They had three versions of
- the product: "Production", "QA", and "Dev". Although it may be the
- same product, a bug in the development environment is not normally
- as critical as a Production bug, nor does it need to be reported
- publicly. When used in conjunction with Target Milestones, one can
- easily specify the environment where a bug can be reproduced, and
- the Milestone by which it will be fixed.</para>
- </informalexample>
- </example>
+ 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select
+ field; the usual practice is to select the most recent version with
+ the bug.
</para>
<para>To create and edit Versions:</para>
@@ -824,27 +549,14 @@
<listitem>
<para>You will notice that the product already has the default
- version "undefined". If your product doesn't use version numbers,
- you may want to leave this as it is or edit it so that it is "---".
- You can then go back to the edit versions page and add new versions
- to your product.</para>
-
- <para>Otherwise, click the "Add" button to the right of the "Add a
- new version" text.</para>
+ version "undefined". Click the "Add" link in the bottom right.</para>
</listitem>
<listitem>
- <para>Enter the name of the Version. This can be free-form
- characters up to the limit of the text box. Then select the "Add"
- button.</para>
+ <para>Enter the name of the Version. This field takes text only.
+ Then click the "Add" button.</para>
</listitem>
- <listitem>
- <para>At this point you can select "Edit" to edit more Versions, or
- return to the "Query" page, from which you can navigate back to the
- product through the "components" link at the foot of the Query
- page.</para>
- </listitem>
</orderedlist>
</section>
@@ -853,13 +565,12 @@
<para>Milestones are "targets" that you plan to get a bug fixed by. For
example, you have a bug that you plan to fix for your 3.0 release, it
- would be assigned the milestone of 3.0. Or, you have a bug that you
- plan to fix for 2.8, this would have a milestone of 2.8.</para>
+ would be assigned the milestone of 3.0.</para>
<note>
<para>Milestone options will only appear for a Product if you turned
- the "usetargetmilestone" field in the "Edit Parameters" screen
- "On".</para>
+ on the "usetargetmilestone" Param in the "Edit Parameters" screen.
+ </para>
</note>
<para>To create new Milestones, set Default Milestones, and set
@@ -867,345 +578,188 @@
<orderedlist>
<listitem>
- <para>Select "edit milestones"</para>
+ <para>Select "Edit milestones" from the "Edit product" page.</para>
</listitem>
<listitem>
- <para>Select "Add" to the right of the "Add a new milestone"
+ <para>Select "Add" in the bottom right corner.
text</para>
</listitem>
<listitem>
<para>Enter the name of the Milestone in the "Milestone" field. You
- can optionally set the "Sortkey", which is a positive or negative
+ can optionally set the "sortkey", which is a positive or negative
number (-255 to 255) that defines where in the list this particular
- milestone appears. Select "Add".</para>
-
- <example>
- <title>Using SortKey with Target Milestone</title>
-
- <informalexample>
- <para>Let's say you create a target milestone called "Release
- 1.0", with Sortkey set to "0". Later, you realize that you will
- have a public beta, called "Beta1". You can create a Milestone
- called "Beta1", with a Sortkey of "-1" in order to ensure
- people will see the Target Milestone of "Beta1" earlier on the
- list than "Release 1.0"</para>
- </informalexample>
- </example>
+ milestone appears. This is because milestones often do not
+ occur in alphanumeric order For example, "Future" might be
+ after "Release 1.2". Select "Add".</para>
</listitem>
<listitem>
- <para>If you want to add more milestones, select the "Edit" link.
- If you don't, well shoot, you have to go back to the "query" page
- and select "components" again, and make your way back to the
- Product you were editing.
- <note>
- <para>This is another in the list of unusual user interface
- decisions that we'd like to get cleaned up. Shouldn't there be a
- link to the effect of "edit the Product I was editing when I
- ended up here"? In any case, clicking "components" in the footer
- takes you back to the "Select product" screen, from which you can
- begin editing your product again.</para>
- </note>
- </para>
- </listitem>
-
- <listitem>
- <para>From the Edit product screen again (once you've made your way
- back), enter the URL for a description of what your milestones are
- for this product in the "Milestone URL" field. It should be of the
- format "http://www.foo.com/bugzilla/product_milestones.html"</para>
-
- <para>Some common uses of this field include product descriptions,
- product roadmaps, and of course a simple description of the meaning
- of each milestone.</para>
- </listitem>
-
- <listitem>
- <para>If you're using Target Milestones, the "Default Milestone"
- field must have some kind of entry. If you really don't care if
- people set coherent Target Milestones, simply leave this at the
- default, "---". However, controlling and regularly updating the
- Default Milestone field is a powerful tool when reporting the
- status of projects.</para>
-
- <para>Select the "Update" button when you are done.</para>
+ <para>From the Edit product screen, you can enter the URL of a
+ page which gives information about your milestones and what
+ they mean. </para>
+
+ <tip>
+ <para>If you want your milestone document to be restricted so
+ that it can only be viewed by people in a particular Bugzilla
+ group, the best way is to attach the document to a bug in that
+ group, and make the URL the URL of that attachment.</para>
+ </tip>
</listitem>
</orderedlist>
</section>
+ </section>
+
+ <section id="voting">
+ <title>Voting</title>
- <section id="voting">
- <title>Voting</title>
-
- <para>The concept of "voting" is a poorly understood, yet powerful
- feature for the management of open-source projects. Each user is
- assigned so many Votes per product, which they can freely reassign (or
- assign multiple votes to a single bug). This allows developers to gauge
- user need for a particular enhancement or bugfix. By allowing bugs with
- a certain number of votes to automatically move from "UNCONFIRMED" to
- "NEW", users of the bug system can help high-priority bugs garner
- attention so they don't sit for a long time awaiting triage.</para>
-
- <para>The daunting challenge of Votes is deciding where you draw the
- line for a "vocal majority". If you only have a user base of 100 users,
- setting a low threshold for bugs to move from UNCONFIRMED to NEW makes
- sense. As the Bugzilla user base expands, however, these thresholds
- must be re-evaluated. You should gauge whether this feature is worth
- the time and close monitoring involved, and perhaps forego
- implementation until you have a critical mass of users who demand
- it.</para>
-
- <para>To modify Voting settings:</para>
-
- <orderedlist>
- <listitem>
- <para>Navigate to the "Edit product" screen for the Product you
- wish to modify</para>
- </listitem>
+ <para>Voting allows users to be given a pot of votes which they can allocate
+ to bugs, to indicate that they'd like them fixed.
+ This allows developers to gauge
+ user need for a particular enhancement or bugfix. By allowing bugs with
+ a certain number of votes to automatically move from "UNCONFIRMED" to
+ "NEW", users of the bug system can help high-priority bugs garner
+ attention so they don't sit for a long time awaiting triage.</para>
- <listitem>
- <para>Set "Maximum Votes per person" to your calculated value.
- Setting this field to "0" disables voting.</para>
- </listitem>
+ <para>To modify Voting settings:</para>
- <listitem>
- <para>Set "Maximum Votes a person can put on a single bug" to your
- calculated value. It should probably be some number lower than the
- "Maximum votes per person". Setting this field to "0" disables
- voting, but leaves the voting options open to the user. This is
- confusing.</para>
- </listitem>
+ <orderedlist>
+ <listitem>
+ <para>Navigate to the "Edit product" screen for the Product you
+ wish to modify</para>
+ </listitem>
- <listitem>
- <para>Set "Number of votes a bug in this product needs to
- automatically get out of the UNCONFIRMED state" to your calculated
- number. Setting this field to "0" disables the automatic move of
- bugs from UNCONFIRMED to NEW. Some people advocate leaving this at
- "0", but of what use are Votes if your Bugzilla user base is unable
- to affect which bugs appear on Development radar?
- <tip>
- <para>You should probably set this number to higher than a small
- coalition of Bugzilla users can influence it. Most sites use this
- as a "referendum" mechanism -- if users are able to vote a bug
- out of UNCONFIRMED, it is a
- <emphasis>really</emphasis>
-
- bad bug!</para>
- </tip>
- </para>
- </listitem>
+ <listitem>
+ <para><emphasis>Maximum Votes per person</emphasis>:
+ Setting this field to "0" disables voting.</para>
+ </listitem>
- <listitem>
- <para>Once you have adjusted the values to your preference, select
- the "Update" button.</para>
- </listitem>
- </orderedlist>
- </section>
+ <listitem>
+ <para><emphasis>Maximum Votes a person can put on a single
+ bug"</emphasis>:
+ It should probably be some number lower than the
+ "Maximum votes per person". Don't set this field to "0" if
+ "Maximum votes per person" is non-zero; that doesn't make
+ any sense.</para>
+ </listitem>
- <section id="groups">
- <title>Groups and Group Security</title>
-
- <para>Groups can be very useful in bugzilla, because they allow users
- to isolate bugs or products that should only be seen by certain people.
- Groups can also be a complicated minefield of interdependencies and
- weirdness if mismanaged.
- <example>
- <title>When to Use Group Security</title>
-
- <informalexample>
- <para>Many Bugzilla sites isolate "Security-related" bugs from all
- other bugs. This way, they can have a fix ready before the security
- vulnerability is announced to the world. You can create a
- "Security" product which, by default, has no members, and only add
- members to the group (in their individual User page, as described
- under User Administration) who should have priveleged access to
- "Security" bugs. Alternately, you may create a Group independently
- of any Product, and change the Group mask on individual bugs to
- restrict access to members only of certain Groups.</para>
- </informalexample>
- </example>
-
- Groups only work if you enable the "usebuggroups" paramater. In
- addition, if the "usebuggroupsentry" parameter is "On", one can
- restrict access to products by groups, so that only members of a
- product group are able to view bugs within that product. Group security
- in Bugzilla can be divided into two categories: Generic and
- Product-Based.</para>
+ <listitem>
+ <para><emphasis>Number of votes a bug in this product needs to
+ automatically get out of the UNCONFIRMED state</emphasis>:
+ Setting this field to "0" disables the automatic move of
+ bugs from UNCONFIRMED to NEW.
+ </para>
+ </listitem>
- <note>
- <para>Groups in Bugzilla are a complicated beast that evolved out of
- very simple user permission bitmasks, apparently itself derived from
- common concepts in UNIX access controls. A "bitmask" is a
- fixed-length number whose value can describe one, and only one, set
- of states. For instance, UNIX file permissions are assigned bitmask
- values: "execute" has a value of 1, "write" has a value of 2, and
- "read" has a value of 4. Add them together, and a file can be read,
- written to, and executed if it has a bitmask of "7". (This is a
- simplified example -- anybody who knows UNIX security knows there is
- much more to it than this. Please bear with me for the purpose of
- this note.) The only way a bitmask scheme can work is by doubling the
- bit count for each value. Thus if UNIX wanted to offer another file
- permission, the next would have to be a value of 8, then the next 16,
- the next 32, etc.</para>
-
- <para>Similarly, Bugzilla offers a bitmask to define group
- permissions, with an internal limit of 64. Several are already
- occupied by built-in permissions. The way around this limitation is
- to avoid assigning groups to products if you have many products,
- avoid bloating of group lists, and religiously prune irrelevant
- groups. In reality, most installations of Bugzilla support far fewer
- than 64 groups, so this limitation has not hit for most sites, but it
- is on the table to be revised for Bugzilla 3.0 because it interferes
- with the security schemes of some administrators.</para>
- </note>
+ <listitem>
+ <para>Once you have adjusted the values to your preference, click
+ "Update".</para>
+ </listitem>
+ </orderedlist>
+ </section>
- <para>To enable Generic Group Security ("usebuggroups"):</para>
+ <section id="groups">
+ <title>Groups and Group Security</title>
- <orderedlist>
- <listitem>
- <para>Turn "On" "usebuggroups" in the "Edit Parameters"
- screen.</para>
- </listitem>
+ <para>Groups allow the administrator
+ to isolate bugs or products that should only be seen by certain people.
+ There are two types of group - Generic Groups, and Product-Based Groups.
+ </para>
+
+ <para>
+ Product-Based Groups are matched with products, and allow you to restrict
+ access to bugs on a per-product basis. They are enabled using the
+ usebuggroups Param. Turning on the usebuggroupsentry
+ Param will mean bugs automatically get added to their product group when
+ filed.
+ </para>
+
+ <para>
+ Generic Groups have no special relationship to products;
+ you create them, and put bugs in them
+ as required. One example of the use of Generic Groups
+ is Mozilla's "Security" group,
+ into which security-sensitive bugs are placed until fixed. Only the
+ Mozilla Security Team are members of this group.
+ </para>
+
+ <para>To create Generic Groups:</para>
- <listitem>
- <para>You will generally have no groups set up. Select the "groups"
- link in the footer.</para>
- </listitem>
+ <orderedlist>
+ <listitem>
+ <para>Select the "groups"
+ link in the footer.</para>
+ </listitem>
- <listitem>
- <para>Take a moment to understand the instructions on the "Edit
- Groups" screen. Once you feel confident you understand what is
- expected of you, select the "Add Group" link.</para>
- </listitem>
+ <listitem>
+ <para>Take a moment to understand the instructions on the "Edit
+ Groups" screen, then select the "Add Group" link.</para>
+ </listitem>
- <listitem>
- <para>Fill out the "New Name" (remember, no spaces!), "New
- Description", and "New User RegExp" fields. "New User RegExp"
- allows you to automatically place all users who fulfill the Regular
- Expression into the new group.
- <example>
- <title>Creating a New Group</title>
-
- <informalexample>
- <para>I created a group called DefaultGroup with a description
- of
- <quote>This is simply a group to play with</quote>
-
- , and a New User RegExp of
- <quote>.*@mydomain.tld</quote>
-
- . This new group automatically includes all Bugzilla users with
- "@mydomain.tld" at the end of their user id. When I finished,
- my new group was assigned bit #128.</para>
- </informalexample>
- </example>
-
- When you have finished, select the Add button.</para>
- </listitem>
- </orderedlist>
+ <listitem>
+ <para>Fill out the "New Name", "New Description", and
+ "New User RegExp" fields. "New User RegExp" allows you to automatically
+ place all users who fulfill the Regular Expression into the new group.
+ When you have finished, click "Add".</para>
+ </listitem>
+ </orderedlist>
- <para>To enable Product-Based Group Security
- (usebuggroupsentry):</para>
+ <para>To use Product-Based Groups:</para>
- <warning>
- <para>Don't forget that you only have 64 groups masks available,
- total, for your installation of Bugzilla! If you plan on having more
- than 50 products in your individual Bugzilla installation, and
- require group security for your products, you should consider either
- running multiple Bugzillas or using Generic Group Security instead of
- Product-Based ("usebuggroupsentry") Group Security.</para>
- </warning>
+ <orderedlist>
+ <listitem>
+ <para>Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit
+ Parameters" screen.</para>
- <orderedlist>
- <listitem>
- <para>Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit
- Parameters" screen.</para>
-
- <warning>
- <para>"usebuggroupsentry" has the capacity to prevent the
- administrative user from directly altering bugs because of
- conflicting group permissions. If you plan on using
- "usebuggroupsentry", you should plan on restricting
- administrative account usage to administrative duties only. In
- other words, manage bugs with an unpriveleged user account, and
- manage users, groups, Products, etc. with the administrative
- account.</para>
- </warning>
- </listitem>
+ <warning>
+ <para>XXX is this still true?
+ "usebuggroupsentry" has the capacity to prevent the
+ administrative user from directly altering bugs because of
+ conflicting group permissions. If you plan on using
+ "usebuggroupsentry", you should plan on restricting
+ administrative account usage to administrative duties only. In
+ other words, manage bugs with an unpriveleged user account, and
+ manage users, groups, Products, etc. with the administrative
+ account.</para>
+ </warning>
+ </listitem>
- <listitem>
- <para>You will generally have no Groups set up, unless you enabled
- "usebuggroupsentry" prior to creating any Products. To create
- "Generic Group Security" groups, follow the instructions given
- above. To create Product-Based Group security, simply follow the
- instructions for creating a new Product. If you need to add users
- to these new groups as you create them, you will find the option to
- add them to the group available under the "Edit User"
- screens.</para>
- </listitem>
- </orderedlist>
+ <listitem>
+ <para>In future, when you create a Product, a matching group will be
+ automatically created. If you need to add a Product Group to
+ a Product which was created before you turned on usebuggroups,
+ then simply create a new group, as outlined above, with the
+ same name as the Product.</para>
+ </listitem>
+ </orderedlist>
- <para>You may find this example illustrative for how bug groups work.
- <example>
- <title>Bugzilla Groups</title>
-
- <literallayout>Bugzilla Groups example ----------------------- For
- this example, let us suppose we have four groups, call them Group1,
- Group2, Group3, and Group4. We have 5 users, User1, User2, User3,
- User4, User5. We have 8 bugs, Bug1, ..., Bug8. Group membership is
- defined by this chart: (X denotes that user is in that group.) (I
- apologize for the nasty formatting of this table. Try viewing it in a
- text-based browser or something for now. -MPB) G G G G r r r r o o o
- o u u u u p p p p 1 2 3 4 +-+-+-+-+ User1|X| | | | +-+-+-+-+ User2|
- |X| | | +-+-+-+-+ User3|X| |X| | +-+-+-+-+ User4|X|X|X| | +-+-+-+-+
- User5| | | | | +-+-+-+-+ Bug restrictions are defined by this chart:
- (X denotes that bug is restricted to that group.) G G G G r r r r o o
- o o u u u u p p p p 1 2 3 4 +-+-+-+-+ Bug1| | | | | +-+-+-+-+ Bug2|
- |X| | | +-+-+-+-+ Bug3| | |X| | +-+-+-+-+ Bug4| | | |X| +-+-+-+-+
- Bug5|X|X| | | +-+-+-+-+ Bug6|X| |X| | +-+-+-+-+ Bug7|X|X|X| |
- +-+-+-+-+ Bug8|X|X|X|X| +-+-+-+-+ Who can see each bug? Bug1 has no
- group restrictions. Therefore, Bug1 can be seen by any user, whatever
- their group membership. This is going to be the only bug that User5
- can see, because User5 isn't in any groups. Bug2 can be seen by
- anyone in Group2, that is User2 and User4. Bug3 can be seen by anyone
- in Group3, that is User3 and User4. Bug4 can be seen by anyone in
- Group4. Nobody is in Group4, so none of these users can see Bug4.
- Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This
- is only User4. User1 cannot see it because he is not in Group2, and
- User2 cannot see it because she is not in Group1. Bug6 can be seen by
- anyone who is in both Group1 and Group3. This would include User3 and
- User4. Similar to Bug5, User1 cannot see Bug6 because he is not in
- Group3. Bug7 can be seen by anyone who is in Group1, Group2, and
- Group3. This is only User4. All of the others are missing at least
- one of those group privileges, and thus cannot see the bug. Bug8 can
- be seen by anyone who is in Group1, Group2, Group3, and Group4. There
- is nobody in all four of these groups, so nobody can see Bug8. It
- doesn't matter that User4 is in Group1, Group2, and Group3, since he
- isn't in Group4.</literallayout>
- </example>
- </para>
- </section>
+ <warning>
+ <para>Bugzilla currently has a limit of 64 groups per installation. If
+ you have more than about 50 products, you should consider
+ running multiple Bugzillas. Ask in the newsgroup for other
+ suggestions for working around this restriction.</para>
+ </warning>
+
+ <para>
+ Note that group permissions are such that you need to be a member
+ of <emphasis>all</emphasis> the groups a bug is in, for whatever
+ reason, to see that bug.
+ </para>
</section>
+
<section id="security">
<title>Bugzilla Security</title>
- <epigraph>
- <para>Putting your money in a wall safe is better protection than
- depending on the fact that no one knows that you hide your money in a
- mayonnaise jar in your fridge.</para>
- </epigraph>
-
- <note>
- <para>Poorly-configured MySQL, Bugzilla, and FTP installations have
+ <warning>
+ <para>Poorly-configured MySQL and Bugzilla installations have
given attackers full access to systems in the past. Please take these
guidelines seriously, even for Bugzilla machines hidden away behind
your firewall. 80% of all computer trespassers are insiders, not
anonymous crackers.</para>
- </note>
+ </warning>
- <para>Secure your installation.
<note>
<para>These instructions must, of necessity, be somewhat vague since
Bugzilla runs on so many different platforms. If you have refinements
@@ -1215,11 +769,13 @@
</para>
</note>
+ <para>To secure your installation:
+
<orderedlist>
<listitem>
<para>Ensure you are running at least MysQL version 3.22.32 or newer.
- Earlier versions had notable security holes and poorly secured
- default configuration choices.</para>
+ Earlier versions had notable security holes and (from a security
+ point of view) poor default configuration choices.</para>
</listitem>
<listitem>
@@ -1228,18 +784,9 @@
system!</emphasis>
Read
- <ulink
- url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html">
+ <ulink url="http://www.mysql.com/doc/P/r/Privilege_system.html">
The MySQL Privilege System</ulink>
-
until you can recite it from memory!</para>
-
- <para>At the very least, ensure you password the "mysql -u root"
- account and the "bugs" account, establish grant table rights (consult
- the Keystone guide in Appendix C: The Bugzilla Database for some
- easy-to-use details) that do not allow CREATE, DROP, RELOAD,
- SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone advice
- back when I knew far less about security than I do now : )</para>
</listitem>
<listitem>
@@ -1273,42 +820,35 @@
<listitem>
<para>Ensure you have adequate access controls for the
- $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ directories, as well
- as the $BUGZILLA_HOME/localconfig and $BUGZILLA_HOME/globals.pl
- files. The localconfig file stores your "bugs" user password, which
- would be terrible to have in the hands of a criminal, while the
- "globals.pl" stores some default information regarding your
- installation which could aid a system cracker. In addition, some
- files under $BUGZILLA_HOME/data/ store sensitive information, and
- $BUGZILLA_HOME/shadow/ stores bug information for faster retrieval.
- If you fail to secure these directories and this file, you will
- expose bug information to those who may not be allowed to see
- it.</para>
+ $BUGZILLA_HOME/data/ directory, as well as the
+ $BUGZILLA_HOME/localconfig file.
+ The localconfig file stores your "bugs" database account password.
+ In addition, some
+ files under $BUGZILLA_HOME/data/ store sensitive information.
+ </para>
- <note>
- <para>Bugzilla provides default .htaccess files to protect the most
- common Apache installations. However, you should verify these are
- adequate according to the site-wide security policy of your web
- server, and ensure that the .htaccess files are allowed to
- "override" default permissions set in your Apache configuration
- files. Covering Apache security is beyond the scope of this Guide;
- please consult the Apache documentation for details.</para>
-
- <para>If you are using a web server that does not support the
- .htaccess control method,
- <emphasis>you are at risk!</emphasis>
-
- After installing, check to see if you can view the file
- "localconfig" in your web browser (e.g.:
- <ulink url="http://bugzilla.mozilla.org/localconfig">
- http://bugzilla.mozilla.org/localconfig</ulink>
-
- ). If you can read the contents of this file, your web server has
- not secured your bugzilla directory properly and you must fix this
- problem before deploying Bugzilla. If, however, it gives you a
- "Forbidden" error, then it probably respects the .htaccess
- conventions and you are good to go.</para>
- </note>
+ <para>Bugzilla provides default .htaccess files to protect the most
+ common Apache installations. However, you should verify these are
+ adequate according to the site-wide security policy of your web
+ server, and ensure that the .htaccess files are allowed to
+ "override" default permissions set in your Apache configuration
+ files. Covering Apache security is beyond the scope of this Guide;
+ please consult the Apache documentation for details.</para>
+
+ <para>If you are using a web server that does not support the
+ .htaccess control method,
+ <emphasis>you are at risk!</emphasis>
+
+ After installing, check to see if you can view the file
+ "localconfig" in your web browser (e.g.:
+ <ulink url="http://bugzilla.mozilla.org/localconfig">
+ http://bugzilla.mozilla.org/localconfig</ulink>
+
+ ). If you can read the contents of this file, your web server has
+ not secured your bugzilla directory properly and you must fix this
+ problem before deploying Bugzilla. If, however, it gives you a
+ "Forbidden" error, then it probably respects the .htaccess
+ conventions and you are good to go.</para>
<para>When you run checksetup.pl, the script will attempt to modify
various permissions on files which Bugzilla uses. If you do not have
@@ -1335,7 +875,7 @@
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572">Bug
65572</ulink>
- for adequate protection in your data/ and shadow/ directories.</para>
+ for adequate protection in your data/ directory.</para>
<para>Note the instructions which follow are Apache-specific. If you
use IIS, Netscape, or other non-Apache web servers, please consult
@@ -1354,15 +894,325 @@
allow from all</literallayout>
</para>
- <para>Place the following text into a file named ".htaccess",
- readable by your web server, in your $BUGZILLA_HOME/shadow directory.
-
- <literallayout>deny from all</literallayout>
- </para>
</listitem>
</orderedlist>
</para>
</section>
+
+ <section id="cust-templates">
+ <title>Template Customisation</title>
+
+ <para>
+ One of the large changes for 2.16 was the templatisation of the
+ entire user-facing UI, using the
+ <ulink url="http://www.template-toolkit.org">Template Toolkit</ulink>.
+ Administrators can now configure the look and feel of Bugzilla without
+ having to edit Perl files or face the nightmare of massive merge
+ conflicts when they upgrade to a newer version in the future.
+ </para>
+
+ <para>
+ Templatisation also makes localised versions of Bugzilla possible,
+ for the first time. In the future, a Bugzilla installation may
+ have templates installed for multiple localisations, and select
+ which ones to use based on the user's browser language setting.
+ </para>
+
+ <section>
+ <title>What to Edit</title>
+ <para>
+ There are two different ways of editing of Bugzilla's templates,
+ and which you use depends mainly on how you upgrade Bugzilla. The
+ template directory structure is that there's a top level directory,
+ <filename>template</filename>, which contains a directory for
+ each installed localisation. The default English templates are
+ therefore in <filename>en</filename>. Underneath that, there
+ is the <filename>default</filename> directory and optionally the
+ <filename>custom</filename> directory. The <filename>default</filename>
+ directory contains all the templates shipped with Bugzilla, whereas
+ the <filename>custom</filename> directory does not exist at first and
+ must be created if you want to use it.
+ </para>
+
+ <para>
+ The first method of making customisations is to directly edit the
+ templates in <filename>template/en/default</filename>. This is
+ probably the best method for small changes if you are going to use
+ the CVS method of upgrading, because if you then execute a
+ <command>cvs update</command>, any template fixes will get
+ automagically merged into your modified versions.
+ </para>
+
+ <para>
+ If you use this method, your installation will break if CVS conflicts
+ occur.
+ </para>
+
+ <para>
+ The other method is to copy the templates into a mirrored directory
+ structure under <filename>template/en/custom</filename>. The templates
+ in this directory automatically override those in default.
+ This is the technique you
+ need to use if you use the overwriting method of upgrade, because
+ otherwise your changes will be lost. This method is also better if
+ you are using the CVS method of upgrading and are going to make major
+ changes, because it is guaranteed that the contents of this directory
+ will not be touched during an upgrade, and you can then decide whether
+ to continue using your own templates, or make the effort to merge your
+ changes into the new versions by hand.
+ </para>
+
+ <para>
+ If you use this method, your installation may break if incompatible
+ changes are made to the template interface. If such changes are made
+ they will be documented in the release notes, provided you are using a
+ stable release of Bugzilla. If you use using unstable code, you will
+ need to deal with this one yourself, although if possible the changes
+ will be mentioned before they occur in the deprecations section of the
+ previous stable release's release notes.
+ </para>
+
+ <note>
+ <para>
+ Don't directly edit the compiled templates in
+ <filename class="directory">data/template/*</filename> - your
+ changes will be lost when Template Toolkit recompiles them.
+ </para>
+ </note>
+ </section>
+
+ <section>
+ <title>How To Edit Templates</title>
+
+ <para>
+ The syntax of the Template Toolkit language is beyond the scope of
+ this guide. It's reasonably easy to pick up by looking at the current
+ templates; or, you can read the manual, available on the
+ <ulink url="http://www.template-toolkit.org">Template Toolkit home
+ page</ulink>. However, you should particularly remember (for security
+ reasons) to always HTML filter things which come from the database or
+ user input, to prevent cross-site scripting attacks.
+ </para>
+
+ <para>
+ However, one thing you should take particular care about is the need
+ to properly HTML filter data that has been passed into the template.
+ This means that if the data can possibly contain special HTML characters
+ such as &lt;, and the data was not intended to be HTML, they need to be
+ converted to entity form, ie &amp;lt;. You use the 'html' filter in the
+ Template Toolkit to do this. If you fail to do this, you may open up
+ your installation to cross-site scripting attacks.
+ </para>
+
+ <para>
+ Also note that Bugzilla adds a few filters of its own, that are not
+ in standard Template Toolkit. In particular, the 'url_quote' filter
+ can convert characters that are illegal or have special meaning in URLs,
+ such as &amp;, to the encoded form, ie %26. This actually encodes most
+ characters (but not the common ones such as letters and numbers and so
+ on), including the HTML-special characters, so there's never a need to
+ HTML filter afterwards.
+ </para>
+
+ <para>
+ Editing templates is a good way of doing a "poor man's custom fields".
+ For example, if you don't use the Status Whiteboard, but want to have
+ a free-form text entry box for "Build Identifier", then you can just
+ edit the templates to change the field labels. It's still be called
+ status_whiteboard internally, but your users don't need to know that.
+ </para>
+
+ <note>
+ <para>
+ If you are making template changes that you intend on submitting back
+ for inclusion in standard Bugzilla, you should read the relevant
+ sections of the
+ <ulink url="http://www.bugzilla.org/developerguide.html">Developers'
+ Guide</ulink>.
+ </para>
+ </note>
+ </section>
+
+
+ <section>
+ <title>Template Formats</title>
+
+ <para>
+ Some CGIs have the ability to use more than one template. For
+ example, buglist.cgi can output bug lists as RDF or two
+ different forms of HTML (complex and simple). (Try this out
+ by appending <filename>&amp;format=simple</filename> to a buglist.cgi
+ URL on your Bugzilla installation.) This
+ mechanism, called template 'formats', is extensible.
+ </para>
+
+ <para>
+ To see if a CGI supports multiple output formats, grep the
+ CGI for "ValidateOutputFormat". If it's not present, adding
+ multiple format support isn't too hard - see how it's done in
+ other CGIs.
+ </para>
+
+ <para>
+ To make a new format template for a CGI which supports this,
+ open a current template for
+ that CGI and take note of the INTERFACE comment (if present.) This
+ comment defines what variables are passed into this template. If
+ there isn't one, I'm afraid you'll have to read the template and
+ the code to find out what information you get.
+ </para>
+
+ <para>
+ Write your template in whatever markup or text style is appropriate.
+ </para>
+
+ <para>
+ You now need to decide what content type you want your template
+ served as. Open up the <filename>localconfig</filename> file and find the
+ <filename>$contenttypes</filename>
+ variable. If your content type is not there, add it. Remember
+ the three- or four-letter tag assigned to you content type.
+ This tag will be part of the template filename.
+ </para>
+
+ <para>
+ Save the template as <filename>&lt;stubname&gt;-&lt;formatname&gt;.&lt;contenttypetag&gt;.tmpl</filename>.
+ Try out the template by calling the CGI as
+ <filename>&lt;cginame&gt;.cgi?format=&lt;formatname&gt;</filename> .
+ </para>
+ </section>
+
+
+ <section>
+ <title>Particular Templates</title>
+
+ <para>
+ There are a few templates you may be particularly interested in
+ customising for your installation.
+ </para>
+
+ <para>
+ <command>index.html.tmpl</command>:
+ This is the Bugzilla front page.
+ </para>
+
+ <para>
+ <command>global/header.html.tmpl</command>:
+ This defines the header that goes on all Bugzilla pages.
+ The header includes the banner, which is what appears to users
+ and is probably what you want to edit instead. However the
+ header also includes the HTML HEAD section, so you could for
+ example add a stylesheet or META tag by editing the header.
+ </para>
+
+ <para>
+ <command>global/banner.html.tmpl</command>:
+ This contains the "banner", the part of the header that appears
+ at the top of all Bugzilla pages. The default banner is reasonably
+ barren, so you'll probably want to customise this to give your
+ installation a distinctive look and feel. It is recommended you
+ preserve the Bugzilla version number in some form so the version
+ you are running can be determined, and users know what docs to read.
+ </para>
+
+ <para>
+ <command>global/footer.html.tmpl</command>:
+ This defines the footer that goes on all Bugzilla pages. Editing
+ this is another way to quickly get a distinctive look and feel for
+ your Bugzilla installation.
+ </para>
+
+ <para>
+ <command>bug/create/user-message.html.tmpl</command>:
+ This is a message that appears near the top of the bug reporting page.
+ By modifying this, you can tell your users how they should report
+ bugs.
+ </para>
+
+ <para>
+ <command>bug/create/create.html.tmpl</command> and
+ <command>bug/create/comment.txt.tmpl</command>:
+ You may wish to get bug submitters to give certain bits of structured
+ information, each in a separate input widget, for which there is not a
+ field in the database. The bug entry system has been designed in an
+ extensible fashion to enable you to define arbitrary fields and widgets,
+ and have their values appear formatted in the initial
+ Description, rather than in database fields. An example of this
+ is the mozilla.org
+ <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided">guided
+ bug submission form</ulink>.
+ </para>
+
+ <para>
+ To make this work, create a custom template for
+ <filename>enter_bug.cgi</filename> (the default template, on which you
+ could base it, is <filename>create.html.tmpl</filename>),
+ and either call it <filename>create.html.tmpl</filename> or use a format and
+ call it <filename>create-&lt;formatname&gt;.html.tmpl</filename>.
+ Put it in the <filename class="directory">custom/bug/create</filename>
+ directory. In it, add widgets for each piece of information you'd like
+ collected - such as a build number, or set of steps to reproduce.
+ </para>
+
+ <para>
+ Then, create a template like
+ <filename>custom/bug/create/comment.txt.tmpl</filename>, also named
+ after your format if you are using one, which
+ references the form fields you have created. When a bug report is
+ submitted, the initial comment attached to the bug report will be
+ formatted according to the layout of this template.
+ </para>
+
+ <para>
+ For example, if your enter_bug template had a field
+ <programlisting>&lt;input type="text" name="buildid" size="30"&gt;</programlisting>
+ and then your comment.txt.tmpl had
+ <programlisting>BuildID: [% form.buildid %]</programlisting>
+ then
+ <programlisting>BuildID: 20020303</programlisting>
+ would appear in the initial checkin comment.
+ </para>
+ </section>
+
+ </section>
+
+ <section id="upgrading">
+ <title>Upgrading to New Releases</title>
+
+ <para>A plain Bugzilla is fairly easy to upgrade from one version to a
+ newer one. Always read the release notes to see if there are any issues
+ that you might need to take note of. It is recommended that you take a
+ backup of your database and your entire Bugzilla installation before attempting an
+ upgrade. You can upgrade a 'clean' installation by untarring a new
+ tarball over the old installation. If you are upgrading from 2.12 or
+ later, and have cvs installed, you can type <filename>cvs -z3 update</filename>,
+ and resolve conflicts if there are any.
+ </para>
+
+ <para>However, things get a bit more complicated if you've made
+ changes to Bugzilla's code. In this case, you may have to re-make or
+ reapply those changes. One good method is to take a diff of your customised
+ version against the original, so you can survey all that you've changed.
+ Hopefully, templatisation will reduce the need for
+ this in the future.</para>
+
+ <para>From version 2.8 onwards, Bugzilla databases can be automatically
+ carried forward during an upgrade. However, because the developers of
+ Bugzilla are constantly adding new
+ tables, columns and fields, you'll probably get SQL errors if you just
+ update the code and attempt to use Bugzilla. Always run the
+ <filename>checksetup.pl</filename>
+ script whenever you upgrade your installation.</para>
+
+ <para>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.</para>
+ </section>
+
+ <!-- Integrating Bugzilla with Third-Party Tools -->
+ &integration;
+
</chapter>
<!-- Keep this comment at the end of the file
diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml
index f6aa00338..7334b02b8 100644
--- a/docs/sgml/conventions.sgml
+++ b/docs/sgml/conventions.sgml
@@ -6,7 +6,7 @@
<primary>conventions</primary>
</indexterm>
- <para>This document uses the following conventions</para>
+ <para>This document uses the following conventions:</para>
<informaltable frame="none">
<tgroup cols="2">
@@ -34,7 +34,7 @@
<entry>
<tip>
- <para>Warm jar lids under the hot tap to loosen them.</para>
+ <para>Would you like a breath mint?</para>
</tip>
</entry>
</row>
@@ -63,7 +63,7 @@
<entry>File Names</entry>
<entry>
- <filename>file.extension</filename>
+ <filename>filename</filename>
</entry>
</row>
@@ -138,12 +138,9 @@
<entry>Code Example</entry>
<entry>
- <programlisting>
- <sgmltag class="starttag">para</sgmltag>
-
- Beginning and end of paragraph
- <sgmltag class="endtag">para</sgmltag>
- </programlisting>
+ <programlisting><sgmltag class="starttag">para</sgmltag>
+Beginning and end of paragraph
+<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row>
</tbody>
diff --git a/docs/sgml/database.sgml b/docs/sgml/database.sgml
index 4cba46a48..d758259da 100644
--- a/docs/sgml/database.sgml
+++ b/docs/sgml/database.sgml
@@ -123,10 +123,10 @@
! You should have locked your security down like the installation
instructions told you to. You can find details on locking down
your database in the Bugzilla FAQ in this directory (under
- "Security"), or more robust security generalities in the MySQL
- searchable documentation at
- http://www.mysql.com/php/manual.php3?section=Privilege_system
- .</para>
+ "Security"), or more robust security generalities in the
+ <ulink url="http://www.mysql.com/php/manual.php3?section=Privilege_system">MySQL
+ searchable documentation</ulink>.
+ </para>
</listitem>
<listitem>
@@ -150,13 +150,6 @@
<command>use bugs;</command>
</para>
- <note>
- <para>Don't forget the
- <quote>;</quote>
-
- at the end of each line, or you'll be kicking yourself
- later.</para>
- </note>
</listitem>
</orderedlist>
</para>
@@ -169,273 +162,212 @@
<para>
<prompt>mysql&gt;</prompt>
-
<command>show tables from bugs;</command>
</para>
- <para>you'll be able to see all the
+ <para>you'll be able to see the names of all the
<quote>spreadsheets</quote>
+ (tables) in your database.</para>
+
+ <para>From the command issued above, ou should have some
+ output that looks like this:
+<programlisting>
++-------------------+
+| Tables in bugs |
++-------------------+
+| attachments |
+| bugs |
+| bugs_activity |
+| cc |
+| components |
+| dependencies |
+| fielddefs |
+| groups |
+| keyworddefs |
+| keywords |
+| logincookies |
+| longdescs |
+| milestones |
+| namedqueries |
+| products |
+| profiles |
+| profiles_activity |
+| shadowlog |
+| tokens |
+| versions |
+| votes |
+| watch |
++-------------------+
+</programlisting>
+</para>
+
+<literallayout>
+ Here's an overview of what each table does. Most columns in each table have
+descriptive names that make it fairly trivial to figure out their jobs.
+
+attachments: This table stores all attachments to bugs. It tends to be your
+largest table, yet also generally has the fewest entries because file
+attachments are so (relatively) large.
+
+bugs: This is the core of your system. The bugs table stores most of the
+current information about a bug, with the exception of the info stored in the
+other tables.
+
+bugs_activity: This stores information regarding what changes are made to bugs
+when -- a history file.
+
+cc: This tiny table simply stores all the CC information for any bug which has
+any entries in the CC field of the bug. Note that, like most other tables in
+Bugzilla, it does not refer to users by their user names, but by their unique
+userid, stored as a primary key in the profiles table.
+
+components: This stores the programs and components (or products and
+components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
+(product) field is the full name of the product, rather than some other unique
+identifier, like bug_id and user_id are elsewhere in the database.
+
+dependencies: Stores data about those cool dependency trees.
+
+fielddefs: A nifty table that defines other tables. For instance, when you
+submit a form that changes the value of "AssignedTo" this table allows
+translation to the actual field name "assigned_to" for entry into MySQL.
+
+groups: defines bitmasks for groups. A bitmask is a number that can uniquely
+identify group memberships. For instance, say the group that is allowed to
+tweak parameters is assigned a value of "1", the group that is allowed to edit
+users is assigned a "2", and the group that is allowed to create new groups is
+assigned the bitmask of "4". By uniquely combining the group bitmasks (much
+like the chmod command in UNIX,) you can identify a user is allowed to tweak
+parameters and create groups, but not edit users, by giving him a bitmask of
+"5", or a user allowed to edit users and create groups, but not tweak
+parameters, by giving him a bitmask of "6" Simple, huh?
+ If this makes no sense to you, try this at the mysql prompt:
+mysql> select * from groups;
+ You'll see the list, it makes much more sense that way.
+
+keyworddefs: Definitions of keywords to be used
+
+keywords: Unlike what you'd think, this table holds which keywords are
+associated with which bug id's.
+
+logincookies: This stores every login cookie ever assigned to you for every
+machine you've ever logged into Bugzilla from. Curiously, it never does any
+housecleaning -- I see cookies in this file I've not used for months. However,
+since Bugzilla never expires your cookie (for convenience' sake), it makes
+sense.
+
+longdescs: The meat of bugzilla -- here is where all user comments are stored!
+You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
+sparingly -- that's only the amount of space the Old Testament from the Bible
+would take (uncompressed, 16 megabytes). Each comment is keyed to the
+bug_id to which it's attached, so the order is necessarily chronological, for
+comments are played back in the order in which they are received.
+
+milestones: Interesting that milestones are associated with a specific product
+in this table, but Bugzilla does not yet support differing milestones by
+product through the standard configuration interfaces.
+
+namedqueries: This is where everybody stores their "custom queries". Very
+cool feature; it beats the tar out of having to bookmark each cool query you
+construct.
+
+products: What products you have, whether new bug entries are allowed for the
+product, what milestone you're working toward on that product, votes, etc. It
+will be nice when the components table supports these same features, so you
+could close a particular component for bug entry without having to close an
+entire product...
+
+profiles: Ahh, so you were wondering where your precious user information was
+stored? Here it is! With the passwords in plain text for all to see! (but
+sshh... don't tell your users!)
+
+profiles_activity: Need to know who did what when to who's profile? This'll
+tell you, it's a pretty complete history.
+
+shadowlog: I could be mistaken here, but I believe this table tells you when
+your shadow database is updated and what commands were used to update it. We
+don't use a shadow database at our site yet, so it's pretty empty for us.
+
+versions: Version information for every product
+
+votes: Who voted for what when
+
+watch: Who (according to userid) is watching who's bugs (according to their
+userid).
- (tables) in your database. It is similar to a file system, only
- faster and more robust for certain types of operations.</para>
-
- <para>From the command issued above, ou should have some output that
- looks like this:
- <programlisting>+-------------------+ | Tables in bugs |
- +-------------------+ | attachments | | bugs | | bugs_activity | | cc
- | | components | | dependencies | | fielddefs | | groups | |
- keyworddefs | | keywords | | logincookies | | longdescs | |
- milestones | | namedqueries | | products | | profiles | |
- profiles_activity | | shadowlog | | tokens | | versions | | votes | |
- watch | +-------------------+</programlisting>
- </para>
- <literallayout>Here's an overview of what each table does. Most
- columns in each table have descriptive names that make it fairly
- trivial to figure out their jobs. attachments: This table stores all
- attachments to bugs. It tends to be your largest table, yet also
- generally has the fewest entries because file attachments are so
- (relatively) large. bugs: This is the core of your system. The bugs
- table stores most of the current information about a bug, with the
- exception of the info stored in the other tables. bugs_activity: This
- stores information regarding what changes are made to bugs when -- a
- history file. cc: This tiny table simply stores all the CC
- information for any bug which has any entries in the CC field of the
- bug. Note that, like most other tables in Bugzilla, it does not refer
- to users by their user names, but by their unique userid, stored as a
- primary key in the profiles table. components: This stores the
- programs and components (or products and components, in newer
- Bugzilla parlance) for Bugzilla. Curiously, the "program" (product)
- field is the full name of the product, rather than some other unique
- identifier, like bug_id and user_id are elsewhere in the database.
- dependencies: Stores data about those cool dependency trees.
- fielddefs: A nifty table that defines other tables. For instance,
- when you submit a form that changes the value of "AssignedTo" this
- table allows translation to the actual field name "assigned_to" for
- entry into MySQL. groups: defines bitmasks for groups. A bitmask is a
- number that can uniquely identify group memberships. For instance,
- say the group that is allowed to tweak parameters is assigned a value
- of "1", the group that is allowed to edit users is assigned a "2",
- and the group that is allowed to create new groups is assigned the
- bitmask of "4". By uniquely combining the group bitmasks (much like
- the chmod command in UNIX,) you can identify a user is allowed to
- tweak parameters and create groups, but not edit users, by giving him
- a bitmask of "5", or a user allowed to edit users and create groups,
- but not tweak parameters, by giving him a bitmask of "6" Simple, huh?
- If this makes no sense to you, try this at the mysql prompt:
- mysql&gt; select * from groups; You'll see the list, it makes much
- more sense that way. keyworddefs: Definitions of keywords to be used
- keywords: Unlike what you'd think, this table holds which keywords
- are associated with which bug id's. logincookies: This stores every
- login cookie ever assigned to you for every machine you've ever
- logged into Bugzilla from. Curiously, it never does any housecleaning
- -- I see cookies in this file I've not used for months. However,
- since Bugzilla never expires your cookie (for convenience' sake), it
- makes sense. longdescs: The meat of bugzilla -- here is where all
- user comments are stored! You've only got 2^24 bytes per comment
- (it's a mediumtext field), so speak sparingly -- that's only the
- amount of space the Old Testament from the Bible would take
- (uncompressed, 16 megabytes). Each comment is keyed to the bug_id to
- which it's attached, so the order is necessarily chronological, for
- comments are played back in the order in which they are received.
- milestones: Interesting that milestones are associated with a
- specific product in this table, but Bugzilla does not yet support
- differing milestones by product through the standard configuration
- interfaces. namedqueries: This is where everybody stores their
- "custom queries". Very cool feature; it beats the tar out of having
- to bookmark each cool query you construct. products: What products
- you have, whether new bug entries are allowed for the product, what
- milestone you're working toward on that product, votes, etc. It will
- be nice when the components table supports these same features, so
- you could close a particular component for bug entry without having
- to close an entire product... profiles: Ahh, so you were wondering
- where your precious user information was stored? Here it is! With the
- passwords in plain text for all to see! (but sshh... don't tell your
- users!) profiles_activity: Need to know who did what when to who's
- profile? This'll tell you, it's a pretty complete history. shadowlog:
- I could be mistaken here, but I believe this table tells you when
- your shadow database is updated and what commands were used to update
- it. We don't use a shadow database at our site yet, so it's pretty
- empty for us. versions: Version information for every product votes:
- Who voted for what when watch: Who (according to userid) is watching
- who's bugs (according to their userid). === THE DETAILS === Ahh, so
- you're wondering just what to do with the information above? At the
- mysql prompt, you can view any information about the columns in a
- table with this command (where "table" is the name of the table you
- wish to view): mysql&gt; show columns from table; You can also view
- all the data in a table with this command: mysql&gt; select * from
- table; -- note: this is a very bad idea to do on, for instance, the
- "bugs" table if you have 50,000 bugs. You'll be sitting there a while
- until you ctrl-c or 50,000 bugs play across your screen. You can
- limit the display from above a little with the command, where
- "column" is the name of the column for which you wish to restrict
- information: mysql&gt; select * from table where (column = "some
- info"); -- or the reverse of this mysql&gt; select * from table where
- (column != "some info"); Let's take our example from the
- introduction, and assume you need to change the word "verified" to
- "approved" in the resolution field. We know from the above
- information that the resolution is likely to be stored in the "bugs"
- table. Note we'll need to change a little perl code as well as this
- database change, but I won't plunge into that in this document. Let's
- verify the information is stored in the "bugs" table: mysql&gt; show
- columns from bugs (exceedingly long output truncated here) |
- bug_status|
- enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL
- | UNCONFIRMED|| Sorry about that long line. We see from this that the
- "bug status" column is an "enum field", which is a MySQL peculiarity
- where a string type field can only have certain types of entries.
- While I think this is very cool, it's not standard SQL. Anyway, we
- need to add the possible enum field entry 'APPROVED' by altering the
- "bugs" table. mysql&gt; ALTER table bugs CHANGE bug_status bug_status
- -&gt; enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
- -&gt; "VERIFIED", "APPROVED", "CLOSED") not null; (note we can take
- three lines or more -- whatever you put in before the semicolon is
- evaluated as a single expression) Now if you do this: mysql&gt; show
- columns from bugs; you'll see that the bug_status field has an extra
- "APPROVED" enum that's available! Cool thing, too, is that this is
- reflected on your query page as well -- you can query by the new
- status. But how's it fit into the existing scheme of things? Looks
- like you need to go back and look for instances of the word
- "verified" in the perl code for Bugzilla -- wherever you find
- "verified", change it to "approved" and you're in business (make sure
- that's a case-insensitive search). Although you can query by the enum
- field, you can't give something a status of "APPROVED" until you make
- the perl changes. Note that this change I mentioned can also be done
- by editing checksetup.pl, which automates a lot of this. But you need
- to know this stuff anyway, right? I hope this database tutorial has
- been useful for you. If you have comments to add, questions,
- concerns, etc. please direct them to mbarnson@excitehome.net. Please
- direct flames to /dev/null :) Have a nice day! === LINKS === Great
- MySQL tutorial site:
- http://www.devshed.com/Server_Side/MySQL/</literallayout>
+===
+THE DETAILS
+===
+
+ Ahh, so you're wondering just what to do with the information above? At the
+mysql prompt, you can view any information about the columns in a table with
+this command (where "table" is the name of the table you wish to view):
+
+mysql> show columns from table;
+
+ You can also view all the data in a table with this command:
+
+mysql> select * from table;
+
+ -- note: this is a very bad idea to do on, for instance, the "bugs" table if
+you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
+50,000 bugs play across your screen.
+
+ You can limit the display from above a little with the command, where
+"column" is the name of the column for which you wish to restrict information:
+
+mysql> select * from table where (column = "some info");
+
+ -- or the reverse of this
+
+mysql> select * from table where (column != "some info");
+
+ Let's take our example from the introduction, and assume you need to change
+the word "verified" to "approved" in the resolution field. We know from the
+above information that the resolution is likely to be stored in the "bugs"
+table. Note we'll need to change a little perl code as well as this database
+change, but I won't plunge into that in this document. Let's verify the
+information is stored in the "bugs" table:
+
+mysql> show columns from bugs
+
+ (exceedingly long output truncated here)
+| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
+
+ Sorry about that long line. We see from this that the "bug status" column is
+an "enum field", which is a MySQL peculiarity where a string type field can
+only have certain types of entries. While I think this is very cool, it's not
+standard SQL. Anyway, we need to add the possible enum field entry
+'APPROVED' by altering the "bugs" table.
+
+mysql> ALTER table bugs CHANGE bug_status bug_status
+ -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
+ -> "VERIFIED", "APPROVED", "CLOSED") not null;
+
+ (note we can take three lines or more -- whatever you put in before the
+semicolon is evaluated as a single expression)
+
+Now if you do this:
+
+mysql> show columns from bugs;
+
+ you'll see that the bug_status field has an extra "APPROVED" enum that's
+available! Cool thing, too, is that this is reflected on your query page as
+well -- you can query by the new status. But how's it fit into the existing
+scheme of things?
+ Looks like you need to go back and look for instances of the word "verified"
+in the perl code for Bugzilla -- wherever you find "verified", change it to
+"approved" and you're in business (make sure that's a case-insensitive search).
+Although you can query by the enum field, you can't give something a status
+of "APPROVED" until you make the perl changes. Note that this change I
+mentioned can also be done by editing checksetup.pl, which automates a lot of
+this. But you need to know this stuff anyway, right?
+ </literallayout>
</section>
</section>
</section>
- <section id="granttables">
- <title>MySQL Permissions &amp; Grant Tables</title>
-
- <note>
- <para>The following portion of documentation comes from my answer to an
- old discussion of Keystone, a cool product that does trouble-ticket
- tracking for IT departments. I wrote this post to the Keystone support
- group regarding MySQL grant table permissions, and how to use them
- effectively. It is badly in need of updating, as I believe MySQL has
- added a field or two to the grant tables since this time, but it serves
- as a decent introduction and troubleshooting document for grant table
- issues. I used Keynote to track my troubles until I discovered
- Bugzilla, which gave me a whole new set of troubles to work on : )
- Although it is of limited use, it still has SOME use, thus it's still
- included.</para>
-
- <para>Please note, however, that I was a relatively new user to MySQL
- at the time. Some of my suggestions, particularly in how to set up
- security, showed a terrible lack of security-related database
- experience.</para>
- </note>
-
- <literallayout>From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999
- Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson
- matt_barnson@singletrac.com To: keystone-users@homeport.org Subject:
- [keystone-users] Grant Tables FAQ [The following text is in the
- "iso-8859-1" character set] [Your display is set for the "US-ASCII"
- character set] [Some characters may be displayed incorrectly] Maybe we
- can include this rambling message in the Keystone FAQ? It gets asked a
- lot, and the only option current listed in the FAQ is
- "--skip-grant-tables". Really, you can't go wrong by reading section 6 of
- the MySQL manual, at http://www.mysql.com/Manual/manual.html. I am sure
- their description is better than mine. MySQL runs fine without
- permissions set up correctly if you run the mysql daemon with the
- "--skip-grant-tables" option. Running this way denies access to nobody.
- Unfortunately, unless you've got yourself firewalled it also opens the
- potential for abuse if someone knows you're running it. Additionally, the
- default permissions for MySQL allow anyone at localhost access to the
- database if the database name begins with "test_" or is named "test"
- (i.e. "test_keystone"). You can change the name of your database in the
- keystone.conf file ($sys_dbname). This is the way I am doing it for some
- of my databases, and it works fine. The methods described below assume
- you're running MySQL on the same box as your webserver, and that you
- don't mind if your $sys_dbuser for Keystone has superuser access. See
- near the bottom of this message for a description of what each field
- does. Method #1: 1. cd /var/lib #location where you'll want to run
- /usr/bin/mysql_install_db shell script from to get it to work. 2. ln -s
- mysql data # soft links the "mysql" directory to "data", which is what
- mysql_install_db expects. Alternately, you can edit mysql_install_db and
- change all the "./data" references to "./mysql". 3. Edit
- /usr/bin/mysql_install_db with your favorite text editor (vi, emacs, jot,
- pico, etc.) A) Copy the "INSERT INTO db VALUES
- ('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately
- after itself. Chage the 'test\_%' value to 'keystone', or the value of
- $sys_dbname in keystone.conf. B) If you are running your keystone
- database with any user, you'll need to copy the "INSERT INTO user VALUES
- ('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line
- after itself and change 'root' to the name of the keystone database user
- ($sys_dbuser) in keystone.conf. # adds entries to the script to create
- grant tables for specific hosts and users. The user you set up has
- super-user access ($sys_dbuser) -- you may or may not want this. The
- layout of mysql_install_db is really very uncomplicated. 4.
- /usr/bin/mysqladmin shutdown # ya gotta shut it down before you can
- reinstall the grant tables! 5. rm -i /var/lib/mysql/mysql/*.IS?' and
- answer 'Y' to the deletion questions. # nuke your current grant tables.
- This WILL NOT delete any other databases than your grant tables. 6.
- /usr/bin/mysql_install_db # run the script you just edited to install
- your new grant tables. 7. mysqladmin -u root password (new_password) #
- change the root MySQL password, or else anyone on localhost can login to
- MySQL as root and make changes. You can skip this step if you want
- keystone to connect as root with no password. 8. mysqladmin -u
- (webserver_user_name) password (new_password) # change the password of
- the $sys_dbuser. Note that you will need to change the password in the
- keystone.conf file as well in $sys_dbpasswd, and if your permissions are
- set up incorrectly anybody can type the URL to your keystone.conf file
- and get the password. Not that this will help them much if your
- permissions are set to @localhost. Method #2: easier, but a pain
- reproducing if you have to delete your grant tables. This is the
- "recommended" method for altering grant tables in MySQL. I don't use it
- because I like the other way :) shell&gt; mysql --user=root keystone
- mysql&gt; GRANT
- SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS,
- FILE, ON keystone.* TO &lt;$sys_dbuser name&gt;@localhost IDENTIFIED BY
- '(password)' WITH GRANT OPTION; OR mysql&gt; GRANT ALL PRIVILEGES ON
- keystone.* TO &lt;$sys_dbuser name&gt;@localhost IDENTIFIED BY
- '(password)' WITH GRANT OPTION; # this grants the required permissions to
- the keystone ($sys_dbuser) account defined in keystone.conf. However, if
- you are runnning many different MySQL-based apps, as we are, it's
- generally better to edit the mysql_install_db script to be able to
- quickly reproduce your permissions structure again. Note that the FILE
- privelege and WITH GRANT OPTION may not be in your best interest to
- include. GRANT TABLE FIELDS EXPLANATION: Quick syntax summary: "%" in
- MySQL is a wildcard. I.E., if you are defining your DB table and in the
- 'host' field and enter '%', that means that any host can access that
- database. Of course, that host must also have a valid db user in order to
- do anything useful. 'db'=name of database. In our case, it should be
- "keystone". "user" should be your "$sys_dbuser" defined in keystone.conf.
- Note that you CANNOT add or change a password by using the "INSERT INTO
- db (X)" command -- you must change it with the mysql -u command as
- defined above. Passwords are stored encrypted in the MySQL database, and
- if you try to enter it directly into the table they will not match.
- TABLE: USER. Everything after "password" is a privelege granted (Y/N).
- This table controls individual user global access rights.
- 'host','user','password','select','insert','update','delete','index','alter'
- ,'create','drop','grant','reload','shutdown','process','file' TABLE: DB.
- This controls access of USERS to databases.
- 'host','db','user','select','insert','update','delete','index','alter','crea
- te','drop','grant' TABLE: HOST. This controls which HOSTS are allowed
- what global access rights. Note that the HOST table, USER table, and DB
- table are very closely connected -- if an authorized USER attempts an SQL
- request from an unauthorized HOST, she's denied. If a request from an
- authorized HOST is not an authorized USER, it is denied. If a globally
- authorized USER does not have rights to a certain DB, she's denied. Get
- the picture?
- 'host','db','select','insert','update','delete','index','alter','create','dr
- op','grant' You should now have a working knowledge of MySQL grant
- tables. If there is anything I've left out of this answer that you feel
- is pertinent, or if my instructions don't work for you, please let me
- know and I'll re-post this letter again, corrected. I threw it together
- one night out of exasperation for all the newbies who don't know squat
- about MySQL yet, so it is almost guaranteed to have errors. Once again,
- you can't go wrong by reading section 6 of the MySQL manual. It is more
- detailed than I! http://www.mysql.com/Manual/manual.html.</literallayout>
- </section>
</appendix>
<!-- Keep this comment at the end of the file
diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml
index f7fafd3e8..91380863f 100644
--- a/docs/sgml/faq.sgml
+++ b/docs/sgml/faq.sgml
@@ -3,6 +3,10 @@
<appendix id="faq">
<title>The Bugzilla FAQ</title>
+ <para>
+ This FAQ includes questions not covered elsewhere in the Guide.
+ </para>
+
<qandaset>
@@ -121,9 +125,9 @@
</question>
<answer>
<para>
- A year has gone by, and I <emphasis>still</emphasis> can't
- find any head-to-head comparisons of Bugzilla against
- other defect-tracking software. However, from my personal
+ We can't find any head-to-head comparisons of Bugzilla against
+ other defect-tracking software. If you know of one, please
+ get in touch. However, from the author's personal
experience with other bug-trackers, Bugzilla offers
superior performance on commodity hardware, better price
(free!), more developer- friendly features (such as stored
@@ -133,24 +137,9 @@
</para>
<para>
If you happen to be a commercial bug-tracker vendor, please
- step forward with a rebuttal so I can include it in the
- FAQ. We're not in pursuit of Bugzilla ueber alles; we
- simply love having a powerful, open-source tool to get our
- jobs done.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
- How do I change my user name (email address) in Bugzilla?
- </para>
- </question>
- <answer>
- <para>
- New in 2.16 - go to the Account section of the Preferences. You will
- be emailed at both addresses for confirmation.
+ step forward with a list of advantages your product has over
+ Bugzilla. We'd be happy to include it in the "Competitors"
+ section.
</para>
</answer>
</qandaentry>
@@ -184,7 +173,7 @@
<question>
<para>
Why MySQL? I'm interested in seeing Bugzilla run on
- Oracle/Sybase/Msql/PostgreSQL/MSSQL?
+ Oracle/Sybase/Msql/PostgreSQL/MSSQL.
</para>
</question>
<answer>
@@ -204,42 +193,41 @@
</question>
<answer>
<para>
- Mozilla.org uses /usr/bonsaitools/bin/perl. The prime rule in making
- submissions is "don't break bugzilla.mozilla.org". If it breaks it, your
- patch will be reverted faster than you can do a diff.
- </para>
- <para>
- Here's Terry Weissman's comment, for some historical context:
- <blockquote>
- <para>
- [This was] purely my own convention. I wanted a place to put a version of
- Perl and other tools that was strictly under my control for the
- various webtools, and not subject to anyone else. Edit it to point
- to whatever you like.
- </para>
- <note>
+ Mozilla.org uses /usr/bonsaitools/bin/perl, because originally
+ Terry wanted a place to put a version of Perl and other tools
+ that was strictly under his control.
+ </para>
<para>
We always recommend that, if possible, you keep the path
- as /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools
- and /usr/bonsaitools/bin directory, then symlink your version
- of perl to /usr/bonsaitools/bin/perl. This will make upgrading
+ as /usr/bonsaitools/bin/perl, and simply add symlink.
+ This will make upgrading
your Bugzilla much easier in the future.
</para>
- </note>
- </blockquote>
- </para>
</answer>
</qandaentry>
+
+ <qandaentry>
+ <question>
+ <para>
+ Is there an easy way to change the Bugzilla cookie name?
+ </para>
+ </question>
+ <answer>
+ <para>
+ At present, no.
+ </para>
+ </answer>
+ </qandaentry>
+
</qandadiv>
<qandadiv id="faq-phb">
- <title>Pointy-Haired-Boss Questions</title>
+ <title>Managerial Questions</title>
<para>
<note>
<para>
- The title of this section doesn't mean you're a PHB -- it just means
- you probably HAVE a PHB who wants to know this :)
+ Questions likely to be asked by managers. :-)
</para>
</note>
</para>
@@ -247,8 +235,8 @@
<qandaentry>
<question>
<para>
- Is Bugzilla web-based or do you have to have specific software or
- specific operating system on your machine?
+ Is Bugzilla web-based, or do you have to have specific software or
+ a specific operating system on your machine?
</para>
</question>
<answer>
@@ -262,7 +250,7 @@
<qandaentry>
<question>
<para>
- Has anyone you know of already done any Bugzilla integration with
+ Can Bugzilla integrate with
Perforce (SCM software)?
</para>
</question>
@@ -282,11 +270,10 @@
</question>
<answer>
<para>
- Absolutely! You can track up to a "soft-limit" of around
- 64 individual "Products", that can each be composed of as
- many "Components" as you want. Check the Administration
- section of the Bugzilla Guide for more information regarding
- setting up Products and Components.
+ Absolutely! You can track any number of Products (although you
+ are limited to about 55 or so if
+ you are using Product-Based Groups), that can each be composed of any
+ number of Components.
</para>
</answer>
</qandaentry>
@@ -308,7 +295,7 @@
<qandaentry>
<question>
<para>
- Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes,
+ Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
are there any that are NOT allowed?
</para>
</question>
@@ -346,19 +333,6 @@
</answer>
</qandaentry>
-
- <qandaentry>
- <question>
- <para>
- The index.html page doesn't show the footer. It's really annoying to have
- to go to the querypage just to check my "my bugs" link.
- </para>
- </question>
- <answer>
- <para>If you upgrade to 2.16, the index page has a footer.
- </para>
- </answer>
- </qandaentry>
<qandaentry>
<question>
<para>
@@ -370,7 +344,7 @@
<para>
Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi">
http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting
- facilities.
+ and graphing facilities.
</para>
<para>
For more advanced reporting, I recommend hooking up a professional
@@ -387,7 +361,7 @@
<question>
<para>
Is there email notification and if so, what do you see when you get an
- email? Do you see bug number and title or is it only the number?
+ email?
</para>
</question>
<answer>
@@ -416,7 +390,7 @@
<qandaentry>
<question>
<para>
- If there is email notification, do users have to have any particular
+ Do users have to have any particular
type of email application?
</para>
</question>
@@ -441,24 +415,6 @@
<qandaentry>
<question>
<para>
- If I just wanted to track certain bugs, as they go through life, can I
- set it up to alert me via email whenever that bug changes, whether it be
- owner, status or description etc.?
- </para>
- </question>
- <answer>
- <para>
- Yes. Place yourself in the "cc" field of the bug you wish to monitor.
- Then change your "Notify me of changes to" field in the Email Settings
- tab of the User Preferences screen in Bugzilla to the "Only those
- bugs which I am listed on the CC line" option.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
Does Bugzilla allow data to be imported and exported? If I had outsiders
write up a bug report using a MS Word bug template, could that template be
imported into "matching" fields? If I wanted to take the results of a query
@@ -523,33 +479,6 @@
<qandaentry>
<question>
<para>
- Can a user re-run a report with a new project, same query?
- </para>
- </question>
- <answer>
- <para>
- Yes.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
- Can a user modify an existing report and then save it into another name?
- </para>
- </question>
- <answer>
- <para>
- You can save an unlimited number of queries in Bugzilla. You are free
- to modify them and rename them to your heart's desire.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
Does Bugzilla have the ability to search by word, phrase, compound
search?
</para>
@@ -565,20 +494,6 @@
<qandaentry>
<question>
<para>
- Can the admin person establish separate group and individual user
- privileges?
- </para>
- </question>
- <answer>
- <para>
- Yes.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
Does Bugzilla provide record locking when there is simultaneous access
to the same bug? Does the second person get a notice that the bug is in use
or how are they notified?
@@ -635,9 +550,8 @@
</question>
<answer>
<para>
- If Bugzilla is set up correctly from the start, continuing maintenance needs
- are minimal and can be completed by unskilled labor. Things like rotate
- backup tapes and check log files for the word "error".
+ If Bugzilla is set up correctly from the start, continuing maintenance
+ needs are minimal and can be done easily using the web interface.
</para>
<para>
Commercial Bug-tracking software typically costs somewhere upwards
@@ -686,52 +600,6 @@
</qandaentry>
</qandadiv>
- <qandadiv id="faq-install">
- <title>Bugzilla Installation</title>
- <qandaentry>
- <question>
- <para>
- How do I download and install Bugzilla?
- </para>
- </question>
- <answer>
- <para>
- Check <ulink url="http://www.bugzilla.org/">
- http://www.bugzilla.org/</ulink> for details.
- Read the other parts of this Guide for installation instructions.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
- How do I install Bugzilla on Windows NT?
- </para>
- </question>
- <answer>
- <para>
- Installation on Windows NT has its own section in
- this document.
- </para>
- </answer>
- </qandaentry>
-
- <qandaentry>
- <question>
- <para>
- Is there an easy way to change the Bugzilla cookie name?
- </para>
- </question>
- <answer>
- <para>
- At present, no.
- </para>
- </answer>
- </qandaentry>
-
- </qandadiv>
-
<qandadiv id="faq-security">
<title>Bugzilla Security</title>
@@ -739,15 +607,14 @@
<question>
<para>
How do I completely disable MySQL security if it's giving me problems
- (I've followed the instructions in the installation section of this guide!)?
+ (I've followed the instructions in the installation section of this guide)?
</para>
</question>
<answer>
<para>
Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this
makes MySQL as secure as taping a $100 to the floor of a football stadium
- bathroom for safekeeping.</emphasis> Please read the Security section of the
- Administration chapter of "The Bugzilla Guide" before proceeding.
+ bathroom for safekeeping.</emphasis>
</para>
</answer>
</qandaentry>
@@ -815,8 +682,8 @@
</question>
<answer>
<para>
- Edit the "changedmail" param. Replace "To:" with "X-Real-To:",
- replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)".
+ Edit the "changedmail" Param. Replace "To:" with "X-Real-To:",
+ replace "Cc:" with "X-Real-CC:", and add a "To: &lt;youremailaddress&gt;".
</para>
</answer>
</qandaentry>
@@ -1002,7 +869,7 @@
<qandaentry>
<question>
<para>
- I think I've set up MySQL permissions correctly, but bugzilla still can't
+ I think I've set up MySQL permissions correctly, but Bugzilla still can't
connect.
</para>
</question>
@@ -1162,6 +1029,20 @@
<qandaentry>
<question>
<para>
+ How do I change my user name (email address) in Bugzilla?
+ </para>
+ </question>
+ <answer>
+ <para>
+ New in 2.16 - go to the Account section of the Preferences. You will
+ be emailed at both addresses for confirmation.
+ </para>
+ </answer>
+ </qandaentry>
+
+ <qandaentry>
+ <question>
+ <para>
The query page is very confusing. Isn't there a simpler way to query?
</para>
</question>
@@ -1184,7 +1065,7 @@
<answer>
<para>
The current behavior is acceptable to bugzilla.mozilla.org and most
- users. I personally don't like it. You have your choice of patches
+ users. You have your choice of patches
to change this behavior, however.
<simplelist>
<member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">
@@ -1192,8 +1073,8 @@
<member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153">
"Accept" button automatically assigns to you</ulink></member>
</simplelist>
- Note that these patches are somewhat dated. You will need to do the find
- and replace manually to apply them. They are very small, though. It is easy.
+ Note that these patches are somewhat dated. You will need to apply
+ them manually.
</para>
</answer>
</qandaentry>
@@ -1224,7 +1105,7 @@
<answer>
<para>
Yup. Just rename it once you download it, or save it under a different
- filename. This will not be fixed anytime too soon, because it would
+ filename. This will not be fixed anytime soon, because it would
cripple some other functionality.
</para>
</answer>
@@ -1288,9 +1169,7 @@
http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy
as adding the "---" priority field to your localconfig file in the appropriate area,
re-running checksetup.pl, and then changing the default priority in your browser using
- "editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle
- it, but for now it's what we have! Although the bug has been closed "RESOLVED WONTFIX",
- there may be a better way to handle this...
+ "editparams.cgi".
</para>
</answer>
</qandaentry>
@@ -1325,7 +1204,7 @@
<listitem>
<para>
Announce your patch and the associated URL
- (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in
+ (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for discussion in
the newsgroup (netscape.public.mozilla.webtools). You'll get a really
good, fairly immediate reaction to the implications of your patch,
which will also give us an idea how well-received the change would
diff --git a/docs/sgml/gfdl.sgml b/docs/sgml/gfdl.sgml
index d9e18de38..047646411 100644
--- a/docs/sgml/gfdl.sgml
+++ b/docs/sgml/gfdl.sgml
@@ -1,10 +1,10 @@
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
-<appendix id="gfdl">
+<section id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
-<!-- sect1>
+<!-- section>
<title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
@@ -15,7 +15,7 @@
not allowed.</para>
</blockquote>
- <sect1 label="0" id="gfdl-0">
+ <section label="0" id="gfdl-0">
<title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook, or other
@@ -38,9 +38,9 @@
can be used for any textual work, regardless of subject matter or whether
it is published as a printed book. We recommend this License principally
for works whose purpose is instruction or reference.</para>
- </sect1>
+ </section>
- <sect1 label="1" id="gfdl-1">
+ <section label="1" id="gfdl-1">
<title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that contains a
@@ -98,9 +98,9 @@
which do not have any title page as such, "Title Page" means the text
near the most prominent appearance of the work's title, preceding the
beginning of the body of the text.</para>
- </sect1>
+ </section>
- <sect1 label="2" id="gfdl-2">
+ <section label="2" id="gfdl-2">
<title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium, either
@@ -115,9 +115,9 @@
<para>You may also lend copies, under the same conditions stated above,
and you may publicly display copies.</para>
- </sect1>
+ </section>
- <sect1 label="3" id="gfdl-3">
+ <section label="3" id="gfdl-3">
<title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more than
@@ -154,9 +154,9 @@
the Document well before redistributing any large number of copies, to
give them a chance to provide you with an updated version of the
Document.</para>
- </sect1>
+ </section>
- <sect1 label="4" id="gfdl-4">
+ <section label="4" id="gfdl-4">
<title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the Document
@@ -284,9 +284,9 @@
<para>The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to assert
or imply endorsement of any Modified Version.</para>
- </sect1>
+ </section>
- <sect1 label="5" id="gfdl-5">
+ <section label="5" id="gfdl-5">
<title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released under
@@ -310,9 +310,9 @@
"History"; likewise combine any sections entitled "Acknowledgements", and
any sections entitled "Dedications". You must delete all sections
entitled "Endorsements."</para>
- </sect1>
+ </section>
- <sect1 label="6" id="gfdl-6">
+ <section label="6" id="gfdl-6">
<title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and other
@@ -326,9 +326,9 @@
distribute it individually under this License, provided you insert a copy
of this License into the extracted document, and follow this License in
all other respects regarding verbatim copying of that document.</para>
- </sect1>
+ </section>
- <sect1 label="7" id="gfdl-7">
+ <section label="7" id="gfdl-7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other
@@ -345,9 +345,9 @@
the entire aggregate, the Document's Cover Texts may be placed on covers
that surround only the Document within the aggregate. Otherwise they must
appear on covers around the whole aggregate.</para>
- </sect1>
+ </section>
- <sect1 label="8" id="gfdl-8">
+ <section label="8" id="gfdl-8">
<title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may
@@ -360,9 +360,9 @@
License. In case of a disagreement between the translation and the
original English version of this License, the original English version
will prevail.</para>
- </sect1>
+ </section>
- <sect1 label="9" id="gfdl-9">
+ <section label="9" id="gfdl-9">
<title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the Document
@@ -372,9 +372,9 @@
who have received copies, or rights, from you under this License will not
have their licenses terminated so long as such parties remain in full
compliance.</para>
- </sect1>
+ </section>
- <sect1 label="10" id="gfdl-10">
+ <section label="10" id="gfdl-10">
<title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised versions of
@@ -394,9 +394,9 @@
Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft)
by the Free Software Foundation.</para>
- </sect1>
+ </section>
- <sect1 label="" id="gfdl-howto">
+ <section label="" id="gfdl-howto">
<title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include a copy
@@ -422,8 +422,8 @@
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit their
use in free software.</para>
- </sect1>
-</appendix>
+ </section>
+</section>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/docs/sgml/glossary.sgml b/docs/sgml/glossary.sgml
index 3e40df58a..cc5d4fb69 100644
--- a/docs/sgml/glossary.sgml
+++ b/docs/sgml/glossary.sgml
@@ -15,10 +15,7 @@
to keep secret files which would otherwise
compromise your installation - e.g. the
<filename>localconfig</filename>
-
- file contains the password to your database. If this information were
- generally available, and remote access to your database turned on,
- you risk corruption of your database by computer criminals or the
+ file contains the password to your database.
curious.</para>
</glossdef>
</glossentry>
@@ -56,7 +53,7 @@
<glossdef>
<para>A
- <quote>Bug</quote>
+ <quote>bug</quote>
in Bugzilla refers to an issue entered into the database which has an
associated number, assignments, comments, etc. Some also refer to a
@@ -71,33 +68,19 @@
<glossterm>Bug Number</glossterm>
<glossdef>
- <para>Each Bugzilla Bug is assigned a number that uniquely identifies
- that Bug. The Bug associated with a Bug Number can be pulled up via a
+ <para>Each Bugzilla bug is assigned a number that uniquely identifies
+ that bug. The bug associated with a bug number can be pulled up via a
query, or easily from the very front page by typing the number in the
"Find" box.</para>
</glossdef>
</glossentry>
<glossentry>
- <glossterm>Bug Life Cycle</glossterm>
-
- <glossdef>
- <para>A Bug has stages through which it must pass before becoming a
- <quote>closed bug</quote>,
- including acceptance, resolution, and verification. The
- <quote>Bug Life Cycle</quote>
-
- is moderately flexible according to the needs of the organization
- using it, though.</para>
- </glossdef>
- </glossentry>
-
- <glossentry>
<glossterm>Bugzilla</glossterm>
<glossdef>
- <para>Bugzilla is the industry-standard bug tracking system. It is
- quite popular among Open Source enthusiasts.</para>
+ <para>Bugzilla is the world-leading free software bug tracking system.
+ </para>
</glossdef>
</glossentry>
</glossdiv>
@@ -127,14 +110,11 @@
<acronym>CPAN</acronym>
stands for the
- <quote>Comprehensive Perl Archive Network</quote>
-
- . CPAN maintains a large number of extremely useful
+ <quote>Comprehensive Perl Archive Network</quote>.
+ CPAN maintains a large number of extremely useful
<glossterm>Perl</glossterm>
-
- modules. By themselves, Perl modules generally do nothing, but when
- used as part of a larger program, they provide much-needed algorithms
- and functionality.</para>
+ modules - encapsulated chunks of code for performing a
+ particular task.</para>
</glossdef>
</glossentry>
</glossdiv>
@@ -169,33 +149,16 @@
<quote>Groups</quote>
has a very special meaning to Bugzilla. Bugzilla's main security
- mechanism comes by lumping users into groups, and assigning those
- groups certain privileges to
+ mechanism comes by placing users in groups, and assigning those
+ groups certain privileges to view bugs in particular
<glossterm>Products</glossterm>
-
- and
- <glossterm>Components</glossterm>
-
in the
<glossterm>Bugzilla</glossterm>
-
database.</para>
</glossdef>
</glossentry>
</glossdiv>
- <glossdiv id="gloss-i">
- <title>I</title>
-
- <glossentry id="gloss-infiniteloop">
- <glossterm>Infinite Loop</glossterm>
-
- <glossdef>
- <para>A loop of information that never ends; see recursion.</para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
<glossdiv id="gloss-m">
<title>M</title>
@@ -221,10 +184,11 @@
<glossterm id="gloss-product">Product</glossterm>
<glossdef>
- <para>A Product is a broad category of types of bugs. In general,
- there are several Components to a Product. A Product may also define a
+ <para>A Product is a broad category of types of bugs, normally
+ representing a single piece of software or entity. In general,
+ there are several Components to a Product. A Product may define a
group (used for security) for all bugs entered into
- components beneath it.</para>
+ its Components.</para>
</glossdef>
</glossentry>
@@ -262,24 +226,7 @@
bugs over their life cycle, thus the need for the
<quote>QA Contact</quote>
- field in a Bug.</para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv id="gloss-r">
- <title>R</title>
-
- <glossentry id="gloss-recursion" xreflabel="Recursion">
- <glossterm>Recursion</glossterm>
-
- <glossdef>
- <para>The property of a function looking back at itself for
- something.
- <quote>GNU</quote>, for instance, stands for
- <quote>GNU's Not UNIX</quote>,
- thus recursing upon itself for definition. For further clarity, see
- Infinite Loop.</para>
+ field in a bug.</para>
</glossdef>
</glossentry>
</glossdiv>
diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml
index 8cadbdd58..0433b4b52 100644
--- a/docs/sgml/installation.sgml
+++ b/docs/sgml/installation.sgml
@@ -1,1729 +1,1766 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
+<chapter id="installation" xreflabel="Bugzilla Installation">
+ <title>Installation</title>
- <chapter id="installation" xreflabel="Bugzilla Installation">
- <title>Installation</title>
- <para>
- 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.
- </para>
- <section id="errata">
- <title>ERRATA</title>
- <para>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.</para>
-
- <simplelist>
- <member>
- If you are installing Bugzilla on S.u.S.e. Linux, or some
- other distributions with <quote>paranoid</quote> security
- options, it is possible that the checksetup.pl script may fail
- with the error: <errorname>cannot chdir(/var/spool/mqueue):
- Permission denied</errorname> This is because your
- <filename>/var/spool/mqueue</filename> directory has a mode of
- <quote>drwx------</quote>. Type <command>chmod 755
- <filename>/var/spool/mqueue</filename></command> as root to
- fix this problem.
- </member>
-
- <member>
- 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
- </member>
-
- <member>
- Release Notes for Bugzilla &bz-ver; are available at
- <filename>docs/rel_notes.txt</filename> in your Bugzilla
- source distribution.
- </member>
-
- <member>
- 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.
- </member>
-
- </simplelist>
-
- <warning>
- <para>
- 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.
- </para>
- </warning>
-
- <warning>
- <para>
- 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.
- </para>
- </warning>
- </section>
-
<section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step">
<title>Step-by-step Install</title>
+
<section>
<title>Introduction</title>
- <para>
- 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.
- </para>
-
- <para>
- 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 <xref linkend="win32" /> for further advice
- on getting Bugzilla to work on Microsoft Windows.
- </para>
-
- <para>
- 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).
- </para>
+
+ <para>Bugzilla has been successfully installed under Solaris, Linux,
+ and Win32. Win32 is not yet officially supported, but many people
+ have got it working fine.
+ Please see the
+ <xref linkend="win32" />
+ for further advice on getting Bugzilla to work on Microsoft
+ Windows.</para>
+
</section>
+
<section>
- <title>Installing the Prerequisites</title>
+ <title>Package List</title>
+
<note>
- <para>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 <xref linkend="bundlebugzilla" /></para>
+ <para> 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
+ <xref linkend="bundlebugzilla" />.
+ </para>
</note>
+
+ <para>The software packages necessary for the proper running of
+ Bugzilla (with download links) are:
+ <orderedlist>
+
+
+<listitem>
+ <para>
+ <ulink url="http://www.mysql.com/">MySQL database server</ulink>
+ (3.22.5 or greater)
+ </para>
+</listitem>
+
+<listitem>
+ <para>
+ <ulink url="http://www.perl.org">Perl</ulink>
+ (5.005 or greater, 5.6.1 is recommended if you wish to
+ use Bundle::Bugzilla)
+ </para>
+</listitem>
+
+<listitem>
+ <para>Perl Modules (minimum version):
+ <orderedlist>
+ <listitem>
<para>
- The software packages necessary for the proper running of bugzilla are:
- <orderedlist>
- <listitem>
- <para>
- MySQL database server and the mysql client (3.22.5 or greater)
- </para>
- </listitem>
- <listitem>
- <para>
- Perl (5.004 or greater, 5.6.1 is recommended if you wish
- to use Bundle::Bugzilla)
- </para>
- </listitem>
- <listitem>
- <para>
- DBI Perl module
- </para>
- </listitem>
- <listitem>
- <para>
- Data::Dumper Perl module
- </para>
- </listitem>
- <listitem>
- <para>
- Bundle::Mysql Perl module collection
- </para>
- </listitem>
- <listitem>
- <para>
- TimeDate Perl module collection
- </para>
- </listitem>
- <listitem>
- <para>
- GD perl module (1.8.3) (optional, for bug charting)
- </para>
- </listitem>
- <listitem>
- <para>
- Chart::Base Perl module (0.99c) (optional, for bug charting)
- </para>
- </listitem>
- <listitem>
- <para>
- DB_File Perl module (optional, for bug charting)
- </para>
- </listitem>
- <listitem>
- <para>
- The web server of your choice. Apache is recommended.
- </para>
- </listitem>
- <listitem>
- <para>
- MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
- </para>
- </listitem>
- </orderedlist>
-
- <warning>
- <para>
- It is a good idea, while installing Bugzilla, to ensure it
- is not <emphasis>accessible</emphasis> 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.
- </para>
- </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>
-
+ <ulink url="http://www.template-toolkit.org">Template</ulink>
+ (v2.07)
</para>
- </section>
- <section id="install-mysql">
- <title>Installing MySQL Database</title>
+ </listitem>
+
+ <listitem>
<para>
- Visit MySQL homepage at <ulink
- 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>.
+ <ulink url="http://www.cpan.org/modules/by-module/AppConfig/">AppConfig
+ </ulink>
+ (v1.52)
</para>
- <para>
- If you install from source or non-package (RPM, deb, etc.)
- binaries you need to add
- <firstterm>mysqld</firstterm> 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.
- <note>
- <para>You should have your init script start
- <glossterm>mysqld</glossterm> with the ability to accept
- large packets. By default, <filename>mysqld</filename>
- 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>
+ </listitem>
- </para>
- <note>
- <para>
- If you plan on running Bugzilla and MySQL on the same
- machine, consider using the <option>--skip-networking</option>
- option in the init script. This enhances security by
- preventing network access to MySQL.
- </para>
- </note>
- </section>
-
- <section id="install-perl">
- <title>Perl (5.004 or greater)</title>
+ <listitem>
<para>
- 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;.
+ <ulink url="http://www.cpan.org/authors/id/MUIR/modules/Text-Tabs%2BWrap-2001.0131.tar.gz">Text::Wrap</ulink>
+ (v2001.0131)
</para>
+ </listitem>
+
+ <listitem>
<para>
- 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.
+ <ulink url="http://search.cpan.org/search?dist=File-Spec">File::Spec
+ </ulink>
+ (v0.8.2)
</para>
- <warning>
- <para>Many people complain that Perl modules will not install
- for them. Most times, the error messages complain that they
- are missing a file in <quote>@INC</quote>. 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
- <emphasis>are</emphasis> the local UNIX sysadmin, please
- consult the newsgroup/mailing list for further assistance or
- hire someone to help you out.
- </para>
- </warning>
- <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
- <para>
- You can skip the following Perl module installation steps by
- installing <productname>Bundle::Bugzilla</productname> from
- <glossterm linkend="gloss-cpan">CPAN</glossterm>, 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;)
- </para>
- <para>
- <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN
- -e 'install "Bundle::Bugzilla"'</command>
- </computeroutput>
- </para>
- <para>
- 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.
- </para>
- </tip>
- </section>
-
- <section>
- <title>DBI Perl Module</title>
+ </listitem>
+
+ <listitem>
<para>
- 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.
+ <ulink url="http://www.cpan.org/modules/by-module/Data/">Data::Dumper
+ </ulink>
+ (any)
</para>
+ </listitem>
+
+ <listitem>
<para>
- Like almost all Perl modules DBI can be found on the Comprehensive Perl
- Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
- real tendency to bog down, so please use mirrors. The current location
- at the time of this writing can be found in <xref linkend="downloadlinks" />.
+ <ulink url="http://www.cpan.org/modules/by-module/Mysql/">DBD::mysql
+ </ulink>
+ (v1.2209)
</para>
+ </listitem>
+
+ <listitem>
<para>
- 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.
+ <ulink url="http://www.cpan.org/modules/by-module/DBI/">DBI</ulink>
+ (v1.13)
</para>
+ </listitem>
+
+ <listitem>
<para>
- To use the CPAN shell to install DBI:
- <informalexample>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>perl -MCPAN -e 'install "DBI"'</command>
- </computeroutput>
- <note>
- <para>Replace "DBI" with the name of whichever module you wish
- to install, such as Data::Dumper, TimeDate, GD, etc.</para>
- </note>
- </para>
- </informalexample>
- To do it the hard way:
- <informalexample>
- <para>
- Untar the module tarball -- it should create its own directory
- </para>
- <para>
- CD to the directory just created, and enter the following commands:
- <orderedlist>
- <listitem>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>perl Makefile.PL</command>
- </computeroutput>
- </para>
- </listitem>
- <listitem>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>make</command>
- </computeroutput>
- </para>
- </listitem>
- <listitem>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>make test</command>
- </computeroutput>
- </para>
- </listitem>
- <listitem>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>make install</command>
- </computeroutput>
- </para>
- </listitem>
- </orderedlist>
- If everything went ok that should be all it takes. For the vast
- majority of perl modules this is all that's required.
- </para>
- </informalexample>
+ <ulink url="http://www.cpan.org/modules/by-module/Date/">Date::Parse
+ </ulink>
+ (any)
</para>
- </section>
- <section>
- <title>Data::Dumper Perl Module</title>
+ </listitem>
+
+ <listitem>
<para>
- The Data::Dumper module provides data structure persistence for Perl
- (similar to Java's serialization). It comes with later sub-releases of
- Perl 5.004, but a re-installation just to be sure it's available won't
- hurt anything.
+ CGI::Carp
+ (any)
</para>
+ </listitem>
+
+ </orderedlist>
+ and, optionally:
+ <orderedlist>
+ <listitem>
<para>
- Data::Dumper is used by the MySQL-related Perl modules. It
- can be found on CPAN (see <xref linkend="downloadlinks" />) and
- can be
- installed by following the same four step make sequence used
- for the DBI module.
+ <ulink url="http://www.cpan.org/modules/by-module/GD/">GD</ulink>
+ (v1.19) for bug charting
</para>
- </section>
-
- <section>
- <title>MySQL related Perl Module Collection</title>
+ </listitem>
+
+ <listitem>
<para>
- 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.
+ <ulink url="http://www.cpan.org/modules/by-module/Chart/">Chart::Base
+ </ulink>
+ (v0.99c) for bug charting
</para>
+ </listitem>
+
+ <listitem>
<para>
- The MySQL modules are all built using one make file which is generated
- by running:
- <prompt>bash#</prompt>
- <command>perl Makefile.pl</command>
+ XML::Parser
+ (any) for the XML interface
</para>
+ </listitem>
+
+ <listitem>
<para>
- The MakeMaker process will ask you a few questions about the desired
- compilation target and your MySQL installation. For many of the questions
- the provided default will be adequate.
+ MIME::Parser
+ (any) for the email interface
</para>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </section>
-
- <section>
- <title>TimeDate Perl Module Collection</title>
- <para>
- 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: <xref linkend="downloadlinks" />). 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.
- </para>
- </section>
- <section>
- <title>GD Perl Module (1.8.3)</title>
- <para>
- 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.
- </para>
- <para>
- 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 <xref linkend="downloadlinks" />.
- </para>
- <note>
- <para>
- The Perl GD library requires some other libraries that may
- or may not be installed on your system, including
- <classname>libpng</classname> and
- <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>
- </note>
- </section>
-
- <section>
- <title>Chart::Base Perl Module (0.99c)</title>
- <para>
- The Chart module provides bugzilla with on-the-fly charting
- abilities. It can be installed in the usual fashion after it
- has been fetched from CPAN where it is found as the
- Chart-x.x... tarball, linked in <xref linkend="downloadlinks" />. 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.
- </para>
- </section>
-
- <section>
- <title>DB_File Perl Module</title>
- <para>
- 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.
- </para>
- </section>
-
- <section>
- <title>HTTP Server</title>
- <para>
- 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 <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>
- 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:
- <programlisting>
-AddHandler cgi-script .cgi
- </programlisting>
- </para>
- <para>
- With apache you'll also want to make sure that within the
- access.conf file the line:
- <programlisting>
-Options ExecCGI
-AllowOverride Limit
-</programlisting>
- is in the stanza that covers the directories into which
- you intend to put the bugzilla .html and .cgi files.
- </para>
+ </listitem>
+ </orderedlist>
+ </para>
+</listitem>
+
+
+<listitem>
+ <para>
+ The web server of your choice.
+ <ulink url="http://www.apache.org/">Apache</ulink>
+ is highly recommended.
+ </para>
+</listitem>
+
+
+ </orderedlist>
+
+ <warning>
+ <para>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.</para>
+ </warning>
+
<note>
- <para>
- AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
- </para>
- <para>
- 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.
- </para>
+ <para>Linux-Mandrake 8.0 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>
- <warning>
- <para>
- There are important files and directories that should not
- be a served by the HTTP server. These are most files in the
- <quote>data</quote> and <quote>shadow</quote> directories
- and the <quote>localconfig</quote> 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 <xref linkend="htaccess" /> for details
- on how to do this for Apache. I appreciate notes on how to
- get this same functionality using other webservers.
- </para>
- </warning>
- </section>
-
- <section>
- <title>Installing the Bugzilla Files</title>
- <para>
- You should untar the Bugzilla files into a directory that
- you're willing to make writable by the default web server user
- (probably <quote>nobody</quote>). You may decide to put the
- files off of the main web space for your web server or perhaps
- off of <filename>/usr/local</filename> 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.
- </para>
- <tip>
- <para>
- If you symlink the bugzilla directory into your Apache's
- HTML heirarchy, you may receive
- <errorname>Forbidden</errorname> errors unless you add the
- <quote>FollowSymLinks</quote> directive to the
- &lt;Directory&gt; entry for the HTML root.
- </para>
- </tip>
- <para>
- 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
- <filename>checksetup.pl</filename> script, which locks down your
- installation.
</para>
- <para>
- Lastly, you'll need to set up a symbolic link to
- <filename>/usr/bonsaitools/bin/perl</filename> for the correct
- location of your perl executable (probably
- <filename>/usr/bin/perl</filename>). Otherwise you must hack
- all the .cgi files to change where they look for perl, or use
- <xref linkend="setperl" />, found in
- <xref linkend="patches" />. I suggest using the symlink
- approach for future release compatability.
- <example>
- <title>Setting up bonsaitools symlink</title>
- <para>
- 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
- <quote>/usr/local/bin/perl</quote> for
- <quote>/usr/bin/perl</quote> below; if on certain other
- UNIX systems, Perl may live in weird places like
- <quote>/opt/perl</quote>. As root, run these commands:
- <programlisting>
-bash# mkdir /usr/bonsaitools
-bash# mkdir /usr/bonsaitools/bin
-bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl
- </programlisting>
- </para>
- <para>
- Alternately, you can simply run this perl one-liner to
- change your path to perl in all the files in your Bugzilla
- installation:
- <programlisting>
-perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
-processmail syncshadowdb
- </programlisting>
- Change the second path to perl to match your installation.
- </para>
- </example>
- <tip>
- <para>
- If you don't have root access to set this symlink up,
- check out the
- <xref linkend="setperl" />, listed in <xref
- linkend="patches" />. It will change the path to perl in all your Bugzilla files for you.
- </para>
- </tip>
- </para>
- </section>
-
- <section>
- <title>Setting Up the MySQL Database</title>
- <para>
- 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.
- </para>
- <para>
- 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 <quote>bugs</quote>, and will
- have minimal permissions.
-
- <warning>
- <para>
- 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 <command>DROP
- DATABASE mysql</command>.
- </para>
- <para>That would be bad.</para>
- </warning>
+ </section>
+
+ <section id="install-mysql">
+ <title>MySQL</title>
+
+ <para>Visit the MySQL homepage at
+ <ulink url="http://www.mysql.com">www.mysql.com</ulink>
+ to grab and install the latest stable release of the server.
</para>
- <para>
- Give the MySQL root user a password. MySQL passwords are
- limited to 16 characters.
- <simplelist>
- <member>
- <computeroutput> <prompt>bash#</prompt> <command>mysql
- -u root mysql</command> </computeroutput>
- </member>
- <member>
- <computeroutput> <prompt>mysql></prompt> <command>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root'; </command> </computeroutput>
- </member>
- <member>
- <computeroutput> <prompt>mysql></prompt> <command>FLUSH
- PRIVILEGES;</command> </computeroutput>
- </member>
- </simplelist> From this point on, if you need to access
- MySQL as the MySQL root user, you will need to use
- <command>mysql -u root -p</command> and enter your
- new_password. Remember that MySQL user names have nothing to
- do with Unix user names (login names).
- </para>
- <para>
- Next, we create the <quote>bugs</quote> user, and grant
- sufficient permissions for checksetup.pl, which we'll use
- later, to work its magic. This also restricts the
- <quote>bugs</quote> user to operations within a database
- called <quote>bugs</quote>, and only allows the account to
- connect from <quote>localhost</quote>. Modify it to reflect
- your setup if you will be connecting from another machine or
- as a different user.
- </para>
- <para>
- Remember to set bugs_password to some unique password.
- <simplelist>
- <member>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
- ALTER,CREATE,DROP,REFERENCES
- ON bugs.* TO bugs@localhost
- IDENTIFIED BY 'bugs_password';</command>
- </computeroutput>
- </member>
- <member>
- <computeroutput>
- <prompt>
- mysql>
- </prompt>
- <command>
- FLUSH PRIVILEGES;
- </command>
- </computeroutput>
- </member>
- </simplelist>
- </para>
- <para>
- Next, run the magic checksetup.pl script. (Many thanks to
- Holger Schurig &lt;holgerschurig@nikocity.de&gt; for writing
- this script!) It will make sure Bugzilla files and directories
- have reasonable permissions, set up the
- <filename>data</filename> directory, and create all the MySQL
- tables.
- <simplelist>
- <member>
- <computeroutput> <prompt>bash#</prompt>
- <command>./checksetup.pl</command> </computeroutput>
- </member>
- </simplelist> The first time you run it, it will create a
- file called <filename>localconfig</filename>.
+ <note>
+ <para> Many of the binary
+ versions of MySQL store their data files in
+ <filename>/var</filename>.
+ On some Unix systems, this is part of a smaller root partition,
+ and may not have room for your bug database. You can set the data
+ directory as an option to <filename>configure</filename>
+ if you build MySQL from source yourself.</para>
+ </note>
+
+ <para>If you install from something other than an RPM or Debian
+ package, you will need to add <filename>mysqld</filename>
+ 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.
</para>
+
+ <para>Change your init script to start
+ <filename>mysqld</filename>
+ with the ability to accept large packets. By default,
+ <filename>mysqld</filename>
+ 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.
+ There is a Bugzilla parameter for maximum attachment size;
+ you should configure it to match the value you choose here.</para>
+
+ <para>If you plan on running Bugzilla and MySQL on the same machine,
+ consider using the
+ <option>--skip-networking</option>
+ option in the init script. This enhances security by preventing
+ network access to MySQL.</para>
+
</section>
+
+ <section id="install-perl">
+ <title>Perl</title>
+
+ <para>Any machine that doesn't have Perl on it is a sad machine indeed.
+ Perl can be got in source form from
+ <ulink url="http://www.perl.com">perl.com</ulink> for the rare
+ *nix systems which don't have it.
+ Although Bugzilla runs with all post-5.005
+ versions of Perl, it's a good idea to be up to the very latest version
+ if you can when running Bugzilla. As of this writing, that is Perl
+ version &perl-ver;.</para>
+
+ <tip id="bundlebugzilla"
+ xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules">
+
+ <para>You can skip the following Perl module installation steps by
+ installing
+ <productname>Bundle::Bugzilla</productname>
+
+ from
+ <glossterm linkend="gloss-cpan">CPAN</glossterm>,
+ which installs all required modules for you.</para>
+
+ <para>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>perl -MCPAN -e 'install "Bundle::Bugzilla"'</command>
+ </computeroutput>
+ </para>
+
+ <para>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.</para>
+ </tip>
+ </section>
+
+ <section id="perl-modules">
+ <title>Perl Modules</title>
+
+ <para>
+ All Perl modules can be found on the
+ <ulink url="http://www.cpan.org">Comprehensive Perl
+ Archive Network</ulink> (CPAN). The
+ CPAN servers have a real tendency to bog down, so please use mirrors.
+ </para>
- <section>
- <title>Tweaking <filename>localconfig</filename></title>
- <para>
- This file contains a variety of settings you may need to tweak including
- how Bugzilla should connect to the MySQL database.
- </para>
- <para>
- The connection settings include:
- <orderedlist>
- <listitem>
- <para>
- server's host: just use <quote>localhost</quote> if the
- MySQL server is local
- </para>
- </listitem>
- <listitem>
- <para>
- database name: <quote>bugs</quote> if you're following
- these directions
- </para>
- </listitem>
- <listitem>
- <para>
- MySQL username: <quote>bugs</quote> if you're following
- these directions
- </para>
- </listitem>
- <listitem>
- <para>
- Password for the <quote>bugs</quote> MySQL account above
- </para>
- </listitem>
- </orderedlist>
+ <para>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:
</para>
+
<para>
- You should also install .htaccess files that the Apache
- webserver will use to restrict access to Bugzilla data files.
- See <xref
- linkend="htaccess" />.
+ <computeroutput>
+ <prompt>bash#</prompt>
+ <command>perl -MCPAN -e 'install "&lt;modulename&gt;"'</command>
+ </computeroutput>
</para>
+
<para>
- Once you are happy with the settings, re-run
- <filename>checksetup.pl</filename>. On this second run, it will
- create the database and an administrator account for which
- you will be prompted to provide information.
+ To do it the hard way:
</para>
- <para>
- 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 <quote>edit parameters</quote> option
- that is filled with editable treats.
+
+ <para>Untar the module tarball -- it should create its own
+ directory</para>
+
+ <para>CD to the directory just created, and enter the following
+ commands:
+ <orderedlist>
+ <listitem>
+ <para>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>perl Makefile.PL</command>
+ </computeroutput>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>make</command>
+ </computeroutput>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>make test</command>
+ </computeroutput>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>make install</command>
+ </computeroutput>
+ </para>
+ </listitem>
+ </orderedlist>
</para>
- <para>
- Should everything work, you will have a nearly empty Bugzilla
- database and a newly-created <filename>localconfig</filename>
- file in your Bugzilla root directory.
+
+ <warning>
+ <para>Many people complain that Perl modules will not install for
+ them. Most times, the error messages complain that they are missing a
+ file in
+ <quote>@INC</quote>.
+ Virtually every time, this error is due to permissions being set too
+ restrictively for you to compile Perl modules or not having the
+ necessary Perl development libraries installed on your system.
+ Consult your local UNIX systems administrator for help solving these
+ permissions issues; if you
+ <emphasis>are</emphasis>
+ the local UNIX sysadmin, please consult the newsgroup/mailing list
+ for further assistance or hire someone to help you out.</para>
+ </warning>
+
+
+ <section>
+ <title>DBI</title>
+
+ <para>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.</para>
+ </section>
+
+ <section>
+ <title>Data::Dumper</title>
+
+ <para>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.</para>
+ </section>
+
+ <section>
+ <title>MySQL-related modules</title>
+
+ <para>The Perl/MySQL interface requires a few mutually-dependent Perl
+ modules. These modules are grouped together into the the
+ Msql-Mysql-modules package.</para>
+
+ <para>The MakeMaker process will ask you a few questions about the
+ desired compilation target and your MySQL installation. For most of the
+ questions the provided default will be adequate, but when asked if your
+ desired target is the MySQL or mSQL packages, you should
+ select the MySQL related ones. Later you will be asked if you wish to
+ provide backwards compatibility with the older MySQL packages; you
+ should answer YES to this question. The default is NO.</para>
+
+ <para>A host of 'localhost' should be fine and a testing user of 'test'
+ with a null password should find itself with sufficient access to run
+ tests on the 'test' database which MySQL created upon installation.
</para>
- <para>
- <note>
- <para>
- 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 <quote>webservergroup</quote> 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 <quote>webserveruser</quote> parameter in
- localconfig as well.
- <example>
- <title>Running checksetup.pl as the web user</title>
- <para>
- 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 <emphasis>second run</emphasis> of
- checksetup.pl, do this:
- <programlisting>
-bash# chown -R apache:apache /usr/local/bugzilla
-bash# su - apache
-bash# cd /usr/local/bugzilla
-bash# ./checksetup.pl
- </programlisting>
- </para>
- </example>
- </para>
- </note>
+ </section>
+
+ <section>
+ <title>TimeDate modules</title>
+
+ <para>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.
</para>
+ </section>
+
+ <section>
+ <title>GD (optional)</title>
+
+ <para>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.</para>
+
<note>
- <para>
- 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.
- </para>
+ <para>The Perl GD library requires some other libraries that may or
+ may not be installed on your system, including
+ <classname>libpng</classname>
+ and
+ <classname>libgd</classname>.
+ The full requirements are listed in the Perl GD library README.
+ If compiling GD fails, it's probably because you're
+ missing a required library.</para>
</note>
</section>
+
+ <section>
+ <title>Chart::Base (optional)</title>
+
+ <para>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.</para>
+ </section>
<section>
- <title>Setting Up Maintainers Manually (Optional)</title>
- <para>
- If you want to add someone else to every group by hand, you
- can do it by typing the appropriate MySQL commands. Run
- <command> mysql -u root -p bugs</command> You
- may need different parameters, depending on your security
- settings. Then:
- <simplelist>
- <member>
- <computeroutput> <prompt>mysql></prompt> <command>update
- profiles set groupset=0x7fffffffffffffff where
- login_name = 'XXX';</command> </computeroutput> (yes, that's <emphasis>fifteen</emphasis><quote>f</quote>'s.
- </member>
- </simplelist> replacing XXX with the Bugzilla email address.
- </para>
- </section>
-
- <section>
- <title>The Whining Cron (Optional)</title>
- <para>
- 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):
- <simplelist>
- <member>
- <computeroutput> <command>cd
- &lt;your-bugzilla-directory&gt; ;
- ./whineatnews.pl</command> </computeroutput>
- </member>
- </simplelist>
+ <title>Template Toolkit</title>
+
+ <para>When you install Template Toolkit, you'll get asked various
+ questions about features to enable. The defaults are fine, except
+ that it is recommended you use the high speed XS Stash of the Template
+ Toolkit, in order to achieve best performance. However, there are
+ known problems with XS Stash and Perl 5.005_02 and lower. If you
+ wish to use these older versions of Perl, please use the regular
+ stash.</para>
+ </section>
+
+
+ </section>
+
+ <section>
+ <title>HTTP Server</title>
+
+ <para>You have a freedom of choice here - Apache, Netscape or any other
+ server on UNIX would do. You can run the web server on a
+ different machine than MySQL, but need to adjust the MySQL
+ <quote>bugs</quote>
+ user permissions accordingly.
+ <note>
+ <para>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.</para>
+ </note>
+ </para>
+
+ <para>You'll want to make sure that your web server will run any file
+ with the .cgi extension as a CGI and not just display it. If you're
+ using Apache that means uncommenting the following line in the httpd.conf
+ file:
+ <programlisting>AddHandler cgi-script .cgi</programlisting>
+ </para>
+
+ <para>With Apache you'll also want to make sure that within the
+ httpd.conf file the line:
+ <programlisting>Options ExecCGI AllowOverride Limit</programlisting>
+
+ is in the stanza that covers the directories into which you intend to
+ put the bugzilla .html and .cgi files.
+
+ <note>
+ <para>AllowOverride Limit allows the use of a Deny statement in the
+ .htaccess file generated by checksetup.pl</para>
+
+ <para>Users of older versions of Apache may find the above lines
+ in the srm.conf and access.conf files, respecitvely.</para>
+ </note>
</para>
+
+ <warning>
+ <para>There are important files and directories that should not be a
+ served by the HTTP server - most files in the
+ <quote>data</quote>
+ and
+ <quote>shadow</quote>
+ directories and the
+ <quote>localconfig</quote>
+ file. You should configure your HTTP server to not serve
+ these files. Failure to do so will expose critical passwords and
+ other data. Please see
+ <xref linkend="htaccess" />
+ for details on how to do this for Apache; the checksetup.pl
+ script should create appropriate .htaccess files for you.</para>
+ </warning>
+ </section>
+
+ <section>
+ <title>Bugzilla</title>
+
+ <para>You should untar the Bugzilla files into a directory that you're
+ willing to make writable by the default web server user (probably
+ <quote>nobody</quote>).
+ You may decide to put the files in the main web space for your
+ web server or perhaps in
+ <filename>/usr/local</filename>
+ with a symbolic link in the web space that points to the Bugzilla
+ directory.</para>
+
<tip>
- <para>
- Depending on your system, crontab may have several manpages.
- The following command should lead you to the most useful
- page for this purpose:
- <programlisting>
- man 5 crontab
- </programlisting>
- </para>
+ <para>If you symlink the bugzilla directory into your Apache's HTML
+ heirarchy, you may receive
+ <errorname>Forbidden</errorname>
+ errors unless you add the
+ <quote>FollowSymLinks</quote>
+ directive to the &lt;Directory&gt; entry for the HTML root
+ in httpd.conf.</para>
</tip>
+
+ <para>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
+ <filename>checksetup.pl</filename>
+ script, which locks down your installation.</para>
+
+ <para>Lastly, you'll need to set up a symbolic link to
+ <filename>/usr/bonsaitools/bin/perl</filename>
+ for the correct location of your Perl executable (probably
+ <filename>/usr/bin/perl</filename>).
+ Otherwise you must hack all the .cgi files to change where they look
+ for Perl. This can be done using the following Perl one-liner, but
+ I suggest using the symlink approach to avoid upgrade hassles.
+ </para>
+
+ <para>
+ <programlisting>perl -pi -e
+ 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
+ processmail syncshadowdb</programlisting>
+
+ Change <filename>/usr/bin/perl</filename> to match the location
+ of Perl on your machine.
+ </para>
</section>
-
+
<section>
- <title>Bug Graphs (Optional)</title>
- <para>
- As long as you installed the GD and Graph::Base Perl modules
- you might as well turn on the nifty bugzilla bug reporting
- graphs.
+ <title>Setting Up the MySQL Database</title>
+
+ <para>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.</para>
+
+ <para>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
+ <quote>bugs</quote>, and will have minimal permissions.
</para>
- <para>
- Add a cron entry like this to run collectstats daily at 5
- after midnight:
- <simplelist>
- <member>
- <computeroutput> <prompt>bash#</prompt> <command>crontab
- -e</command> </computeroutput>
- </member>
- <member>
- <computeroutput> 5 0 * * * cd
- &lt;your-bugzilla-directory&gt; ; ./collectstats.pl
- </computeroutput>
- </member>
- </simplelist>
+
+ <para>Begin by giving the MySQL root user a password. MySQL passwords are limited
+ to 16 characters.
+ <simplelist>
+ <member>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>mysql -u root mysql</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>UPDATE user SET Password=PASSWORD('&lt;new_password'&gt;)
+ WHERE user='root';</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>FLUSH PRIVILEGES;</command>
+ </computeroutput>
+ </member>
+ </simplelist>
+
+ From this point on, if you need to access MySQL as the MySQL root user,
+ you will need to use
+ <command>mysql -u root -p</command>
+
+ and enter &lt;new_password&gt;. Remember that MySQL user names have
+ nothing to do with Unix user names (login names).</para>
+
+ <para>Next, we use an SQL <command>GRANT</command> command to create a
+ <quote>bugs</quote>
+
+ user, and grant sufficient permissions for checksetup.pl, which we'll
+ use later, to work its magic. This also restricts the
+ <quote>bugs</quote>
+ user to operations within a database called
+ <quote>bugs</quote>, and only allows the account to connect from
+ <quote>localhost</quote>.
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.</para>
+
+ <para>Remember to set &lt;bugs_password&gt; to some unique password.
+ <simplelist>
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
+ ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost
+ IDENTIFIED BY '&lt;bugs_password&gt;';</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>FLUSH PRIVILEGES;</command>
+ </computeroutput>
+ </member>
+ </simplelist>
</para>
- <para>
- After two days have passed you'll be able to view bug graphs
- from the Bug Reports page.
+ </section>
+
+ <section>
+ <title>
+ <filename>checksetup.pl</filename>
+ </title>
+
+ <para>Next, run the magic checksetup.pl script. (Many thanks to
+ <ulink url="mailto:holgerschurig@nikocity.de">Holger Schurig </ulink>
+ for writing this script!)
+ This script is designed to make sure your MySQL database and other
+ configuration options are consistent with the Bugzilla CGI files.
+ It will make sure Bugzilla files and directories have reasonable
+ permissions, set up the
+ <filename>data</filename>
+ directory, and create all the MySQL tables.
+ <simplelist>
+ <member>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>./checksetup.pl</command>
+ </computeroutput>
+ </member>
+ </simplelist>
+
+ The first time you run it, it will create a file called
+ <filename>localconfig</filename>.</para>
+
+ <para>This file contains a variety of settings you may need to tweak
+ including how Bugzilla should connect to the MySQL database.</para>
+
+ <para>The connection settings include:
+ <orderedlist>
+ <listitem>
+ <para>server's host: just use
+ <quote>localhost</quote>
+ if the MySQL server is local</para>
+ </listitem>
+
+ <listitem>
+ <para>database name:
+ <quote>bugs</quote>
+ if you're following these directions</para>
+ </listitem>
+
+ <listitem>
+ <para>MySQL username:
+ <quote>bugs</quote>
+ if you're following these directions</para>
+ </listitem>
+
+ <listitem>
+ <para>Password for the
+ <quote>bugs</quote>
+ MySQL account; (&lt;bugs_password&gt;) above</para>
+ </listitem>
+ </orderedlist>
</para>
+
+ <para>Once you are happy with the settings,
+ <filename>su</filename> to the user
+ your web server runs as, and re-run
+ <filename>checksetup.pl</filename>. (Note: on some security-conscious
+ systems, you may need to change the login shell for the webserver
+ account before you can do this.)
+ On this second run, it will create the database and an administrator
+ account for which you will be prompted to provide information.</para>
+
+ <note>
+ <para>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.</para>
+ </note>
</section>
-
+
<section>
<title>Securing MySQL</title>
- <para>
- 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.
- </para>
- <para>
- Most MySQL installs have "interesting" default security parameters:
- <simplelist>
- <member>mysqld defaults to running as root</member>
- <member>it defaults to allowing external network connections</member>
- <member>it has a known port number, and is easy to detect</member>
- <member>it defaults to no passwords whatsoever</member>
- <member>it defaults to allowing "File_Priv"</member>
- </simplelist>
- </para>
- <para>
- 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.
+
+ <para>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.</para>
+
+ <para>Most MySQL installs have "interesting" default security
+ parameters:
+ <simplelist>
+ <member>mysqld defaults to running as root</member>
+
+ <member>it defaults to allowing external network connections</member>
+
+ <member>it has a known port number, and is easy to detect</member>
+
+ <member>it defaults to no passwords whatsoever</member>
+
+ <member>it defaults to allowing "File_Priv"</member>
+ </simplelist>
</para>
- <para>
- To see your permissions do:
- <simplelist>
- <member>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>mysql -u root -p</command>
- </computeroutput>
- </member>
- <member>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>use mysql;</command>
- </computeroutput>
- </member>
- <member>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>show tables;</command>
- </computeroutput>
- </member>
- <member>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>select * from user;</command>
- </computeroutput>
- </member>
- <member>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>select * from db;</command>
- </computeroutput>
- </member>
- </simplelist>
+
+ <para>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.</para>
+
+ <para>To see your permissions do:
+ <simplelist>
+ <member>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>mysql -u root -p</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>use mysql;</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>show tables;</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>select * from user;</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>select * from db;</command>
+ </computeroutput>
+ </member>
+ </simplelist>
</para>
- <para>
- To fix the gaping holes:
- <simplelist>
- <member>DELETE FROM user WHERE User='';</member>
- <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member>
- <member> FLUSH PRIVILEGES;</member>
- </simplelist>
+
+ <para>To fix the gaping holes:
+ <simplelist>
+ <member>DELETE FROM user WHERE User='';</member>
+
+ <member>UPDATE user SET Password=PASSWORD('new_password') WHERE
+ user='root';</member>
+
+ <member>FLUSH PRIVILEGES;</member>
+ </simplelist>
</para>
- <para>
- If you're not running "mit-pthreads" you can use:
- <simplelist>
- <member>GRANT USAGE ON *.* TO bugs@localhost;</member>
- <member>GRANT ALL ON bugs.* TO bugs@localhost;</member>
- <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member>
- <member>FLUSH PRIVILEGES;</member>
- </simplelist>
+
+ <para>If you're not running "mit-pthreads" you can use:
+ <simplelist>
+ <member>GRANT USAGE ON *.* TO bugs@localhost;</member>
+
+ <member>GRANT ALL ON bugs.* TO bugs@localhost;</member>
+
+ <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member>
+
+ <member>FLUSH PRIVILEGES;</member>
+ </simplelist>
</para>
- <para>
- 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:
- <simplelist>
- <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member>
- <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member>
- <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member>
- <member>FLUSH PRIVILEGES;</member>
- </simplelist>
+
+ <para>With "mit-pthreads" you'll need to modify the "globals.pl"
+ Mysql-&gt;Connect line to specify a specific host name instead of
+ "localhost", and accept external connections:
+ <simplelist>
+ <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member>
+
+ <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member>
+
+ <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member>
+
+ <member>FLUSH PRIVILEGES;</member>
+ </simplelist>
</para>
- <para>
- Use .htaccess files with the Apache webserver to secure your
- bugzilla install. See <xref linkend="htaccess" />
+
+ <para>Consider also:
+ <orderedlist>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+
+ <listitem>
+ <para>using the --user= option to mysqld to run it as an
+ unprivileged user.</para>
+ </listitem>
+
+ <listitem>
+ <para>running MySQL in a chroot jail</para>
+ </listitem>
+
+ <listitem>
+ <para>running the httpd in a chroot jail</para>
+ </listitem>
+
+ <listitem>
+ <para>making sure the MySQL passwords are different from the OS
+ passwords (MySQL "root" has nothing to do with system
+ "root").</para>
+ </listitem>
+
+ <listitem>
+ <para>running MySQL on a separate untrusted machine</para>
+ </listitem>
+
+ <listitem>
+ <para>making backups ;-)</para>
+ </listitem>
+ </orderedlist>
</para>
+ </section>
+
+ <section>
+ <title>Configuring Bugzilla</title>
<para>
- Consider also:
- <orderedlist>
- <listitem>
- <para>
- 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.
- </para>
- </listitem>
- <listitem>
- <para>
- using the --user= option to mysqld to run it as an unprivileged
- user.
- </para>
- </listitem>
- <listitem>
- <para>
- starting MySQL in a chroot jail
- </para>
- </listitem>
- <listitem>
- <para>
- running the httpd in a "chrooted" jail
- </para>
- </listitem>
- <listitem>
- <para>
- making sure the MySQL passwords are different from the OS
- passwords (MySQL "root" has nothing to do with system "root").
- </para>
- </listitem>
- <listitem>
- <para>
- running MySQL on a separate untrusted machine
- </para>
- </listitem>
- <listitem>
- <para>
- making backups ;-)
- </para>
- </listitem>
- </orderedlist>
+ You should run through the parameters on the Edit Parameters page
+ (link in the footer) and set them all to appropriate values.
+ They key parameters are documented in <xref linkend="parameters" />.
</para>
</section>
- </section>
- <section id="osx">
- <title>Mac OS X Installation Notes</title>
- <para>
- 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.
- </para>
- <para>
- 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
- &lt;http://sourceforge.net/projects/fink/>.
- </para>
- <para>
- Follow the instructions for setting up Fink. Once it's
- installed, you'll want to run the following as root:
- <command>fink install gd</command>
- </para>
- <para>
- It will prompt you for a number of dependencies, type 'y' and
- hit enter to install all of the dependencies. Then watch it
- work.
- </para>
- <para>
- 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
- :-)
- </para>
- <para>
- Instead of typing <quote>install GD</quote> at the
- <prompt>cpan&gt;</prompt> prompt, type <command>look
- GD</command>. 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 <command>patch &lt;
- patchfile</command>:
- </para>
- <para>
- <programlisting>
-<![CDATA[
-
---- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000
-+++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001
-@@ -3,8 +3,8 @@
- warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
-
- # =====> 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') {
-
-]]>
- </programlisting>
- </para>
- <para>
- Then, run these commands to finish the installation of the perl module:
- <simplelist>
- <member><command>perl Makefile.PL</command></member>
- <member><command>make</command></member>
- <member><command>make test</command></member>
- <member><command>make install</command></member>
- <member>And don't forget to run <command>exit</command> to get back to cpan.</member>
- </simplelist>
- </para>
- <para>
- Happy Hacking!
- </para>
- </section>
-
- <section id="bsdinstall" xreflabel="BSD Installation Notes">
- <title>BSD Installation Notes</title>
- <para>
- For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
- consult <xref linkend="osx" />.
- </para>
</section>
-
- <section id="geninstall" xreflabel="Installation General Notes">
- <title>Installation General Notes</title>
+ <section id="extraconfig">
+ <title>Optional Additional Configuration</title>
+
<section>
- <title>Modifying Your Running System</title>
- <para>
- Bugzilla optimizes database lookups by storing all relatively static
- information in the versioncache file, located in the data/ subdirectory
- under your installation directory.
+ <title>Dependency Charts</title>
+
+ <para>As well as the text-based dependency graphs, Bugzilla also
+ supports dependency graphing, using a package called 'dot'.
+ Exactly how this works is controlled by the 'webdotbase' parameter,
+ which can have one of three values:
</para>
+
<para>
- If you make a change to the structural data in your database
- (the versions table for example), or to the
- <quote>constants</quote> encoded in defparams.pl, you will
- need to remove the cached content from the data directory
- (by doing a <quote>rm data/versioncache</quote>), or your
- changes won't show up.
+ <orderedlist>
+ <listitem>
+ <para>
+ A complete file path to the command 'dot' (part of
+ <ulink url="http://www.graphviz.org/">GraphViz</ulink>)
+ will generate the graphs locally
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A URL prefix pointing to an installation of the webdot package will
+ generate the graphs remotely
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A blank value will disable dependency graphing.
+ </para>
+ </listitem>
+ </orderedlist>
</para>
- <para>
- 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.
+
+ <para>So, to get this working, install
+ <ulink url="http://www.graphviz.org/">GraphViz</ulink>. If you
+ do that, you need to
+ <ulink url="http://httpd.apache.org/docs/mod/mod_imap.html">enable
+ server-side image maps</ulink> in Apache.
+ Alternatively, you could set up a webdot server, or use the AT&amp;T
+ public webdot server (the
+ default for the webdotbase param). Note that AT&amp;T's server won't work
+ if Bugzilla is only accessible using HTTPS.
</para>
+ </section>
+
+ <section>
+ <title>Bug Graphs</title>
+
+ <para>As long as you installed the GD and Graph::Base Perl modules you
+ might as well turn on the nifty Bugzilla bug reporting graphs.</para>
+
+ <para>Add a cron entry like this to run
+ <filename>collectstats.pl</filename>
+ daily at 5 after midnight:
+ <simplelist>
+ <member>
+ <computeroutput>
+ <prompt>bash#</prompt>
+
+ <command>crontab -e</command>
+ </computeroutput>
+ </member>
+
+ <member>
+ <computeroutput>5 0 * * * cd &lt;your-bugzilla-directory&gt; ;
+ ./collectstats.pl</computeroutput>
+ </member>
+ </simplelist>
+ </para>
+
+ <para>After two days have passed you'll be able to view bug graphs from
+ the Bug Reports page.</para>
</section>
+
<section>
- <title>Upgrading From Previous Versions</title>
+ <title>The Whining Cron</title>
+
+ <para>By now you have a fully functional Bugzilla, but what good are
+ bugs if they're not annoying? To help make those bugs more annoying you
+ can set up Bugzilla's automatic whining system to complain at engineers
+ which leave their bugs in the NEW state without triaging them.
+ </para>
+ <para>
+ This can be done by
+ adding the following command as a daily crontab entry (for help on that
+ see that crontab man page):
+ <simplelist>
+ <member>
+ <computeroutput>
+ <command>cd &lt;your-bugzilla-directory&gt; ;
+ ./whineatnews.pl</command>
+ </computeroutput>
+ </member>
+ </simplelist>
+ </para>
+
+ <tip>
+ <para>Depending on your system, crontab may have several manpages.
+ The following command should lead you to the most useful page for
+ this purpose:
+ <programlisting>man 5 crontab</programlisting>
+ </para>
+ </tip>
+ </section>
+
+ <section id="bzldap">
+ <title>LDAP Authentication</title>
<para>
- A plain Bugzilla is fairly easy to upgrade from one version to a newer one.
- However, things get a bit more complicated if you've made changes to
- Bugzilla's code. In this case, you may have to re-make or reapply those
- changes.
- It is recommended that you take a backup of your database and your entire
- Bugzilla installation before attempting an upgrade. You can upgrade a 'clean'
- installation by untarring a new tarball over the old installation. If you
- are upgrading from 2.12 or later, you can type <filename>cvs -z3
- update</filename>, and resolve conflicts if there are any.
+ <warning>
+ <para>This information on using the LDAP
+ authentication options with Bugzilla is old, and the authors do
+ not know of anyone who has tested it. Approach with caution.
+ </para>
+ </warning>
</para>
+
<para>
- Because the developers of Bugzilla are constantly adding new tables, columns
- and fields, you'll probably get SQL errors if you just update the code and
- attempt to use Bugzilla. Always run the checksetup.pl script whenever
- you upgrade your installation.
+ The existing authentication
+ scheme for Bugzilla uses email addresses as the primary user ID, and a
+ password to authenticate that user. All places within Bugzilla where
+ you need to deal with user ID (e.g assigning a bug) use the email
+ address. The LDAP authentication builds on top of this scheme, rather
+ than replacing it. The initial log in is done with a username and
+ password for the LDAP directory. This then fetches the email address
+ from LDAP and authenticates seamlessly in the standard Bugzilla
+ authentication scheme using this email address. If an account for this
+ address already exists in your Bugzilla system, it will log in to that
+ account. If no account for that email address exists, one is created at
+ the time of login. (In this case, Bugzilla will attempt to use the
+ "displayName" or "cn" attribute to determine the user's full name.)
+ After authentication, all other user-related tasks are still handled by
+ email address, not LDAP username. You still assign bugs by email
+ address, query on users by email address, etc.
+ </para>
+
+ <para>Using LDAP for Bugzilla authentication requires the
+ Mozilla::LDAP (aka PerLDAP) Perl module. The
+ Mozilla::LDAP module in turn requires Netscape's Directory SDK for C.
+ After you have installed the SDK, then install the PerLDAP module.
+ Mozilla::LDAP and the Directory SDK for C are both
+ <ulink url="http://www.mozilla.org/directory/">available for
+ download</ulink> from mozilla.org.
</para>
+
<para>
- 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.
+ Set the Param 'useLDAP' to "On" **only** if you will be using an LDAP
+ directory for
+ authentication. Be very careful when setting up this parameter; if you
+ set LDAP authentication, but do not have a valid LDAP directory set up,
+ you will not be able to log back in to Bugzilla once you log out. (If
+ this happens, you can get back in by manually editing the data/params
+ file, and setting useLDAP back to 0.)
</para>
+
+ <para>If using LDAP, you must set the
+ three additional parameters: Set LDAPserver to the name (and optionally
+ port) of your LDAP server. If no port is specified, it defaults to the
+ default port of 389. (e.g "ldap.mycompany.com" or
+ "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching
+ for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids
+ must be unique under the DN specified here. Set LDAPmailattribute to
+ the name of the attribute in your LDAP directory which contains the
+ primary email address. On most directory servers available, this is
+ "mail", but you may need to change this.
+ </para>
</section>
+
+ <section id="content-type"
+ xreflabel="Preventing untrusted Bugzilla content from executing malicious Javascript code">
+
+ <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>
- <section id="htaccess" xreflabel=".htaccess files and security">
- <title><filename>.htaccess</filename> files and security</title>
<para>
- To enhance the security of your Bugzilla installation,
- Bugzilla will generate
- <glossterm><filename>.htaccess</filename></glossterm> files
- which the Apache webserver can use to restrict access to
- the bugzilla data files. The checksetup script will
- generate the <filename>.htaccess</filename> files. These .htaccess files
- will not work with Apache 1.2.x - but this has security holes, so you
- shouldn't be using it anyway.
-
- <note>
- <para>
- If you are using an alternate provider of
- <productname>webdot</productname> services for graphing
- (as described when viewing
- <filename>editparams.cgi</filename> in your web
- browser), you will need to change the ip address in
- <filename>data/webdot/.htaccess</filename> to the ip
- address of the webdot server that you are using.
- </para>
- </note>
-
+ <programlisting>bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; charset=ISO-8859-1/i" *.cgi *.pl
+ </programlisting>
</para>
- <para>
- The default .htaccess file may not provide adequate access
- restrictions, depending on your web server configuration.
- Be sure to check the &lt;Directory&gt; entries for your
- Bugzilla directory so that the <filename>.htaccess</filename>
- file is allowed to override web server defaults. For instance,
- let's assume your installation of Bugzilla is installed to
- <filename>/usr/local/bugzilla</filename>. You should have
- this &lt;Directory&gt; entry in your <filename>httpd.conf</filename>
- file:
+ <para>All this one-liner command does is search for all instances of
+ <quote>Content-type: text/html</quote>
+
+ and replaces it with
+ <quote>Content-Type: text/html; charset=ISO-8859-1</quote>
+
+ . This specification prevents possible Javascript attacks on the
+ browser, and is suggested for all English-speaking sites. For
+ non-English-speaking Bugzilla sites, I suggest changing
+ <quote>ISO-8859-1</quote>, above, to
+ <quote>UTF-8</quote>.</para>
+
+ <para>Note: using &lt;meta&gt; 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.</para>
+ </section>
+
+ <section id="htaccess" xreflabel=".htaccess files and security">
+ <title>
+ <filename>.htaccess</filename>
+ files and security</title>
+
+ <para>To enhance the security of your Bugzilla installation, Bugzilla's
+ <filename>checksetup.pl</filename> script will generate
+ <glossterm>
+ <filename>.htaccess</filename>
+ </glossterm>
+
+ files which the Apache webserver can use to restrict access to the
+ bugzilla data files.
+ These .htaccess files will not work with Apache 1.2.x - but this
+ has security holes, so you shouldn't be using it anyway.
+ <note>
+ <para>If you are using an alternate provider of
+ <productname>webdot</productname>
+
+ services for graphing (as described when viewing
+ <filename>editparams.cgi</filename>
+
+ in your web browser), you will need to change the ip address in
+ <filename>data/webdot/.htaccess</filename>
+
+ to the ip address of the webdot server that you are using.</para>
+ </note>
</para>
+ <para>The default .htaccess file may not provide adequate access
+ restrictions, depending on your web server configuration. Be sure to
+ check the &lt;Directory&gt; entries for your Bugzilla directory so that
+ the
+ <filename>.htaccess</filename>
+
+ file is allowed to override web server defaults. For instance, let's
+ assume your installation of Bugzilla is installed to
+ <filename>/usr/local/bugzilla</filename>
+
+ . You should have this &lt;Directory&gt; entry in your
+ <filename>httpd.conf</filename>
+
+ file:</para>
+
<para>
- <programlisting>
-<![CDATA[
-<Directory /usr/local/bugzilla/>
+
+<programlisting><![CDATA[
+ <Directory /usr/local/bugzilla/>
Options +FollowSymLinks +Indexes +Includes +ExecCGI
AllowOverride All
</Directory>
-]]>
- </programlisting>
- </para>
+]]></programlisting>
- <para>
- The important part above is <quote>AllowOverride All</quote>.
- Without that, the <filename>.htaccess</filename> file created by
- <filename>checksetup.pl</filename> will not have sufficient
- permissions to protect your Bugzilla installation.
</para>
- <para>
- If you are using Internet Information Server or other web
- server which does not observe <filename>.htaccess</filename>
- conventions, you can disable their creation by editing
- <filename>localconfig</filename> and setting the
- <varname>$create_htaccess</varname> variable to
- <parameter>0</parameter>.
- </para>
- </section>
+ <para>The important part above is
+ <quote>AllowOverride All</quote>
- <section id="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 <ulink url="http://www.snert.com/Software/Throttle/">Module Instructions</ulink> for more information. </para>
- </section>
-
- <section id="content-type" xreflabel="Preventing untrusted Bugzilla contentfrom executing malicious Javascript code">
- <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
- <quote>Content-Type: text/html; charset=ISO-8859-1</quote>.
- This specification prevents possible Javascript attacks on the
- browser, and is suggested for all English-speaking sites. For
- non-english-speaking Bugzilla sites, I suggest changing
- <quote>ISO-8859-1</quote>, above, to <quote>UTF-8</quote>.
+ . Without that, the
+ <filename>.htaccess</filename>
+
+ file created by
+ <filename>checksetup.pl</filename>
+
+ will not have sufficient permissions to protect your Bugzilla
+ installation.</para>
+
+ <para>If you are using Internet Information Server (IIS) or another
+ web server which does not observe
+ <filename>.htaccess</filename>
+ conventions, you can disable their creation by editing
+ <filename>localconfig</filename>
+ and setting the
+ <varname>$create_htaccess</varname>
+ variable to
+ <parameter>0</parameter>.
</para>
</section>
-
- <section id="unixhistory">
- <title>UNIX Installation Instructions History</title>
- <para>
- This document was originally adapted from the Bonsai
- installation instructions by Terry Weissman
- &lt;terry@mozilla.org&gt;.
- </para>
- <para>
- The February 25, 1999 re-write of this page was done by Ry4an
- Brase &lt;ry4an@ry4an.org&gt;, with some edits by Terry
- Weissman, Bryce Nesbitt, Martin Pool, &amp; Dan Mosedale (But
- don't send bug reports to them; report them using bugzilla, at <ulink
- url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ).
- </para>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- <para>
- Comments from people using this Guide for the first time are
- particularly welcome.
- </para>
+ <section id="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
+ <ulink url="http://www.snert.com/Software/Throttle/">Module
+ Instructions</ulink>
+ for more information.</para>
</section>
</section>
-
+
<section id="win32" xreflabel="Win32 Installation Notes">
<title>Win32 Installation Notes</title>
- <para>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 <emphasis>best</emphasis>
- and <emphasis>easiest</emphasis> 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.</para>
- <para>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.</para>
+ <para>This section covers installation on Microsoft Windows.
+ Bugzilla has been made to work on Win32 platforms, but the Bugzilla team
+ wish to emphasise that The easiest way to install Bugzilla on
+ Intel-archiecture machines
+ is to install some variant of GNU/Linux, then follow the UNIX
+ installation instructions in this Guide. If you have any influence in the
+ platform choice for running this system, please choose GNU/Linux instead
+ of Microsoft Windows.</para>
+
+ <warning>
+ <para>After that warning, here's the situation for 2.16
+ and Windows. It doesn't work at all out of the box.
+ You are almost certainly better off getting
+ the 2.17 version from CVS (after consultation with the Bugzilla Team to
+ make sure you are pulling on a stable day) because we'll be doing a load
+ of work to make the Win32 experience more pleasant than it is now.
+ </para>
+ </warning>
+
+ <para>
+ If you still want to try this, to have any hope of getting it to work,
+ you'll need to apply the
+ <ulink url="">mail patch</ulink> from
+ <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=124174">bug 124174</ulink>.
+ After that, you'll need to read the (outdated) installation
+ instructions below, some (probably a lot better) <ulink url="http://bugzilla.mozilla.org/attachment.cgi?id=84430&amp;action=view">more
+ recent ones</ulink> kindly provided by Toms Baugis and Jean-Sebastien
+ Guay, and also check the
+ <ulink url="http://www.bugzilla.org/releases/2.16/docs/win32.html">Bugzilla 2.16 Win32 update page
+ </ulink>. If we get time,
+ we'll write some better installation instructions for 2.16 and put
+ them up there. But no promises.
+ </para>
+
<section id="wininstall" xreflabel="Win32 Installation: Step-by-step">
<title>Win32 Installation: Step-by-step</title>
+
<note>
- <para>
- You should be familiar with, and cross-reference, the rest
- of the
- <xref linkend="installation" /> section while performing your
- Win32 installation.
- </para>
- <para> 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 <emphasis>very</emphasis> skilled Windows Systems
- Administrator with strong troubleshooting abilities, a high
- tolerance for pain, and moderate perl skills. Bugzilla on NT
- requires hacking source code and implementing some advanced
- utilities. What follows is the recommended installation
- procedure for Win32; additional suggestions are provided in
- <xref linkend="faq" />.
- </para>
+ <para>You should be familiar with, and cross-reference, the rest of
+ the
+ <xref linkend="installation" />
+
+ section while performing your Win32 installation.</para>
+
+ <para>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
+ <emphasis>very</emphasis>
+
+ skilled Windows Systems Administrator with strong troubleshooting
+ abilities, a high tolerance for pain, and moderate perl skills.
+ Bugzilla on NT requires hacking source code and implementing some
+ advanced utilities. What follows is the recommended installation
+ procedure for Win32; additional suggestions are provided in
+ <xref linkend="faq" />
+
+ .</para>
</note>
-
+
<procedure>
- <step>
- <para>
- Install <ulink url="http://www.apache.org/">Apache Web
- Server</ulink> for Windows, and copy the Bugzilla files
- somewhere Apache can serve them. Please follow all the
- instructions referenced in <xref linkend="installation" />
- regarding your Apache configuration, particularly
- instructions regarding the <quote>AddHandler</quote>
- parameter and <quote>ExecCGI</quote>.
- </para>
- <note>
- <para>
- You may also use Internet Information Server or Personal
- Web Server for this purpose. However, setup is quite
- different. If ActivePerl doesn't seem to handle your
- file associations correctly (for .cgi and .pl files),
- please consult <xref linkend="faq" />.
- </para>
- <para>
- 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.
- </para>
- </note>
- </step>
- <step>
- <para>
- Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary.
- </para>
- <para>
- Please also check the following links to fully understand the status
- of ActivePerl on Win32:
- <ulink url="http://language.perl.com/newdocs/pod/perlport.html">
- Perl Porting</ulink>, and
- <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html">
- Perl on Win32 FAQ</ulink>
- </para>
- </step>
- <step>
- <para>
- Use ppm from your perl\bin directory to install the following
- packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip,
- GD, AppConfig, and Template. You may need to extract them from
- .zip format using Winzip or other unzip program first. Most of
- these additional ppm modules can be downloaded from ActiveState,
- but AppConfig and Template should be obtained from OpenInteract
- using <ulink type="http"
- url="http://openinteract.sourceforge.net/">the instructions on
- the Template Toolkit web site</ulink>.
+ <step>
+ <para>Install
+ <ulink url="http://www.apache.org/">Apache Web Server</ulink>
+
+ for Windows, and copy the Bugzilla files somewhere Apache can serve
+ them. Please follow all the instructions referenced in
+ <xref linkend="installation" />
+
+ regarding your Apache configuration, particularly instructions
+ regarding the
+ <quote>AddHandler</quote>
+
+ parameter and
+ <quote>ExecCGI</quote>
+
+ .</para>
+
+ <note>
+ <para>You may also use Internet Information Server or Personal
+ Web Server for this purpose. However, setup is quite different.
+ If ActivePerl doesn't seem to handle your file associations
+ correctly (for .cgi and .pl files), please consult
+ <xref linkend="faq" />
+
+ .</para>
+
+ <para>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.</para>
+ </note>
+ </step>
+
+ <step>
+ <para>Install
+ <ulink url="http://www.activestate.com/">ActivePerl</ulink>
+
+ for Windows. Check
+ <ulink
+ url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">
+ http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink>
+
+ for a current compiled binary.</para>
+
+ <para>Please also check the following links to fully understand the
+ status of ActivePerl on Win32:
+ <ulink url="http://language.perl.com/newdocs/pod/perlport.html">
+ Perl Porting</ulink>
+
+ , and
+ <ulink
+ url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html">
+ Perl on Win32 FAQ</ulink>
</para>
- <note>
- <para>
- You can find a list of modules at
- <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only">
- http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink>
- or <ulink
- url="http://www.activestate.com/PPMPackages/5.6plus">http://www.activestate.com/PPMPackages/5.6plus</ulink>
- </para>
- </note>
- <para>
- The syntax for ppm is:
- <computeroutput>
- <prompt>C:> </prompt><command>ppm &lt;modulename&gt;</command>
- </computeroutput>
- </para>
-
- <example>
- <title>Installing ActivePerl ppd Modules on Microsoft Windows</title>
- <para><prompt>C:></prompt><command>ppm
- <option>DBD-Mysql</option></command></para>
- <para>Watch your capitalization!</para>
- </example>
-
- <para>
- ActiveState's 5.6Plus directory also contains an AppConfig ppm, so
- you might see the following error when trying to install the
- version at OpenInteract:
+ </step>
+
+ <step>
+ <para>Use ppm from your perl\bin directory to install the following
+ packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD,
+ AppConfig, and Template. You may need to extract them from .zip
+ format using Winzip or other unzip program first. Most of these
+ additional ppm modules can be downloaded from ActiveState, but
+ AppConfig and Template should be obtained from OpenInteract using
+ <ulink type="http" url="http://openinteract.sourceforge.net/">the
+ instructions on the Template Toolkit web site</ulink>
+
+ .</para>
+
+ <note>
+ <para>You can find a list of modules at
+ <ulink
+ url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only">
+ http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink>
+
+ or
+ <ulink url="http://www.activestate.com/PPMPackages/5.6plus">
+ http://www.activestate.com/PPMPackages/5.6plus</ulink>
+ </para>
+ </note>
+
+ <para>The syntax for ppm is:
+ <computeroutput>
+ <prompt>C:&gt;</prompt>
+
+ <command>ppm &lt;modulename&gt;</command>
+ </computeroutput>
</para>
+
+ <example>
+ <title>Installing ActivePerl ppd Modules on Microsoft
+ Windows</title>
+
+ <para>
+ <prompt>C:&gt;</prompt>
+
+ <command>ppm
+ <option>DBD-Mysql</option>
+ </command>
+ </para>
+
+ <para>Watch your capitalization!</para>
+ </example>
+
+ <para>ActiveState's 5.6Plus directory also contains an AppConfig
+ ppm, so you might see the following error when trying to install
+ the version at OpenInteract:</para>
+
<para>
- <computeroutput>
- Error installing package 'AppConfig': Read a PPD for
- 'AppConfig', but it is not intended for this build of Perl
- (MSWin32-x86-multi-thread)
- </computeroutput>
- </para>
- <para>
- If so, download both <ulink
- url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz">the
- tarball</ulink> and <ulink
- url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd">the
- ppd</ulink> directly from OpenInteract, then run ppm from within
- the same directory to which you downloaded those files and
- install the package by referencing the ppd file explicitly via in
- the install command, f.e.:
- <example>
- <title>Installing OpenInteract ppd Modules manually on Microsoft
- Windows</title>
+ <computeroutput>Error installing package 'AppConfig': Read a PPD
+ for 'AppConfig', but it is not intended for this build of Perl
+ (MSWin32-x86-multi-thread)</computeroutput>
+ </para>
+
+ <para>If so, download both
+ <ulink
+ url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.tar.gz">
+ the tarball</ulink>
+
+ and
+ <ulink
+ url="http://openinteract.sourceforge.net/ppmpackages/AppConfig.ppd">
+ the ppd</ulink>
+
+ directly from OpenInteract, then run ppm from within the same
+ directory to which you downloaded those files and install the
+ package by referencing the ppd file explicitly via in the install
+ command, f.e.:
+ <example>
+ <title>Installing OpenInteract ppd Modules manually on Microsoft
+ Windows</title>
+
+ <para>
+ <computeroutput>
+ <command>install
+ <filename>C:\AppConfig.ppd</filename>
+ </command>
+ </computeroutput>
+ </para>
+ </example>
+ </para>
+ </step>
+
+ <step>
+ <para>Install MySQL for NT.
+ <note>
+ <para>You can download MySQL for Windows NT from
+ <ulink 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>
+ </note>
+ </para>
+ </step>
+
+ <step>
+ <para>Setup MySQL</para>
+
+ <substeps>
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>C:&gt;</prompt>
+
+ <command>C:\mysql\bin\mysql -u root mysql</command>
+ </computeroutput>
+ </para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>DELETE FROM user WHERE Host='localhost' AND
+ User='';</command>
+ </computeroutput>
+ </para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>UPDATE user SET Password=PASSWORD ('new_password')
+ WHERE user='root';</command>
+ </computeroutput>
+ </para>
+
+ <para>
+ <quote>new_password</quote>
+
+ , above, indicates whatever password you wish to use for your
+ <quote>root</quote>
+
+ user.</para>
+ </step>
+
+ <step id="ntbugs-password">
<para>
- <computeroutput><command>install
- <filename>C:\AppConfig.ppd</filename></command></computeroutput>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX,
+ ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost
+ IDENTIFIED BY 'bugs_password';</command>
+ </computeroutput>
</para>
- </example>
+
+ <para>
+ <quote>bugs_password</quote>
+
+ , above, indicates whatever password you wish to use for your
+ <quote>bugs</quote>
+
+ user.</para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>FLUSH PRIVILEGES;</command>
+ </computeroutput>
+ </para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>create database bugs;</command>
+ </computeroutput>
+ </para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>mysql&gt;</prompt>
+
+ <command>exit;</command>
+ </computeroutput>
+ </para>
+ </step>
+
+ <step>
+ <para>
+ <computeroutput>
+ <prompt>C:&gt;</prompt>
+
+ <command>C:\mysql\bin\mysqladmin -u root -p
+ reload</command>
+ </computeroutput>
+ </para>
+ </step>
+ </substeps>
+ </step>
+
+ <step>
+ <para>Edit
+ <filename>checksetup.pl</filename>
+
+ in your Bugzilla directory. Change this line:</para>
+
+ <para>
+ <programlisting>my $webservergid =
+ getgrnam($my_webservergroup);</programlisting>
</para>
- </step>
-
- <step>
- <para>
- Install MySQL for NT.
- <note>
- <para>
- You can download MySQL for Windows NT from <ulink 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>
- </note>
- </para>
- </step>
- <step>
- <para>
- Setup MySQL
- </para>
- <substeps>
- <step>
- <para>
- <computeroutput>
- <prompt>C:> </prompt>
- <command>C:\mysql\bin\mysql -u root mysql</command>
- </computeroutput>
- </para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>DELETE FROM user WHERE Host='localhost' AND User='';</command>
- </computeroutput>
- </para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';</command>
- </computeroutput>
- </para>
- <para><quote>new_password</quote>, above, indicates
- whatever password you wish to use for your
- <quote>root</quote> user.</para>
- </step>
- <step id="ntbugs-password">
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>GRANT SELECT, INSERT, UPDATE, DELETE,
- INDEX, ALTER, CREATE, DROP, REFERENCES
- ON bugs.* to bugs@localhost
- IDENTIFIED BY 'bugs_password';</command>
- </computeroutput>
- </para>
- <para><quote>bugs_password</quote>, above, indicates
- whatever password you wish to use for your
- <quote>bugs</quote> user.</para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>FLUSH PRIVILEGES;</command>
- </computeroutput>
- </para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>create database bugs;</command>
- </computeroutput>
- </para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>mysql></prompt>
- <command>exit;</command>
- </computeroutput>
- </para>
- </step>
- <step>
- <para>
- <computeroutput>
- <prompt>C:></prompt>
- <command>C:\mysql\bin\mysqladmin -u root -p reload</command>
- </computeroutput>
- </para>
- </step>
- </substeps>
- </step>
-
- <step>
- <para>
- Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change
- this line:
- </para>
- <para>
- <programlisting>
-my $webservergid = getgrnam($my_webservergroup);
- </programlisting>
- </para>
- <para>
- to
- </para>
- <para>
- <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>
- </step>
-
- <step>
- <para>
- Run <filename>checksetup.pl</filename> from the Bugzilla directory.
- </para>
- </step>
-
- <step>
- <para>Edit <filename>localconfig</filename> to suit your
- requirements. Set <varname>$db_pass</varname> to your
- <quote>bugs_password</quote> from <xref linkend="ntbugs-password" />, and <varname>$webservergroup</varname> to <quote>8</quote>.</para>
- <note>
- <para>Not sure on the <quote>8</quote> for
- <varname>$webservergroup</varname> above. If it's
- wrong, please send corrections.</para>
- </note>
- </step>
-
- <step>
- <para>
- Edit <filename>defparams.pl</filename> to suit your
- requirements. Particularly, set
- <varname>DefParam("maintainer")</varname> and
- <varname>DefParam("urlbase") to match your
- install.</varname>
- </para>
- <note>
- <para>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.</para>
- </note>
- </step>
-
- <step>
- <note>
- <para>
- There are several alternatives to Sendmail that will work on Win32.
- The one mentioned here is a <emphasis>suggestion</emphasis>, not
- a requirement. Some other mail packages that can work include
- <ulink url="http://www.blat.net/">BLAT</ulink>,
- <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>,
- <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>,
- 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.
- </para>
- </note>
-
- <procedure>
- <step>
- <para>
- Download NTsendmail, available from<ulink 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)
- </para>
- </step>
-
- <step>
- <para>Put ntsendmail.pm into your .\perl\lib directory.</para>
- </step>
-
- <step>
- <para>Add to globals.pl:</para>
- <programlisting>
-# these settings configure the NTsendmail process
-use NTsendmail;
-$ENV{"NTsendmail"}="your.smtpserver.box";
-$ENV{"NTsendmail_debug"}=1;
-$ENV{"NTsendmail_max_tries"}=5;
- </programlisting>
- <note>
- <para>
- Some mention to also edit
- <varname>$db_pass</varname> in
- <filename>globals.pl</filename> to be your
- <quote>bugs_password</quote>. Although this may get
- you around some problem authenticating to your
- database, since globals.pl is not normally
- restricted by <filename>.htaccess</filename>, your
- database password is exposed to whoever uses your
- web server.
- </para>
- </note>
- </step>
-
- <step>
- <para>
- Find and comment out all occurences of
- <quote><command>open(SENDMAIL</command></quote> in
- your Bugzilla directory. Then replace them with:
- <programlisting>
-# 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);
- </programlisting>
- </para>
- <note>
- <para>
- Some have found success using the commercial product,
- <productname>Windmail</productname>.
- You could try replacing your sendmail calls with:
- <programlisting>
-open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
- </programlisting>
- or something to that effect.
- </para>
- </note>
- </step>
- </procedure>
- </step>
-
- <step>
- <para>
- Change all references in all files from
- <filename>processmail</filename> to
- <filename>processmail.pl</filename>, and
- rename <filename>processmail</filename> to
- <filename>processmail.pl</filename>.
- </para>
- <note>
- <para>
- 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.
- </para>
- </note>
- <note>
- <para>
- 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.
- <programlisting>
+
+ <para>to</para>
+
+ <para>
+ <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>
+ </step>
+
+ <step>
+ <para>Run
+ <filename>checksetup.pl</filename>
+
+ from the Bugzilla directory.</para>
+ </step>
+
+ <step>
+ <para>Edit
+ <filename>localconfig</filename>
+
+ to suit your requirements. Set
+ <varname>$db_pass</varname>
+
+ to your
+ <quote>bugs_password</quote>
+
+ from
+ <xref linkend="ntbugs-password" />
+
+ , and
+ <varname>$webservergroup</varname>
+
+ to
+ <quote>8</quote>
+
+ .</para>
+
+ <note>
+ <para>Not sure on the
+ <quote>8</quote>
+
+ for
+ <varname>$webservergroup</varname>
+
+ above. If it's wrong, please send corrections.</para>
+ </note>
+ </step>
+
+ <step>
+ <para>Edit
+ <filename>defparams.pl</filename>
+
+ to suit your requirements. Particularly, set
+ <varname>DefParam("maintainer")</varname>
+
+ and
+ <varname>DefParam("urlbase") to match your install.</varname>
+ </para>
+
+ <note>
+ <para>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.</para>
+ </note>
+ </step>
+
+ <step>
+ <note>
+ <para>There are several alternatives to Sendmail that will work
+ on Win32. The one mentioned here is a
+ <emphasis>suggestion</emphasis>
+
+ , not a requirement. Some other mail packages that can work
+ include
+ <ulink url="http://www.blat.net/">BLAT</ulink>
+
+ ,
+ <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>
+
+ ,
+ <ulink url="http://www.dynamicstate.com/">Mercury
+ Sendmail</ulink>
+
+ , 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.</para>
+ </note>
+
+ <procedure>
+ <step>
+ <para>Download NTsendmail, available from
+ <ulink 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)</para>
+ </step>
+
+ <step>
+ <para>Put ntsendmail.pm into your .\perl\lib directory.</para>
+ </step>
+
+ <step>
+ <para>Add to globals.pl:</para>
+
+ <programlisting># these settings configure the NTsendmail
+ process use NTsendmail;
+ $ENV{"NTsendmail"}="your.smtpserver.box";
+ $ENV{"NTsendmail_debug"}=1;
+ $ENV{"NTsendmail_max_tries"}=5;</programlisting>
+
+ <note>
+ <para>Some mention to also edit
+ <varname>$db_pass</varname>
+
+ in
+ <filename>globals.pl</filename>
+
+ to be your
+ <quote>bugs_password</quote>
+
+ . Although this may get you around some problem
+ authenticating to your database, since globals.pl is not
+ normally restricted by
+ <filename>.htaccess</filename>
+
+ , your database password is exposed to whoever uses your web
+ server.</para>
+ </note>
+ </step>
+
+ <step>
+ <para>Find and comment out all occurences of
+ <quote>
+ <command>open(SENDMAIL</command>
+ </quote>
+
+ in your Bugzilla directory. Then replace them with:
+ <programlisting># new sendmail functionality my $mail=new
+ NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
+ $to=$login; my $subject=$urlbase;
+ $mail-&gt;send($from,$to,$subject,$msg);</programlisting>
+ </para>
+
+ <note>
+ <para>Some have found success using the commercial product,
+ <productname>Windmail</productname>
+
+ . You could try replacing your sendmail calls with:
+ <programlisting>open SENDMAIL,
+ "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t &gt;
+ mail.log";</programlisting>
+
+ or something to that effect.</para>
+ </note>
+ </step>
+ </procedure>
+ </step>
+
+ <step>
+ <para>Change all references in all files from
+ <filename>processmail</filename>
+
+ to
+ <filename>processmail.pl</filename>
+
+ , and rename
+ <filename>processmail</filename>
+
+ to
+ <filename>processmail.pl</filename>
+
+ .</para>
+
+ <note>
+ <para>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.</para>
+ </note>
+
+ <note>
+ <para>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.
+ <programlisting>
<![CDATA[
my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server
@@ -1737,9 +1774,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist";
}
]]>
-</programlisting>
-here is a test mail program for Net::SMTP:
-<programlisting>
+ </programlisting>
+
+ here is a test mail program for Net::SMTP:
+ <programlisting>
<![CDATA[
use Net::SMTP;
@@ -1757,241 +1795,352 @@ recipient's address
exit;
]]>
-</programlisting>
- </para>
- </note>
- </step>
- <step>
- <note>
- <para>
- This step is optional if you are using IIS or another
- web server which only decides on an interpreter based
- upon the file extension (.pl), rather than the
- <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl)
- </para>
- </note>
- <para>
- Modify the path to perl on the first line (#!) of all
- files to point to your Perl installation, and add
- <quote>perl</quote> 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 <quote>setperl.csh</quote>
- utility to speed part of this procedure, available in the
- <xref linkend="patches" /> section of The Bugzilla Guide.
- However, it requires the Cygwin GNU-compatible environment
- for Win32 be set up in order to work. See <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin.
- </para>
- </step>
-
- <step>
- <para>
- Modify the invocation of all system() calls in all perl
- scripts in your Bugzilla directory. You should specify the
- full path to perl for each system() call. For instance, change
- this line in processmail:
- <programlisting><![CDATA[
+ </programlisting>
+ </para>
+ </note>
+ </step>
+
+ <step>
+ <note>
+ <para>This step is optional if you are using IIS or another web
+ server which only decides on an interpreter based upon the file
+ extension (.pl), rather than the
+ <quote>shebang</quote>
+
+ line (#/usr/bonsaitools/bin/perl)</para>
+ </note>
+
+ <para>Modify the path to perl on the first line (#!) of all files
+ to point to your Perl installation, and add
+ <quote>perl</quote>
+
+ 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
+ <quote>setperl.csh</quote>
+
+ utility to speed part of this procedure, available in the
+ <xref linkend="patches" />
+
+ section of The Bugzilla Guide. However, it requires the Cygwin
+ GNU-compatible environment for Win32 be set up in order to work.
+ See
+ <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>
+
+ for details on obtaining Cygwin.</para>
+ </step>
+
+ <step>
+ <para>Modify the invocation of all system() calls in all perl
+ scripts in your Bugzilla directory. You should specify the full
+ path to perl for each system() call. For instance, change this line
+ in processmail:
+ <programlisting>
+<![CDATA[
system ("./processmail",@ARGLIST);
- </programlisting> to
- <programlisting>
+ </programlisting> to
+ <programlisting>
system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
-]]> </programlisting>
- </para>
- </step>
- <step>
- <para>
- Add <function>binmode()</function> calls so attachments
- will work (<ulink
- url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>).
+]]>
+ </programlisting>
</para>
+ </step>
+
+ <step>
+ <para>Add
+ <function>binmode()</function>
+
+ calls so attachments will work (
+ <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug
+ 62000</ulink>
+
+ ).</para>
+
+ <para>Because Microsoft Windows based systems handle binary files
+ different than Unix based systems, you need to add the following
+ lines to
+ <filename>createattachment.cgi</filename>
+
+ and
+ <filename>showattachment.cgi</filename>
+
+ before the
+ <function>require 'CGI.pl';</function>
+
+ line.</para>
+
<para>
- Because Microsoft Windows based systems handle binary
- files different than Unix based systems, you need to add
- the following lines to
- <filename>createattachment.cgi</filename> and
- <filename>showattachment.cgi</filename> before the
- <function>require 'CGI.pl';</function> line.
-</para>
-<para>
-<programlisting>
+ <programlisting>
<![CDATA[
binmode(STDIN);
binmode(STDOUT);
]]>
-</programlisting>
+ </programlisting>
</para>
+
<note>
- <para>
- According to <ulink
- url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>,
- the perl documentation says that you should always use
- <function>binmode()</function> when dealing with binary
- files, but never when dealing with text files. That seems
- to suggest that rather than arbitrarily putting
- <function>binmode()</function> at the beginning of the
- attachment files, there should be logic to determine if
- <function>binmode()</function> is needed or not.
- </para>
+ <para>According to
+ <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">
+ bug 62000</ulink>
+
+ , the perl documentation says that you should always use
+ <function>binmode()</function>
+
+ when dealing with binary files, but never when dealing with text
+ files. That seems to suggest that rather than arbitrarily putting
+
+ <function>binmode()</function>
+
+ at the beginning of the attachment files, there should be logic
+ to determine if
+ <function>binmode()</function>
+
+ is needed or not.</para>
</note>
</step>
</procedure>
<tip>
- <para>
- If you are using IIS or Personal Web Server, you must add cgi
- relationships to Properties -> Home directory (tab) ->
- Application Settings (section) -> Configuration (button),
- such as:
- </para>
- <para>
- <programlisting>
-.cgi to: &lt;perl install directory&gt;\perl.exe %s %s
-.pl to: &lt;perl install directory&gt;\perl.exe %s %s
-GET,HEAD,POST
- </programlisting>
- Change the path to Perl to match your
- install, of course.
- </para>
+ <para>If you are using IIS or Personal Web Server, you must add cgi
+ relationships to Properties -&gt; Home directory (tab) -&gt;
+ Application Settings (section) -&gt; Configuration (button), such
+ as:</para>
+
+ <para>
+ <programlisting>.cgi to: &lt;perl install directory&gt;\perl.exe %s
+ %s .pl to: &lt;perl install directory&gt;\perl.exe %s %s
+ GET,HEAD,POST</programlisting>
+
+ Change the path to Perl to match your install, of course.</para>
</tip>
</section>
<section id="addlwintips">
<title>Additional Windows Tips</title>
+
<tip>
- <para>
- From Andrew Pearson:
- <blockquote>
- <para>
- 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 <ulink url="
- http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink>
- </para>
- <para>
- Basically you need to add two String Keys in the
- registry at the following location:
- </para>
- <para>
- <programlisting>
-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
- </programlisting>
- </para>
- <para>
- The keys should be called ".pl" and ".cgi", and both
- should have a value something like:
- <command>c:/perl/bin/perl.exe "%s" "%s"</command>
- </para>
- <para>
- The KB article only talks about .pl, but it goes into
- more detail and provides a perl test script.
- </para>
- </blockquote>
- </para>
+ <para>From Andrew Pearson:
+ <blockquote>
+ <para>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
+ <ulink
+ url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP">
+ http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink>
+ </para>
+
+ <para>Basically you need to add two String Keys in the registry at
+ the following location:</para>
+
+ <para>
+ <programlisting>
+ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap</programlisting>
+ </para>
+
+ <para>The keys should be called ".pl" and ".cgi", and both should
+ have a value something like:
+ <command>c:/perl/bin/perl.exe "%s" "%s"</command>
+ </para>
+
+ <para>The KB article only talks about .pl, but it goes into more
+ detail and provides a perl test script.</para>
+ </blockquote>
+ </para>
</tip>
+
<tip>
- <para>
- If attempting to run Bugzilla 2.12 or older, you will need
- to remove encrypt() calls from the Perl source. This is
- <emphasis>not necessary</emphasis> for Bugzilla 2.13 and
- later, which includes the current release, Bugzilla
- &bz-ver;.
- <example>
- <title>Removing encrypt() for Windows NT Bugzilla version
- 2.12 or earlier</title>
- <para>
- Replace this:
- <programlisting>
-SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
-my $enteredcryptpwd = FetchOneColumn();
- </programlisting>
-with this:
- <programlisting>
-my $enteredcryptpwd = $enteredpwd
- </programlisting>
- in cgi.pl.
- </para>
- </example>
- </para>
+ <para>If attempting to run Bugzilla 2.12 or older, you will need to
+ remove encrypt() calls from the Perl source. This is
+ <emphasis>not necessary</emphasis>
+
+ for Bugzilla 2.13 and later, which includes the current release,
+ Bugzilla &amp;bz-ver;.
+ <example>
+ <title>Removing encrypt() for Windows NT Bugzilla version 2.12 or
+ earlier</title>
+
+ <para>Replace this:
+ <programlisting>SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
+ ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
+ $enteredcryptpwd = FetchOneColumn();</programlisting>
+
+ with this:
+ <programlisting>my $enteredcryptpwd = $enteredpwd</programlisting>
+
+ in cgi.pl.</para>
+ </example>
+ </para>
</tip>
</section>
+ </section>
+
+ <section id="osx">
+ <title>Mac OS X Installation Notes</title>
+
+ <para>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.</para>
+
+ <para>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
+ &lt;http://sourceforge.net/projects/fink/&gt;.</para>
+
+ <para>Follow the instructions for setting up Fink. Once it's installed,
+ you'll want to run the following as root:
+ <command>fink install gd</command>
+ </para>
+
+ <para>It will prompt you for a number of dependencies, type 'y' and hit
+ enter to install all of the dependencies. Then watch it work.</para>
+
+ <para>To prevent creating conflicts with the software that Apple installs
+ by default, Fink creates its own directory tree at /sw where it installs
+ most of the software that it installs. This means your libraries and
+ headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib
+ and /usr/local/include. Because of these changed locations for the
+ libraries, the Perl GD module will not install directly via CPAN, because it
+ looks for the specific paths instead of getting them from your
+ environment. But there's a way around that :-)</para>
+
+ <para>Instead of typing
+ <quote>install GD</quote>
+ at the
+ <prompt>cpan&gt;</prompt>
+ prompt, type
+ <command>look GD</command>.
+ 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 <ulink url="../sgml/gd-makefile.patch">this patch</ulink>
+ to the Makefile.PL file (save the
+ patch into a file and use the command
+ <command>patch &lt; patchfile</command>.)
+ </para>
- <section id="bzldap">
- <title>Bugzilla LDAP Integration</title>
+ <para>Then, run these commands to finish the installation of the GD
+ module:
+ <simplelist>
+ <member>
+ <command>perl Makefile.PL</command>
+ </member>
+
+ <member>
+ <command>make</command>
+ </member>
+
+ <member>
+ <command>make test</command>
+ </member>
+
+ <member>
+ <command>make install</command>
+ </member>
+
+ <member>And don't forget to run
+ <command>exit</command>
+
+ to get back to CPAN.</member>
+ </simplelist>
+ </para>
+
+ </section>
+
+ <section id="troubleshooting">
+ <title>Troubleshooting</title>
+
+ <para>This section gives solutions to common Bugzilla installation
+ problems.
+ </para>
+
+ <section>
+ <title>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</title>
+
<para>
- What follows is some late-breaking information on using the
- LDAP authentication options with Bugzilla. The author has not
- tested these (nor even formatted this section!) so please
- contribute feedback to the newsgroup.
+ Try executing <command>perl -MCPAN -e 'install CPAN'</command>
+ and then continuing.
+ </para>
+
+ <para>
+ Certain older versions of the CPAN toolset were somewhat naive about how
+ to upgrade Perl modules. When a couple of modules got rolled into the core
+ Perl distribution for 5.6.1, CPAN thought that the best way to get those
+ modules up to date was to haul down the Perl distribution itself and
+ build it. Needless to say, this has caused headaches for just about
+ everybody. Upgrading to a newer version of CPAN with the
+ commandline above should fix things.
</para>
- <literallayout>
-Mozilla::LDAP module
-
-The Mozilla::LDAP module allows you to use LDAP for authentication to
-the Bugzilla system. This module is not required if you are not using
-LDAP.
-
-Mozilla::LDAP (aka PerLDAP) is available for download from
-http://www.mozilla.org/directory.
-
-NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
-Follow the link for "Directory SDK for C" on that same page to
-download the SDK first. After you have installed this SDK, then
-install the PerLDAP module.
-----------------------------------------------------------------------
-
-Post-Installation Checklist
-----------------------------------------------------------------------
-Set useLDAP to "On" **only** if you will be using an LDAP directory
-for authentication. Be very careful when setting up this parameter;
-if you set LDAP authentication, but do not have a valid LDAP directory
-set up, you will not be able to log back in to Bugzilla once you log
-out. (If this happens, you can get back in by manually editing the
-data/params file, and setting useLDAP back to 0.)
-
-If using LDAP, you must set the three additional parameters:
-
-Set LDAPserver to the name (and optionally port) of your LDAP server.
-If no port is specified, it defaults to the default port of 389. (e.g
-"ldap.mycompany.com" or "ldap.mycompany.com:1234")
-
-Set LDAPBaseDN to the base DN for searching for users in your LDAP
-directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
-the DN specified here.
-
-Set LDAPmailattribute to the name of the attribute in your LDAP
-directory which contains the primary email address. On most directory
-servers available, this is "mail", but you may need to change this.
-----------------------------------------------------------------------
-
-(Not sure where this bit should go, but it's important that it be in
-there somewhere...)
-----------------------------------------------------------------------
-Using LDAP authentication for Bugzilla:
-
-The existing authentication scheme for Bugzilla uses email addresses
-as the primary user ID, and a password to authenticate that user. All
-places within Bugzilla where you need to deal with user ID (e.g
-assigning a bug) use the email address.
-
-The LDAP authentication builds on top of this scheme, rather than
-replacing it. The initial log in is done with a username and password
-for the LDAP directory. This then fetches the email address from LDAP
-and authenticates seamlessly in the standard Bugzilla authentication
-scheme using this email address. If an account for this address
-already exists in your Bugzilla system, it will log in to that
-account. If no account for that email address exists, one is created
-at the time of login. (In this case, Bugzilla will attempt to use the
-"displayName" or "cn" attribute to determine the user's full name.)
-
-After authentication, all other user-related tasks are still handled
-by email address, not LDAP username. You still assign bugs by email
-address, query on users by email address, etc.
-----------------------------------------------------------------------
- </literallayout>
</section>
+
+
+ <section>
+ <title>DBD::Sponge::db prepare failed</title>
+
+ <para>
+ The following error message may appear due to a bug in DBD::mysql
+ (over which the Bugzilla team have no control):
+ </para>
+
+<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248.
+ SV = NULL(0x0) at 0x20fc444
+ REFCNT = 1
+ FLAGS = (PADBUSY,PADMY)
+]]></programlisting>
+
+ <para>
+ To fix this, go to
+ <filename>&lt;path-to-perl&gt;/lib/DBD/sponge.pm</filename>
+ in your Perl installation and replace
+ </para>
+
+<programlisting><![CDATA[ my $numFields;
+ if ($attribs->{'NUM_OF_FIELDS'}) {
+ $numFields = $attribs->{'NUM_OF_FIELDS'};
+ } elsif ($attribs->{'NAME'}) {
+ $numFields = @{$attribs->{NAME}};
+]]></programlisting>
+
+ <para>
+ by
+ </para>
+
+<programlisting><![CDATA[ my $numFields;
+ if ($attribs->{'NUM_OF_FIELDS'}) {
+ $numFields = $attribs->{'NUM_OF_FIELDS'};
+ } elsif ($attribs->{'NAMES'}) {
+ $numFields = @{$attribs->{NAMES}};
+]]></programlisting>
+
+ <para>
+ (note the S added to NAME.)
+ </para>
+ </section>
+
+ <section id="paranoid-security">
+ <title>cannot chdir(/var/spool/mqueue)</title>
+
+ <para>If you are installing Bugzilla on SuSE Linux, or some other
+ distributions with
+ <quote>paranoid</quote>
+ security options, it is possible that the checksetup.pl script may fail
+ with the error:
+<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied
+]]></programlisting>
+ </para>
+
+ <para>
+ This is because your
+ <filename>/var/spool/mqueue</filename>
+ directory has a mode of
+ <quote>drwx------</quote>. Type
+ <command>chmod 755
+ <filename>/var/spool/mqueue</filename>
+ </command>
+ as root to fix this problem.
+ </para>
+ </section>
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -2012,3 +2161,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
+
diff --git a/docs/sgml/integration.sgml b/docs/sgml/integration.sgml
index e801847d6..68054ee13 100644
--- a/docs/sgml/integration.sgml
+++ b/docs/sgml/integration.sgml
@@ -1,6 +1,6 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB -->
-<chapter id="integration">
+<section id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
@@ -13,43 +13,32 @@
. Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was
- closed. These kinds of changes cause the engineer responsible to be
- <quote>on the hook</quote>
-
- (include cool URL link here for Hook policies at mozilla.org). Bonsai
- also includes gateways to
- <xref linkend="tinderbox" />
-
- and Bugzilla</para>
+ closed. Bonsai
+ also integrates with
+ <xref linkend="tinderbox" />.
+ </para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title>
<para>CVS integration is best accomplished, at this point, using the
- Bugzilla Email Gateway. There have been some files submitted to allow
- greater CVS integration, but we need to make certain that Bugzilla is not
- tied into one particular software management package.</para>
+ Bugzilla Email Gateway.</para>
- <para>Follow the instructions in the FAQ for enabling Bugzilla e-mail
+ <para>Follow the instructions in this Guide for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of
- <quote>[Bug XXXX]</quote>
-
- , and you can have CVS check-in comments append to your Bugzilla bug. If
+ <quote>[Bug XXXX]</quote>,
+ and you can have CVS check-in comments append to your Bugzilla bug. If
you have your check-in script include an @resolution field, you can even
change the Bugzilla bug state.</para>
- <para>There is also a project, based upon somewhat dated Bugzilla code,
- to integrate CVS and Bugzilla through CVS' ability to email. Check it out
- at:
+ <para>There is also a CVSZilla project, based upon somewhat dated
+ Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
+ email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
- http://homepages.kcbbs.gen.nz/~tonyg/</ulink>
-
- , under the
- <quote>cvszilla</quote>
-
- link.</para>
+ http://homepages.kcbbs.gen.nz/~tonyg/</ulink>.
+ </para>
</section>
<section id="scm"
@@ -86,7 +75,7 @@
<para>We need Tinderbox integration information.</para>
</section>
-</chapter>
+</section>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/docs/sgml/patches.sgml b/docs/sgml/patches.sgml
index 540109feb..43f816758 100644
--- a/docs/sgml/patches.sgml
+++ b/docs/sgml/patches.sgml
@@ -26,160 +26,54 @@
setting up your VirtualHost section for Bugzilla with a rule like
this:</para>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<VirtualHost 12.34.56.78>
RewriteEngine On
RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</VirtualHost>
-]]>
- </programlisting>
+]]></programlisting>
</listitem>
<listitem>
<para>There are many, many more things you can do with mod_rewrite.
- As time goes on, I will include many more in the Guide. For now,
- though, please refer to the mod_rewrite documentation at
- <ulink url="http://www.apache.org">http://www.apache.org</ulink>
+ Please refer to the mod_rewrite documentation at
+ <ulink url="http://www.apache.org">http://www.apache.org</ulink>.
</para>
</listitem>
</orderedlist>
</section>
- <section id="setperl" xreflabel="The setperl.csh Utility">
- <title>The setperl.csh Utility</title>
-
- <para>You can use the "setperl.csh" utility to quickly and easily change
- the path to perl on all your Bugzilla files. This is a C-shell script; if
- you do not have "csh" or "tcsh" in the search path on your system, it
- will not work!</para>
-
- <procedure>
- <step>
- <para>Download the "setperl.csh" utility to your Bugzilla directory
- and make it executable.</para>
-
- <substeps>
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>cd /your/path/to/bugzilla</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>wget -O setperl.csh
- 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>chmod u+x setperl.csh</command>
- </computeroutput>
- </para>
- </step>
- </substeps>
- </step>
-
- <step>
- <para>Prepare (and fix) Bugzilla file permissions.</para>
-
- <substeps>
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>chmod u+w *</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>chmod u+x duplicates.cgi</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>chmod a-x bug_status.html</command>
- </computeroutput>
- </para>
- </step>
- </substeps>
- </step>
-
- <step>
- <para>Run the script:</para>
-
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>./setperl.csh /your/path/to/perl</command>
- </computeroutput>
-
- <example>
- <title>Using Setperl to set your perl path</title>
-
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>./setperl.csh /usr/bin/perl</command>
- </computeroutput>
- </para>
- </example>
- </para>
- </step>
- </procedure>
- </section>
-
<section id="cmdline">
<title>Command-line Bugzilla Queries</title>
- <para>Users can query Bugzilla from the command line using this suite of
- utilities.</para>
-
- <para>The query.conf file contains the mapping from options to field
+ <para>There are a suite of Unix utilities for querying Bugzilla from the
+ command line. They live in the
+ <filename class="directory">contrib/cmdline</filename>
+ directory. However, they
+ have not yet been updated to work with 2.16 (post-templatisation.).
+ There are three files - <filename>query.conf</filename>,
+ <filename>buglist</filename> and <filename>bugs</filename>.</para>
+
+ <para><filename>query.conf</filename>
+ contains the mapping from options to field
names and comparison types. Quoted option names are "grepped" for, so it
should be easy to edit this file. Comments (#) have no effect; you must
- make sure these lines do not contain any quoted "option"</para>
+ make sure these lines do not contain any quoted "option".</para>
- <para>buglist is a shell script which submits a Bugzilla query and writes
+ <para><filename>buglist</filename>
+ is a shell script which submits a Bugzilla query and writes
the resulting HTML page to stdout. It supports both short options, (such
as "-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or
"--reporter=bar"). If the first character of an option is not "-", it is
treated as if it were prefixed with "--default=".</para>
- <para>The columlist is taken from the COLUMNLIST environment variable.
+ <para>The column list is taken from the COLUMNLIST environment variable.
This is equivalent to the "Change Columns" option when you list bugs in
- buglist.cgi. If you have already used Bugzilla, use
- <command>grep COLUMLIST ~/.netscape/cookies</command>
-
- to see your current COLUMNLIST setting.</para>
+ buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST
+ in your cookies file to see your current COLUMNLIST setting.</para>
- <para>bugs is a simple shell script which calls buglist and extracts the
+ <para><filename>bugs</filename> is a simple shell script which calls
+ <filename>buglist</filename> and extracts the
bug numbers from the output. Adding the prefix
"http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into
a working link if any bugs are found. Counting bugs is easy. Pipe the
@@ -187,100 +81,13 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
</para>
- <para>Akkana says she has good results piping buglist output through
+ <para>Akkana Peck says she has good results piping
+ <filename>buglist</filename> output through
<command>w3m -T text/html -dump</command>
</para>
- <procedure>
- <step>
- <para>Download three files:</para>
-
- <substeps>
- <step>
- <para>
- <computeroutput>
- <prompt>bash$</prompt>
-
- <command>wget -O query.conf
- 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash$</prompt>
-
- <command>wget -O buglist
- 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command>
- </computeroutput>
- </para>
- </step>
-
- <step>
- <para>
- <computeroutput>
- <prompt>bash#</prompt>
-
- <command>wget -O bugs
- 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command>
- </computeroutput>
- </para>
- </step>
- </substeps>
- </step>
-
- <step>
- <para>Make your utilities executable:
- <computeroutput>
- <prompt>bash$</prompt>
-
- <command>chmod u+x buglist bugs</command>
- </computeroutput>
- </para>
- </step>
- </procedure>
</section>
- <section id="quicksearch">
- <title>The Quicksearch Utility</title>
-
- <para>Quicksearch is a new, experimental feature of the 2.12 release. It
- consist of two Javascript files, "quicksearch.js" and "localconfig.js",
- and two documentation files, "quicksearch.html" and
- "quicksearchhack.html"</para>
-
- <para>The index.html page has been updated to include the QuickSearch
- text box.</para>
-
- <para>To take full advantage of the query power, the Bugzilla maintainer
- must edit "localconfig.js" according to the value sets used in the local
- installation.</para>
-
- <para>Currently, keywords must be hard-coded in localconfig.js. If they
- are not, keywords are not automatically recognized. This means, if
- localconfig.js is left unconfigured, that searching for a bug with the
- "foo" keyword will only find bugs with "foo" in the summary, status
- whiteboard, product or component name, but not those with the keyword
- "foo".</para>
-
- <para>Workarounds for Bugzilla users:
- <simplelist>
- <member>search for '!foo' (this will find only bugs with the keyword
- "foo"</member>
-
- <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member>
- </simplelist>
- </para>
-
- <para>When this tool is ported from client-side JavaScript to server-side
- Perl, the requirement for hard-coding keywords can be fixed.
- <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This
- bug</ulink>
-
- has details.</para>
- </section>
</appendix>
<!-- Keep this comment at the end of the file
diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml
index b447ef9c0..a3986c27d 100644
--- a/docs/sgml/using.sgml
+++ b/docs/sgml/using.sgml
@@ -1,167 +1,16 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
-<!-- TOC
-Chapter: Using Bugzilla
- Create an account
- Logging in
- Setting up preferences
- Account Settings
- Email Settings
- Page Footer
- Permissions
- Life cycle of a bug
- Creating a bug
- Checking for duplicates
- Overview of all bug fields
- Setting bug permissions
- The Query Interface
- Standard Queries
- Email Queries
- Boolean Queries
- Regexp Queries
- The Query Results
- Changing Columns
- Changing sorting order
- Mass changes
- Miscellaneous usage hints
--->
<chapter id="using">
<title>Using Bugzilla</title>
- <section id="whatis">
- <title>What is Bugzilla?</title>
-
- <para>Bugzilla is one example of a class of programs called "Defect
- Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
- Tracking Systems allow individual or groups of developers to keep track
- of outstanding bugs in their product effectively. Bugzilla was originally
- written by Terry Weissman in a programming language called "TCL", to
- replace a crappy bug-tracking database used internally by Netscape
- Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
- it remains to this day. Most commercial defect-tracking software vendors
- at the time charged enormous licensing fees, and Bugzilla quickly became
- a favorite of the open-source crowd (with its genesis in the open-source
- browser project, Mozilla). It is now the de-facto standard
- defect-tracking system against which all others are measured.</para>
-
- <para>Bugzilla has matured immensely, and now boasts many advanced
- features. These include:
- <itemizedlist>
- <listitem>
- <para>Powerful searching</para>
- </listitem>
-
- <listitem>
- <para>User-configurable email notifications of bug changes</para>
- </listitem>
-
- <listitem>
- <para>Full change history</para>
- </listitem>
-
- <listitem>
- <para>Inter-bug dependency tracking and graphing</para>
- </listitem>
-
- <listitem>
- <para>Excellent attachment management</para>
- </listitem>
-
- <listitem>
- <para>Integrated, product-based, granular security schema</para>
- </listitem>
-
- <listitem>
- <para>Fully security-audited, and runs under Perl's taint mode</para>
- </listitem>
-
- <listitem>
- <para>A robust, stable RDBMS back-end</para>
- </listitem>
-
- <listitem>
- <para>Web, XML, email and console interfaces</para>
- </listitem>
-
- <listitem>
- <para>Completely customisable and/or localisable web user
- interface</para>
- </listitem>
-
- <listitem>
- <para>Extensive configurability</para>
- </listitem>
-
- <listitem>
- <para>Smooth upgrade pathway between versions</para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section id="why">
- <title>Why Should We Use Bugzilla?</title>
-
- <para>For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor 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.</para>
-
- <para>These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.</para>
-
- <para>But why should
- <emphasis>you</emphasis>
-
- use Bugzilla?</para>
-
- <para>Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration deployment
- management, chip design and development problem tracking (both
- pre-and-post fabrication), and software and hardware bug tracking for
- luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
- Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
- provides a powerful, easy-to-use solution to configuration management and
- replication problems</para>
-
- <para>Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented workflow
- and positive feedback for good performance. How many times do you wake up
- in the morning, remembering that you were supposed to do
- <emphasis>something</emphasis>
-
- today, but you just can't quite remember? Put it in Bugzilla, and you
- have a record of it from which you can extrapolate milestones, predict
- 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>Ultimately, Bugzilla puts the power in your hands to improve your
- value to your employer or business while providing a usable framework for
- your natural attention to detail and knowledge store to flourish.</para>
- </section>
-
<section id="how">
<title>How do I use Bugzilla?</title>
- <para>This section contains information for end-users of Bugzilla. If you
- are administering a Bugzilla installation, please consult the Installing
- and Administering Bugzilla portions of this Guide.</para>
-
- <para>There is a Bugzilla test installation, called
- <ulink url="http://landfill.tequilarista.org/">Landfill</ulink>
-
- , which you are welcome to play with. However, it does not necessarily
+ <para>This section contains information for end-users of Bugzilla.
+ There is a Bugzilla test installation, called
+ <ulink url="http://landfill.bugzilla.org/">Landfill</ulink>,
+ which you are welcome to play with (if it's up.)
+ However, it does not necessarily
have all Bugzilla features enabled, and often runs cutting-edge versions
of Bugzilla for testing, so some things may work slightly differently
than mentioned here.</para>
@@ -173,8 +22,8 @@ Chapter: Using Bugzilla
Consult with the administrator responsible for your installation of
Bugzilla for the URL you should use to access it. If you're
test-driving Bugzilla, use this URL:
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
- http://landfill.tequilarista.org/bugzilla-tip/</ulink>
+ <ulink url="http://landfill.bugzilla.org/bugzilla-tip/">
+ http://landfill.bugzilla.org/bugzilla-tip/</ulink>
</para>
<orderedlist>
@@ -200,18 +49,17 @@ Chapter: Using Bugzilla
<listitem>
<para>Click the
<quote>Log In</quote>
-
link in the yellow area at the bottom of the page in your browser,
enter your email address and password into the spaces provided, and
click
- <quote>Login</quote>
-
- .</para>
+ <quote>Login</quote>.
+ </para>
+
</listitem>
</orderedlist>
- <para>You are now logged in. Bugzilla uses cookies for authentication,
- so (unless your IP address changes) you should not have to log in
+ <para>You are now logged in. Bugzilla uses cookies for authentication
+ so, unless your IP address changes, you should not have to log in
again.</para>
</section>
@@ -221,75 +69,65 @@ Chapter: Using Bugzilla
<para>The core of Bugzilla is the screen which displays a particular
bug. It's a good place to explain some Bugzilla concepts.
<ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">
+ url="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1">
Bug 1 on Landfill</ulink>
- is a good example. Note that the names of most fields are hyperlinks;
+ is a good example. Note that the labels for most fields are hyperlinks;
clicking them will take you to context-sensitive help on that
- particular field.</para>
+ particular field. Fields marked * may not be present on every
+ installation of Bugzilla.</para>
<orderedlist>
<listitem>
<para>
- <emphasis>Product and Component</emphasis>
-
- : Bugs are divided up by Product and Component, with a Product
+ <emphasis>Product and Component</emphasis>:
+ Bugs are divided up by Product and Component, with a Product
having one or more Components in it. For example,
bugzilla.mozilla.org's "Bugzilla" Product is composed of several
Components:
<simplelist>
<member>
<emphasis>Administration:</emphasis>
-
Administration of a Bugzilla installation.</member>
<member>
<emphasis>Bugzilla-General:</emphasis>
-
Anything that doesn't fit in the other components, or spans
multiple components.</member>
<member>
<emphasis>Creating/Changing Bugs:</emphasis>
-
Creating, changing, and viewing bugs.</member>
<member>
<emphasis>Documentation:</emphasis>
-
The Bugzilla documentation, including The Bugzilla Guide.</member>
<member>
<emphasis>Email:</emphasis>
-
Anything to do with email sent by Bugzilla.</member>
<member>
<emphasis>Installation:</emphasis>
-
The installation process of Bugzilla.</member>
<member>
<emphasis>Query/Buglist:</emphasis>
-
Anything to do with searching for bugs and viewing the
buglists.</member>
<member>
<emphasis>Reporting/Charting:</emphasis>
-
Getting reports from Bugzilla.</member>
<member>
<emphasis>User Accounts:</emphasis>
-
Anything about managing a user account from the user's perspective.
Saved queries, creating accounts, changing passwords, logging in,
etc.</member>
<member>
<emphasis>User Interface:</emphasis>
-
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates,
etc.</member>
@@ -301,46 +139,41 @@ Chapter: Using Bugzilla
<para>
<emphasis>Status and Resolution:</emphasis>
- A bug passes through several Statuses in its lifetime, and ends up
- in the RESOLVED status, with one of a set of Resolutions (e.g.
- FIXED, INVALID.) The different possible values for Status and
- Resolution on your installation will be documented in the
+ These define exactly what state the bug is in - from not even
+ being confirmed as a bug, through to being fixed and the fix
+ confirmed by Quality Assurance. The different possible values for
+ Status and Resolution on your installation should be documented in the
context-sensitive help for those items.</para>
</listitem>
<listitem>
<para>
<emphasis>Assigned To:</emphasis>
-
The person responsible for fixing the bug.</para>
</listitem>
<listitem>
<para>
- <emphasis>URL:</emphasis>
-
+ <emphasis>*URL:</emphasis>
A URL associated with the bug, if any.</para>
</listitem>
<listitem>
<para>
<emphasis>Summary:</emphasis>
-
A one-sentence summary of the problem.</para>
</listitem>
<listitem>
<para>
- <emphasis>Status Whiteboard:</emphasis>
-
+ <emphasis>*Status Whiteboard:</emphasis>
(a.k.a. Whiteboard) A free-form text area for adding short notes
and tags to a bug.</para>
</listitem>
<listitem>
<para>
- <emphasis>Keywords:</emphasis>
-
+ <emphasis>*Keywords:</emphasis>
The administrator can define keywords which you can use to tag and
categorise bugs - e.g. The Mozilla Project has keywords like crash
and regression.</para>
@@ -349,7 +182,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Platform and OS:</emphasis>
-
These indicate the computing environment where the bug was
found.</para>
</listitem>
@@ -357,7 +189,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Version:</emphasis>
-
The "Version" field is usually used for versions of a product which
have been released, and is set to indicate which versions of a
Component have the particular problem the bug report is
@@ -367,7 +198,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Priority:</emphasis>
-
The bug assignee uses this field to prioritise his or her bugs.
It's a good idea not to change this on other people's bugs.</para>
</listitem>
@@ -375,7 +205,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Severity:</emphasis>
-
This indicates how severe the problem is - from blocker
("application unusable") to trivial ("minor cosmetic issue"). You
can also use this field to indicate whether a bug is an enhancement
@@ -384,8 +213,7 @@ Chapter: Using Bugzilla
<listitem>
<para>
- <emphasis>Target:</emphasis>
-
+ <emphasis>*Target:</emphasis>
(a.k.a. Target Milestone) A future version by which the bug is to
be fixed. e.g. The Bugzilla Project's milestones for future
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
@@ -396,29 +224,25 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Reporter:</emphasis>
-
The person who filed the bug.</para>
</listitem>
<listitem>
<para>
<emphasis>CC list:</emphasis>
-
A list of people who get mail when the bug changes.</para>
</listitem>
<listitem>
<para>
<emphasis>Attachments:</emphasis>
-
You can attach files (e.g. testcases or patches) to bugs. If there
are any attachments, they are listed in this section.</para>
</listitem>
<listitem>
<para>
- <emphasis>Dependencies:</emphasis>
-
+ <emphasis>*Dependencies:</emphasis>
If this bug cannot be fixed unless other bugs are fixed (depends
on), or this bug stops other bugs being fixed (blocks), their
numbers are recorded here.</para>
@@ -426,15 +250,13 @@ Chapter: Using Bugzilla
<listitem>
<para>
- <emphasis>Votes:</emphasis>
-
+ <emphasis>*Votes:</emphasis>
Whether this bug has any votes.</para>
</listitem>
<listitem>
<para>
<emphasis>Additional Comments:</emphasis>
-
You can add your two cents to the bug discussion here, if you have
something worthwhile to say.</para>
</listitem>
@@ -447,8 +269,8 @@ Chapter: Using Bugzilla
<para>The Bugzilla Search page is is the interface where you can find
any bug report, comment, or patch currently in the Bugzilla system. You
can play with it here:
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
- landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>
+ <ulink url="http://landfill.bugzilla.org/bugzilla-tip/query.cgi">
+ landfill.bugzilla.org/bugzilla-tip/query.cgi</ulink>
.</para>
@@ -460,7 +282,7 @@ Chapter: Using Bugzilla
<para>Highly advanced querying is done using Boolean Charts, which have
their own
<ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">
+ url="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html">
context-sensitive help</ulink>
.</para>
@@ -517,10 +339,9 @@ Chapter: Using Bugzilla
<para>Years of bug writing experience has been distilled for your
reading pleasure into the
<ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html">
- Bug Writing Guidelines</ulink>
-
- . While some of the advice is Mozilla-specific, the basic principles of
+ url="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html">
+ Bug Writing Guidelines</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
@@ -532,15 +353,13 @@ Chapter: Using Bugzilla
<orderedlist>
<listitem>
<para>Go to
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
+ <ulink url="http://landfill.bugzilla.org/bugzilla-tip/">
Landfill</ulink>
-
in your browser and click
<ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi">
- Enter a new bug report</ulink>
-
- .</para>
+ url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi">
+ Enter a new bug report</ulink>.
+ </para>
</listitem>
<listitem>
@@ -560,29 +379,138 @@ Chapter: Using Bugzilla
</section>
</section>
- <section id="init4me">
- <title>User Preferences</title>
+ <section id="hintsandtips">
+ <title>Hints and Tips</title>
+
+ <para>This section distills some Bugzilla tips and best practices
+ that have been developed.</para>
+
+ <section>
+ <title>Autolinkification</title>
+ <para>Bugzilla comments are plain text - so posting HTML will result
+ in literal HTML tags rather than being interpreted by a browser.
+ However, Bugzilla will automatically make hyperlinks out of certain
+ sorts of text in comments. For example, the text
+ http://www.bugzilla.org will be turned into
+ <ulink url="http://www.bugzilla.org">http://www.bugzilla.org</ulink>.
+ Other strings which get linkified in the obvious manner are:
+ <simplelist>
+ <member>bug 12345</member>
+ <member>bug 23456, comment 53</member>
+ <member>attachment 4321</member>
+ <member>mailto:george@example.com</member>
+ <member>george@example.com</member>
+ <member>ftp://ftp.mozilla.org</member>
+ <member>Most other sorts of URL</member>
+ </simplelist>
+ </para>
+
+ <para>A corollary here is that if you type a bug number in a comment,
+ you should put the word "bug" before it, so it gets autolinkified
+ for the convenience of others.
+ </para>
+ </section>
- <para>You can customise various aspects of Bugzilla, via the "Edit prefs"
- link in the page footer, once you have logged in, e.g. to
- <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1">
- Landfill</ulink>
+ <section id="quicksearch">
+ <title>Quicksearch</title>
- . The preferences are split into four tabs.</para>
+ <para>Quicksearch is a single-text-box query tool which uses
+ metacharacters to indicate what is to be searched. For example, typing
+ "<filename>foo|bar</filename>"
+ into Quicksearch would search for "foo" or "bar" in the
+ summary and status whiteboard of a bug; adding
+ "<filename>:BazProduct</filename>" would
+ search only in that product.
+ </para>
+
+ <para>You'll find the Quicksearch box on Bugzilla's
+ front page, along with a
+ <ulink url="../../quicksearch.html">Help</ulink>
+ link which details how to use it.</para>
+ </section>
+
+ <section id="commenting">
+ <title>Comments</title>
+
+ <para>If you are changing the fields on a bug, only comment if
+ either you have something pertinent to say, or Bugzilla requires it.
+ Otherwise, you may spam people unnecessarily with bug mail.
+ To take an example: a user can set up their account to filter out messages
+ where someone just adds themselves to the CC field of a bug
+ (which happens a lot.) If you come along, add yourself to the CC field,
+ and add a comment saying "Adding self to CC", then that person
+ gets a pointless piece of mail they would otherwise have avoided.
+ </para>
+
+ <para>
+ Don't use sigs in comments. Signing your name ("Bill") is acceptable,
+ particularly if you do it out of habit, but full mail/news-style
+ four line ASCII art creations are not.
+ </para>
+ </section>
+
+ <section id="attachments">
+ <title>Attachments</title>
+
+ <para>
+ Use attachments, rather than comments, for large chunks of ASCII data,
+ such as trace, debugging output files, or log files. That way, it doesn't
+ bloat the bug for everyone who wants to read it, and cause people to
+ receive fat, useless mails.
+ </para>
+
+ <para>Trim screenshots. There's no need to show the whole screen if
+ you are pointing out a single-pixel problem.
+ </para>
+
+ <para>Don't attach simple test cases (e.g. one HTML file, one
+ CSS file and an image) as a ZIP file. Instead, upload them in
+ reverse order and edit the referring file so that they point to the
+ attached files. This way, the test case works immediately
+ out of the bug.
+ </para>
+ </section>
+
+ <section>
+ <title>Filing Bugs</title>
+
+ <para>Try to make sure that everything said in the summary is also
+ said in the first comment. Summaries are often updated and this will
+ ensure your original information is easily accessible.
+ </para>
+
+ <para>
+ You do not need to put "any" or similar strings in the URL field.
+ If there is no specific URL associated with the bug, leave this
+ field blank.
+ </para>
+
+ <para>If you feel a bug you filed was incorrectly marked as a
+ DUPLICATE of another, please question it in your bug, not
+ the bug it was duped to. Feel free to CC the person who duped it
+ if they are not already CCed.
+ </para>
+ </section>
+ </section>
+
+ <section id="userpreferences">
+ <title>User Preferences</title>
+
+ <para>Once you have logged in, you can customise various aspects of
+ Bugzilla via the "Edit prefs" link in the page footer.
+ The preferences are split into four tabs:</para>
<section id="accountsettings" xreflabel="Account Settings">
<title>Account Settings</title>
- <para>On this tab, you can change your basic Account Settings,
+ <para>On this tab, you can change your basic account information,
including your password, email address and real name. For security
reasons, in order to change anything on this page you must type your
<emphasis>current</emphasis>
-
password into the
<quote>Password</quote>
-
- field. If you attempt to change your email address, a confirmation
+ field at the top of the page.
+ If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.</para>
</section>
@@ -600,28 +528,27 @@ Chapter: Using Bugzilla
"Users to watch" text entry box you can receive a copy of all the
bugmail of other users (security settings permitting.) This powerful
functionality enables seamless transitions as developers change
- projects, managers wish to get in touch with the issues faced by their
- direct reports, or users go on vacation.</para>
+ projects or users go on holiday.</para>
<note>
- <para>This option may not be available in all Bugzilla installations.
- Ask your administrator.</para>
+ <para>The ability to watch other users may not be available in all
+ Bugzilla installations. If you can't see it, ask your
+ administrator.</para>
</note>
</section>
<section id="footersettings">
<title>Page Footer</title>
-
- <para>By default, this page is quite barren. However, if you explore
- the Search page some more, you will find that you can store numerous
- queries on the server, so if you regularly run a particular query it is
- just a drop-down menu away. Once you have a stored query, you can come
+
+ <para>On the Search page, you can store queries in Bugzilla, so if you
+ regularly run a particular query it is just a drop-down menu away.
+ Once you have a stored query, you can come
here to request that it also be displayed in your page footer.</para>
</section>
<section id="permissionsettings">
<title>Permissions</title>
-
+
<para>This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you
are in, and whether you can edit bugs or perform various administration
diff --git a/docs/sgml/variants.sgml b/docs/sgml/variants.sgml
index 5fbea801f..73f6822fb 100644
--- a/docs/sgml/variants.sgml
+++ b/docs/sgml/variants.sgml
@@ -1,5 +1,5 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">-->
-<chapter id="variants" xreflabel="Bugzilla Variants and Competitors">
+<appendix id="variants" xreflabel="Bugzilla Variants and Competitors">
<title>Bugzilla Variants and Competitors</title>
<para>I created this section to answer questions about Bugzilla competitors
@@ -13,13 +13,12 @@
<section id="rhbugzilla" xreflabel="Red Hat Bugzilla">
<title>Red Hat Bugzilla</title>
- <para>Red Hat Bugzilla is probably the most popular Bugzilla variant on
- the planet. One of the major benefits of Red Hat Bugzilla is the ability
+ <para>Red Hat Bugzilla is a fork of Bugzilla 2.8.
+ One of its major benefits is the ability
to work with Oracle, MySQL, and PostGreSQL databases serving as the
- back-end, instead of just MySQL. Dave Lawrence has worked very hard to
- keep Red Hat Bugzilla up-to-date, and many people prefer the
- snappier-looking page layout of Red Hat Bugzilla to the default
- Mozilla-standard formatting.</para>
+ back-end, instead of just MySQL. Dave Lawrence of Red Hat is
+ active in the Bugzilla community, and we hope to see a reunification
+ of the fork before too long.</para>
<para>URL:
<ulink url="http://bugzilla.redhat.com/bugzilla/">
@@ -30,38 +29,26 @@
<section id="variant-fenris" xreflabel="Loki Bugzilla, a.k.a. Fenris">
<title>Loki Bugzilla (Fenris)</title>
- <para>Fenris can be found at
- <ulink url="http://fenris.lokigames.com/">
- http://fenris.lokigames.com</ulink>
-
- . It is a fork from Bugzilla.</para>
+ <para>Fenris was a fork from Bugzilla made by Loki Games; when
+ Loki went into receivership, it died. While Loki's other code lives on,
+ its custodians recommend Bugzilla for future bug-tracker deployments.
+ </para>
</section>
<section id="variant-issuezilla" xreflabel="Issuezilla">
<title>Issuezilla</title>
- <para>Issuezilla is another fork from Bugzilla, and seems nearly as
- popular as the Red Hat Bugzilla fork. Some Issuezilla team members are
- regular contributors to the Bugzilla mailing list/newsgroup. Issuezilla
- is not the primary focus of bug-tracking at tigris.org, however. Their
- Java-based bug-tracker,
- <xref linkend="variant-scarab" />
-
- , is under heavy development and looks promising!</para>
-
- <para>URL:
- <ulink url="http://issuezilla.tigris.org/servlets/ProjectHome">
- http://issuezilla.tigris.org/servlets/ProjectHome</ulink>
- </para>
+ <para>Issuezilla was another fork from Bugzilla, made by collab.net and
+ hosted at tigris.org. It is also dead; the primary focus of bug-tracking
+ at tigris.org is their Java-based bug-tracker,
+ <xref linkend="variant-scarab"/>.</para>
</section>
- <section id="variant-scarab"
- xreflabel="Scarab, a newfangled Java-based issue tracker">
+ <section id="variant-scarab" xreflabel="Scarab">
<title>Scarab</title>
- <para>Scarab is a promising new bug-tracking system built using Java
- Serlet technology. As of this writing, no source code has been released
- as a package, but you can obtain the code from CVS.</para>
+ <para>Scarab is a new open source bug-tracking system built using Java
+ Serlet technology. It is currently at version 1.0 beta 8.</para>
<para>URL:
<ulink url="http://scarab.tigris.org/">http://scarab.tigris.org</ulink>
@@ -72,32 +59,29 @@
<title>Perforce SCM</title>
<para>Although Perforce isn't really a bug tracker, it can be used as
- such through the
- <quote>jobs</quote>
-
+ such through the <quote>jobs</quote>
functionality.</para>
- <para>
+ <para>URL:
<ulink url="http://www.perforce.com/perforce/technotes/note052.html">
+ http://www.perforce.com/perforce/technotes/note052.html
</ulink>
-
- http://www.perforce.com/perforce/technotes/note052.html</para>
+ </para>
</section>
<section id="variant-sourceforge" xreflabel="SourceForge">
<title>SourceForge</title>
- <para>SourceForge is more of a way of coordinating geographically
- distributed free software and open source projects over the Internet than
- strictly a bug tracker, but if you're hunting for bug-tracking for your
- open project, it may be just what the software engineer ordered!</para>
+ <para>SourceForge is a way of coordinating geographically
+ distributed free software and open source projects over the Internet.
+ It has a built-in bug tracker, but it's not highly thought of.</para>
<para>URL:
<ulink url="http://www.sourceforge.net">
http://www.sourceforge.net</ulink>
</para>
</section>
-</chapter>
+</appendix>
<!-- Keep this comment at the end of the file
Local variables:
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-04-18 22:12:06 +0200