Skip to content

bugzilla
bugzilla
Commit f643372f authored by jake%bugzilla.org's avatar jake%bugzilla.org
Browse files
Options

Bug 256019 - The documentation was unclear regarding what to do if the…

Bug 256019 - The documentation was unclear regarding what to do if the administrator gets logged out while "shutdownhtml" is active. Patch by Shane H. W. Travis <travis@sedsystems.ca> r=jake
parent d6d0b782
Hide whitespace changes
Inline Side-by-side
Showing with 167 additions and 127 deletions
docs/xml/administration.xml
View file @ f643372f
...@@ -5,10 +5,12 @@ ...@@ -5,10 +5,12 @@
<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>
...@@ -17,189 +19,228 @@ ...@@ -17,189 +19,228 @@
<procedure> <procedure>
<step> <step>
<para> <para>
<command>maintainer</command>: <command>maintainer</command>:
The maintainer parameter is the email address of the person
responsible for maintaining this The maintainer parameter is the email address of the person
Bugzilla installation. The address need not be that of a valid Bugzilla responsible for maintaining this Bugzilla installation.
account.</para> The address need not be that of a valid Bugzilla account.
</para>
</step> </step>
<step> <step>
<para> <para>
<command>urlbase</command>: <command>urlbase</command>:
This parameter defines the fully qualified domain name and web
server path to your Bugzilla installation.</para> This parameter defines the fully qualified domain name and web
server path to your Bugzilla installation.
<para>For example, if your Bugzilla query page is </para>
<filename>http://www.foo.com/bugzilla/query.cgi</filename>,
set your <quote>urlbase</quote> <para>
to <filename>http://www.foo.com/bugzilla/</filename>.</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>
<step> <step>
<para> <para>
<command>makeproductgroups</command>: <command>makeproductgroups</command>:
This dictates whether or not to automatically create groups
when new products are created. This dictates whether or not to automatically create groups
when new products are created.
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<command>useentrygroupdefault</command>: <command>useentrygroupdefault</command>:
Bugzilla products can have a group associated with them, so that
certain users can only see bugs in certain products. When this Bugzilla products can have a group associated with them, so that
parameter is set to <quote>on</quote>, this certain users can only see bugs in certain products. When this
causes the initial group controls on newly created products parameter is set to <quote>on</quote>, this
to place all newly-created bugs in the group causes the initial group controls on newly created products
having the same name as the product immediately. to place all newly-created bugs in the group
After a product is initially created, the group controls having the same name as the product immediately.
can be further adjusted without interference by After a product is initially created, the group controls
this mechanism.</para> can be further adjusted without interference by
this mechanism.
</para>
</step> </step>
<step> <step>
<para> <para>
<command>shadowdb</command>: <command>shadowdb</command>:
You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only table-level You run into an interesting problem when Bugzilla reaches a
write locking. What this means is that if someone needs to make a high level of continuous activity. MySQL supports only table-level
change to a bug, they will lock the entire table until the operation write locking. What this means is that if someone needs to make a
is complete. Locking for write also blocks reads until the write is change to a bug, they will lock the entire table until the operation
complete. Note that more recent versions of mysql support row level is complete. Locking for write also blocks reads until the write is
locking using different table types. These types are slower than the complete. Note that more recent versions of mysql support row level
standard type, and Bugzilla does not yet take advantage of features locking using different table types. These types are slower than the
such as transactions which would justify this speed decrease. The standard type, and Bugzilla does not yet take advantage of features
Bugzilla team are, however, happy to hear about any experiences with such as transactions which would justify this speed decrease. The
row level locking and Bugzilla.</para> Bugzilla team are, however, happy to hear about any experiences with
row level locking and Bugzilla.
<para>The <quote>shadowdb</quote> </para>
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 <para>
continue unimpeded on a read-only shadow copy of the database. The <quote>shadowdb</quote> parameter was designed to get around
Although your database size will double, a shadow database can cause this limitation. While only a single user is allowed to write to
an enormous performance improvement when implemented on extremely a table at a time, reads can continue unimpeded on a read-only
high-traffic Bugzilla databases.</para> 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 <para>
shadow bug database. You will need to set the host and port settings The value of the parameter defines the name of the shadow bug
from the params page, and set up replication in your database server database. You will need to set the host and port settings from
so that updates reach this readonly mirror. Consult your database the params page, and set up replication in your database server
documentation for more detail.</para> so that updates reach this readonly mirror. Consult your database
documentation for more detail.
</para>
</step> </step>
<step> <step>
<para> <para>
<command>shutdownhtml</command>: <command>shutdownhtml</command>:
If you need to shut down Bugzilla to perform administration, enter If you need to shut down Bugzilla to perform administration, enter
some descriptive HTML here and anyone who tries to use Bugzilla will some descriptive text (with embedded HTML codes, if you'd like)
receive a page to that effect. Obviously, editparams.cgi will into this box. Anyone who tries to use Bugzilla (including admins)
still be accessible so you can remove the HTML and re-enable Bugzilla. will receive a page displaying this text. Users can neither log in
:-) nor log out while shutdownhtml is enabled.
</para> </para>
<note>
<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>
</step> </step>
<step> <step>
<para> <para>
<command>passwordmail</command>: <command>passwordmail</command>:
Every time a user creates an account, the text of Every time a user creates an account, the text of this parameter
this parameter (with substitutions) is sent to the new user along with (with substitutions) is sent to the new user along with their
their password message.</para> password message.
</para>
<para>Add any text you wish to the "passwordmail" parameter box. For <para>
instance, many people choose to use this box to give a quick training Add any text you wish to the "passwordmail" parameter box. For
blurb about how to use Bugzilla at your site.</para> instance, many people choose to use this box to give a quick
training blurb about how to use Bugzilla at your site.
</para>
</step> </step>
<step> <step>
<para> <para>
<command>movebugs</command>: <command>movebugs</command>:
This option is an undocumented feature to allow moving bugs This option is an undocumented feature to allow moving bugs
between separate Bugzilla installations. You will need to understand between separate Bugzilla installations. You will need to understand
the source code in order to use this feature. Please consult the source code in order to use this feature. Please consult
<filename>movebugs.pl</filename> in your Bugzilla source tree for <filename>movebugs.pl</filename> in your Bugzilla source tree for
further documentation, such as it is. further documentation, such as it is.
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<command>useqacontact</command>: <command>useqacontact</command>:
This allows you to define an email address for each component, in This allows you to define an email address for each component,
addition in addition to that of the default owner, who will be sent
to that of the default owner, who will be sent carbon copies of carbon copies of incoming bugs.
incoming bugs.</para> </para>
</step> </step>
<step> <step>
<para> <para>
<command>usestatuswhiteboard</command>: <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 This defines whether you wish to have a free-form, overwritable field
that it can be deleted or modified with ease, and provides an associated with each bug. The advantage of the Status Whiteboard is
easily-searchable field for indexing some bugs that have some trait that it can be deleted or modified with ease, and provides an
in common. easily-searchable field for indexing some bugs that have some trait
in common.
</para> </para>
</step> </step>
<step> <step>
<para> <para>
<command>whinedays</command>: <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 Set this to the number of days you want to let bugs go
untouched new bugs. If you do not plan to use this feature, simply do in the NEW or REOPENED state before notifying people they have
not set up the whining cron job described in the installation untouched new bugs. If you do not plan to use this feature, simply
instructions, or set this value to "0" (never whine).</para> do not set up the whining cron job described in the installation
instructions, or set this value to "0" (never whine).
</para>
</step> </step>
<step> <step>
<para> <para>
<command>commenton*</command>: <command>commenton*</command>:
All these
fields allow you to dictate what changes can pass without comment, All these fields allow you to dictate what changes can pass
and which must have a comment from the person who changed them. without comment, and which must have a comment from the
Often, administrators will allow users to add themselves to the CC person who changed them. Often, administrators will allow
list, accept bugs, or change the Status Whiteboard without adding a users to add themselves to the CC list, accept bugs, or
comment as to their reasons for the change, yet require that most change the Status Whiteboard without adding a comment as to
other changes come with an explanation.</para> their reasons for the change, yet require that most other
changes come with an explanation.
<para>Set the "commenton" options according to your site policy. It </para>
is a wise idea to require comments when users resolve, reassign, or
reopen bugs at the very least. <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.
</para>
<note> <note>
<para>It is generally far better to require a developer comment <para>
when resolving bugs than not. Few things are more annoying to bug It is generally far better to require a developer comment
database users than having a developer mark a bug "fixed" without when resolving bugs than not. Few things are more annoying to bug
any comment as to what the fix was (or even that it was truly database users than having a developer mark a bug "fixed" without
fixed!)</para> any comment as to what the fix was (or even that it was truly
fixed!)
</para>
</note> </note>
</para>
</step> </step>
<step> <step>
<para> <para>
<command>supportwatchers</command>: <command>supportwatchers</command>:
Turning on this option allows users to ask to receive copies of Turning on this option allows users to ask to receive copies
all a particular other user's bug email. This is, of of bug mail sent to another user. Watching a user with
course, subject to the groupset restrictions on the bug; if the different group permissions is not a way to 'get around' the
<quote>watcher</quote> system; copied emails are still subject to the normal groupset
would not normally be allowed to view a bug, the watcher cannot get permissions of a bug, and <quote>watchers</quote> will only be
around the system by setting herself up to watch the bugs of someone copied on emails from bugs they would normally be allowed to view.
with bugs outside her privileges. They would still only receive email </para>
updates for those bugs she could normally view.</para>
</step> </step>
<step> <step>
<para> <para>
<command>noresolveonopenblockers</command>: <command>noresolveonopenblockers</command>:
...@@ -209,7 +250,6 @@ ...@@ -209,7 +250,6 @@
is affected. Users will be still able to resolve bugs to is affected. Users will be still able to resolve bugs to
resolutions other than FIXED if they have unresolved dependent resolutions other than FIXED if they have unresolved dependent
bugs. bugs.
</para> </para>
</step> </step>
......
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