Skip to content

bugzilla
bugzilla
Commit d7e7e09f authored by gerv%gerv.net's avatar gerv%gerv.net
Browse files
Options

Bug 139051 - fix misspelling of "privilege". Patch by mental <xor@ivwnet.com>, 2xr=bbaetz.

parent 0d0367e5
Show whitespace changes
Inline Side-by-side
Showing with 1398 additions and 1061 deletions
docs/en/xml/administration.xml
View file @ d7e7e09f
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<!-- TOC <chapter id="administration">
Chapter: Administration <title>Administering Bugzilla</title>
Localconfig and Checksetup.pl customizations <subtitle>
The Email Gateway Or, I just got this cool thing installed. Now what the heck do I
Editing parameters do with it?
Deciding your site policies </subtitle>
The Shadow Database
Customizing password mail & layout
The Whining Cron
Why you shouldn't allow deletion
User administration
Creating Users
Disabling Users
User Permissions
Product Administration
Creating products
Creating components
Assigning default owners and Q/A contacts to components
Product Milestones
Product Versions
Voting
-->
<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>
<PARA> <para>
So you followed the README isntructions to the letter, and So you followed <quote><xref linkend="installation" /></quote> to the
just logged into bugzilla with your super-duper god account and you are sitting at the query letter, and logged into Bugzilla for the very first time with your
screen. Yet, you have nothing to query. Your first act of business needs to be to setup the super-duper god account. You sit, contentedly staring at the
operating parameters for bugzilla.</PARA> 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"> <section id="postinstall-check">
<TITLE>Post-Installation Checklist</TITLE> <title>Post-Installation Checklist</title>
<PARA> <para>
After installation, follow the checklist below to ensure that After installation, follow the checklist below to help ensure
you have a successful installation. that you have a successful installation. If you do not see a
If you do not see a recommended setting for a parameter, recommended setting for a parameter, consider leaving it at the
consider leaving it at the default default while you perform your initial tests on your Bugzilla
while you perform your initial tests on your Bugzilla setup. setup.
</PARA> </para>
<INDEXTERM> <indexterm>
<PRIMARY>checklist</PRIMARY> <primary>checklist</primary>
</INDEXTERM> </indexterm>
<PROCEDURE> <procedure>
<STEP> <step>
<PARA> <para>
Bring up "editparams.cgi" in your web browser. For instance, to edit parameters Bring up <filename>editparams.cgi</filename> in your web
at mozilla.org, the URL would be <ULINK URL="http://bugzilla.mozilla.org/editparams.cgi"> browser. This should be available as the <quote>edit
http://bugzilla.mozilla.org/editparams.cgi</ULINK>, also available under the "edit parameters" parameters</quote> link from any Bugzilla screen once you
link on your query page. have logged in.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>The <quote>maintainer</quote> is the email address of
Set "maintainer" to <EMPHASIS>your</EMPHASIS> email address. the person responsible for maintaining this Bugzilla
This allows Bugzilla's error messages installation. The maintainer need not be a valid Bugzilla
to display your email 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. address and allow people to contact you for help.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>The <quote>urlbase</quote> parameter defines the fully
Set "urlbase" to the URL reference for your Bugzilla installation. qualified domain name and web server path to your Bugzilla
If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi, installation.</para>
your url base is http://www.foo.com/bugzilla/ <para>
</PARA> For example, if your bugzilla query page is
</STEP> http://www.foo.com/bugzilla/query.cgi, set your
<STEP> <quote>urlbase</quote> is http://www.foo.com/bugzilla/.
<PARA> </para>
Set "usebuggroups" to "1" <EMPHASIS>only</EMPHASIS> </step>
if you need to restrict access to products. <step>
I suggest leaving this parameter <EMPHASIS>off</EMPHASIS> <para><quote>usebuggroups</quote> dictates whether or not to
while initially testing your Bugzilla. implement group-based security for Bugzilla. If set,
</PARA> Bugzilla bugs can have an associated groupmask defining
</STEP> which groups of users are allowed to see and edit the
<STEP> bug.</para>
<PARA> <para>
Set "usebuggroupsentry" to "1" if you want to restrict access to products. Set "usebuggroups" to "on" <emphasis>only</emphasis> if you
Once again, if you are simply testing your installation, I suggest against may wish to restrict access to products. I suggest leaving
turning this parameter on; the strict security checking may stop you from this parameter <emphasis>off</emphasis> while initially
being able to modify your new entries. testing your Bugzilla.
</PARA> </para>
</STEP> </step>
<STEP> <step>
<PARA> <para>
Set "shadowdb" to "bug_shadowdb" if you will be <quote>usebuggroupsentry</quote>, when set to
running a *very* large installation of Bugzilla. <quote>on</quote>, requires that all bugs have an associated
The shadow database enables many simultaneous users groupmask when submitted. This parameter is made for those
to read and write to the database installations where product isolation is a necessity.
without interfering with one another. </para>
<NOTE> <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>
</step>
<step>
<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. 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>
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.
<note>
<para>
Enabling "shadowdb" can adversely affect the stability Enabling "shadowdb" can adversely affect the stability
of your installation of Bugzilla. of your installation of Bugzilla. You should regularly
You may frequently need to manually synchronize your databases, check that your database is in sync. It is often
or schedule nightly syncs advisable to force a shadow database sync nightly via
via "cron" <quote>cron</quote>.
</PARA> </para>
</NOTE> </note> Once again, in testing you should avoid this option
Once again, in testing you should -- use it if or when you <emphasis>need</emphasis> to use
avoid this option -- use it if or when you <EMPHASIS>need</EMPHASIS> to use it, and have it, and have repeatedly run into the problem it was designed
repeatedly run into the problem it was designed to solve -- very long wait times while to solve -- very long wait times while attempting to commit
attempting to commit a change to the database. a change to the database. Mozilla.org began needing
</PARA> <quote>shadowdb</quote> when they reached around 40,000
<PARA> Bugzilla users with several hundred Bugzilla bug changes and
If you use the "shadowdb" option, comments per day.
it is only natural that you should turn the "queryagainstshadowdb" </para>
option "On" as well. Otherwise you are replicating data into a shadow database for no reason! <para>
</PARA> If you use the "shadowdb" option, it is only natural that
</STEP> you should turn the "queryagainstshadowdb" option "On" as
<STEP> well. Otherwise you are replicating data into a shadow
<PARA> database for no reason!
If you have custom logos or HTML you must put in place to fit within your site design guidelines, </para>
place the code in the "headerhtml", "footerhtml", "errorhtml", </step>
"bannerhtml", or "blurbhtml" text boxes. <step>
<NOTE> <para><quote>headerhtml</quote>, <quote>footerhtml</quote>,
<PARA> <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 The "headerhtml" text box is the HTML printed out
<EMPHASIS>before</EMPHASIS> any other code on the page. <emphasis>before</emphasis> any other code on the page,
If you have a special banner, put the code for it in "bannerhtml". except the CONTENT-TYPE header sent by the Bugzilla
You may want to leave these engine. If you have a special banner, put the code for
settings at the defaults initially. it in "bannerhtml". You may want to leave these settings
</PARA> at the defaults initially.
</NOTE> </para>
</PARA> </note>
</STEP> </para>
<STEP> </step>
<PARA> <step>
Add any text you wish to the "passwordmail" parameter box. For instance, <para><quote>passwordmail</quote> is rather simple. Every
many people choose to use this box to give a quick training blurb about how to time a user creates an account, the text of this parameter
use Bugzilla at your site. is read as the text to send to the new user along with their
</PARA> password message.</para>
</STEP> <para>
<STEP> Add any text you wish to the "passwordmail" parameter box.
<PARA> For instance, many people choose to use this box to give a
Ensure "newemailtech" is "on". quick training blurb about how to use Bugzilla at your site.
Your users will thank you. This is the default in the post-2.12 world, and is </para>
only an issue if you are upgrading. </step>
</PARA> <step>
</STEP> <para><quote>useqacontact</quote> allows you to define an
<STEP> email address for each component, in addition to that of the
<PARA> default owner, who will be sent carbon copies of incoming
Do you want to use the qa contact ("useqacontact") bugs. The critical difference between a QA Contact and an
and status whiteboard ("usestatuswhiteboard") fields? Owner is that the QA Contact follows the component. If you
These fields are useful because they allow for more flexibility, reassign a bug from component A to component B, the QA
particularly when you have an existing Contact for that bug will change with the reassignment,
Quality Assurance and/or Release Engineering team, regardless of owner.</para>
but they may not be needed for smaller installations. <para><quote>usestatuswhiteboard</quote> defines whether you
</PARA> wish to have a free-form, overwritable field associated with
</STEP> each bug. The advantage of the Status Whiteboard is that it
<STEP> can be deleted or modified with ease, and provides an
<PARA> easily-searchable field for indexing some bugs that have
Set "whinedays" to the amount of days you want to let bugs go some trait in common. Many people will put <quote>help
in the "New" or "Reopened" state before wanted</quote>, <quote>stalled</quote>, or <quote>waiting
notifying people they have untouched new bugs. If you do not plan to use this feature, simply do on reply from somebody</quote> messages into the Status
not set up the whining cron job described in the README, or set this value to "0". Whiteboard field so those who peruse the bugs are aware of
</PARA> their status even more than that which can be indicated by
</STEP> the Resolution fields.</para>
<STEP> <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>
</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 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>
</step>
<step>
<para><quote>commenton</quote> 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. Set the "commenton" options according to your site policy.
It is a wise idea to require comments when users It is a wise idea to require comments when users resolve,
resolve, reassign, or reopen bugs. reassign, or reopen bugs at the very least.
<NOTE> <note>
<PARA> <para>
It is generally far better to require a developer comment when resolving bugs than not. It is generally far better to require a developer
Few things are more annoying to bug database users than having a developer comment when resolving bugs than not. Few things are
mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) more annoying to bug database users than having a
</PARA> developer mark a bug "fixed" without any comment as to
</NOTE> what the fix was (or even that it was truly fixed!)
</PARA> </para>
</STEP> </note>
<STEP> </para>
<PARA> </step>
Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their <step>
respective areas, and can offer many other benefits, such as allowing a developer to pick up a <para>The <quote>supportwatchers</quote> option can be an
former engineer's bugs without requiring her to change all the information in the bug. exceptionally powerful tool in the hands of a power Bugzilla
</PARA> user. By enabling this option, you allow users to receive
</STEP> email updates whenever other users receive email updates.
</PROCEDURE> This is, of course, subject to the groupset restrictions on
</SECTION> 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>
</step>
</procedure>
</section>
<SECTION id="useradmin"> <section id="useradmin">
<TITLE>User Administration</TITLE> <title>User Administration</title>
<PARA> <para>
User administration is one of the easiest parts of Bugzilla. User administration is one of the easiest parts of Bugzilla.
Keeping it from getting out of hand, however, can become a challenge. Keeping it from getting out of hand, however, can become a
</PARA> challenge.
</para>
<SECTION id="defaultuser"> <section id="defaultuser">
<TITLE>Creating the Default User</TITLE> <title>Creating the Default User</title>
<PARA> <para>
When you first run checksetup.pl after installing Bugzilla, it will prompt you When you first run checksetup.pl after installing Bugzilla, it
for the administrative username (email address) and password for this "super user". will prompt you for the administrative username (email
If for some reason you were to delete the "super user" account, re-running address) and password for this "super user". If for some
checksetup.pl will again prompt you for this username and password. reason you were to delete the "super user" account, re-running
</PARA> checksetup.pl will again prompt you for this username and
<TIP> password.
<PARA> </para>
If you wish to add more administrative users, you must use the MySQL interface. <tip>
Run "mysql" from the command line, and use these commands ("mysql>" denotes the <para>
mysql prompt, not something you should type in): If you wish to add more administrative users, you must use the
<COMMAND><PROMPT>mysql></PROMPT> use bugs;</COMMAND> MySQL interface. Run "mysql" from the command line, and use
<COMMAND><PROMPT>mysql></PROMPT> update profiles set groupset=0x7ffffffffffffff these commands ("mysql>" denotes the mysql prompt, not
where login_name = "(user's login name)"; </COMMAND> something you should type in):
</PARA> <command><prompt>mysql></prompt> use bugs;</command>
</TIP> <command><prompt>mysql></prompt> update profiles set
</SECTION> groupset=0x7ffffffffffffff where login_name = "(user's
login name)"; </command>
</para>
<para>Yes, that is <emphasis>fourteen</emphasis>
<quote>f</quote>'s. A whole lot of f-ing going on if you
want to create a new administator.</para>
</tip>
</section>
<SECTION id="manageusers"> <section id="manageusers">
<TITLE>Managing Other Users</TITLE> <title>Managing Other Users</title>
<SECTION id="login"> <section id="login">
<TITLE>Logging In</TITLE> <title>Logging In</title>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Open the index.html page for your Bugzilla installation in your browser window. Open the index.html page for your Bugzilla installation
</PARA> in your browser window.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Click the "Query Existing Bug Reports" link. Click the "Query Existing Bug Reports" link.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Click the "Log In" link at the foot of the page. Click the "Log In" link at the foot of the page.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Type your email address, and the password which was emailed to you when you Type your email address, and the password which was
created your Bugzilla account, into the spaces provided. emailed to you when you created your Bugzilla account,
</PARA> into the spaces provided.
</LISTITEM> </para>
</ORDEREDLIST> </listitem>
<PARA>Congratulations, you are logged in!</PARA> </orderedlist>
</SECTION> <para>Congratulations, you are logged in!</para>
</section>
<SECTION id="createnewusers"> <section id="createnewusers">
<TITLE>Creating new users</TITLE> <title>Creating new users</title>
<PARA> <para>
Your users can create their own user accounts by clicking the "New Account" Your users can create their own user accounts by clicking
link at the bottom of each page. the "New Account" link at the bottom of each page. However,
However, should you desire to create user accounts ahead of time, here is how you do it. should you desire to create user accounts ahead of time,
</PARA> here is how you do it.
<ORDEREDLIST> </para>
<LISTITEM> <orderedlist>
<PARA> <listitem>
After logging in, click the "Users" link at the footer of the query page. <para>
</PARA> After logging in, click the "Users" link at the footer
</LISTITEM> of the query page.
<LISTITEM> </para>
<PARA> </listitem>
To see a specific user, type a portion of their login name <listitem>
in the box provided and click "submit". <para>
To see all users, simply click the "submit" button. To see a specific user, type a portion of their login
You must click "submit" here to be able to add a new user. name in the box provided and click "submit". To see all
</PARA> users, simply click the "submit" button. You must click
<TIP> "submit" here to be able to add a new user.
<PARA> </para>
More functionality is available via the list on the right-hand side <tip>
of the text entry box. <para>
You can match what you type as a case-insensitive substring (the default) More functionality is available via the list on the
of all users on your system, a case-sensitive regular expression right-hand side of the text entry box. You can match
(please see the "man regexp" manual page for details on regular expression syntax), what you type as a case-insensitive substring (the
or a <EMPHASIS>reverse</EMPHASIS> regular expression match, default) of all users on your system, a case-sensitive
where every user name which does NOT match the regular expression regular expression (please see the <command>man
is selected. regexp</command> manual page for details on regular
</PARA> expression syntax), or a <emphasis>reverse</emphasis>
</TIP> regular expression match, where every user name which
</LISTITEM> does NOT match the regular expression is selected.
<LISTITEM> </para>
<PARA> </tip>
Click the "Add New User" link at the bottom of the user list </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Click the "Add New User" link at the bottom of the user
<PARA> list
Fill out the form presented. This page is self-explanatory. When done, click "submit". </para>
</PARA> </listitem>
<NOTE> <listitem>
<PARA> <para>
Adding a user this way will <EMPHASIS>not</EMPHASIS> send an email Fill out the form presented. This page is
informing them of their username and password. self-explanatory. When done, click "submit".
In general, it is preferable to log out and use the "New Account" </para>
button to create users, as it will pre-populate all the required fields and also notify <note>
the user of her account name and password. <para>
</PARA> Adding a user this way will <emphasis>not</emphasis>
</NOTE> send an email informing them of their username and
</LISTITEM> password. While useful for creating dummy accounts
</ORDEREDLIST> (watchers which shuttle mail to another system, for
</SECTION> instance, or email addresses which are a mailing
list), in general it is preferable to log out and use
the <quote>New Account</quote> button to create users,
as it will pre-populate all the required fields and
also notify the user of her account name and
password.
</para>
</note>
</listitem>
</orderedlist>
</section>
<SECTION id="disableusers"> <section id="disableusers">
<TITLE>Disabling Users</TITLE> <title>Disabling Users</title>
<PARA> <para>
I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen, I bet you noticed that big "Disabled Text" entry box
when you edit an account? available from the "Add New User" screen, when you edit an
By entering any text in this box and selecting "submit", account? By entering any text in this box and selecting
you have prevented the user from using Bugzilla via the web interface. "submit", you have prevented the user from using Bugzilla
Your explanation, written in this text box, will be presented to the user via the web interface. Your explanation, written in this
the next time she attempts to use the system. text box, will be presented to the user the next time she
<WARNING> attempts to use the system.
<PARA> <warning>
Don't disable your own administrative account, or you will hate life! <para>
</PARA> Don't disable your own administrative account, or you
</WARNING> will hate life!
</PARA> </para>
</SECTION> <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"> <section id="modifyusers">
<TITLE>Modifying Users</TITLE> <title>Modifying Users</title>
<PARA> <para>
Here I will attempt to describe the function of each option on the user edit screen. Here I will attempt to describe the function of each option
</PARA> on the Edit User screen.
<ITEMIZEDLIST> </para>
<LISTITEM> <itemizedlist>
<PARA> <listitem>
<EMPHASIS>Login Name</EMPHASIS>: This is generally the user's email address. <para>
However, if you have edited your system parameters, <emphasis>Login Name</emphasis>: This is generally the
this may just be the user's login name or some other identifier. user's email address. However, if you have edited your
<TIP> system parameters, this may just be the user's login
<PARA> name or some other identifier.
For compatability reasons, you should probably <tip>
stick with email addresses as user login names. It will make your life easier. <para>
</PARA> For compatability reasons, you should probably stick
</TIP> with email addresses as user login names. It will
</PARA> make your life easier.
</LISTITEM> </para>
<LISTITEM> </tip>
<PARA> </para>
<EMPHASIS>Real Name</EMPHASIS>: Duh! </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> <emphasis>Real Name</emphasis>: Duh!
<PARA> </para>
<EMPHASIS>Password</EMPHASIS>: You will only see asterisks in versions </listitem>
of Bugzilla newer than 2.10 or early 2.11. You can change the user password here. <listitem>
</PARA> <para>
</LISTITEM> <emphasis>Password</emphasis>: You can change the user
<LISTITEM> password here. It is normal to only see asterisks.
<PARA> </para>
<EMPHASIS>Email Notification</EMPHASIS>: You may choose from one of three options: </listitem>
<ORDEREDLIST> <listitem>
<LISTITEM> <para>
<PARA> <emphasis>Email Notification</emphasis>: You may choose
from one of three options:
<orderedlist>
<listitem>
<para>
All qualifying bugs except those which I change: All qualifying bugs except those which I change:
The user will be notified of any change to any bug The user will be notified of any change to any bug
for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher". for which she is the reporter, assignee, QA
</PARA> Contact, CC recipient, or "watcher".
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Only those bugs which I am listed on the CC line: Only those bugs which I am listed on the CC line:
The user will not be notified of changes to bugs where she is the assignee, The user will not be notified of changes to bugs
reporter, or Q/A contact, but will receive them if she is on the CC list. where she is the assignee, reporter, or QA
<NOTE> Contact, but will receive them if she is on the CC
<PARA> list.
She will still receive whining cron emails if you set up the "whinemail" feature. <note>
</PARA> <para>
</NOTE> She will still receive whining cron emails if
</PARA> you set up the "whinemail" feature.
</LISTITEM> </para>
<LISTITEM> </note>
<PARA> </para>
<EMPHASIS>All Qualifying Bugs</EMPHASIS>: This user is a glutton for punishment. </listitem>
If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher", <listitem>
she will get email updates regarding the bug. <para>
</PARA> <emphasis>All Qualifying Bugs</emphasis>: This
</LISTITEM> user is a glutton for punishment. If her name is
</ORDEREDLIST> in the reporter, QA Contact, CC, assignee, or is a
</PARA> "watcher", she will get email updates regarding
<PARA> the bug.
<EMPHASIS>Disable Text</EMPHASIS>: If you type anything in this box, </para>
including just a space, the user account is disabled from making any changes </listitem>
to bugs via the web interface, and what you type in this box is presented as the reason. </orderedlist>
<WARNING> </para>
<PARA>Don't disable the administrator account!</PARA> <para>
</WARNING> <emphasis>Disable Text</emphasis>: If you type anything
<NOTE> in this box, including just a space, the user account is
<PARA> disabled from making any changes to bugs via the web
As of this writing, the user can still submit bugs via the e-mail gateway, interface, and what you type in this box is presented as
if you set it up, despite the disabled text field. The e-mail gateway should the reason.
<EMPHASIS>not</EMPHASIS> be enabled for secure installations of Bugzilla. <warning>
</PARA> <para>Don't disable the administrator account!</para>
</NOTE> </warning>
</PARA> <note>
</LISTITEM> <para>
<LISTITEM> As of this writing, the user can still submit bugs
<PARA> via the e-mail gateway, if you set it up, despite
<EMPHASIS>CanConfirm</EMPHASIS>: This field is only used if you have enabled the disabled text field. The e-mail gateway should
"unconfirmed" status in your parameters screen. If you enable this for a user, <emphasis>not</emphasis> be enabled for secure
that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status). installations of Bugzilla.
Be judicious about allowing users to turn this bit on for other users. </para>
</PARA> </note>
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<EMPHASIS>Creategroups</EMPHASIS>: This option will allow a user to create and <para>
destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security <emphasis>CanConfirm</emphasis>: This field is only used
option "usebuggroupsentry" in your parameters, this setting has no effect. if you have enabled "unconfirmed" status in your
</PARA> parameters screen. If you enable this for a user, that
</LISTITEM> user can then move bugs from "Unconfirmed" to
<LISTITEM> "Confirmed" status (e.g.: "New" status). Be judicious
<PARA> about allowing users to turn this bit on for other
<EMPHASIS>Editbugs</EMPHASIS>: Unless a user has this bit set, they can only edit users.
those bugs for which they are the assignee or the reporter. </para>
<NOTE> </listitem>
<PARA> <listitem>
Leaving this option unchecked does not prevent users from adding <para>
comments to a bug! They simply cannot change a bug priority, severity, <emphasis>Creategroups</emphasis>: This option will
etc. unless they are the assignee or reporter. allow a user to create and destroy groups in Bugzilla.
</PARA> Unless you are using the Bugzilla GroupSentry security
</NOTE> option "usebuggroupsentry" in your parameters, this
</PARA> setting has no effect.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<EMPHASIS>Editcomponents</EMPHASIS>: This flag allows a user to create new <para>
products and components, as well as modify and destroy those that have no bugs <emphasis>Editbugs</emphasis>: Unless a user has this
associated with them. If a product or component has bugs associated with it, bit set, they can only edit those bugs for which they
those bugs must be moved to a different product or component before Bugzilla are the assignee or the reporter.
will allow them to be destroyed. The name of a product or component can be <note>
changed without affecting the associated bugs, but it tends to annoy <para>
the hell out of your users when these change a lot. Leaving this option unchecked does not prevent users
</PARA> from adding comments to a bug! They simply cannot
</LISTITEM> change a bug priority, severity, etc. unless they
<LISTITEM> are the assignee or reporter.
<PARA> </para>
<EMPHASIS>Editkeywords</EMPHASIS>: If you use Bugzilla's keyword functionality, </note>
enabling this feature allows a user can create and destroy keywords. </para>
As always, the keywords for existing bugs containing the keyword </listitem>
the user wishes to destroy must be changed before Bugzilla will allow it to die. <listitem>
You must be very careful about creating too many new keywords <para>
if you run a very large Bugzilla installation; keywords are global variables <emphasis>Editcomponents</emphasis>: This flag allows a
across products, and you can often run into a phenomenon called "keyword bloat". user to create new products and components, as well as
This confuses users, and then the feature goes unused. modify and destroy those that have no bugs associated
</PARA> with them. If a product or component has bugs
</LISTITEM> associated with it, those bugs must be moved to a
<LISTITEM> different product or component before Bugzilla will
<PARA> allow them to be destroyed. The name of a product or
<EMPHASIS>Editusers</EMPHASIS>: This flag allows a user do what you're doing component can be changed without affecting the
right now: edit other users. associated bugs, but it tends to annoy the hell out of
This will allow those with the right to do so to remove administrator your users when these change a lot.
priveleges from other users or grant them to themselves. Enable with care. </para>
</PARA> </listitem>
</LISTITEM> <listitem>
<LISTITEM> <para>
<PARA> <emphasis>Editkeywords</emphasis>: If you use Bugzilla's
<EMPHASIS>PRODUCT</EMPHASIS>: PRODUCT bugs access. This allows an administrator, keyword functionality, enabling this feature allows a
with product-level granularity, to specify in which products a user can edit bugs. user can create and destroy keywords. As always, the
The user must still have the "editbugs" privelege to edit bugs in this area; keywords for existing bugs containing the keyword the
this simply restricts them from even seeing bugs outside these boundaries if the administrator user wishes to destroy must be changed before Bugzilla
has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups, 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>
</listitem>
<listitem>
<para>
<emphasis>Editusers</emphasis>: This flag allows a user
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>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. this option has no effect.
</PARA> </para>
</LISTITEM> </listitem>
</ITEMIZEDLIST> </itemizedlist>
</SECTION> </section>
</SECTION> </section>
</SECTION> </section>
<SECTION id="programadmin"> <section id="programadmin">
<TITLE>Product, Component, Milestone, and Version Administration</TITLE> <title>Product, Component, Milestone, and Version
<EPIGRAPH> Administration</title>
<PARA> <epigraph>
<para>
Dear Lord, we have to get our users to do WHAT? Dear Lord, we have to get our users to do WHAT?
</PARA> </para>
</EPIGRAPH> </epigraph>
<SECTION id="products"> <section id="products">
<TITLE>Products</TITLE> <title>Products</title>
<SUBTITLE>Formerly, and in some spots still, called "Programs"</SUBTITLE> <subtitle>Formerly, and in some spots still, called
<PARA> "Programs"</subtitle>
<GLOSSTERM baseform="product" linkend="gloss_product">Products</GLOSSTERM> are the <para>
broadest category in Bugzilla, and you should have the least of these. <glossterm linkend="gloss-product" baseform="product">Products</glossterm> are
If your company makes computer games, you should have one product per game, the broadest category in Bugzilla, and you should have the
and possibly a few special products least of these. If your company makes computer games, you
(website, meetings...) should have one product per game, and possibly a few special
</PARA> products (website, meetings...)
<PARA> </para>
A Product (formerly called "Program", and still referred to that way <para>
in some portions of the source code) controls some very important functions. A Product (formerly called "Program", and still referred to
The number of "votes" available for users to vote for the most important bugs that way in some portions of the source code) controls some
is set per-product, as is the number of votes required to move a bug automatically very important functions. The number of "votes" available for
from the UNCONFIRMED status to the NEW status. One can close a Product for further users to vote for the most important bugs is set per-product,
bug entry and define various Versions available from the Edit Product screen. as is the number of votes required to move a bug automatically
</PARA> from the UNCONFIRMED status to the NEW status. One can close
<PARA>To create a new product:</PARA> a Product for further bug entry and define various Versions
<ORDEREDLIST> available from the Edit product screen.
<LISTITEM> </para>
<PARA> <para>To create a new product:</para>
<orderedlist>
<listitem>
<para>
Select "components" from the yellow footer Select "components" from the yellow footer
</PARA> </para>
<TIP> <tip>
<PARA> <para>
It may seem counterintuitive to click "components" when you want It may seem counterintuitive to click "components" when
to edit the properties associated with Products. This is one of a long you want to edit the properties associated with
list of things we want in Bugzilla 3.0... Products. This is one of a long list of things we want
</PARA> in Bugzilla 3.0...
</TIP> </para>
</LISTITEM> </tip>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Select the "Add" link to the right of "Add a new product". Select the "Add" link to the right of "Add a new product".
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Enter the name of the product and a description. Enter the name of the product and a description. The
The Description field is free-form. Description field is free-form.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
<TIP> <tip>
<PARA> <para>
Don't worry about the "Closed for bug entry", "Maximum Votes per person", Don't worry about the "Closed for bug entry", "Maximum Votes
"Maximum votes a person can put on a single bug", "Number of votes a bug in per person", "Maximum votes a person can put on a single
this Product needs to automatically get out of the UNCOMFIRMED state", bug", "Number of votes a bug in this Product needs to
and "Version" options yet. automatically get out of the UNCOMFIRMED state", and
We'll cover those in a few moments. "Version" options yet. We'll cover those in a few moments.
</PARA> </para>
</TIP> </tip>
</SECTION> </section>
<SECTION id="components"> <section id="components">
<TITLE>Components</TITLE> <title>Components</title>
<PARA> <para>
Components are subsections of a Product. Components are subsections of a Product.
<EXAMPLE> <example>
<TITLE>Creating some Components</TITLE> <title>Creating some Components</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
The computer game you are designing may a "UI" component, an "API" component, The computer game you are designing may have a "UI"
a "Sound System" component, and a "Plugins" component, each overseen by a different component, an "API" component, a "Sound System"
programmer. It often makes sense to divide Components in Bugzilla according to the component, and a "Plugins" component, each overseen by
natural divisions of responsibility within your Product or company. a different programmer. It often makes sense to divide
</PARA> Components in Bugzilla according to the natural
</INFORMALEXAMPLE> divisions of responsibility within your Product or
</EXAMPLE> company.
</para>
Each component has a owner and (if you turned it on in the parameters), a qa </informalexample>
contact. The owner should be the primary person who fixes bugs in that component. The QA </example> Each component has a owner and (if you turned it on
Contact should be the person who will ensure these bugs are completely fixed. The Owner, in the parameters), a QA Contact. The owner should be the
QA Contact, and Reporter will get email when new bugs are created in this Component and primary person who fixes bugs in that component. The QA
when these bugs change. Default Owner and Default QA Contact fields only dictate the Contact should be the person who will ensure these bugs are
<EMPHASIS>default assignments</EMPHASIS>; the Owner and Q/A Contact fields in a bug completely fixed. The Owner, QA Contact, and Reporter will get
are otherwise unrelated to the Component. email when new bugs are created in this Component and when
</PARA> 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>
<PARA> <para>
To create a new Component: To create a new Component:
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Select the "Edit components" link from the "Edit Product" page Select the "Edit components" link from the "Edit product"
</PARA> page
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
Select the "Add" link to the right of the "Add a new component" text <para>
on the "Select Component" page. Select the "Add" link to the right of the "Add a new
</PARA> component" text on the "Select Component" page.
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
Fill out the "Component" field, a short "Description", and the "Initial Owner". <para>
The "Component" field should not contain a space. The "Description" field is Fill out the "Component" field, a short "Description", and
free-form. The "Initial Owner" field must be that of a valid user already the "Initial Owner". The Component and Description fields
existing in the database. If the initial owner does not exist, Bugzilla are free-form; the "Initial Owner" field must be that of a
will refuse to create the component. user ID already existing in the database. If the initial
<TIP> owner does not exist, Bugzilla will refuse to create the
<PARA> component.
Is your "Default Owner" a user who is not yet in the database? <tip>
No problem. <para>
<ORDEREDLIST> Is your "Default Owner" a user who is not yet in the
<LISTITEM> database? No problem.
<PARA> <orderedlist>
Select the "Log out" link on the footer of the page. <listitem>
</PARA> <para>
</LISTITEM> Select the "Log out" link on the footer of the
<LISTITEM> page.
<PARA> </para>
Select the "New Account" link on the footer of the "Relogin" page </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Select the "New Account" link on the footer of
<PARA> the "Relogin" page
Type in the email address of the default owner you want to create </para>
in the "E-mail address" field, and her full name in the "Real name" </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. field, then select the "Submit Query" button.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Now select "Log in" again, type in your login information, and you Now select "Log in" again, type in your login
can modify the product to use the Default Owner information information, and you can modify the product to
you require. use the Default Owner information you require.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
</PARA> </para>
</TIP> </tip>
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Either "edit" more components or return to the "query" page on the ensuing Either Edit more components or return to the Bugzilla
"Addming new component" page. To return to the Product you were editing, you Query Page. To return to the Product you were editing, you
must select the "components" link as before. must select the Components link as before.
</PARA> </para>
</LISTITEM> </listitem>
</ORDEREDLIST> </orderedlist>
</SECTION> </section>
<SECTION id="versions"> <section id="versions">
<TITLE>Versions</TITLE> <title>Versions</title>
<PARA> <para>
Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", Versions are the revisions of the product, such as "Flinders
and "Flinders 2000". Using Versions helps you isolate code changes and are an aid 3.1", "Flinders 95", and "Flinders 2000". Using Versions
in reporting. helps you isolate code changes and are an aid in reporting.
<EXAMPLE> <example>
<TITLE>Common Use of Versions</TITLE> <title>Common Use of Versions</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
A user reports a bug A user reports a bug against Version "Beta 2.0" of your
against Version "Beta 2.0" of your product. The current Version of your software product. The current Version of your software is
is "Release Candidate 1", and no longer has the bug. This will "Release Candidate 1", and no longer has the bug. This
help you triage and classify bugs according to their relevance. It is also will help you triage and classify bugs according to
possible people may report bugs against bleeding-edge beta versions that are their relevance. It is also possible people may report
not evident in older versions of the software. This can help isolate code bugs against bleeding-edge beta versions that are not
changes that caused the bug evident in older versions of the software. This can
</PARA> help isolate code changes that caused the bug
</INFORMALEXAMPLE> </para>
</EXAMPLE> </informalexample>
<EXAMPLE> </example>
<TITLE>A Different Use of Versions</TITLE> <example>
<INFORMALEXAMPLE> <title>A Different Use of Versions</title>
<PARA> <informalexample>
This field has been used to good effect by an online service provider in a slightly <para>
different way. They had three versions of the product: "Production", "QA", This field has been used to good effect by an online
and "Dev". Although it may be the same product, a bug in the development service provider in a slightly different way. They had
environment is not normally as critical as a Production bug, nor does it three versions of the product: "Production", "QA", and
need to be reported publicly. When used in conjunction with Target Milestones, "Dev". Although it may be the same product, a bug in
one can easily specify the environment where a bug can be reproduced, and the development environment is not normally as critical
the Milestone by which it will be fixed. as a Production bug, nor does it need to be reported
</PARA> publicly. When used in conjunction with Target
</INFORMALEXAMPLE> Milestones, one can easily specify the environment where
</EXAMPLE> a bug can be reproduced, and the Milestone by which it
</PARA> will be fixed.
<PARA> </para>
</informalexample>
</example>
</para>
<para>
To create and edit Versions: To create and edit Versions:
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
From the "Edit Product" screen, select "Edit Versions" From the "Edit product" screen, select "Edit Versions"
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
You will notice that the product already has the default version "undefined". You will notice that the product already has the default
If your product doesn't use version numbers, you may want to leave this as it is version "undefined". If your product doesn't use version
or edit it so that it is "---". You can then go back to the edit versions page numbers, you may want to leave this as it is or edit it so
and add new versions to your product. that it is "---". You can then go back to the edit
</PARA> 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>
</PARA> Otherwise, click the "Add" button to the right of the "Add
</LISTITEM> a new version" text.
<LISTITEM> </para>
<PARA> </listitem>
Enter the name of the Version. This can be free-form characters up to the limit of the <listitem>
text box. Then select the "Add" button. <para>
</PARA> Enter the name of the Version. This can be free-form
</LISTITEM> characters up to the limit of the text box. Then select
<LISTITEM> the "Add" button.
<PARA> </para>
At this point you can select "Edit" to edit more Versions, or return to the "Query" </listitem>
page, from which you can navigate back to the product through the "components" link <listitem>
at the foot of the Query page. <para>
</PARA> At this point you can select "Edit" to edit more Versions,
</LISTITEM> or return to the "Query" page, from which you can navigate
</ORDEREDLIST> back to the product through the "components" link at the
</SECTION> foot of the Query page.
</para>
</listitem>
</orderedlist>
</section>
<SECTION id="milestones"> <section id="milestones">
<TITLE>Milestones</TITLE> <title>Milestones</title>
<PARA> <para>
Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that Milestones are "targets" that you plan to get a bug fixed by.
you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a For example, you have a bug that you plan to fix for your 3.0
bug that you plan to fix for 2.8, this would have a milestone of 2.8. release, it would be assigned the milestone of 3.0. Or, you
</PARA> have a bug that you plan to fix for 2.8, this would have a
<NOTE> milestone of 2.8.
<PARA> </para>
Milestone options will only appear for a Product if you turned the "usetargetmilestone" field <note>
in the "Edit Parameters" screen "On". <para>
</PARA> Milestone options will only appear for a Product if you
</NOTE> turned the "usetargetmilestone" field in the "Edit
<PARA> Parameters" screen "On".
To create new Milestones, set Default Milestones, and set Milestone URL: </para>
</PARA> </note>
<ORDEREDLIST> <para>
<LISTITEM> To create new Milestones, set Default Milestones, and set
<PARA> Milestone URL:
</para>
<orderedlist>
<listitem>
<para>
Select "edit milestones" Select "edit milestones"
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Select "Add" to the right of the "Add a new milestone" text Select "Add" to the right of the "Add a new milestone"
</PARA> text
</LISTITEM> </para>
<LISTITEM> </listitem>
<PARA> <listitem>
<para>
Enter the name of the Milestone in the "Milestone" field. Enter the name of the Milestone in the "Milestone" field.
You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255) You can optionally set the "Sortkey", which is a positive
that defines where in the list this particular milestone appears. or negative number (-255 to 255) that defines where in the
Select "Add". list this particular milestone appears. Select "Add".
</PARA> </para>
<EXAMPLE> <example>
<TITLE>Using SortKey with Target Milestone</TITLE> <title>Using SortKey with Target Milestone</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". Let's say you create a target milestone called
Later, you realize that you will have a public beta, called "Beta1". "Release 1.0", with Sortkey set to "0". Later, you
You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure realize that you will have a public beta, called
people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0" "Beta1". You can create a Milestone called "Beta1",
</PARA> with a Sortkey of "-1" in order to ensure people will
</INFORMALEXAMPLE> see the Target Milestone of "Beta1" earlier on the
</EXAMPLE> list than "Release 1.0"
</LISTITEM> </para>
<LISTITEM> </informalexample>
<PARA> </example>
If you want to add more milestones, select the "Edit" link. </listitem>
If you don't, well shoot, you have to go back to the "query" page and select "components" <listitem>
again, and make your way back to the Product you were editing. <para>
<NOTE> If you want to add more milestones, select the "Edit"
<PARA> link. If you don't, well shoot, you have to go back to the
This is another in the list of unusual user interface decisions that "query" page and select "components" again, and make your
we'd like to get cleaned up. Shouldn't there be a link to the effect of way back to the Product you were editing.
"edit the Product I was editing when I ended up here"? In any case, <note>
clicking "components" in the footer takes you back to the "Select product" <para>
screen, from which you can begin editing your product again. This is another in the list of unusual user interface
</PARA> decisions that we'd like to get cleaned up. Shouldn't
</NOTE> there be a link to the effect of "edit the Product I
</PARA> was editing when I ended up here"? In any case,
</LISTITEM> clicking "components" in the footer takes you back to
<LISTITEM> the "Select product" screen, from which you can begin
<PARA> editing your product again.
From the Edit Product screen again (once you've made your way back), enter the URL </para>
for a description of what your milestones are for this product in the "Milestone URL" field. </note>
It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" </para>
</PARA> </listitem>
<PARA> <listitem>
Some common uses of this field include product descriptions, product roadmaps, <para>
and of course a simple description of the meaning of each milestone. From the Edit product screen again (once you've made your
</PARA> way back), enter the URL for a description of what your
</LISTITEM> milestones are for this product in the "Milestone URL"
<LISTITEM> field. It should be of the format
<PARA> "http://www.foo.com/bugzilla/product_milestones.html"
If you're using Target Milestones, the "Default Milestone" field must have some </para>
kind of entry. If you really don't care if people set coherent Target Milestones, <para>
simply leave this at the default, "---". However, controlling and regularly updating the Default Some common uses of this field include product
Milestone field is a powerful tool when reporting the status of projects. descriptions, product roadmaps, and of course a simple
</PARA> description of the meaning of each milestone.
<PARA>Select the "Update" button when you are done.</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <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>
</listitem>
</orderedlist>
</section>
</PARA> <section id="voting">
</LISTITEM> <title>Voting</title>
</ORDEREDLIST> <para>
</SECTION> The concept of "voting" is a poorly understood, yet powerful
feature for the management of open-source projects. Each user
<SECTION id="voting"> is assigned so many Votes per product, which they can freely
<TITLE>Voting</TITLE> reassign (or assign multiple votes to a single bug). This
<PARA> allows developers to gauge user need for a particular
The concept of "voting" is a poorly understood, yet powerful feature for the management enhancement or bugfix. By allowing bugs with a certain number
of open-source projects. Each user is assigned so many Votes per product, which they can of votes to automatically move from "UNCONFIRMED" to "NEW",
freely reassign (or assign multiple votes to a single bug). users of the bug system can help high-priority bugs garner
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. attention so they don't sit for a long time awaiting triage.
</PARA> </para>
<PARA> <para>
The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you The daunting challenge of Votes is deciding where you draw the
only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED line for a "vocal majority". If you only have a user base of
to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be 100 users, setting a low threshold for bugs to move from
re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved, UNCONFIRMED to NEW makes sense. As the Bugzilla user base
and perhaps forego implementation until you have a critical mass of users who demand it. expands, however, these thresholds must be re-evaluated. You
</PARA> should gauge whether this feature is worth the time and close
<PARA>To modify Voting settings:</PARA> monitoring involved, and perhaps forego implementation until
<ORDEREDLIST> you have a critical mass of users who demand it.
<LISTITEM> </para>
<PARA> <para>To modify Voting settings:</para>
Navigate to the "Edit Product" screen for the Product you wish to modify <orderedlist>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Navigate to the "Edit product" screen for the Product you
<PARA> wish to modify
Set "Maximum Votes per person" to your calculated value. Setting this field </para>
to "0" disables voting. </listitem>
</PARA> <listitem>
</LISTITEM> <para>
<LISTITEM> Set "Maximum Votes per person" to your calculated value.
<PARA> Setting this field to "0" disables voting.
Set "Maximum Votes a person can put on a single bug" to your calculated value. It </para>
should probably be some number lower than the "Maximum votes per person". </listitem>
Setting this field to "0" disables voting, but leaves the voting options open <listitem>
to the user. This is confusing. <para>
</PARA> Set "Maximum Votes a person can put on a single bug" to
</LISTITEM> your calculated value. It should probably be some number
<LISTITEM> lower than the "Maximum votes per person". Setting this
<PARA> field to "0" disables voting, but leaves the voting
Set "Number of votes a bug in this product needs to automatically get out of the options open to the user. This is confusing.
UNCONFIRMED state" to your calculated number. Setting this field to "0" </para>
disables the automatic move of bugs from UNCONFIRMED to NEW. Some people </listitem>
advocate leaving this at "0", but of what use are Votes if your Bugzilla <listitem>
user base is unable to affect which bugs appear on Development radar? <para>
<TIP> Set "Number of votes a bug in this product needs to
<PARA> automatically get out of the UNCONFIRMED state" to your
You should probably set this number to higher than a small coalition of calculated number. Setting this field to "0" disables
Bugzilla users can influence it. Most sites use this as a "referendum" the automatic move of bugs from UNCONFIRMED to NEW. Some
mechanism -- if users are able to vote a bug out of UNCONFIRMED, it people advocate leaving this at "0", but of what use are
is a <EMPHASIS>really</EMPHASIS> bad bug! Votes if your Bugzilla user base is unable to affect which
</PARA> bugs appear on Development radar?
</TIP> <tip>
</PARA> <para>
</LISTITEM> You should probably set this number to higher than a
<LISTITEM> small coalition of Bugzilla users can influence it.
<PARA> Most sites use this as a "referendum" mechanism -- if
Once you have adjusted the values to your preference, select the "Update" button. users are able to vote a bug out of UNCONFIRMED, it is
</PARA> a <emphasis>really</emphasis> bad bug!
</LISTITEM> </para>
</ORDEREDLIST> </tip>
</SECTION> </para>
</listitem>
<SECTION id="groups"> <listitem>
<TITLE>Groups and Group Security</TITLE> <para>
<PARA> Once you have adjusted the values to your preference,
Groups can be very useful in bugzilla, because they allow users to isolate select the "Update" button.
bugs or products that should only be seen by certain people. Groups can also </para>
be a complicated minefield of interdependencies and weirdness if mismanaged. </listitem>
</orderedlist>
</section>
<EXAMPLE> <section id="groups">
<TITLE>When to Use Group Security</TITLE> <title>Groups and Group Security</title>
<INFORMALEXAMPLE> <para>
<PARA> Groups can be very useful in bugzilla, because they allow
Many Bugzilla sites isolate "Security-related" bugs from all other bugs. users to isolate bugs or products that should only be seen by
This way, they can have a fix ready before the security vulnerability certain people. Groups can also be a complicated minefield of
is announced to the world. You can create a "Security" product which, by interdependencies and weirdness if mismanaged.
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. <example>
In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access <title>When to Use Group Security</title>
to products by groups, so that only members of a product group are able to view <informalexample>
bugs within that product. <para>
Group security in Bugzilla can be divided into two categories: Many Bugzilla sites isolate "Security-related" bugs from
Generic and Product-Based. all other bugs. This way, they can have a fix ready
</PARA> before the security vulnerability is announced to the
<NOTE> world. You can create a "Security" product which, by
<PARA> default, has no members, and only add members to the
Groups in Bugzilla are a complicated beast that evolved out of very simple user group (in their individual User page, as described under
permission bitmasks, apparently itself derived from common concepts in UNIX access User Administration) who should have priveleged access
controls. A "bitmask" is a fixed-length number whose value can describe one, and to "Security" bugs. Alternately, you may create a Group
only one, set of states. For instance, UNIX file permissions are assigned bitmask independently of any Product, and change the Group mask
values: "execute" has a value of 1, "write" has a value of 2, on individual bugs to restrict access to members only of
and "read" has a value of 4. Add them together, certain Groups.
and a file can be read, written to, and executed if it has a bitmask of "7". (This </para>
is a simplified example -- anybody who knows UNIX security knows there is much </informalexample>
more to it than this. Please bear with me for the purpose of this note.) The only </example> Groups only work if you enable the "usebuggroups"
way a bitmask scheme can work is by doubling the bit count for each value. Thus paramater. In addition, if the "usebuggroupsentry" parameter
if UNIX wanted to offer another file permission, the next would have to be a value of is "On", one can restrict access to products by groups, so
8, then the next 16, the next 32, etc. that only members of a product group are able to view bugs
</PARA> within that product. Group security in Bugzilla can be divided
<PARA> into two categories: Generic and Product-Based.
Similarly, Bugzilla offers a bitmask to define group permissions, with an internal </para>
limit of 64. Several are already occupied <note>
by built-in permissions. The way around this limitation is <para>
to avoid assigning groups to products if you have many products, avoid bloating Groups in Bugzilla are a complicated beast that evolved out
of group lists, and religiously prune irrelevant groups. In reality, most installations of very simple user permission bitmasks, apparently itself
of Bugzilla support far fewer than 64 groups, so this limitation has not hit derived from common concepts in UNIX access controls. A
for most sites, but it is on the table to be revised for Bugzilla 3.0 "bitmask" is a fixed-length number whose value can describe
because it interferes with the security schemes of some administrators. one, and only one, set of states. For instance, UNIX file
</PARA> permissions are assigned bitmask values: "execute" has a
</NOTE> value of 1, "write" has a value of 2, and "read" has a
<PARA> 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>
<para>
To enable Generic Group Security ("usebuggroups"): To enable Generic Group Security ("usebuggroups"):
</PARA> </para>
<ORDEREDLIST> <orderedlist>
<LISTITEM> <listitem>
<PARA> <para>
Turn "On" "usebuggroups" in the "Edit Parameters" screen. Turn "On" "usebuggroups" in the "Edit Parameters" screen.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
You will generally have no groups set up. Select the "groups" link You will generally have no groups set up. Select the
in the footer. "groups" link in the footer.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Take a moment to understand the instructions on the "Edit Groups" screen. Take a moment to understand the instructions on the "Edit
Once you feel confident you understand what is expected of you, select the Groups" screen. Once you feel confident you understand
"Add Group" link. what is expected of you, select the "Add Group" link.
</PARA> </para>
</LISTITEM> </listitem>
<LISTITEM> <listitem>
<PARA> <para>
Fill out the "New Name" (remember, no spaces!), "New Description", and "New Fill out the "New Name" (remember, no spaces!), "New
User RegExp" fields. "New User RegExp" allows you to automatically place Description", and "New User RegExp" fields. "New User
all users who fulfill the Regular Expression into the new group. RegExp" allows you to automatically place all users who
fulfill the Regular Expression into the new group.
<EXAMPLE> <example>
<TITLE>Creating a New Group</TITLE> <title>Creating a New Group</title>
<INFORMALEXAMPLE> <informalexample>
<PARA> <para>
I created a group called "DefaultGroup" with a description of "This is simply I created a group called DefaultGroup with a
a group to play with", and a "New User RegExp" of "*@velio.com". This description of <quote>This is simply a group to play
new group automatically includes all Bugzilla users with "@velio.com" at the with</quote>, and a New User RegExp of <quote>.*@mydomain.tld</quote>.
end of their user id. When I finished, my new group was assigned bit #128. This new group automatically includes all Bugzilla
</PARA> users with "@mydomain.tld" at the end of their user id.
</INFORMALEXAMPLE> When I finished, my new group was assigned bit #128.
</EXAMPLE> </para>
</informalexample>
</example> When you have finished, select the Add
button.
</para>
</listitem>
</orderedlist>
When you have finished, select the "Add" button. <para>
</PARA> To enable Product-Based Group Security (usebuggroupsentry):
</LISTITEM> </para>
</ORDEREDLIST> <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>
<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>
<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>
<para>
You may find this example illustrative for how bug groups work.
<example>
<title>Bugzilla Groups</title>
<literallayout>
Bugzilla Groups example
-----------------------
<PARA> For this example, let us suppose we have four groups, call them
To enable Product-Based Group Security ("usebuggroupsentry"): Group1, Group2, Group3, and Group4.
</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>
<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>
<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>
</SECTION>
</SECTION>
<SECTION id="security"> We have 5 users, User1, User2, User3, User4, User5.
<TITLE>Bugzilla Security</TITLE>
<EPIGRAPH> We have 8 bugs, Bug1, ..., Bug8.
<PARA>
Putting your money in a wall safe is better protection than depending on the fact that Group membership is defined by this chart:
no one knows that you hide your money in a mayonnaise jar in your fridge. (X denotes that user is in that group.)
</PARA> (I apologize for the nasty formatting of this table. Try viewing
</EPIGRAPH> it in a text-based browser or something for now. -MPB)
<NOTE>
<PARA> G G G G
Poorly-configured MySQL, Bugzilla, and FTP installations have given attackers full r r r r
access to systems in the past. Please take these guidelines seriously, even o o o o
for Bugzilla machines hidden away behind your firewall. 80% of all computer u u u u
trespassers are insiders, not anonymous crackers. p p p p
</PARA> 1 2 3 4
</NOTE> +-+-+-+-+
<PARA> User1|X| | | |
First thing's first: Secure your installation. +-+-+-+-+
<NOTE> User2| |X| | |
<PARA> +-+-+-+-+
These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different User3|X| |X| |
platforms. If you have refinements of these directions for specific platforms, please +-+-+-+-+
submit them to <ULINK URL="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ULINK> User4|X|X|X| |
</PARA> +-+-+-+-+
</NOTE> User5| | | | |
<ORDEREDLIST> +-+-+-+-+
<LISTITEM>
<PARA> Bug restrictions are defined by this chart:
Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had (X denotes that bug is restricted to that group.)
notable security holes and poorly secured default configuration choices.
</PARA> G G G G
</LISTITEM> r r r r
<LISTITEM> o o o o
<PARA><EMPHASIS>There is no substitute for understanding the tools on your system!</EMPHASIS> u u u u
Read <ULINK URL="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> p p p p
The MySQL Privelege System</ULINK> until you can recite it from memory!</PARA> 1 2 3 4
<PARA> +-+-+-+-+
At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant Bug1| | | | |
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 Bug2| |X| | |
advice back when I knew far less about security than I do now : ) +-+-+-+-+
</PARA> Bug3| | |X| |
</LISTITEM> +-+-+-+-+
<LISTITEM> Bug4| | | |X|
<PARA> +-+-+-+-+
Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to Bug5|X|X| | |
port 25 for Sendmail +-+-+-+-+
and port 80 for Apache. Bug6|X| |X| |
</PARA> +-+-+-+-+
</LISTITEM> Bug7|X|X|X| |
<LISTITEM> +-+-+-+-+
<PARA>Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories. Bug8|X|X|X|X|
Run it, instead, as a user with a name, set via your httpd.conf file.</PARA> +-+-+-+-+
</LISTITEM>
<LISTITEM> Who can see each bug?
<PARA>
Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and Bug1 has no group restrictions. Therefore, Bug1 can be seen by any
$BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig file. user, whatever their group membership. This is going to be the only
The localconfig file stores your "bugs" user password, bug that User5 can see, because User5 isn't in any groups.
which would be terrible to have in the hands
of a criminal. Also some files under $BUGZILLA_HOME/data/ store sensitive information, and Bug2 can be seen by anyone in Group2, that is User2 and User4.
$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 Bug3 can be seen by anyone in Group3, that is User3 and User4.
be allowed to see it.
</PARA> Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of
<PARA> these users can see Bug4.
On Apache, you can use .htaccess files to protect access to these directories, as outlined
in <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ULINK> for the
localconfig file, and <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=65572">
Bug 65572</ULINK> for adequate protection in your data/ and shadow/ directories.
</PARA>
<PARA>
Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other
non-Apache web servers, please consult your system documentation for how to secure these
files from being transmitted to curious users.
</PARA>
<PARA>
Place the following text into a file named ".htaccess", readable by your web server,
in your $BUGZILLA_HOME/data directory.
<LITERALLAYOUT>
&lt;Files comments&gt;
allow from all
&lt;/Files&gt;
deny from all
</LITERALLAYOUT>
</PARA>
<PARA>
Place the following text into a file named ".htaccess", readable by your web server,
in your $BUGZILLA_HOME/ directory.
<LITERALLAYOUT>
&lt;Files localconfig&gt;
deny from all
&lt;/Files&gt;
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>
</CHAPTER>
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>
</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
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>
<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 of these directions for specific platforms,
please submit them to <ulink url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ulink>
</para>
</note>
<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>
</listitem>
<listitem>
<para><emphasis>There is no substitute for understanding the
tools on your system!</emphasis> Read <ulink url="http://www.mysql.com/documentation/mysql/bychapter/manual_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>
<para>
Lock down /etc/inetd.conf. Heck, disable inet entirely on
this box. It should only listen to port 25 for Sendmail
and port 80 for Apache.
</para>
</listitem>
<listitem>
<para>
Do not run Apache as <quote>nobody</quote>. This will
require very lax permissions in your Bugzilla directories.
Run it, instead, as a user with a name, set via your
httpd.conf file.
<note>
<para>
<quote>nobody</quote> is a real user on UNIX systems.
Having a process run as user id <quote>nobody</quote>
is absolutely no protection against system crackers
versus using any other user account. As a general
security measure, I recommend you create unique user
ID's for each daemon running on your system and, if
possible, use "chroot" to jail that process away from
the rest of your system.
</para>
</note>
</para>
</listitem>
<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>
<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>
On Apache, you can use .htaccess files to protect access
to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories.
</para>
<para>
Note the instructions which follow are Apache-specific.
If you use IIS, Netscape, or other non-Apache web servers,
please consult your system documentation for how to secure
these files from being transmitted to curious users.
</para>
<para>
Place the following text into a file named ".htaccess",
readable by your web server, in your $BUGZILLA_HOME/data
directory. <literallayout> &lt;Files comments&gt; allow
from all &lt;/Files&gt; deny from all </literallayout>
</para>
<para>
Place the following text into a file named ".htaccess",
readable by your web server, in your $BUGZILLA_HOME/
directory. <literallayout> &lt;Files localconfig&gt; deny
from all &lt;/Files&gt; 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>
</chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:upper
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t
sgml-indent-step:2 sgml-auto-insert-required-elements:t
sgml-indent-data:t sgml-balanced-tag-edit:t
sgml-parent-document:nil
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil sgml-local-catalogs:nil
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: End:
--> -->
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