Skip to content

bugzilla
bugzilla
Commit 16cff0a1 authored by karl%kornel.name's avatar karl%kornel.name
Browse files
Options

Bug 313469: Various small docs bugs found doing a clean install - Patch by A.…

Bug 313469: Various small docs bugs found doing a clean install - Patch by A. Karl Kornel <karl@kornel.name r=colin.ogilvie
parent 3b3210dd
Hide whitespace changes
Inline Side-by-side
Showing with 658 additions and 408 deletions
docs/en/xml/administration.xml
View file @ 16cff0a1
...@@ -5,215 +5,312 @@ ...@@ -5,215 +5,312 @@
<section id="parameters"> <section id="parameters">
<title>Bugzilla Configuration</title> <title>Bugzilla Configuration</title>
<para>Bugzilla is configured by changing various parameters, accessed <para>
from the "Edit parameters" link in the page footer. Here are Bugzilla is configured by changing various parameters, accessed
some of the key parameters on that page. You should run down this from the "Edit parameters" link in the page footer. Here are
list and set them appropriately after installing Bugzilla.</para> some of the key parameters on that page. You should run down this
list and set them appropriately after installing Bugzilla.
</para>
<indexterm> <indexterm>
<primary>checklist</primary> <primary>checklist</primary>
</indexterm> </indexterm>
<procedure> <variablelist>
<step> <varlistentry>
<para> <term>
<command>maintainer</command>: maintainer
The maintainer parameter is the email address of the person </term>
responsible for maintaining this <listitem>
Bugzilla installation. The address need not be that of a valid Bugzilla <para>
account.</para> The maintainer parameter is the email address of the person
</step> responsible for maintaining this Bugzilla installation.
The address need not be that of a valid Bugzilla account.
<step> </para>
<para> </listitem>
<command>urlbase</command>: </varlistentry>
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 <varlistentry>
<filename>http://www.foo.com/bugzilla/query.cgi</filename>, <term>
set your <quote>urlbase</quote> urlbase
to <filename>http://www.foo.com/bugzilla/</filename>.</para> </term>
</step> <listitem>
<para>
This parameter defines the fully qualified domain name and web
server path to your Bugzilla installation.
</para>
<step> <para>
<para> For example, if your Bugzilla query page is
<command>makeproductgroups</command>: <filename>http://www.foo.com/bugzilla/query.cgi</filename>,
This dictates whether or not to automatically create groups set your <quote>urlbase</quote>
when new products are created. to <filename>http://www.foo.com/bugzilla/</filename>.
</para> </para>
</step> </listitem>
</varlistentry>
<step> <varlistentry>
<para> <term>
<command>useentrygroupdefault</command>: makeproductgroups
Bugzilla products can have a group associated with them, so that </term>
certain users can only see bugs in certain products. When this <listitem>
parameter is set to <quote>on</quote>, this <para>
causes the initial group controls on newly created products This dictates whether or not to automatically create groups
to place all newly-created bugs in the group when new products are created.
having the same name as the product immediately. </para>
After a product is initially created, the group controls </listitem>
can be further adjusted without interference by </varlistentry>
this mechanism.</para>
</step> <varlistentry>
<term>
<step> useentrygroupdefault
<para> </term>
<command>shadowdb</command>: <listitem>
You run into an interesting problem when Bugzilla reaches a <para>
high level of continuous activity. MySQL supports only table-level Bugzilla products can have a group associated with them, so that
write locking. What this means is that if someone needs to make a certain users can only see bugs in certain products. When this
change to a bug, they will lock the entire table until the operation parameter is set to <quote>on</quote>, this
is complete. Locking for write also blocks reads until the write is causes the initial group controls on newly created products
complete. Note that more recent versions of mysql support row level to place all newly-created bugs in the group
locking using different table types. These types are slower than the having the same name as the product immediately.
standard type, and Bugzilla does not yet take advantage of features After a product is initially created, the group controls
such as transactions which would justify this speed decrease. The can be further adjusted without interference by
Bugzilla team are, however, happy to hear about any experiences with this mechanism.
row level locking and Bugzilla.</para> </para>
</listitem>
<para>The <quote>shadowdb</quote> </varlistentry>
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 <varlistentry>
continue unimpeded on a read-only shadow copy of the database. <term>
Although your database size will double, a shadow database can cause maildeliverymethod
an enormous performance improvement when implemented on extremely </term>
high-traffic Bugzilla databases.</para> <listitem>
<para>
This is used to specify how email is sent, or if it is sent at
all. There are several options included for different MTAs,
along with two additional options that disable email sending.
"testfile" does not send mail, but instead saves it in
<filename>data/mailer.testfile</filename> for later review.
"none" disables email sending entirely.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
shadowdb
</term>
<listitem>
<para>
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. Note that more recent versions of mysql support row level
locking using different table types. These types are slower than the
standard type, and Bugzilla does not yet take advantage of features
such as transactions which would justify this speed decrease. The
Bugzilla team are, however, happy to hear about any experiences with
row level locking and Bugzilla.
</para>
<para>
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> <para>
As a guide, on reasonably old hardware, mozilla.org began needing As a guide, on reasonably old hardware, mozilla.org began needing
<quote>shadowdb</quote> <quote>shadowdb</quote> when they reached around 40,000 Bugzilla
when they reached around 40,000 Bugzilla users with several hundred users with several hundred Bugzilla bug changes and comments per day.
Bugzilla bug changes and comments per day.</para> </para>
<para>The value of the parameter defines the name of the
shadow bug database. You will need to set the host and port settings
from the params page, and set up replication in your database server
so that updates reach this readonly mirror. Consult your database
documentation for more detail.</para>
</step>
<step>
<para>
<command>shutdownhtml</command>:
If you need to shut down Bugzilla to perform administration, enter <para>
some descriptive HTML here and anyone who tries to use Bugzilla will The value of the parameter defines the name of the shadow bug
receive a page to that effect. Obviously, editparams.cgi will database. You will need to set the host and port settings from
still be accessible so you can remove the HTML and re-enable Bugzilla. the params page, and set up replication in your database server
:-) so that updates reach this readonly mirror. Consult your database
</para> documentation for more detail.
</step> </para>
</listitem>
</varlistentry>
<step> <varlistentry>
<para> <term>
<command>passwordmail</command>: shutdownhtml
</term>
<listitem>
<para>
If you need to shut down Bugzilla to perform administration, enter
some descriptive text (with embedded HTML codes, if you'd like)
into this box. Anyone who tries to use Bugzilla (including admins)
will receive a page displaying this text. Users can neither log in
nor log out while shutdownhtml is enabled.
</para>
Every time a user creates an account, the text of <note>
this parameter (with substitutions) is sent to the new user along with <para>
their password message.</para> Although regular log-in capability is disabled while 'shutdownhtml'
is enabled, safeguards are in place to protect the unfortunate
admin who loses connection to Bugzilla. Should this happen to you,
go directly to the <filename>editparams.cgi</filename> (by typing
the URL in manually, if necessary). Doing this will prompt you to
log in, and your name/password will be accepted here (but nowhere
else).
</para>
</note>
</listitem>
</varlistentry>
<para>Add any text you wish to the "passwordmail" parameter box. For <varlistentry>
instance, many people choose to use this box to give a quick training <term>
blurb about how to use Bugzilla at your site.</para> passwordmail
</step> </term>
<listitem>
<para>
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
instance, many people choose to use this box to give a quick
training blurb about how to use Bugzilla at your site.
</para>
</listitem>
</varlistentry>
<step> <varlistentry>
<para> <term>
<command>movebugs</command>: movebugs
</term>
<listitem>
<para>
This option is an undocumented feature to allow moving bugs
between separate Bugzilla installations. You will need to understand
the source code in order to use this feature. Please consult
<filename>movebugs.pl</filename> in your Bugzilla source tree for
further documentation, such as it is.
</para>
</listitem>
</varlistentry>
This option is an undocumented feature to allow moving bugs <varlistentry>
between separate Bugzilla installations. You will need to understand <term>
the source code in order to use this feature. Please consult useqacontact
<filename>movebugs.pl</filename> in your Bugzilla source tree for </term>
further documentation, such as it is. <listitem>
</para> <para>
</step> This allows you to define an email address for each component,
in addition to that of the default assignee, who will be sent
carbon copies of incoming bugs.
</para>
</listitem>
</varlistentry>
<step> <varlistentry>
<para> <term>
<command>useqacontact</command>: usestatuswhiteboard
</term>
This allows you to define an email address for each component, in <listitem>
addition <para>
to that of the default owner, who will be sent carbon copies of This defines whether you wish to have a free-form, overwritable field
incoming bugs.</para> associated with each bug. The advantage of the Status Whiteboard is
</step> that it can be deleted or modified with ease, and provides an
<step> easily-searchable field for indexing some bugs that have some trait
<para> in common.
<command>usestatuswhiteboard</command>: </para>
This defines whether you wish to have a free-form, overwritable field </listitem>
associated with each bug. The advantage of the Status Whiteboard is </varlistentry>
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.
</para>
</step>
<step> <varlistentry>
<para> <term>
<command>whinedays</command>: whinedays
Set this to the number of days you want to let bugs go </term>
in the NEW or REOPENED state before notifying people they have <listitem>
untouched new bugs. If you do not plan to use this feature, simply do <para>
not set up the whining cron job described in the installation Set this to the number of days you want to let bugs go
instructions, or set this value to "0" (never whine).</para> in the NEW or REOPENED state before notifying people they have
</step> 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
<step> instructions, or set this value to "0" (never whine).
<para> </para>
<command>commenton*</command>: </listitem>
All these </varlistentry>
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
list, accept bugs, or change the Status Whiteboard without adding a
comment as to their reasons for the change, yet require that most
other changes come with an explanation.</para>
<para>Set the "commenton" options according to your site policy. It
is a wise idea to require comments when users resolve, reassign, or
reopen bugs at the very least.
<note>
<para>It is generally far better to require a developer comment
when resolving bugs than not. Few things are more annoying to bug
database users than having a developer mark a bug "fixed" without
any comment as to what the fix was (or even that it was truly
fixed!)</para>
</note>
</para>
</step>
<step> <varlistentry>
<para> <term>
<command>supportwatchers</command>: commenton*
</term>
Turning on this option allows users to ask to receive copies of <listitem>
all a particular other user's bug email. This is, of <para>
course, subject to the groupset restrictions on the bug; if the All these fields allow you to dictate what changes can pass
<quote>watcher</quote> without comment, and which must have a comment from the
would not normally be allowed to view a bug, the watcher cannot get person who changed them. Often, administrators will allow
around the system by setting herself up to watch the bugs of someone users to add themselves to the CC list, accept bugs, or
with bugs outside her privileges. They would still only receive email change the Status Whiteboard without adding a comment as to
updates for those bugs she could normally view.</para> their reasons for the change, yet require that most other
</step> changes come with an explanation.
</para>
<step>
<para>
<command>noresolveonopenblockers</command>:
This option will prevent users from resolving bugs as FIXED if <para>
they have unresolved dependencies. Only the FIXED resolution Set the "commenton" options according to your site policy. It
is affected. Users will be still able to resolve bugs to is a wise idea to require comments when users resolve, reassign, or
resolutions other than FIXED if they have unresolved dependent reopen bugs at the very least.
bugs. </para>
</para> <note>
</step> <para>
It is generally far better to require a developer comment
when resolving bugs than not. Few things are more annoying to bug
database users than having a developer mark a bug "fixed" without
any comment as to what the fix was (or even that it was truly
fixed!)
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
supportwatchers
</term>
<listitem>
<para>
Turning on this option allows users to ask to receive copies
of bug mail sent to another user. Watching a user with
different group permissions is not a way to 'get around' the
system; copied emails are still subject to the normal groupset
permissions of a bug, and <quote>watchers</quote> will only be
copied on emails from bugs they would normally be allowed to view.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
noresolveonopenblockers
</term>
<listitem>
<para>
This option will prevent users from resolving bugs as FIXED if
they have unresolved dependencies. Only the FIXED resolution
is affected. Users will be still able to resolve bugs to
resolutions other than FIXED if they have unresolved dependent
bugs.
</para>
</listitem>
</varlistentry>
</procedure> </variablelist>
</section> </section>
<section id="useradmin"> <section id="useradmin">
...@@ -439,6 +536,46 @@ ...@@ -439,6 +536,46 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section id="impersonatingusers">
<title>Impersonating Users</title>
<para>
There may be times when an administrator would like to do something as
another user. The <command>sudo</command> feature may be used to do
this.
</para>
<note>
<para>
To use the sudo feature, you must be in the
<emphasis>bz_sudoers</emphasis> group. By default, all
administrators are in this group.</para>
</note>
<para>
If you have access to this feature, you may start a session by
going to the Edit Users page, Searching for a user and clicking on
their login. You should see a link below their login name titled
"Impersonate this user". Click on the link. This will take you
to a page where you will see a description of the feature and
instructions for using it. After reading the text, simply
enter the login of the user you would like to impersonate, provide
a short message explaining why you are doing this, and press the
button.</para>
<para>
As long as you are using this feature, everything you do will be done
as if you were logged in as the user you are impersonating.</para>
<warning>
<para>
The user you are impersonating will not be told about what you are
doing. If you do anything that results in mail being sent, that
mail will appear to be from the user you are impersonating. You
should be extremely careful while using this feature.</para>
</warning>
</section>
</section> </section>
</section> </section>
...@@ -499,12 +636,12 @@ ...@@ -499,12 +636,12 @@
company.</para> company.</para>
<para> <para>
Each component has a owner and (if you turned it on in the parameters), Each component has a default assignee and (if you turned it on in the parameters),
a QA Contact. The owner should be the primary person who fixes bugs in a QA Contact. The default assignee should be the primary person who fixes bugs in
that component. The QA Contact should be the person who will ensure that component. The QA Contact should be the person who will ensure
these bugs are completely fixed. The Owner, QA Contact, and Reporter these bugs are completely fixed. The Assignee, QA Contact, and Reporter
will get email when new bugs are created in this Component and when will get email when new bugs are created in this Component and when
these bugs change. Default Owner and Default QA Contact fields only these bugs change. Default Assignee and Default QA Contact fields only
dictate the dictate the
<emphasis>default assignments</emphasis>; <emphasis>default assignments</emphasis>;
these can be changed on bug submission, or at any later point in these can be changed on bug submission, or at any later point in
...@@ -524,9 +661,9 @@ ...@@ -524,9 +661,9 @@
<listitem> <listitem>
<para>Fill out the "Component" field, a short "Description", <para>Fill out the "Component" field, a short "Description",
the "Initial Owner" and "Initial QA Contact" (if enabled.) the "Default Assignee" and "Default QA Contact" (if enabled.)
The Component and Description fields may contain HTML; The Component and Description fields may contain HTML;
the "Initial Owner" field must be a login name the "Default Assignee" field must be a login name
already existing in the database. already existing in the database.
</para> </para>
</listitem> </listitem>
...@@ -591,7 +728,7 @@ ...@@ -591,7 +728,7 @@
<listitem> <listitem>
<para>Enter the name of the Milestone in the "Milestone" field. You <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 number (-32768 to 32767) that defines where in the list this particular
milestone appears. This is because milestones often do not milestone appears. This is because milestones often do not
occur in alphanumeric order For example, "Future" might be occur in alphanumeric order For example, "Future" might be
after "Release 1.2". Select "Add".</para> after "Release 1.2". Select "Add".</para>
...@@ -793,7 +930,7 @@ ...@@ -793,7 +930,7 @@
</para> </para>
<para> <para>
Only users with the ability to edit the bug may Only users with the ability to edit the bug may
set flags on bugs. This includes the owner, reporter, and set flags on bugs. This includes the assignee, reporter, and
any user with the <computeroutput>editbugs</computeroutput> any user with the <computeroutput>editbugs</computeroutput>
permission. permission.
</para> </para>
...@@ -821,7 +958,7 @@ ...@@ -821,7 +958,7 @@
<para> <para>
When you click on the <quote>Create a Flag Type for...</quote> When you click on the <quote>Create a Flag Type for...</quote>
link, you will be presented with a form. Here is what the felds in link, you will be presented with a form. Here is what the fields in
the form mean: the form mean:
</para> </para>
...@@ -838,7 +975,7 @@ ...@@ -838,7 +975,7 @@
<title>Description</title> <title>Description</title>
<para> <para>
This describes the flag in more detail. At present, this doesn't This describes the flag in more detail. At present, this doesn't
whos up anywhere helpful; ideally, it would be nice to have show up anywhere helpful; ideally, it would be nice to have
it show up as a tooltip. This field it show up as a tooltip. This field
can be as long as you like, and can contain any character you want. can be as long as you like, and can contain any character you want.
</para> </para>
...@@ -1273,7 +1410,7 @@ ...@@ -1273,7 +1410,7 @@
</orderedlist> </orderedlist>
<para>These controls are often described in this order, so a <para>These controls are often described in this order, so a
product that requires a user to be a member of group "foo" product that requires a user to be a member of group "foo"
to enter a bug and then requires that the bug stay resticted to enter a bug and then requires that the bug stay restricted
to group "foo" at all times and that only members of group "foo" to group "foo" at all times and that only members of group "foo"
can edit the bug even if they otherwise could see the bug would can edit the bug even if they otherwise could see the bug would
have its controls summarized by...</para> have its controls summarized by...</para>
...@@ -1355,204 +1492,333 @@ Support: ENTRY, DEFAULT/MANDATORY, CANEDIT ...@@ -1355,204 +1492,333 @@ Support: ENTRY, DEFAULT/MANDATORY, CANEDIT
<section id="upgrading"> <section id="upgrading">
<title>Upgrading to New Releases</title> <title>Upgrading to New Releases</title>
<warning> <para>
<para>Upgrading is a one-way process. You should backup your database Upgrading Bugzilla is something we all want to do from time to time,
and current Bugzilla directory before attempting the upgrade. If you wish be it to get new features or pick up the latest security fix. How easy
to revert to the old Bugzilla version for any reason, you will have to it is to update depends on a few factors:
restore from these backups.
</para>
</warning>
<para>Upgrading Bugzilla is something we all want to do from time to time,
be it to get new features or pick up the latest security fix. How easy
it is to update depends on a few factors.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>If the new version is a revision or a new point release</para> <para>
If the new version is a revision or a new point release
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>How many, if any, local changes have been made</para> <para>
How many local changes (if any) have been made
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>There are also three different methods to upgrade your installation. <section id="upgrading-version-defns">
</para> <title>Version Definitions</title>
<orderedlist> <para>
<listitem> Bugzilla displays the version you are using at the top of most
<para>Using CVS (<xref linkend="upgrade-cvs"/>)</para> pages you load. It will look something like '2.16.7' or '2.18rc3'
</listitem> or '2.19.1+'. The first number in this series is the Major Version.
<listitem> This does not change very often (that is to say, almost never);
<para>Downloading a new tarball (<xref linkend="upgrade-tarball"/>)</para> Bugzilla was 1.x.x when it was first created, and went to 2.x.x
</listitem> when it was re-written in perl in Sept 1998. If/When the major version
<listitem> is changed to 3.x.x, it will signify a significant structural change
<para>Applying the relevant patches (<xref linkend="upgrade-patches"/>)</para> and will be accompanied by much fanfare and many instructions on
</listitem> how to upgrade, including a revision to this page. :)
</orderedlist> </para>
<para>Which options are available to you may depend on how large a jump <para>
you are making and/or your network configuration. The second number in the version is called the 'minor number', and
</para> a release that changes the minor number is called a 'point release'.
An even number in this position (2.14, 2.16, 2.18, 2.20, etc.)
represents a stable version, while an odd number (2.17, 2.19, etc.)
represents a development version. In the past, stable point releases
were feature-based, coming when certain enhancements had been
completed, or the Bugzilla development team felt that enough
progress had been made overall. As of version 2.18, however,
Bugzilla has moved to a time-based release schedule; current plans
are to create a stable point release every 6 months or so after
2.18 is deployed.
</para>
<para>Revisions are normally released to fix security vulnerabilities <para>
and are distinguished by an increase in the third number. For example, The third number in the Bugzilla version represents a bugfix version.
when 2.16.6 was released, it was a revision to 2.16.5. Bugfix Revisions are normally released only to address security
</para> vulnerabilities; in the future, it is likely that the Bugzilla
development team will back-port bugfixes in a new point release to
the old point release for a limited period. Once enough of these
bugfixes have accumulated (or a new security vulnerability is
identified and closed), a bugfix release will be made. As an
example, 2.16.6 was a bugfix release, and improved on 2.16.5.
</para>
<para>Point releases are normally released when the Bugzilla team feels <note>
that there has been a significant amount of progress made between the <para>
last point release and the current time. These are often proceeded by a When reading version numbers, everything separated by a point ('.')
stabilization period and release candidates, however the use of should be read as a single number. It is <emphasis>not</emphasis>
development versions or release candidates is beyond the scope of this the same as decimal. 2.14 is newer than 2.8 because minor version
document. Point releases can be distinguished by an increase in the 14 is greater than minor version 8. 2.24.11 would be newer than
second number, or minor version. For example, 2.18.0 is a newer point 2.24.9 (because bugfix 11 is greater than bugfix 9. This is
release than 2.16.5. confusing to some people who aren't used to dealing with software.
</para> </para>
</note>
</section>
<para>The examples in this section are written as if you were updating <section id="upgrading-methods">
to version 2.18.1. The procedures are the same regardless if you are <title>Upgrading - Methods and Procedure</title>
updating to a new point release or a new revision. However, the chance <para>
of running into trouble increases when upgrading to a new point release, There are three different ways to upgrade your installation.
escpecially if you've made local changes. </para>
</para>
<para>These examples also assume that your Bugzilla installation is at <orderedlist>
<filename>/var/www/html/bugzilla</filename>. If that is not the case, <listitem>
simply substitute the proper paths where appropriate. <para>
</para> Using CVS (<xref linkend="upgrade-cvs"/>)
</para>
</listitem>
<listitem>
<para>
Downloading a new tarball (<xref linkend="upgrade-tarball"/>)
</para>
</listitem>
<listitem>
<para>
Applying the relevant patches (<xref linkend="upgrade-patches"/>)
</para>
</listitem>
</orderedlist>
<example id="upgrade-cvs"> <para>
Each of these options has its own pros and cons; the one that's
right for you depends on how long it has been since you last
installed, the degree to which you have customized your installation,
and/or your network configuration. (Some discussion of the various
methods of updating compared with degree and methods of local
customization can be found in <xref linkend="template-method"/>.)
</para>
<para>
The larger the jump you are trying to make, the more difficult it
is going to be to upgrade if you have made local customizations.
Upgrading from 2.18 to 2.18.1 should be fairly painless even if
you are heavily customized, but going from 2.14 to 2.18 is going
to mean a fair bit of work re-writing your local changes to use
the new files, logic, templates, etc. If you have done no local
changes at all, however, then upgrading should be approximately
the same amount of work regardless of how long it has been since
your version was released.
</para>
<warning>
<para>
Upgrading is a one-way process. You should backup your database
and current Bugzilla directory before attempting the upgrade. If
you wish to revert to the old Bugzilla version for any reason, you
will have to restore from these backups.
</para>
</warning>
<para>
The examples in the following sections are written as though the
user were updating to version 2.18.1, but the procedures are the
same regardless of whether one is updating to a new point release
or simply trying to obtain a new bugfix release. Also, in the
examples the user's Bugzilla installation is found at
<filename>/var/www/html/bugzilla</filename>. If that is not the
same as the location of your Bugzilla installation, simply
substitute the proper paths where appropriate.
</para>
<section id="upgrade-cvs">
<title>Upgrading using CVS</title> <title>Upgrading using CVS</title>
<para>Every release of Bugzilla, whether it is a revision or a point <para>
release, is tagged in CVS. Also, every tarball we have distributed Every release of Bugzilla, whether it is a point release or a bugfix,
since version 2.12 has been primed for using CVS. This does, however, is tagged in CVS. Also, every tarball that has been distributed since
require that you are able to access cvs-mirror.mozilla.org on port version 2.12 has been created in such a way that it can be used with
2401. CVS once it is unpacked. Doing so, however, requires that you are able
to access cvs-mirror.mozilla.org on port 2401, which may not be an
option or a possibility for some users, especially those behind a
highly restrictive firewall.
</para>
<tip> <tip>
<para>If you can do this, updating using CVS is probably the most <para>
painless method, especially if you have a lot of local changes. If you can, updating using CVS is probably the most painless
method, especially if you have a lot of local changes.
</para> </para>
</tip> </tip>
</para>
<programlisting> <para>
The following shows the sequence of commands needed to update a
Bugzilla installation via CVS, and a typical series of results.
</para>
<programlisting>
bash$ <command>cd /var/www/html/bugzilla</command> bash$ <command>cd /var/www/html/bugzilla</command>
bash$ <command>cvs login</command> bash$ <command>cvs login</command>
Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot
CVS password: <command>anonymous</command> CVS password: <emphasis>('anonymous', or just leave it blank)</emphasis>
bash$ <command>cvs -q update -r BUGZILLA-2_18_1 -dP</command> bash$ <command>cvs -q update -r BUGZILLA-2_18_1 -dP</command>
P checksetup.pl P checksetup.pl
P collectstats.pl P collectstats.pl
P globals.pl P globals.pl
P docs/rel_notes.txt P docs/rel_notes.txt
P template/en/default/list/quips.html.tmpl P template/en/default/list/quips.html.tmpl
</programlisting> <emphasis>(etc.)</emphasis>
</programlisting>
<para>
<caution> <caution>
<para>If a line in the output from <command>cvs update</command> <para>
begins with a <computeroutput>C</computeroutput> that represents a If a line in the output from <command>cvs update</command> begins
file with local changes that CVS was unable to properly merge. You with a <computeroutput>C</computeroutput>, then that represents a
need to resolve these conflicts manually before Bugzilla (or at file with local changes that CVS was unable to properly merge. You
least the portion using that file) will be usable. need to resolve these conflicts manually before Bugzilla (or at
least the portion using that file) will be usable.
</para> </para>
</caution> </caution>
</section>
<note> <section id="upgrade-tarball">
<para>You also need to run <command>./checksetup.pl</command> <title>Upgrading using the tarball</title>
before your Bugzilla upgrade will be complete.
</para>
</note>
</para>
</example>
<example id="upgrade-tarball"> <para>
<title>Upgrading using the tarball</title> If you are unable (or unwilling) to use CVS, another option that's
always available is to obtain the latest tarball from the <ulink
url="http://www.bugzilla.org/download/">Download Page</ulink> and
create a new Bugzilla installation from that.
</para>
<para>If you are unable or unwilling to use CVS, another option that's <para>
always available is to download the latest tarball. This is the most This sequence of commands shows how to get the tarball from the
difficult option to use, especially if you have local changes. command-line; it is also possible to download it from the site
</para> directly in a web browser. If you go that route, save the file
to the <filename class="directory">/var/www/html</filename>
directory (or its equivalent, if you use something else) and
omit the first three lines of the example.
</para>
<programlisting> <programlisting>
bash$ <command>cd /var/www/html</command> bash$ <command>cd /var/www/html</command>
bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.1.tar.gz</command> bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.1.tar.gz</command>
<emphasis>Output omitted</emphasis> <emphasis>(Output omitted)</emphasis>
bash$ <command>tar xzvf bugzilla-2.18.1.tar.gz</command> bash$ <command>tar xzvf bugzilla-2.18.1.tar.gz</command>
bugzilla-2.18.1/ bugzilla-2.18.1/
bugzilla-2.18.1/.cvsignore bugzilla-2.18.1/.cvsignore
bugzilla-2.18.1/1x1.gif bugzilla-2.18.1/1x1.gif
<emphasis>Output truncated</emphasis> <emphasis>(Output truncated)</emphasis>
bash$ <command>cd bugzilla-2.18.1</command> bash$ <command>cd bugzilla-2.18.1</command>
bash$ <command>cp ../bugzilla/localconfig* .</command> bash$ <command>cp ../bugzilla/localconfig* .</command>
bash$ <command>cp -r ../bugzilla/data .</command> bash$ <command>cp -r ../bugzilla/data .</command>
bash$ <command>cd ..</command> bash$ <command>cd ..</command>
bash$ <command>mv bugzilla bugzilla.old</command> bash$ <command>mv bugzilla bugzilla.old</command>
bash$ <command>mv bugzilla-2.18.1 bugzilla</command> bash$ <command>mv bugzilla-2.18.1 bugzilla</command>
bash$ <command>cd bugzilla</command> </programlisting>
bash$ <command>./checksetup.pl</command>
<emphasis>Output omitted</emphasis>
</programlisting>
<para>
<warning> <warning>
<para>The <command>cp</command> commands both end with periods which <para>
is a very important detail, it tells the shell that the destination The <command>cp</command> commands both end with periods which
directory is the current working directory. Also, the period at the is a very important detail, it tells the shell that the destination
beginning of the <command>./checksetup.pl</command> is important and directory is the current working directory.
can not be omitted.
</para> </para>
</warning> </warning>
<note> <para>
<para>You will now have to reapply any changes you have made to your This upgrade method will give you a clean install of Bugzilla with the
local installation manually. same version as the tarball. That's fine if you don't have any local
</para> customizations that you want to maintain, but if you do then you will
</note> need to reapply them by hand to the appropriate files.
</para> </para>
</example>
<example id="upgrade-patches">
<title>Upgrading using patches</title>
<para>The Bugzilla team will normally make a patch file available for
revisions to go from the most recent revision to the new one. You could
also read the release notes and grab the patches attached to the
mentioned bug, but it is safer to use the released patch file as
sometimes patches get changed before they get checked in.
It is also theoretically possible to
scour the fixed bug list and pick and choose which patches to apply
from a point release, but this is not recommended either as what you'll
end up with is a hodge podge Bugzilla that isn't really any version.
This would also make it more difficult to upgrade in the future.
</para>
<programlisting> <para>
It's worth noting that since 2.12, the Bugzilla tarballs come
CVS-ready, so if you decide at a later date that you'd rather use
CVS as an upgrade method, your code will already be set up for it.
</para>
</section>
<section id="upgrade-patches">
<title>Upgrading using patches</title>
<para>
If you are doing a bugfix upgrade -- that is, one where only the
last number of the revision changes, such as from 2.16.6 to 2.16.7
-- then you have the option of obtaining and applying a patch file
from the <ulink
url="http://www.bugzilla.org/download/">Download Page</ulink>.
This file is made available by the <ulink
url="http://www.bugzilla.org/developers/profiles.html">Bugzilla
Development Team</ulink>, and is a collection of all the bug fixes
and security patches that have been made since the last bugfix
release. If you are planning to upgrade via patches, it is safer
to grab this developer-made patch file than to read the patch
notes and apply all (or even just some of) the patches oneself,
as sometimes patches on bugs get changed before they get checked in.
</para>
<para>
As above, this example starts with obtaining the file via the
command line. If you have already downloaded it, you can omit the
first two commands.
</para>
<programlisting>
bash$ <command>cd /var/www/html/bugzilla</command> bash$ <command>cd /var/www/html/bugzilla</command>
bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.0-to-2.18.1.diff.gz</command> bash$ <command>wget ftp://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.18.0-to-2.18.1.diff.gz</command>
<emphasis>Output omitted</emphasis> <emphasis>(Output omitted)</emphasis>
bash$ <command>gunzip bugzilla-2.18.0-to-2.18.1.diff.gz</command> bash$ <command>gunzip bugzilla-2.18.0-to-2.18.1.diff.gz</command>
bash$ <command>patch -p1 &lt; bugzilla-2.18.0-to-2.18.1.diff</command> bash$ <command>patch -p1 &lt; bugzilla-2.18.0-to-2.18.1.diff</command>
patching file checksetup.pl patching file checksetup.pl
patching file collectstats.pl patching file collectstats.pl
patching file globals.pl patching file globals.pl
<emphasis>(etc.)</emphasis>
</programlisting>
<warning>
<para>
Be aware that upgrading from a patch file does not change the
entries in your <filename class="directory">CVS</filename> directory.
This could make it more difficult to upgrade using CVS
(<xref linkend="upgrade-cvs"/>) in the future.
</para>
</warning>
</section>
</section>
<section id="upgrading-completion">
<title>Completing Your Upgrade</title>
<para>
Regardless of which upgrade method you choose, you will need to
run <command>./checksetup.pl</command> before your Bugzilla
upgrade will be complete.
</para>
<programlisting>
bash$ <command>cd bugzilla</command>
bash$ <command>./checksetup.pl</command>
</programlisting> </programlisting>
<warning>
<para>
The period at the beginning of the command
<command>./checksetup.pl</command> is important and can not
be omitted.
</para>
</warning>
<para> <para>
<caution> If you have done a lot of local modifications, it wouldn't hurt
<para>If you do this, beware that this doesn't change the entires in to run the Bugzilla Testing suite. This is not a required step,
your <filename id="dir">CVS</filename> directory so it may make but it isn't going to hurt anything, and might help point out
updates using CVS (<xref linkend="upgrade-cvs"/>) more difficult in the some areas that could be improved. (More information on the
future. test suite can be had by following this link to the appropriate
</para> section in the <ulink
</caution> url="http://www.bugzilla.org/docs/developer.html#testsuite">Developers'
Guide</ulink>.)
</para> </para>
</example>
</section>
</section> </section>
</chapter> </chapter>
......
docs/en/xml/installation.xml
View file @ 16cff0a1
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: installation.xml,v 1.103 2008/04/04 06:47:33 mozilla%colinogilvie.co.uk Exp $ --> <!-- $Id: installation.xml,v 1.104 2008/04/04 06:47:34 karl%kornel.name Exp $ -->
<chapter id="installing-bugzilla"> <chapter id="installing-bugzilla">
<title>Installing Bugzilla</title> <title>Installing Bugzilla</title>
...@@ -211,9 +211,7 @@ ...@@ -211,9 +211,7 @@
The first thing it checks is whether you have appropriate The first thing it checks is whether you have appropriate
versions of all the required versions of all the required
Perl modules. The aim of this section is to pass this check. Perl modules. The aim of this section is to pass this check.
When it passes, When it passes, proceed to <xref linkend="configuration"/>.
<emphasis>do not run it again</emphasis>,
but proceed to <xref linkend="configuration"/>.
</para> </para>
<para> <para>
...@@ -533,29 +531,58 @@ ...@@ -533,29 +531,58 @@
<section id="install-MTA"> <section id="install-MTA">
<title>Mail Transfer Agent (MTA)</title> <title>Mail Transfer Agent (MTA)</title>
<para>Bugzilla is dependent on the availability of an e-mail system for its user <para>
authentication and for other tasks. </para> Bugzilla is dependent on the availability of an e-mail system for its
user authentication and for other tasks.
</para>
<note>
<para>
This is not entirely true. It is possible to completely disable
email sending, or to have Bugzilla store email messages in a
file instead of sending them. However, this is mainly intended
for testing, as disabling or diverting email on a production
machine would mean that users could miss important events (such
as bug changes or the creation of new accouts).
</para>
<para>
For more information, see the "maildeliverymethod" parameter in
<xref linkend="parameters" />.
</para>
</note>
<para>On Linux, any Sendmail-compatible MTA (Mail Transfer Agent) will suffice. <para>
Sendmail, Postfix, qmail and Exim are examples of common MTAs. Sendmail is the On Linux, any Sendmail-compatible MTA (Mail Transfer Agent) will
original Unix MTA, but the others are easier to configure, and therefore many people suffice. Sendmail, Postfix, qmail and Exim are examples of common
replace Sendmail with Postfix or Exim. They are drop-in replacements, so that Bugzilla MTAs. Sendmail is the original Unix MTA, but the others are easier to
will not distinguish between them.</para> configure, and therefore many people replace Sendmail with Postfix or
Exim. They are drop-in replacements, so Bugzilla will not
distinguish between them.
</para>
<para> <para>
If you are using Sendmail, version 8.7 or higher is required. If you are using Sendmail, version 8.7 or higher is required.
If you are using a Sendmail-compatible MTA, it must be congruent with at least version 8.7 of Sendmail. If you are using a Sendmail-compatible MTA, it must be congruent with
at least version 8.7 of Sendmail.
</para> </para>
<para>Consult the manual for the specific MTA you choose for detailed installation <para>
instructions. Each of these programs will have their own configuration files where you must Consult the manual for the specific MTA you choose for detailed
configure certain parameters to ensure that the mail is delivered properly. They installation instructions. Each of these programs will have their own
are implemented as services, and you should ensure that the MTA is in the configuration files where you must configure certain parameters to
auto-start list of services for the machine.</para> ensure that the mail is delivered properly. They are implemented
as services, and you should ensure that the MTA is in the auto-start
list of services for the machine.
</para>
<para>
If a simple mail sent with the command-line 'mail' program
succeeds, then Bugzilla should also be fine.
</para>
<para>If a simple mail sent with the command-line 'mail' program succeeds, then
Bugzilla should also be fine.</para>
</section> </section>
</section> </section>
...@@ -594,6 +621,18 @@ ...@@ -594,6 +621,18 @@
password (for simplicity, it should not contain single quote password (for simplicity, it should not contain single quote
characters) and put it here. characters) and put it here.
</para> </para>
<para>
You may need to change the value of
<emphasis>webservergroup</emphasis> if your web server does not
run in the "apache" group. On Debian, for example, Apache runs in
the "www-data" group. If you are going to run Bugzilla on a
machine where you do not have root access (such as on a shared web
hosting account), you will need to leave
<emphasis>webservergroup</emphasis> empty, ignoring the warnings
that <filename>checksetup.pl</filename> will subsequently display
every time it in run.
</para>
<para> <para>
The other options in the <filename>localconfig</filename> file The other options in the <filename>localconfig</filename> file
...@@ -1077,69 +1116,6 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s ...@@ -1077,69 +1116,6 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s
</section> </section>
<section id="http-aol">
<title>AOL Server</title>
<para>Ben FrantzDale reported success using AOL Server with Bugzilla. He
reported his experience and what appears below is based on that.
</para>
<para>AOL Server will have to be configured to run
<glossterm linkend="gloss-cgi">CGI</glossterm> scripts, please consult
the documentation that came with your server for more information on
how to do this.
</para>
<para>Because AOL Server doesn't support <filename>.htaccess</filename>
files, you'll have to create a <glossterm linkend="gloss-tcl">TCL</glossterm>
script. You should create an <filename>aolserver/modules/tcl/filter.tcl</filename>
file (the filename shouldn't matter) with the following contents (change
<computeroutput>/bugzilla/</computeroutput> to the web-based path to
your Bugzilla installation):
</para>
<programlisting>
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
ns_register_filter preauth GET /bugzilla/*.pl filter_deny
ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
ns_register_filter preauth GET /bugzilla/data/* filter_deny
ns_register_filter preauth GET /bugzilla/template/* filter_deny
proc filter_deny { why } {
ns_log Notice "filter_deny"
return "filter_return"
}
</programlisting>
<warning>
<para>This probably doesn't account for all possible editor backup
files so you may wish to add some additional variations of
<filename>localconfig</filename>. For more information, see
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=186383">
bug 186383</ulink> or <ulink
url="http://online.securityfocus.com/bid/6501">Bugtraq ID 6501</ulink>.
</para>
</warning>
<note>
<para>If you are using webdot from research.att.com (the default
configuration for the <option>webdotbase</option> paramater), you
will need to allow access to <filename>data/webdot/*.dot</filename>
for the reasearch.att.com machine.
</para>
<para>If you are using a local installation of <ulink
url="http://www.graphviz.org">GraphViz</ulink>, you will need to allow
everybody to access <filename>*.png</filename>,
<filename>*.gif</filename>, <filename>*.jpg</filename>, and
<filename>*.map</filename> in the
<filename class="directory">data/webdot</filename> directory.
</para>
</note>
</section>
</section> </section>
<section id="install-config-bugzilla"> <section id="install-config-bugzilla">
...@@ -1152,6 +1128,14 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s ...@@ -1152,6 +1128,14 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s
front page. If not, consult the Troubleshooting section, front page. If not, consult the Troubleshooting section,
<xref linkend="troubleshooting"/>. <xref linkend="troubleshooting"/>.
</para> </para>
<note>
<para>
The URL above may be incorrect if you installed Bugzilla into a
subdirectory or used a symbolic link from your web site root to
the Bugzilla directory.
</para>
</note>
<para> <para>
Log in with the administrator account you defined in the last Log in with the administrator account you defined in the last
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment